Class the represents a floating-point color of red, green, blue, and alpha More...

Public Member Functions
	Rgba (Rgba c)
	Initializes a new instance of the pluginbase.Helpers.Data.Rgba struct. More...

	Rgba (float r, float g, float b)
	Initializes a new instance of the pluginbase.Helpers.Data.Rgba struct. More...

	Rgba (Rgba rgb, float a)
	Initializes a new instance of the pluginbase.Helpers.Data.Rgba struct. More...

	Rgba (float r, float g, float b, float a)
	Initializes a new instance of the pluginbase.Helpers.Data.Rgba struct. More...

string	ToHex ()
	Convert the Rgba instance to a 8-digit hex string More...

override string	ToString ()
	Show the Rgba in a human-readable string format More...

byte []	ToBytes ()
	Convert Rgba instance to array of 4 bytes More...

void	Clamp (float min, float max)
	Clamp each component of Rgba to between min and max More...

void	Clamp ()
	Clamp each component between 0 and 1 More...

void	ClampScale (float max)
	Clamp the Rgba instance, but in a way that scales down the rest of the colors eg, if you have 2.0,1.0,0.5,1.0, and ClampScale(1). You will get 1.0, 0.5, 0.25, 1.0 The alpha component does not follow the scaling More...

void	ClampScale ()
	Clamp the Rgba instance, but in a way that scales down the rest of the colors eg, if you have 2.0,1.0,0.5,1.0, and ClampScale(1). You will get 1.0, 0.5, 0.25, 1.0 The alpha component does not follow the scaling More...

Rgba	Mix (Rgba with, float amt)
	Mix current color with an amount of a second color More...

Static Public Member Functions
static Rgba	FromBytes (byte[] bytes)
	Gets the Rgba instance of a 3 or 4-tuple byte array More...

static Rgba	FromBytes (byte r, byte g, byte b, byte a)
	Gets the Rgba from the byte-version of rgba More...

static Rgba	FromBytes (byte r, byte g, byte b)
	Gets the Rgba instaince from bytes RGB More...

static Rgba	FromBytes (int r, int g, int b, int a)
	Gets the Rgba instance from 0-255 range integers More...

static Rgba	FromBytes (int r, int g, int b)
	Gets the Rgba instance from 0-255 range integers More...

static Rgba	FromHexString (string hexString)
	Gets an Rgba instance from a 3,4,6,8 length hex string, including starting '#' eg #123, #1234, #11223344, #112233 More...

static implicit	operator Vector4 (Rgba color)
	Cast to a vector4 for easy conversion More...

static implicit	operator Rgba (Vector4 vec)
	Get a rgba instance from a vector More...

static	operator Rgba (float[] colors)
	Convert a 4-tuple float array to an Rgba instance More...

static Rgba	operator+ (Rgba v, Rgba w)
	Add instances More...

static Rgba	operator- (Rgba v, Rgba w)
	Subtract components More...

static Rgba	operator* (Rgba v, Rgba w)
	Multiply each component by its counterpart More...

static Rgba	operator* (Rgba v, float c)
	Multiply each component by a constant More...

static Rgba	operator* (float c, Rgba v)
	Multiply each component by a constant More...

static Rgba	operator/ (Rgba v, float c)
	Divide each component by a constant More...

Public Attributes
float	R
	Red component More...

float	G
	Green component More...

float	B
	Blue component More...

float	A
	Alpha component More...

Static Public Attributes
static readonly Rgba	Zero = new Rgba(0f, 0f, 0f, 0f)
	All-zeros (0,0,0,0) More...

static readonly Rgba	Black = new Rgba(0f, 0f, 0f, 1f)
	Black (0,0,0,1) More...

static readonly Rgba	White = new Rgba(1f, 1f, 1f, 1f)
	White (1,1,1,1) More...

static readonly Rgba	Gray = new Rgba(0.5f, 0.5f, 0.5f, 1f)
	Gray (0.5, 0.5, 0.5, 1) More...

static readonly Rgba	Transparent = new Rgba(0f, 0f, 0f, 0f)
	Transparent (0,0,0,0) More...

static readonly Rgba	Red = new Rgba(1f, 0f, 0f, 1f)
	Red (1,0,0,1) More...

