Struct ColourEffectConfiguration

Simple colour modification effects Mulitple effects can be combined, the result of one effect is fed into the input source of the next The ordering is: [Clear Surface Background?] -> Single Colour -> GrayScale -> Colourise -> Negative -> Opacity

Namespace: Yak2D

Assembly: Yak2D.Api.dll

Syntax

public struct ColourEffectConfiguration

Properties

BackgroundClearColour

If the user elects to clear the desination surface being rendering, this is the colour used

Declaration

public Colour BackgroundClearColour { get; set; }

Property Value

Type	Description
Colour

ClearBackground

Destination surface can be cleared with a chosen colour before rendering if desired

Declaration

public bool ClearBackground { get; set; }

Property Value

Type	Description
System.Boolean

ColourForSingleColourAndColourise

Selected colour to mix in single colour and colourise effects

Declaration

public Colour ColourForSingleColourAndColourise { get; set; }

Property Value

Type	Description
Colour

Colourise

Mix source with colourised image (0 to 1). 1 being entirely colourised

Declaration

public float Colourise { get; set; }

Property Value

Type	Description
System.Single

GrayScale

Mix source with grayscaled image (0 to 1). 1 being entirely grayscale

Declaration

public float GrayScale { get; set; }

Property Value

Type	Description
System.Single

Negative

Mix source with negative image (0 to 1). 1 being entirely negative

Declaration

public float Negative { get; set; }

Property Value

Type	Description
System.Single

Opacity

Multiply all RGBA components of colour by opacity value (0 to 1)

Declaration

public float Opacity { get; set; }

Property Value

Type	Description
System.Single

SingleColour

Mix source with a single colour (0 to 1), 1 being entirely the chosen colour

Declaration

public float SingleColour { get; set; }

Property Value

Type	Description
System.Single