SCR_ColorAHSV Interface Reference

Public Member Functions
void	SCR_ColorAHSV (float alpha, float hue, float saturation, float value)
	Constructs SCR_ColorAHSV from alpha, hue, saturation, and value.
Color	ToColor ()
	Returns a Color representation of this AHSV object.
SCR_ColorAHSV	WithHueShift (float hueShift)
	Returns a copy with a shifted hue HueShift is added to the Hue and then moduloed.

Static Public Member Functions
static SCR_ColorAHSV	FromColorInt (int color)
	Converts an packed color value into an AHSV color object.
static SCR_ColorAHSV	FromColor (Color color)
	Converts color to AHSV format.
static SCR_ColorAHSV	FromARGB (float a, float r, float g, float b)
	Converts RGB color to AHSV format.

Public Attributes
float	m_fAlpha
float	m_fHue
float	m_fSaturation
float	m_fValue

Constructor & Destructor Documentation

SCR_ColorAHSV()

void SCR_ColorAHSV.SCR_ColorAHSV	(	float	alpha,
		float	hue,
		float	saturation,
		float	value )

Constructs SCR_ColorAHSV from alpha, hue, saturation, and value.

Parameters

[in]	alpha	Alpha is the transparency level of the color.
[in]	hue	Hue represents color's position on the color wheel, from 0 to 1.
[in]	saturation	Saturates the color intensity.
[in]	value	Value represents brightness.

Member Function Documentation

FromARGB()

static SCR_ColorAHSV SCR_ColorAHSV.FromARGB ( float a, float r, float g, float b )

static

Converts RGB color to AHSV format.

Parameters

[in]	a	Alpha component.
[in]	r	Red component.
[in]	g	Green component.
[in]	b	Blue component.

Returns

an AHSV color format.

FromColor()

static SCR_ColorAHSV SCR_ColorAHSV.FromColor ( Color color )

static

Converts color to AHSV format.

Parameters

[in]

color

Color.

Returns

an AHSV color.

FromColorInt()

static SCR_ColorAHSV SCR_ColorAHSV.FromColorInt ( int color )

static

Converts an packed color value into an AHSV color object.

Parameters

[in]

color

Packed color.

Returns

an SCR_ColorAHSV.

ToColor()

Color SCR_ColorAHSV.ToColor

(

)

Returns a Color representation of this AHSV object.

Returns

Engine color.

WithHueShift()

SCR_ColorAHSV SCR_ColorAHSV.WithHueShift

(

float

hueShift

)

Returns a copy with a shifted hue HueShift is added to the Hue and then moduloed.

Parameters

[in]

hueShift

HueShift should not be greater than 1 or less than -1;

Returns

New SCR_ColorAHSV of rotated hue color with alpha, saturation, and value preserved.

Member Data Documentation

m_fAlpha

float SCR_ColorAHSV.m_fAlpha

m_fHue

float SCR_ColorAHSV.m_fHue

m_fSaturation

float SCR_ColorAHSV.m_fSaturation

m_fValue

float SCR_ColorAHSV.m_fValue

---

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

• Game/Utilities/SCR_ColorAHSV.c