static readonly Rgba	Green = new Rgba(0f, 1f, 0f, 1f)
	Green (0,1,0,1) More...

static readonly Rgba	Blue = new Rgba(0f, 0f, 1f, 1f)
	Blue (0,0,1,1) More...

Properties
Rgba	Grayscale `[get]`
	Get the average grayscale version of this color Alpha remains the same More...

float	Luminosity `[get]`
	Get the average luminosity, multiplied by alpha More...

float	LuminosityRgb `[get]`
	Get the luminosity of just the RGB components More...

float	LuminosityWeighted `[get]`
	Gets the human-eye corrected luminosity weights More...

float	LuminosityWeightedRgb `[get]`
	Gets the human-eye corrected RGB components, luminosity More...

Detailed Description

Class the represents a floating-point color of red, green, blue, and alpha

Attribute: StructLayout(LayoutKind.Sequential, Pack = 1)

Constructor & Destructor Documentation

◆ Rgba() [1/4]

pluginbase.Helpers.Data.Rgba.Rgba ( Rgba c )

Initializes a new instance of the pluginbase.Helpers.Data.Rgba struct.

Parameters

c C.

         {
             R = c.R;
             G = c.G;
             B = c.B;
             A = c.A;
         }

◆ Rgba() [2/4]

pluginbase.Helpers.Data.Rgba.Rgba	(	float	r,
		float	g,
		float	b
	)

Initializes a new instance of the pluginbase.Helpers.Data.Rgba struct.

Parameters

r	The red component.
g	The green component.
b	The blue component.

◆ Rgba() [3/4]

pluginbase.Helpers.Data.Rgba.Rgba	(	Rgba	rgb,
		float	a
	)

Initializes a new instance of the pluginbase.Helpers.Data.Rgba struct.

Parameters

rgb	Rgb.
a	The alpha component.

         {
             R = rgb.R;
             G = rgb.G;
             B = rgb.B;
             A = a;
         }

◆ Rgba() [4/4]

pluginbase.Helpers.Data.Rgba.Rgba	(	float	r,
		float	g,
		float	b,
		float	a
	)

Initializes a new instance of the pluginbase.Helpers.Data.Rgba struct.

Parameters

r	The red component.
g	The green component.
b	The blue component.
a	The alpha component.

Member Function Documentation

◆ Clamp() [1/2]

void pluginbase.Helpers.Data.Rgba.Clamp	(	float	min,
		float	max
	)

Clamp each component of Rgba to between min and max

Parameters

min	Minimum.
max	Max.

         {
             R = R < min ? min : (R > max ? max : R);
             G = G < min ? min : (G > max ? max : G);
             B = B < min ? min : (B > max ? max : B);
             A = A < min ? min : (A > max ? max : A);
         }

◆ Clamp() [2/2]

void pluginbase.Helpers.Data.Rgba.Clamp ( )

Clamp each component between 0 and 1

         {
             Clamp(0f, 1f);
         }

◆ ClampScale() [1/2]

void pluginbase.Helpers.Data.Rgba.ClampScale ( float max )

Clamp the Rgba instance, but in a way that scales down the rest of the colors eg, if you have 2.0,1.0,0.5,1.0, and ClampScale(1). You will get 1.0, 0.5, 0.25, 1.0 The alpha component does not follow the scaling

Parameters

max Max.

         {
             float mval = R > G && R > B ? R : (G > B ? G : B);
             if (mval > max)
             {
                 float ratio = 1f / (mval / max);
                 R *= ratio;
                 G *= ratio;
                 B *= ratio;
             }
             A = A > max ? max : A;
         }

◆ ClampScale() [2/2]

void pluginbase.Helpers.Data.Rgba.ClampScale ( )

Clamp the Rgba instance, but in a way that scales down the rest of the colors eg, if you have 2.0,1.0,0.5,1.0, and ClampScale(1). You will get 1.0, 0.5, 0.25, 1.0 The alpha component does not follow the scaling

         {
             ClampScale(1f);
         }

◆ FromBytes() [1/5]

static Rgba pluginbase.Helpers.Data.Rgba.FromBytes ( byte [] bytes )

static

