RootSignature

Description

sealed class Tinman.AddOns.DirectX12.Pipeline.RootSignature

Derived from

Disposable abstract
INativeHandle

Full source code is included in the Tinman 3D SDK download.

Wraps a DirectX 12 root signature object.

See also

RootSignature.Initialize

Public / Constructors

Root​Signature

public constructor RootSignature → (1)

pipeline in : RenderPipeline

[not-null]
The render pipeline to use.

Creates a new instance of RootSignature.

Public / Methods

Add​Descriptor​Table

public method AddDescriptorTable → (1)

slots in : IVectorConst<ShaderSlot>

[not-null]
The shader slots to include in the descriptor table. All shader slots must have the same ShaderSlot.ShaderType.

Adds a descriptor table to the root signature.

See also

LifecycleState.Created

Add​Shader​Type

public method AddShaderType → (1)

shaderType in : int32

The shader type.

The given shader type is used by the root signature.

See also

LifecycleState.Created

Add​Static​Sampler

public method AddStaticSampler → (3)

sampler in : DirectX12SamplerState

[not-null]
The sampler description.

shaderType in : int32

The shader type.

shaderSlot in : int32

The shader slot.

Adds a static sampler to the root signature.

The DirectX12SamplerState.BorderColor must be one of the following values:

See also

LifecycleState.Created

Initialize

public method Initialize → ()

returns → bool

true if the object has been initialized,
false if the object has already been initialized before.

Initializes the object, if necessary.

RenderException

If a graphics subsystem error has occurred.

Set​Root​Descriptor​Tables

public method SetRootDescriptorTables → ()

Sets the root descriptor tables in the command list.

Set​Root​Signature

public method SetRootSignature → ()

Sets the root signature in the command list.

Stage​Commit

public method StageCommit → ()

Commits all dirty staging descriptor tables.

Stage​Descriptor​Slot

public method StageDescriptorSlot → (3)

table in : int32

The descriptor table index.

slot in : int32

The descriptor table slot.

descriptor in : IntPtr

The CPU descriptor to stage.

Stages a slot in a descriptor table.

Stage​Descriptor​Slots

public method StageDescriptorSlots → (3)

component in : int32

The shader slot component (see ShaderSlot.Component).

bindType in : int32

The shader slot bind type (see ShaderSlot.BindingType).

descriptor in : IntPtr

The CPU descriptor to stage.

Stages all descriptor table slots that refer to the given shader component.

Public / Attributes

Descriptor​Table​Count

public attribute DescriptorTableCount → (get)

value : int32

[>=0]
The number of root signatures.

Returns the number of descriptor tables in the root signature.