Class GPUPipelineState.Description

Pipeline state description

System.Object
GPUPipelineState.Description
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
[Unmanaged]
public sealed class Description : ValueType

Fields

BlendMode

Colors blending mode

Declaration
public BlendingMode BlendMode
Field Value
BlendingMode

CullMode

Primitives culling mode

Declaration
public CullMode CullMode
Field Value
CullMode

DepthClipEnable

Enable/disable depth clipping

Declaration
public bool DepthClipEnable
Field Value
System.Boolean

DepthEnable

Enable/disable depth (DepthFunc and DepthWriteEnable)

Declaration
public bool DepthEnable
Field Value
System.Boolean

DepthFunc

A function that compares depth data against existing depth data

Declaration
public ComparisonFunc DepthFunc
Field Value
ComparisonFunc

DepthWriteEnable

Enable/disable depth write

Declaration
public bool DepthWriteEnable
Field Value
System.Boolean

DS

Domain shader program

Declaration
public IntPtr DS
Field Value
System.IntPtr

GS

Geometry shader program

Declaration
public IntPtr GS
Field Value
System.IntPtr

HS

Hull shader program

Declaration
public IntPtr HS
Field Value
System.IntPtr

PrimitiveTopology

Input primitives topology

Declaration
public PrimitiveTopologyType PrimitiveTopology
Field Value
PrimitiveTopologyType

PS

Pixel shader program

Declaration
public IntPtr PS
Field Value
System.IntPtr

StencilDepthFailOp

The stencil operation to perform when stencil testing passes and depth testing fails.

Declaration
public StencilOperation StencilDepthFailOp
Field Value
StencilOperation

StencilEnable

Enable/disable stencil buffer usage

Declaration
public bool StencilEnable
Field Value
System.Boolean

StencilFailOp

The stencil operation to perform when stencil testing fails.

Declaration
public StencilOperation StencilFailOp
Field Value
StencilOperation

StencilFunc

The comparison function for the stencil test.

Declaration
public ComparisonFunc StencilFunc
Field Value
ComparisonFunc

StencilPassOp

The stencil operation to perform when stencil testing and depth testing both pass.

Declaration
public StencilOperation StencilPassOp
Field Value
StencilOperation

StencilReadMask

The read mask applied to the reference value and each stencil buffer entry to determine the significant bits for the stencil test.

Declaration
public byte StencilReadMask
Field Value
System.Byte

StencilWriteMask

The write mask applied to values written into the stencil buffer.

Declaration
public byte StencilWriteMask
Field Value
System.Byte

VS

Vertex shader program

Declaration
public IntPtr VS
Field Value
System.IntPtr

Wireframe

True if use wireframe rendering, otherwise false

Declaration
public bool Wireframe
Field Value
System.Boolean

Properties

Default

Default description

Declaration
[Unmanaged]
public static GPUPipelineState.Description Default { get; }
Property Value
GPUPipelineState.Description

DefaultFullscreenTriangle

Default description for fullscreen triangle rendering

Declaration
[Unmanaged]
public static GPUPipelineState.Description DefaultFullscreenTriangle { get; }
Property Value
GPUPipelineState.Description

DefaultNoDepth

Default description without using depth buffer at all

Declaration
[Unmanaged]
public static GPUPipelineState.Description DefaultNoDepth { get; }
Property Value
GPUPipelineState.Description

Extension Methods