Struct ClearValue

Structure that specifies a clear value.

Namespace: Evergine.Common.Graphics
Assembly: Evergine.Common.dll
Syntax
public struct ClearValue

Constructors

ClearValue(ClearFlags, Color)

Initializes a new instance of the ClearValue struct.

Declaration
public ClearValue(ClearFlags flags, Color colorValue)
Parameters
Type Name Description
ClearFlags flags

Identifies the textures to clear ClearFlags.
Color colorValue

The value to clear the color attachment.

ClearValue(ClearFlags, params Color[])

Initializes a new instance of the ClearValue struct.

Declaration
public ClearValue(ClearFlags flags, params Color[] colorValues)
Parameters
Type Name Description
ClearFlags flags

Identifies the textures to clear ClearFlags.
Color[] colorValues

The array of values to clear the color attachments.

ClearValue(ClearFlags, params Vector4[])

Initializes a new instance of the ClearValue struct.

Declaration
public ClearValue(ClearFlags flags, params Vector4[] colorValues)
Parameters
Type Name Description
ClearFlags flags

Identifies the textures to clear ClearFlags.
Vector4[] colorValues

The array of values to clear the color attachments.

ClearValue(ClearFlags, float, byte, Color)

Initializes a new instance of the ClearValue struct.

Declaration
public ClearValue(ClearFlags flags, float depth, byte stencil, Color colorValue)
Parameters
Type Name Description
ClearFlags flags

Identifies the textures to clear ClearFlags.
float depth

The value to clear the depth buffer.
byte stencil

The value to clear the stencil buffer.
Color colorValue

The value to clear the color attachment.

ClearValue(ClearFlags, float, byte, params Color[])

Initializes a new instance of the ClearValue struct.

Declaration
public ClearValue(ClearFlags flags, float depth, byte stencil, params Color[] colorValues)
Parameters
Type Name Description
ClearFlags flags

Identifies the textures to clear ClearFlags.
float depth

The value to clear the depth buffer.
byte stencil

The value to clear the stencil buffer.
Color[] colorValues

The array of values to clear the color attachments.

ClearValue(ClearFlags, float, byte, params Vector4[])

Initializes a new instance of the ClearValue struct.

Declaration
public ClearValue(ClearFlags flags, float depth, byte stencil, params Vector4[] colorValues)
Parameters
Type Name Description
ClearFlags flags

Identifies the textures to clear ClearFlags.
float depth

The value to clear the depth buffer.
byte stencil

The value to clear the stencil buffer.
Vector4[] colorValues

The array of values to clear the color attachments.

Fields

ColorValues

The array of clear color values to use when clearing each color attachment.

Declaration
public Vector4[] ColorValues
Field Value
Type Description
Vector4[]

Depth

The depth clear value to use when clearing a depth/stencil attachment.

Declaration
public float Depth
Field Value
Type Description
float

Flags

Used to perform ClearValue.

Declaration
public ClearFlags Flags
Field Value
Type Description
ClearFlags

Stencil

The stencil clear value used when clearing a depth/stencil attachment.

Declaration
public byte Stencil
Field Value
Type Description
byte

Properties

Default

Gets default values for clear value.

Declaration
public static ClearValue Default { get; }
Property Value
Type Description
ClearValue
Remarks

This means one ColorAttachment using CornFlowerBlue as the clear color, with depth = 1 and stencil = 0.

None

Gets the default values for the None clear value.

Declaration
public static ClearValue None { get; }
Property Value
Type Description
ClearValue

Extension Methods