Gets the Rgba instance of a 3 or 4-tuple byte array

Returns: The bytes.

Parameters

bytes Bytes.

Attribute: 0] / 255f, bytes[1] / 255f, bytes[2

/ 255f);

Attribute: 0] / 255f, bytes[1] / 255f, bytes[2] / 255f, bytes[3

/ 255f);

         {
             if (bytes.Length == 3)
             {
                 return new Rgba(bytes[0] / 255f, bytes[1] / 255f, bytes[2] / 255f);
             }
             if (bytes.Length == 4)
             {
                 return new Rgba(bytes[0] / 255f, bytes[1] / 255f, bytes[2] / 255f, bytes[3] / 255f);
             }
             throw new ArgumentOutOfRangeException("Expected 3 or 4 bytes");
         }

◆ FromBytes() [2/5]

static Rgba pluginbase.Helpers.Data.Rgba.FromBytes	(	byte	r,
		byte	g,
		byte	b,
		byte	a
	)

static

Gets the Rgba from the byte-version of rgba

Returns: The bytes.

Parameters

r	The red component.
g	The green component.
b	The blue component.
a	The alpha component.

         {
             return new Rgba(r/255f, g/255f, b/255f, a/255f);
         }

◆ FromBytes() [3/5]

static Rgba pluginbase.Helpers.Data.Rgba.FromBytes	(	byte	r,
		byte	g,
		byte	b
	)

static

Gets the Rgba instaince from bytes RGB

Returns: The bytes.

Parameters

r	The red component.
g	The green component.
b	The blue component.

         {
             return FromBytes(r, g, b, byte.MaxValue);
         }

◆ FromBytes() [4/5]

static Rgba pluginbase.Helpers.Data.Rgba.FromBytes	(	int	r,
		int	g,
		int	b,
		int	a
	)

static

Gets the Rgba instance from 0-255 range integers

Returns: The bytes.

Parameters

r	The red component.
g	The green component.
b	The blue component.
a	The alpha component.

         {
             return FromBytes((byte)r, (byte)g, (byte)b, (byte)a);
         }

◆ FromBytes() [5/5]

static Rgba pluginbase.Helpers.Data.Rgba.FromBytes	(	int	r,
		int	g,
		int	b
	)

static

Gets the Rgba instance from 0-255 range integers

Returns: The bytes.

Parameters

r	The red component.
g	The green component.
b	The blue component.

         {
             return FromBytes((byte)r, (byte)g, (byte)b);
         }

◆ FromHexString()

static Rgba pluginbase.Helpers.Data.Rgba.FromHexString ( string hexString )

static

Gets an Rgba instance from a 3,4,6,8 length hex string, including starting '#' eg #123, #1234, #11223344, #112233

Returns: The hex string.

Parameters

hexString Hex string.

Attribute: 0

!= '#')

Attribute: 1

),

Attribute: 2

),

Attribute: 3

),

Attribute: 4

) : byte.MaxValue);

Attribute: 1], hexString[2

),

Attribute: 3], hexString[4

),

Attribute: 5], hexString[6

),

Attribute: 7], hexString[8

) : byte.MaxValue);

         {
             if (hexString[0] != '#')
             {
                 throw new FormatException("Invalid hex string");
             }   
 
             if (hexString.Length == 4 || hexString.Length == 5) //eg #AAA or #AAAF (RGB/RGBA)
             {
                 return Rgba.FromBytes(
                     Hex.CharValExpanded(hexString[1]),
                     Hex.CharValExpanded(hexString[2]),
                     Hex.CharValExpanded(hexString[3]),
                     hexString.Length == 5 ? Hex.CharValExpanded(hexString[4]) : byte.MaxValue);
             }
             if (hexString.Length == 7 || hexString.Length == 9) //eg #AAAAAA or #AABBCCFF
             {
                 return Rgba.FromBytes(
                     Hex.CharVal(hexString[1], hexString[2]),
                     Hex.CharVal(hexString[3], hexString[4]),
                     Hex.CharVal(hexString[5], hexString[6]),
                     hexString.Length == 9 ? Hex.CharVal(hexString[7], hexString[8]) : byte.MaxValue);
             }
 
             throw new ArgumentOutOfRangeException("Invalid hex string");
         }

