Rose::Color::HSV Class Reference

Description

Colors in HSV space.

Use HSV when possible since most manipulations of color are defined in this domain and therefore must otherwise be converted to/from the RGB space.

Definition at line 180 of file Color.h.

#include <Rose/Color.h>

Public Member Functions
	HSV ()
	Default constructed color.
	HSV (Component h, Component s, Component v, Component a=1.0)
	Construct a color from components.
	HSV (const RGB &)
	Convert an RGB color to HSV space.
std::string	toHtml () const
	Convert to HTML string.
std::string	toAnsi (Layer) const
	Convert to ANSI color escape.
Component	h () const
	Component of color.
Component	s () const
	Component of color.
Component	v () const
	Component of color.
Component	a () const
	Component of color.
Component	hue () const
	Component of color.
Component	saturation () const
	Component of color.
Component	value () const
	Component of color.
Component	alpha () const
	Component of color.

Constructor & Destructor Documentation

HSV() [1/2]

Rose::Color::HSV::HSV ( )

inline

Default constructed color.

Default constructed colors are useful when a color is stored in a container, but should not generally be used otherwise. Therefore, a default constructed color will be bright red as a warning.

Definition at line 188 of file Color.h.

HSV() [2/2]

Rose::Color::HSV::HSV ( Component  h, Component  s, Component  v, Component  a = 1.0  )

inline

Construct a color from components.

The components are each values between zero and one. Values outside this domain are clipped.

Definition at line 193 of file Color.h.

References Rose::Color::clip().

Member Function Documentation

h()

Component Rose::Color::HSV::h ( ) const

inline

Component of color.

HSV components are named hue, saturation, value, and alpha (or just the first letter of each).

Components are floating-point values between zero and one.

Definition at line 205 of file Color.h.

s()

Component Rose::Color::HSV::s ( ) const

inline

Component of color.

HSV components are named hue, saturation, value, and alpha (or just the first letter of each).

Components are floating-point values between zero and one.

Definition at line 206 of file Color.h.

v()

Component Rose::Color::HSV::v ( ) const

inline

Component of color.

HSV components are named hue, saturation, value, and alpha (or just the first letter of each).

Components are floating-point values between zero and one.

Definition at line 207 of file Color.h.

a()

Component Rose::Color::HSV::a ( ) const

inline

Component of color.

HSV components are named hue, saturation, value, and alpha (or just the first letter of each).

Components are floating-point values between zero and one.

Definition at line 208 of file Color.h.

hue()

Component Rose::Color::HSV::hue ( ) const

inline

Component of color.

HSV components are named hue, saturation, value, and alpha (or just the first letter of each).

Components are floating-point values between zero and one.

Definition at line 209 of file Color.h.

saturation()

Component Rose::Color::HSV::saturation ( ) const

inline

Component of color.

HSV components are named hue, saturation, value, and alpha (or just the first letter of each).

Components are floating-point values between zero and one.

Definition at line 210 of file Color.h.

value()

Component Rose::Color::HSV::value ( ) const

inline

Component of color.

HSV components are named hue, saturation, value, and alpha (or just the first letter of each).

Components are floating-point values between zero and one.

Definition at line 211 of file Color.h.

alpha()

Component Rose::Color::HSV::alpha ( ) const

inline

Component of color.

HSV components are named hue, saturation, value, and alpha (or just the first letter of each).

Components are floating-point values between zero and one.

Definition at line 212 of file Color.h.

---

The documentation for this class was generated from the following file:

• Color.h