Hexagon.HexColor Class Reference

Provides extension methods for Unity Color and Vector3 types to simplify common color transformations and formatting. More...

Static Public Member Functions
static Color	VectorToColor (this Vector3 vector, float a=1.0f)
	Converts a Vector3 to a Color, using optional alpha.
static Color	VectorToColor (this Vector4 vector)
	Converts a Vector4 to a Color.
static Vector3	ColorToVector3 (this Color color)
	Converts a Color to a Vector3 containing only RGB components.
static Vector4	ColorToVector4 (this Color color)
	Converts a Color to a Vector4.
static Color	WithRed (this Color color, float r)
	Returns a copy of the color with a new red component.
static Color	WithGreen (this Color color, float g)
	Returns a copy of the color with a new green component.
static Color	WithBlue (this Color color, float b)
	Returns a copy of the color with a new blue component.
static Color	WithAlpha (this Color color, float a)
	Returns a copy of the color with a new alpha component.
static Color	WithBrightness (this Color color, float brightness)
	Applies brightness scaling after normalizing RGB components.
static float	GetRGBMagnitude (this Color color)
	Computes Euclidean length of RGB components.
static float	GetRGBAMagnitude (this Color color)
	Computes Euclidean length of RGBA components.
static Color	ScaleRGB (this Color color, float scalar)
	Scales RGB channels by a given factor.
static Color	ScaleRGBA (this Color color, float scalar)
	Scales all RGBA channels by a given factor.
static Color	NormalizeRGB (this Color color)
	Normalizes RGB components to unit length; output brightness is constant.
static Color	NormalizeRGBA (this Color color)
	Normalizes all RGBA components to unit length; output brightness is constant.
static string	WrapInHTMLTagRGB (this Color color, string @string)
	Wraps a string in a Unity color tag using RGB only.
static string	WrapInHTMLTagRGBA (this Color color, string @string)
	Wraps a string in a Unity color tag including alpha.

Detailed Description

Provides extension methods for Unity Color and Vector3 types to simplify common color transformations and formatting.

Member Function Documentation

ColorToVector3()

static Vector3 Hexagon.HexColor.ColorToVector3 ( this Color color )

static

Converts a Color to a Vector3 containing only RGB components.

Parameters

color

Input Color.

Returns

Vector3 with r, g, b components.

ColorToVector4()

static Vector4 Hexagon.HexColor.ColorToVector4 ( this Color color )

static

Converts a Color to a Vector4.

Parameters

color

Input Color.

Returns

Vector4 with r, g, b, a components.

GetRGBAMagnitude()

static float Hexagon.HexColor.GetRGBAMagnitude ( this Color color )

inlinestatic

Computes Euclidean length of RGBA components.

Parameters

color

Input color.

Returns

Magnitude of RGBA vector.

GetRGBMagnitude()

static float Hexagon.HexColor.GetRGBMagnitude ( this Color color )

inlinestatic

Computes Euclidean length of RGB components.

Parameters

color

Input color.

Returns

Magnitude of RGB vector.

NormalizeRGB()

static Color Hexagon.HexColor.NormalizeRGB ( this Color color )

inlinestatic

Normalizes RGB components to unit length; output brightness is constant.

Parameters

color

Input color.

Returns

Color with normalized RGB and original alpha.

NormalizeRGBA()

static Color Hexagon.HexColor.NormalizeRGBA ( this Color color )

inlinestatic

Normalizes all RGBA components to unit length; output brightness is constant.

Parameters

color

Input color.

Returns

Color with normalized RGBA.

ScaleRGB()

static Color Hexagon.HexColor.ScaleRGB ( this Color color, float scalar )

inlinestatic

Scales RGB channels by a given factor.

Parameters

color	Input color.
scalar	Scaling factor.

Returns

Color with scaled RGB, original alpha.

ScaleRGBA()

static Color Hexagon.HexColor.ScaleRGBA ( this Color color, float scalar )

inlinestatic

Scales all RGBA channels by a given factor.

Parameters

color	Input color.
scalar	Scaling factor.

Returns

Color with scaled RGBA components.

VectorToColor() [1/2]

static Color Hexagon.HexColor.VectorToColor ( this Vector3 vector, float a = 1.0f )

static

Converts a Vector3 to a Color, using optional alpha.

Parameters

vector	Vector3 with RGB components in [0,1] range.
a	Alpha value to use, default is 1.0.

Returns

A Color constructed from the vector and alpha.

VectorToColor() [2/2]

static Color Hexagon.HexColor.VectorToColor ( this Vector4 vector )

static

Converts a Vector4 to a Color.

Parameters

vector

Vector4 with RGBA components in [0,1] range.

Returns

A Color constructed from the vector.

WithAlpha()

static Color Hexagon.HexColor.WithAlpha ( this Color color, float a )

static

Returns a copy of the color with a new alpha component.

WithBlue()

static Color Hexagon.HexColor.WithBlue ( this Color color, float b )

static

Returns a copy of the color with a new blue component.

WithBrightness()

static Color Hexagon.HexColor.WithBrightness ( this Color color, float brightness )

inlinestatic

Applies brightness scaling after normalizing RGB components.

Parameters

color	Input color to adjust.
brightness	Scaling factor for brightness.

Returns

Normalized and brightness-scaled color.

WithGreen()

static Color Hexagon.HexColor.WithGreen ( this Color color, float g )

static

Returns a copy of the color with a new green component.

WithRed()

static Color Hexagon.HexColor.WithRed ( this Color color, float r )

static

Returns a copy of the color with a new red component.

WrapInHTMLTagRGB()

static string Hexagon.HexColor.WrapInHTMLTagRGB ( this Color color, string @ string )

inlinestatic

Wraps a string in a Unity color tag using RGB only.

Parameters

color	Text color.
string	String to wrap.

Returns

String with Unity color tag applied.

WrapInHTMLTagRGBA()

static string Hexagon.HexColor.WrapInHTMLTagRGBA ( this Color color, string @ string )

inlinestatic

Wraps a string in a Unity color tag including alpha.

Parameters

color	Text color.
string	String to wrap.

Returns

String with Unity color tag applied.

---

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

• Assets/Hexagon/Core/HexColor.cs