◆ Mix()

Rgba pluginbase.Helpers.Data.Rgba.Mix	(	Rgba	with,
		float	amt
	)

Mix current color with an amount of a second color

Parameters

with	With.
amt	Amt.

         {
             return this * (1f - amt) + with * amt;
         }

◆ operator Rgba() [1/2]

static implicit pluginbase.Helpers.Data.Rgba.operator Rgba ( Vector4 vec )

static

Get a rgba instance from a vector

         {
             return new Rgba(vec.X, vec.Y, vec.Z, vec.W);
         }

◆ operator Rgba() [2/2]

static pluginbase.Helpers.Data.Rgba.operator Rgba ( float [] colors )

explicitstatic

Convert a 4-tuple float array to an Rgba instance

Attribute: 0], colors[1], colors[2], colors[3

);

         {
             if (colors.Length != 4)
             {
                 throw new IndexOutOfRangeException("Unable to convert array to RGBA, incorrect size");
             }
             return new Rgba(colors[0], colors[1], colors[2], colors[3]);
         }

◆ operator Vector4()

static implicit pluginbase.Helpers.Data.Rgba.operator Vector4 ( Rgba color )

static

Cast to a vector4 for easy conversion

         {
             return new Vector4(color.R, color.G, color.B, color.A);
         }

◆ operator*() [1/3]

static Rgba pluginbase.Helpers.Data.Rgba.operator*	(	Rgba	v,
		Rgba	w
	)

static

Multiply each component by its counterpart

         {
             return new Rgba(v.R * w.R, v.G * w.G, v.B * w.B, v.A * w.A);
         }

◆ operator*() [2/3]

static Rgba pluginbase.Helpers.Data.Rgba.operator*	(	Rgba	v,
		float	c
	)

static

Multiply each component by a constant

         {
             return new Rgba(v.R * c, v.G * c, v.B * c, v.A * c);
         }

◆ operator*() [3/3]

static Rgba pluginbase.Helpers.Data.Rgba.operator*	(	float	c,
		Rgba	v
	)

static

Multiply each component by a constant

         {
             return new Rgba(v.R * c, v.G * c, v.B * c, v.A * c);
         }

◆ operator+()

static Rgba pluginbase.Helpers.Data.Rgba.operator+	(	Rgba	v,
		Rgba	w
	)

static

Add instances

         {
             return new Rgba(v.R + w.R, v.G + w.G, v.B + w.B, v.A + w.A);
         }

◆ operator-()

static Rgba pluginbase.Helpers.Data.Rgba.operator-	(	Rgba	v,
		Rgba	w
	)

static

Subtract components

         {
             return new Rgba(v.R - w.R, v.G - w.G, v.B - w.B, v.A - w.A);
         }

◆ operator/()

static Rgba pluginbase.Helpers.Data.Rgba.operator/	(	Rgba	v,
		float	c
	)

static

Divide each component by a constant

         {
             return new Rgba(v.R / c, v.G / c, v.B / c, v.A / c);
         }

◆ ToBytes()

byte [] pluginbase.Helpers.Data.Rgba.ToBytes ( )

Convert Rgba instance to array of 4 bytes

Returns: The bytes.

         {
             return new byte[]
             {
                 (byte)(R * 255f),
                 (byte)(G * 255f),
                 (byte)(B * 255f),
                 (byte)(A * 255f)
             };
         }

◆ ToHex()

string pluginbase.Helpers.Data.Rgba.ToHex ( )

Convert the Rgba instance to a 8-digit hex string

Returns: The hex.

         {
             byte r = (byte)(this.R * byte.MaxValue);
             byte g = (byte)(this.G * byte.MaxValue);
             byte b = (byte)(this.B * byte.MaxValue);
             byte a = (byte)(this.A * byte.MaxValue);
             return string.Format("#{0}{1}{2}{3}", Hex.ToHex(r, 2), Hex.ToHex(g, 2), Hex.ToHex(b, 2), Hex.ToHex(a, 2));
         }

◆ ToString()

override string pluginbase.Helpers.Data.Rgba.ToString ( )

Show the Rgba in a human-readable string format

