Class RedGreenBlue

The RGB class instance

Inheritance

object

BaseColorModel

RedGreenBlue

Namespace: Terminaux.Colors.Models

Assembly: Terminaux.dll

Syntax

public class RedGreenBlue : BaseColorModel

Properties

A

The alpha value indicating transparency applied to the OriginalRgb value.

Declaration

public int A { get; }

Property Value

Type	Description
int

B

The blue color value [0 -> 255]

Declaration

public int B { get; }

Property Value

Type	Description
int

BNormalized

The blue color value [0.0 -> 0.1]

Declaration

public double BNormalized { get; }

Property Value

Type	Description
double

G

The green color value [0 -> 255]

Declaration

public int G { get; }

Property Value

Type	Description
int

GNormalized

The green color value [0.0 -> 0.1]

Declaration

public double GNormalized { get; }

Property Value

Type	Description
double

OriginalRgb

The original RGB values (always opaque)

Declaration

public RedGreenBlue OriginalRgb { get; }

Property Value

Type	Description
RedGreenBlue

R

The red color value [0 -> 255]

Declaration

public int R { get; }

Property Value

Type	Description
int

RNormalized

The red color value [0.0 -> 0.1]

Declaration

public double RNormalized { get; }

Property Value

Type	Description
double

Vector

Gets the three-dimension vector values from RGB color

Declaration

public Vector3 Vector { get; }

Property Value

Type	Description
Vector3

Methods

Equals(object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

object.Equals(object)

Equals(RedGreenBlue)

Declaration

public bool Equals(RedGreenBlue other)

Parameters

Type	Name	Description
RedGreenBlue	other

Returns

Type	Description
bool

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

GetOrderCode()

Gets the RGB order code

Declaration

public int GetOrderCode()

Returns

Type	Description
int	RGB order code in decimal RRRGGGBBB format

IsSpecifierAndValueValid(string)

Does the string specifier represent a valid RGB specifier?

Declaration

public static bool IsSpecifierAndValueValid(string specifier)

Parameters

Type	Name	Description
string	specifier	Specifier that represents a valid RGB specifier

Returns

Type	Description
bool	True if the specifier is valid; false otherwise.

IsSpecifierValid(string, bool)

Does the string specifier represent a valid RGB specifier?

Declaration

public static bool IsSpecifierValid(string specifier, bool checkParts = false)

Parameters

Type	Name	Description
string	specifier	Specifier that represents a valid RGB specifier
bool	checkParts	Whether to check the parts count or not

Returns

Type	Description
bool	True if the specifier is valid; false otherwise.

ParseSpecifierToRgb(string, ColorSettings?)

Parses the specifier and returns an instance of RedGreenBlue

Declaration

public static RedGreenBlue ParseSpecifierToRgb(string specifier, ColorSettings? settings = null)

Parameters

Type	Name	Description
string	specifier	Specifier of RGB
ColorSettings	settings	Settings to use. Use null for global settings

Returns

Type	Description
RedGreenBlue	An instance of RedGreenBlue

Exceptions

Type	Condition
TerminauxException

ToString()

<R>;<G>;<B>

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()

Operators

operator ==(RedGreenBlue, RedGreenBlue)

Declaration

public static bool operator ==(RedGreenBlue left, RedGreenBlue right)

Parameters

Type	Name	Description
RedGreenBlue	left
RedGreenBlue	right

Returns

Type	Description
bool

operator !=(RedGreenBlue, RedGreenBlue)

Declaration

public static bool operator !=(RedGreenBlue left, RedGreenBlue right)

Parameters

Type	Name	Description
RedGreenBlue	left
RedGreenBlue	right

Returns

Type	Description
bool