SceneColor Struct

The alpha channel: 0 is transparent, 255 is opaque.

public byte A { get; init; }

Property value

B

The blue channel.

public byte B { get; init; }

Property value

Black

Gets the opaque black color.

public static SceneColor Black { get; }

Property value

G

The green channel.

public byte G { get; init; }

Property value

IsOpaque

Gets a value that indicates whether the color is fully opaque.

public bool IsOpaque { get; }

Property value

Opacity

Gets the opacity of the color, from 0 to 1.

public double Opacity { get; }

Property value

double

R

The red channel.

public byte R { get; init; }

Property value

Transparent

Gets the transparent color.

public static SceneColor Transparent { get; }

Property value

White

Gets the opaque white color.

public static SceneColor White { get; }

Property value

Methods

Name	Description
Deconstruct(byte, byte, byte, byte)
Equals(SceneColor)
Equals(object)
FromHsl(double, double, double, double)	Creates a color from its hue, saturation and lightness, as the CSS function `hsl()`.
GetHashCode()
Parse(string)	Parses a CSS color: `#rgb`, `#rgba`, `#rrggbb`, `#rrggbbaa`, a CSS color name such as `steelblue`, or the functions `rgb()`, `rgba()`, `hsl()` and `hsla()`, with commas or spaces.
ToHexRgb()	Returns the color as `#rrggbb`, without its alpha channel.
ToString()	Returns the color as `#rrggbb`, or `#rrggbbaa` when it is not opaque.
TryParse(string?, SceneColor)	Tries to parse a CSS color: `#rgb`, `#rgba`, `#rrggbb`, `#rrggbbaa`, a CSS color name, or `rgb()`, `rgba()`, `hsl()` and `hsla()`.
WithOpacity(double)	Returns a copy of the color with another opacity.

Deconstruct(byte, byte, byte, byte)

public void Deconstruct(out byte R, out byte G, out byte B, out byte A)

Parameters

R byte
G byte
B byte
A byte

No documentation is available.

Equals overloads

Equals(SceneColor)

public bool Equals(SceneColor other)

Parameters

other SceneColor

Returns

No documentation is available.

Equals(object)

public override bool Equals(object obj)

Parameters

obj object

Returns

No documentation is available.

FromHsl(double, double, double, double)

Creates a color from its hue, saturation and lightness, as the CSS function hsl().

public static SceneColor FromHsl(double hue, double saturation, double lightness, double alpha = 1d)

Parameters

hue double: The hue, in degrees; it wraps around 360.
saturation double: The saturation, from 0 to 1.
lightness double: The lightness, from 0 to 1.
alpha double: The opacity, from 0 to 1.

Returns

SceneColor The color, its channels rounded to the nearest integer.

Exceptions

ArgumentOutOfRangeException: A value is not finite.

GetHashCode()

public override int GetHashCode()

Returns

int

No documentation is available.

Parse(string)

Parses a CSS color: #rgb, #rgba, #rrggbb, #rrggbbaa, a CSS color name such as steelblue, or the functions rgb(), rgba(), hsl() and hsla(), with commas or spaces.

public static SceneColor Parse(string value)

Parameters

value string: The text to parse.

Returns

SceneColor The color.

Exceptions

FormatException: value is not a supported color.

ToHexRgb()

Returns the color as #rrggbb, without its alpha channel.

public string ToHexRgb()

Returns

string The hexadecimal notation of the color.

ToString()

Returns the color as #rrggbb, or #rrggbbaa when it is not opaque.

public override string ToString()

Returns

string The hexadecimal notation of the color.

TryParse(string?, SceneColor)

Tries to parse a CSS color: #rgb, #rgba, #rrggbb, #rrggbbaa, a CSS color name, or rgb(), rgba(), hsl() and hsla().

public static bool TryParse(string? value, out SceneColor color)

Parameters

value string?: The text to parse.
color SceneColor: The color, when the method returns true.

Returns

bool true when value is a supported color.

WithOpacity(double)

Returns a copy of the color with another opacity.

public SceneColor WithOpacity(double opacity)

Parameters

opacity double: The opacity, from 0 to 1.

Returns

SceneColor The color.

Operators

Name	Description
operator ==(SceneColor, SceneColor)
implicit operator SceneColor(string)	Converts a text to a color with `SceneColor.Parse`.
operator !=(SceneColor, SceneColor)

operator ==(SceneColor, SceneColor)

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

Parameters

left SceneColor
right SceneColor

Returns

No documentation is available.

implicit operator SceneColor(string)

Converts a text to a color with SceneColor.Parse.

public static implicit operator SceneColor(string value)

Parameters

value string: The text to parse.

Returns

operator !=(SceneColor, SceneColor)

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

Parameters

left SceneColor
right SceneColor

Returns