Class Gorgon2DBatchState

Defines the state to pass to a call to the Begin(Gorgon2DBatchState, GorgonCameraCommon) method.

Inheritance

object

Gorgon2DBatchState

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: Gorgon.Renderers

Assembly: Gorgon.Renderers.Gorgon2D.dll

Syntax

public sealed class Gorgon2DBatchState

Fields

AdditiveAlphaOverwrite

A pre-defined batch state that sets up additive blending for color values, and using the source alpha channel to overwrite the destination alpha channel.

Declaration

public static readonly Gorgon2DBatchState AdditiveAlphaOverwrite

Field Value

Type	Description
Gorgon2DBatchState

AdditiveBlend

A pre-defined batch state that sets up additive blending.

Declaration

public static readonly Gorgon2DBatchState AdditiveBlend

Field Value

Type	Description
Gorgon2DBatchState

DepthEnabled

A pre-defined batch state that enables depth testing/writing and modulated blending.

Declaration

public static readonly Gorgon2DBatchState DepthEnabled

Field Value

Type	Description
Gorgon2DBatchState

DepthEnabledAdditiveBlend

A pre-defined batch state that enables depth testing/writing and additive blending.

Declaration

public static readonly Gorgon2DBatchState DepthEnabledAdditiveBlend

Field Value

Type	Description
Gorgon2DBatchState

DepthEnabledNoBlend

A pre-defined batch state that enables depth testing/writing and no blending.

Declaration

public static readonly Gorgon2DBatchState DepthEnabledNoBlend

Field Value

Type	Description
Gorgon2DBatchState

DepthEnabledPremultipliedBlend

A pre-defined batch state that enables depth testing/writing and premultiplied blending.

Declaration

public static readonly Gorgon2DBatchState DepthEnabledPremultipliedBlend

Field Value

Type	Description
Gorgon2DBatchState

DepthRead

A pre-defined batch state that enables depth read testing and modulated blending.

Declaration

public static readonly Gorgon2DBatchState DepthRead

Field Value

Type	Description
Gorgon2DBatchState

DepthReadAdditiveBlend

A pre-defined batch state that enables depth read testing and additive blending.

Declaration

public static readonly Gorgon2DBatchState DepthReadAdditiveBlend

Field Value

Type	Description
Gorgon2DBatchState

DepthReadNoBlend

A pre-defined batch state that enables depth read testing and no blending.

Declaration

public static readonly Gorgon2DBatchState DepthReadNoBlend

Field Value

Type	Description
Gorgon2DBatchState

DepthReadPremultipliedBlend

A pre-defined batch state that enables depth read testing and premultiplied blending.

Declaration

public static readonly Gorgon2DBatchState DepthReadPremultipliedBlend

Field Value

Type	Description
Gorgon2DBatchState

InvertedBlend

A pre-defined batch state that sets an inverted blending mode.

Declaration

public static readonly Gorgon2DBatchState InvertedBlend

Field Value

Type	Description
Gorgon2DBatchState

ModulatedAlphaOverwrite

A pre-defined batch state that sets up modulated blending for color values, and using the source alpha channel to overwrite the destination alpha channel.

Declaration

public static readonly Gorgon2DBatchState ModulatedAlphaOverwrite

Field Value

Type	Description
Gorgon2DBatchState

NoBlend

A pre-defined batch state that turns off blending.

Declaration

public static readonly Gorgon2DBatchState NoBlend

Field Value

Type	Description
Gorgon2DBatchState

PremultipliedBlend

A pre-defined batch state that sets up premultiplied blending.

Declaration

public static readonly Gorgon2DBatchState PremultipliedBlend

Field Value

Type	Description
Gorgon2DBatchState

PremultipliedBlendAlphaOverwrite

A pre-defined batch state that sets up premultiplied blendingfor color values, and using the source alpha channel to overwrite the destination alpha channel.

Declaration

public static readonly Gorgon2DBatchState PremultipliedBlendAlphaOverwrite

Field Value

Type	Description
Gorgon2DBatchState

ScissorClipping

A pre-defined batch state that sets scissor rectangle clipping.

Declaration

public static readonly Gorgon2DBatchState ScissorClipping

Field Value

Type	Description
Gorgon2DBatchState

SoftAdditiveBlend

A pre-defined batch state that sets up soft additive blending.

Declaration

public static readonly Gorgon2DBatchState SoftAdditiveBlend

Field Value

Type	Description
Gorgon2DBatchState

WireFrameNoCulling

A pre-defined batch state that sets up wirefame mode with no culling.

Declaration

public static readonly Gorgon2DBatchState WireFrameNoCulling

Field Value

Type	Description
Gorgon2DBatchState

Properties

BlendFactor

Property to set or return the blending factor used to modulate with the pixel shader, current render target or both.

Declaration

public GorgonColor BlendFactor { get; set; }

Property Value

Type	Description
GorgonColor

BlendSampleMask

Property to set or return the mask used to define which samples get updated in the active render target(s).

Declaration

public int BlendSampleMask { get; set; }

Property Value

Type	Description
int

BlendState

Property to return the current blending state to apply.

Declaration

public GorgonBlendState BlendState { get; }

Property Value

Type	Description
GorgonBlendState

DepthStencilState

Property to return the current depth/stencil state to apply.

Declaration

public GorgonDepthStencilState DepthStencilState { get; }

Property Value

Type	Description
GorgonDepthStencilState

PixelShaderState

Property to return the current pixel shader to use.

Declaration

public Gorgon2DShaderState<GorgonPixelShader> PixelShaderState { get; }

Property Value

Type	Description
Gorgon2DShaderState<GorgonPixelShader>

RasterState

Property to return the current raster state to apply.

Declaration

public GorgonRasterState RasterState { get; }

Property Value

Type	Description
GorgonRasterState

StencilReference

Property to set or return the stencil reference value used when performing a stencil test.

Declaration

public int StencilReference { get; set; }

Property Value

Type	Description
int

VertexShaderState

Property to return the current vertex shader to use.

Declaration

public Gorgon2DShaderState<GorgonVertexShader> VertexShaderState { get; }

Property Value

Type	Description
Gorgon2DShaderState<GorgonVertexShader>

Extension Methods

GorgonDebugExtensions.ValidateObject<T>(T, string)

GorgonNullExtensions.AsNullable<T>(object)

GorgonNullExtensions.IfNull<T>(object, T)

GorgonNullExtensions.IsNull(object)