.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.Image.HSVValue:
==========================================================================================================================================
|phoenix_title| **wx.Image.HSVValue**
==========================================================================================================================================
A simple class which stores hue, saturation and value as doubles in the range 0.0-1.0.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
HSVValue:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.Image.HSVValue.__init__` Constructor for :ref:`wx.Image.HSVValue`, an object that contains values for hue, saturation and value which represent the value of a color.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.Image.HSVValue.hue` A public C++ attribute of type ``float``.
:attr:`~wx.Image.HSVValue.saturation` A public C++ attribute of type ``float``.
:attr:`~wx.Image.HSVValue.value` A public C++ attribute of type ``float``.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.Image.HSVValue(object)
**Possible constructors**::
HSVValue(h: float=0.0, s: float=0.0, v: float=0.0) -> None
A simple class which stores hue, saturation and value as doubles in
the range 0.0-1.0.
.. method:: __init__(self, h: float=0.0, s: float=0.0, v: float=0.0)
Constructor for :ref:`wx.Image.HSVValue`, an object that contains values for hue, saturation and value which represent the value of a color.
It is used by :meth:`wx.Image.HSVtoRGB` and :meth:`wx.Image.RGBtoHSV` , which convert between ``HSV`` color space and ``RGB`` color space.
:param `h`:
:type `h`: float
:param `s`:
:type `s`: float
:param `v`:
:type `v`: float
:rtype: `None`
.. attribute:: hue
A public C++ attribute of type ``float``.
.. attribute:: saturation
A public C++ attribute of type ``float``.
.. attribute:: value
A public C++ attribute of type ``float``.