Struct FpaColour

Color support

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: FpAssistantCore.General

Assembly: FpAssistantCoreScl.dll

Syntax

public struct FpaColour

Remarks

Added as PCL and CL do not support System.Drawing.Color

Constructors

FpaColour(KnownColours)

Create a colour using RGB

Declaration

public FpaColour(FpaColour.KnownColours knownColour)

Parameters

Type	Name	Description
FpaColour.KnownColours	knownColour	Known colour name from enum selection

Exceptions

Type	Condition
NotImplementedException	KnownColours enum value is not currently supported in FpaColour struct constructor

See Also

FpaColour.KnownColours

FpaColour(byte, KnownColours)

Create a colour using RGB with an Alpha value

Declaration

public FpaColour(byte alpha, FpaColour.KnownColours knownColour)

Parameters

Type	Name	Description
byte	alpha
FpaColour.KnownColours	knownColour	Known colour name from enum selection

Exceptions

Type	Condition
NotImplementedException	KnownColours enum value is not currently supported in FpaColour struct constructor

See Also

FpaColour.KnownColours

FpaColour(byte, byte, byte)

Create a colour using RGB

Declaration

public FpaColour(byte red, byte green, byte blue)

Parameters

Type	Name	Description
byte	red	Value of red in RGB colour
byte	green	Value of green in RGB colour
byte	blue	Value of blue in RGB colour

FpaColour(byte, byte, byte, byte)

Create a colour using RGB with an Alpha channel

Declaration

public FpaColour(byte alpha, byte red, byte green, byte blue)

Parameters

Type	Name	Description
byte	alpha	Value of alpha channel
byte	red	Value of red in RGB colour
byte	green	Value of green in RGB colour
byte	blue	Value of blue in RGB colour

Properties

Alpha

Access to Alpha property

Declaration

public byte Alpha { get; set; }

Property Value

Type	Description
byte	byte value of Alpha channel

Blue

Access to RGB blue property

Declaration

public byte Blue { get; set; }

Property Value

Type	Description
byte	byte value of blue

Green

Access to RGB green property

Declaration

public byte Green { get; set; }

Property Value

Type	Description
byte	byte value of green

Red

Access to RGB red property

Declaration

public byte Red { get; set; }

Property Value

Type	Description
byte	byte value of red

Methods

AsSystemDrawingColor()

Returns a color object based on the System.Drawing.Color

Declaration

public Color AsSystemDrawingColor()

Returns

Type	Description
Color

Remarks

Only available for .NET Standard 2.0 and above