Returns: A System.String that represents the current pluginbase.Helpers.Data.Rgba.

         {
             return string.Format("[{0},{1},{2},{3}]", R, G, B, A);
         }

Member Data Documentation

◆ A

float pluginbase.Helpers.Data.Rgba.A

Alpha component

◆ B

float pluginbase.Helpers.Data.Rgba.B

Blue component

◆ Black

readonly Rgba pluginbase.Helpers.Data.Rgba.Black = new Rgba(0f, 0f, 0f, 1f)

static

Black (0,0,0,1)

◆ Blue

readonly Rgba pluginbase.Helpers.Data.Rgba.Blue = new Rgba(0f, 0f, 1f, 1f)

static

Blue (0,0,1,1)

◆ G

float pluginbase.Helpers.Data.Rgba.G

Green component

◆ Gray

readonly Rgba pluginbase.Helpers.Data.Rgba.Gray = new Rgba(0.5f, 0.5f, 0.5f, 1f)

static

Gray (0.5, 0.5, 0.5, 1)

◆ Green

readonly Rgba pluginbase.Helpers.Data.Rgba.Green = new Rgba(0f, 1f, 0f, 1f)

static

Green (0,1,0,1)

◆ R

float pluginbase.Helpers.Data.Rgba.R

Red component

◆ Red

readonly Rgba pluginbase.Helpers.Data.Rgba.Red = new Rgba(1f, 0f, 0f, 1f)

static

Red (1,0,0,1)

◆ Transparent

readonly Rgba pluginbase.Helpers.Data.Rgba.Transparent = new Rgba(0f, 0f, 0f, 0f)

static

Transparent (0,0,0,0)

◆ White

readonly Rgba pluginbase.Helpers.Data.Rgba.White = new Rgba(1f, 1f, 1f, 1f)

static

White (1,1,1,1)

◆ Zero

readonly Rgba pluginbase.Helpers.Data.Rgba.Zero = new Rgba(0f, 0f, 0f, 0f)

static

All-zeros (0,0,0,0)

Property Documentation

◆ Grayscale

Rgba pluginbase.Helpers.Data.Rgba.Grayscale

get

Get the average grayscale version of this color Alpha remains the same

The grayscale.

◆ Luminosity

float pluginbase.Helpers.Data.Rgba.Luminosity

get

Get the average luminosity, multiplied by alpha

The luminosity.

◆ LuminosityRgb

float pluginbase.Helpers.Data.Rgba.LuminosityRgb

get

Get the luminosity of just the RGB components

The luminosity rgb.

◆ LuminosityWeighted

float pluginbase.Helpers.Data.Rgba.LuminosityWeighted

get

Gets the human-eye corrected luminosity weights

The luminosity weighted.

◆ LuminosityWeightedRgb

float pluginbase.Helpers.Data.Rgba.LuminosityWeightedRgb

get

Gets the human-eye corrected RGB components, luminosity

The luminosity weighted rgb.

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

pluginbase/Helpers/Data/Rgba.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ Rgba() [1/4]

◆ Rgba() [2/4]

◆ Rgba() [3/4]

◆ Rgba() [4/4]

Member Function Documentation

◆ Clamp() [1/2]

◆ Clamp() [2/2]

◆ ClampScale() [1/2]

◆ ClampScale() [2/2]

◆ FromBytes() [1/5]

◆ FromBytes() [2/5]

◆ FromBytes() [3/5]

◆ FromBytes() [4/5]

◆ FromBytes() [5/5]

◆ FromHexString()

◆ Mix()

◆ operator Rgba() [1/2]

◆ operator Rgba() [2/2]

◆ operator Vector4()

◆ operator*() [1/3]

◆ operator*() [2/3]

◆ operator*() [3/3]

◆ operator+()

◆ operator-()

◆ operator/()

◆ ToBytes()

◆ ToHex()

◆ ToString()

Member Data Documentation

◆ A

◆ B

◆ Black

◆ Blue

◆ G

◆ Gray

◆ Green

◆ R

◆ Red

◆ Transparent

◆ White

◆ Zero

Property Documentation

◆ Grayscale

◆ Luminosity

◆ LuminosityRgb

◆ LuminosityWeighted

◆ LuminosityWeightedRgb