DirectXEffect

Description

abstract class Tinman.Engine.API.DirectXEffect
→ <TParameters : RenderEffectParameters>
→ <TBlendState ^ref>
→ <TDepthStencilState ^ref>
→ <TRasterizerState ^ref>
→ <TSamplerState ^ref>

Derived from: RenderEffectGeneric<TParameters> ^abstract
Extended by: DirectX11Effect ^abstract
DirectX12Effect ^abstract

Abstract base class for IRenderEffect implementations for DirectX 11 or higher.

An implementing class must perform the following steps in its constructor:

Create render effect passes with RenderEffect.PassCreate.
Create shader objects with RenderEffect.ShaderCreate and assign them to render effect passes with RenderEffect.ShaderAssign.
Create render state objects with BlendStateCreate², DepthStencilStateCreate², RasterizerStateCreate² and assign them to render effect passes with BlendStateAssign³, DepthStencilStateAssign³, RasterizerStateAssign³.
Create sampler state objects with SamplerStateCreate² and assign them to shader slots with SamplerStateAssign¹.
Create constant buffer objects with ConstantBufferCreate and assign them to shader slots with ConstantBufferAssign.
Assign shader resources to shader slots with ShaderResourceCreate and ShaderResourceAssign.
Assign unordered access resources to shader slots with UnorderedAccessResourceCreate and UnorderedAccessResourceAssign.

If an implementation wants to use low-level parameter slots, the following steps must be performed in the constructor:

Declare automatic use of constant buffers with ConstantBufferDeclare.
Declare automatic use of sampler states with SamplerStateAssign⁴.
Declare automatic use of shader resources with ShaderResourceDeclare.
Declare automatic use of unordered access resources with UnorderedAccessResourceDeclare.
Declare low-level parameter slots with IRenderEffectParameters.ParameterDeclare, for example by calling RenderEffectParameters.Declare.

When using low-level parameter slots, the following methods are called automatically:

ConstantBufferCreate
ConstantBufferAssign
SamplerStateAssign¹
ShaderResourceCreate
UnorderedAccessResourceAssign

Public / Methods

BlendStateApply

public abstract method BlendStateApply → (2)

preset ⁱⁿ : RenderStatePreset: The render state preset.
state ^opt : TBlendState = null: The state description to update or null to use a default one.
returns → TBlendState: state ^opt

Applies the given render state preset.

See also: RenderStatePreset.AlphaBlending
RenderStatePreset.AlphaCoverage

BlendStateAssign

_3 overloads

public method BlendStateAssign¹ → (2)

state ⁱⁿ : RenderStatePreset: The blend state.
pass ⁱⁿ : int32: [0..IRenderEffectBase.PassCount-1]
The render effect pass.
returns → int32: The blend state index.

Assigns a blend state to a render effect pass.

RenderException: If a graphics subsystem error has occurred.

public method BlendStateAssign² → (2)

state ⁱⁿ : TBlendState: [not-null]
The blend state.
pass ⁱⁿ : int32: [0..IRenderEffectBase.PassCount-1]
The render effect pass.
returns → int32: The blend state index.

Assigns a blend state to a render effect pass.

RenderException: If a graphics subsystem error has occurred.

public method BlendStateAssign³ → (2)

state ⁱⁿ : int32: [0..DirectXEffect.BlendStateCount-1]
The blend state index.
pass ⁱⁿ : int32: [0..IRenderEffectBase.PassCount-1]
The render effect pass.

Assigns a blend state to a render effect pass.

BlendStateCreate

_2 overloads

public method BlendStateCreate¹ → (1)

state ⁱⁿ : RenderStatePreset: The blend state
returns → int32: The blend state index.

Creates a blend state.

RenderException: If a graphics subsystem error has occurred.

public method BlendStateCreate² → (1)

stateDesc ⁱⁿ : TBlendState: [not-null]
The blend state
returns → int32: The blend state index.

Creates a blend state.

RenderException: If a graphics subsystem error has occurred.

ConstantBufferAssign

public method ConstantBufferAssign → (3)

buffer ⁱⁿ : int32: [0..DirectXEffect.ConstantBufferCount-1]
The constant buffer index.
shader ⁱⁿ : int32: [0..RenderEffect.ShaderObjectCount-1]
The shader object index.
slot ⁱⁿ : int32: [>=0]
The shader slot.

Assigns a constant buffer to a shader slot.

ConstantBufferCreate

public method ConstantBufferCreate → (1)

size ⁱⁿ : int32: [>0]
The buffer size, in bytes.
returns → int32: The constant buffer index.

Creates a constant buffer.

RenderException: If a graphics subsystem error has occurred.

ConstantBufferDeclare

public method ConstantBufferDeclare → (1)

name ⁱⁿ : string: [not-empty]
The constant buffer name.

Declares automatic use of the given constant buffer.

All shader objects must have been created via RenderEffect.ShaderCreate and must have been assigned to passes via RenderEffect.ShaderAssign before a constant buffer may be declared.

RenderException: If a graphics subsystem error has occurred.

DepthStencilStateApply

public abstract method DepthStencilStateApply → (2)

preset ⁱⁿ : RenderStatePreset: The render state preset.
state ^opt : TDepthStencilState = null: The state description to update or null to use a default one.
returns → TDepthStencilState: state ^opt

Applies the given render state preset.

See also: RenderStatePreset.NoWriteZ

DepthStencilStateAssign

_3 overloads

public method DepthStencilStateAssign¹ → (2)

state ⁱⁿ : RenderStatePreset: The depth/stencil state.
pass ⁱⁿ : int32: [0..IRenderEffectBase.PassCount-1]
The render effect pass.
returns → int32: The depth/stencil state index.

Assigns a depth/stencil state to a render effect pass.

RenderException: If a graphics subsystem error has occurred.

public method DepthStencilStateAssign² → (2)

state ⁱⁿ : TDepthStencilState: [not-null]
The depth/stencil state.
pass ⁱⁿ : int32: [0..IRenderEffectBase.PassCount-1]
The render effect pass.
returns → int32: The depth/stencil state index.

Assigns a depth/stencil state to a render effect pass.

RenderException: If a graphics subsystem error has occurred.

public method DepthStencilStateAssign³ → (2)

state ⁱⁿ : int32: [0..DirectXEffect.DepthStencilStateCount-1]
The depth/stencil state index.
pass ⁱⁿ : int32: [0..IRenderEffectBase.PassCount-1]
The render effect pass.

Assigns a depth/stencil state to a render effect pass.

DepthStencilStateCreate

_2 overloads

public method DepthStencilStateCreate¹ → (1)

state ⁱⁿ : RenderStatePreset: The depth/stencil state.
returns → int32: The depth/stencil state index.

Creates a depth/stencil state.

RenderException: If a graphics subsystem error has occurred.

public method DepthStencilStateCreate² → (1)

stateDesc ⁱⁿ : TDepthStencilState: [not-null]
The depth/stencil state.
returns → int32: The depth/stencil state index.

Creates a depth/stencil state.

RenderException: If a graphics subsystem error has occurred.

PassState

public method PassState → (7)

pass ⁱⁿ : int32: [0..IRenderEffectBase.PassCount-1]
The render effect pass.
stencilRef ^opt : int32 = 0: The stencil reference value.
sampleMask ^opt : int32 = ~0: The coverage sample mask.
blendFactorR ^opt : float32 = 1: The red blend factors.
blendFactorG ^opt : float32 = 1: The green blend factors.
blendFactorB ^opt : float32 = 1: The blue blend factors.
blendFactorA ^opt : float32 = 1: The alpha blend factors.

Assigns render state to a render effect pass.

RasterizerStateApply

public abstract method RasterizerStateApply → (2)

preset ⁱⁿ : RenderStatePreset: The render state preset.
state ^opt : TRasterizerState = null: The state description to update or null to use a default one.
returns → TRasterizerState: state ^opt

Applies the given render state preset.

See also: RenderStatePreset.AlphaBlending
RenderStatePreset.NoCulling
RenderStatePreset.Wireframe

RasterizerStateAssign

_3 overloads

public method RasterizerStateAssign¹ → (2)

state ⁱⁿ : RenderStatePreset: The rasterizer state.
pass ⁱⁿ : int32: [0..IRenderEffectBase.PassCount-1]
The render effect pass.
returns → int32: The rasterizer state index.

Assigns a rasterizer state to a render effect pass.

RenderException: If a graphics subsystem error has occurred.

public method RasterizerStateAssign² → (2)

state ⁱⁿ : TRasterizerState: [not-null]
The rasterizer state.
pass ⁱⁿ : int32: [0..IRenderEffectBase.PassCount-1]
The render effect pass.
returns → int32: The rasterizer state index.

Assigns a rasterizer state to a render effect pass.

RenderException: If a graphics subsystem error has occurred.

public method RasterizerStateAssign³ → (2)

state ⁱⁿ : int32: [0..DirectXEffect.RasterizerStateCount-1]
The rasterizer state index.
pass ⁱⁿ : int32: [0..IRenderEffectBase.PassCount-1]
The render effect pass.

Assigns a rasterizer state to a render effect pass.

RasterizerStateCreate

_2 overloads

public method RasterizerStateCreate¹ → (1)

state ⁱⁿ : RenderStatePreset: The rasterizer state.
returns → int32: The rasterizer state index.

Creates a rasterizer state.

RenderException: If a graphics subsystem error has occurred.

public method RasterizerStateCreate² → (1)

stateDesc ⁱⁿ : TRasterizerState: [not-null]
The rasterizer state.
returns → int32: The rasterizer state index.

Creates a rasterizer state.

RenderException: If a graphics subsystem error has occurred.

RenderStateAssign

_2 overloads

public method RenderStateAssign¹ → (1)

pass ⁱⁿ : int32: [0..IRenderEffectBase.PassCount-1]
The render effect pass.

Assigns the given common render state preset to the given pass.

This method simply delegates to BlendStateAssign¹, DepthStencilStateAssign¹ and RasterizerStateAssign¹, passing the render state preset obtained from RenderEffectParameters.EffectRenderState.

RenderException: If a graphics subsystem error has occurred.

public method RenderStateAssign² → (2)

state ⁱⁿ : RenderStatePreset: The render state preset state.
pass ⁱⁿ : int32: [0..IRenderEffectBase.PassCount-1]
The render effect pass.

Assigns the given render state preset to the given pass.

This method simply delegates to BlendStateAssign¹, DepthStencilStateAssign¹ and RasterizerStateAssign¹.

RenderException: If a graphics subsystem error has occurred.

SamplerStateApply

public abstract method SamplerStateApply → (2)

preset ⁱⁿ : SamplerStatePreset: The render state preset.
state ^opt : TSamplerState = null: The state description to update or null to use a default one.
returns → TSamplerState: state ^opt

Applies the given render state preset.

SamplerStateAssign

_4 overloads

public method SamplerStateAssign¹ → (3)

sampler ⁱⁿ : int32: [0..DirectXEffect.SamplerStateCount-1]
The sampler state index.
shader ⁱⁿ : int32: [0..RenderEffect.ShaderObjectCount-1]
The shader object index.
slot ⁱⁿ : int32: [>=0]
The shader slot.

Assigns the given sampler state to a shader slot.

public method SamplerStateAssign² → (2)

sampler ⁱⁿ : SamplerStatePreset: The sampler state.
name ⁱⁿ : string: [not-empty]
The sampler state name.
returns → int32: The sampler state index.

Declares automatic use of the given sampler state.

All shader objects must have been created via RenderEffect.ShaderCreate and must have been assigned to passes via RenderEffect.ShaderAssign before a sampler state may be declared.

RenderException: If a graphics subsystem error has occurred.

public method SamplerStateAssign³ → (3)

sampler ⁱⁿ : TSamplerState: [not-null]
The sampler state.
name ⁱⁿ : string: [not-empty]
The sampler state name.
count ^opt : int32 = 1: [>=1]
The number of consecutive sampler states.
returns → int32: The sampler state index.

Declares automatic use of the given sampler state.

All shader objects must have been created via RenderEffect.ShaderCreate and must have been assigned to passes via RenderEffect.ShaderAssign before a sampler state may be declared.

RenderException: If a graphics subsystem error has occurred.

public method SamplerStateAssign⁴ → (2)

sampler ⁱⁿ : int32: [0..DirectXEffect.SamplerStateCount-1]
The sampler state index.
name ⁱⁿ : string: [not-empty]
The sampler state name.

Declares automatic use of the given sampler state.

All shader objects must have been created via RenderEffect.ShaderCreate and must have been assigned to passes via RenderEffect.ShaderAssign before a sampler state may be declared.

RenderException: If a graphics subsystem error has occurred.

SamplerStateCreate

_2 overloads

public method SamplerStateCreate¹ → (1)

state ⁱⁿ : SamplerStatePreset: The sampler state.
returns → int32: The sampler state index.

Creates a sampler state.

RenderException: If a graphics subsystem error has occurred.

public method SamplerStateCreate² → (1)

stateDesc ⁱⁿ : TSamplerState: [not-null]
The sampler state.
returns → int32: The sampler state index.

Creates a sampler state.

RenderException: If a graphics subsystem error has occurred.

ShaderResourceAssign

public method ShaderResourceAssign → (3)

resource ⁱⁿ : int32: [0..DirectXEffect.ShaderResourceCount-1]
The shader resource.
shader ⁱⁿ : int32: [0..RenderEffect.ShaderObjectCount-1]
The shader object index.
slot ⁱⁿ : int32: [>=0]
The shader slot.

Assigns the given shader resource to a slot of the given shader.

RenderException: If a graphics subsystem error has occurred.

ShaderResourceCreate

public method ShaderResourceCreate → ()

returns → int32: The shader resource index.

Creates a new shader resource.

ShaderResourceDeclare

public method ShaderResourceDeclare → (1)

name ⁱⁿ : string: [not-empty]
The shader resource name.

Declares automatic use of the given shader resource.

All shader objects must have been created via RenderEffect.ShaderCreate and must have been assigned to passes via RenderEffect.ShaderAssign before a shader resource may be declared.

RenderException: If a graphics subsystem error has occurred.

ShaderResourceDeclareWithState

_2 overloads

public method ShaderResourceDeclareWithState¹ → (2)

name ⁱⁿ : string: [not-empty]
The shader resource name.
sampler ^opt : string = null: The sampler name. If null, name ⁱⁿ will be used after adding the "Sampler" suffix.

Declares automatic use of the given shader resource and assigns the common sampler state preset, by delegating to RenderEffectParameters.EffectSamplerState and ShaderResourceDeclareWithState².

All shader objects must have been created via RenderEffect.ShaderCreate and must have been assigned to passes via RenderEffect.ShaderAssign before a shader resource may be declared.

RenderException: If a graphics subsystem error has occurred.

public method ShaderResourceDeclareWithState² → (3)

name ⁱⁿ : string: [not-empty]
The shader resource name.
preset ⁱⁿ : SamplerStatePreset: The sampler state preset state.
sampler ^opt : string = null: The sampler name. If null, name ⁱⁿ will be used after adding the "Sampler" suffix.

Declares automatic use of the given shader resource and assigns the given sampler state preset, by delegating to ShaderResourceDeclare and SamplerStateAssign².

All shader objects must have been created via RenderEffect.ShaderCreate and must have been assigned to passes via RenderEffect.ShaderAssign before a shader resource may be declared.

RenderException: If a graphics subsystem error has occurred.

UnorderedAccessResourceAssign

public method UnorderedAccessResourceAssign → (3)

resource ⁱⁿ : int32: [0..DirectXEffect.UnorderedAccessResourceCount-1]
The unordered access resource index.
shader ⁱⁿ : int32: [0..RenderEffect.ShaderObjectCount-1]
The shader object index.
slot ⁱⁿ : int32: [>=0]
The shader slot.

Assigns the given unordered access resource to a slot of the given shader.

UnorderedAccessResourceCreate

public method UnorderedAccessResourceCreate → ()

returns → int32: The unordered access resource index.

Creates a new unordered access resource.

UnorderedAccessResourceDeclare

public method UnorderedAccessResourceDeclare → (1)

name ⁱⁿ : string: [not-empty]
The unordered access resource name.

Declares automatic use of the given unordered access resource.

All shader objects must have been created via RenderEffect.ShaderCreate and must have been assigned to passes via RenderEffect.ShaderAssign before an unordered access resource may be declared.

RenderException: If a graphics subsystem error has occurred.

Public / Attributes

BlendStateCount

public attribute BlendStateCount → (get)

value : int32: [>=0]
The number of blend states.

Returns the number of blend states.

ConstantBufferCount

public attribute ConstantBufferCount → (get)

value : int32: [>=0]
The number of constant buffers.

Returns the number of constant buffers.

DepthStencilStateCount

public attribute DepthStencilStateCount → (get)

value : int32: [>=0]
The number of depth/stencil.

Returns the number of depth/stencil states.

RasterizerStateCount

public attribute RasterizerStateCount → (get)

value : int32: [>=0]
The number of rasterizer states.

Returns the number of rasterizer states.

SamplerStateCount

public attribute SamplerStateCount → (get)

value : int32: [>=0]
The number of sampler states.

Returns the number of sampler states.

ShaderResourceCount

public attribute ShaderResourceCount → (get)

value : int32: [>=0]
The number of shader resources.

Returns the number of shader resources.

UnorderedAccessResourceCount

public attribute UnorderedAccessResourceCount → (get)

value : int32: [>=0]
The number of unordered access resources.

Returns the number of unordered access resources.

Protected / Constructors

DirectXEffect

protected constructor DirectXEffect → (4)

parameters ⁱⁿ : TParameters: [not-null]
The render effect parameters object.
repositoryPublic ⁱⁿ : Path: [not-null]
The public GPU shader repository path or Path.Unknown if none.
repositoryPrivate ⁱⁿ : Path: [not-null]
The private GPU shader repository path or Path.Unknown if none.
shaderTypeCount ⁱⁿ : int32: [>=1]
The number of shader types.

Creates a new instance of DirectXEffect.

Protected / Methods

ClearResourceBindings

protected virtual method ClearResourceBindings → ()

Clears the given binding slots for shader resources and unordered access resources.

The default implementation clears all resource bindings by calling SetShaderResourceBinding and SetUnorderedAccessResourceBinding passing null as the current resource object.

DoBlendStateCreate

protected abstract method DoBlendStateCreate → (2)

state ⁱⁿ : int32: The state index.
stateDesc ⁱⁿ : TBlendState: The state description.

Creates a blend state.

RenderException: If a graphics subsystem error has occurred.

DoConstantBufferCreate

protected abstract method DoConstantBufferCreate → (2)

buffer ⁱⁿ : int32: The constant buffer index.
sizeAligned ⁱⁿ : int32: Aligned size, in bytes.

Creates a constant buffer.

RenderException: If a graphics subsystem error has occurred.

DoConstantBufferUpdate

protected abstract method DoConstantBufferUpdate → (2)

buffer ⁱⁿ : int32: The constant buffer.
data ⁱⁿ : ByteBuffer: The updated constant buffer data.

Updates the given constant buffer.

This method will only be called between paired calls to DoConstantBufferUpdateBegin and DoConstantBufferUpdateEnd.

DoConstantBufferUpdateBegin

[EmptyBody]
protected virtual method DoConstantBufferUpdateBegin → ()

Begins a sequence of constant buffer updates.

See also: DirectXEffect.DoConstantBufferUpdate

DoConstantBufferUpdateEnd

[EmptyBody]
protected virtual method DoConstantBufferUpdateEnd → ()

Ends the current sequence of constant buffer updates.

See also: DirectXEffect.DoConstantBufferUpdate

DoDepthStencilStateCreate

protected abstract method DoDepthStencilStateCreate → (2)

state ⁱⁿ : int32: The state index.
stateDesc ⁱⁿ : TDepthStencilState: The state description.

Creates a depth/stencil state.

RenderException: If a graphics subsystem error has occurred.

DoRasterizerStateCreate

protected abstract method DoRasterizerStateCreate → (2)

state ⁱⁿ : int32: The state index.
stateDesc ⁱⁿ : TRasterizerState: The state description.

Creates a rasterizer state.

RenderException: If a graphics subsystem error has occurred.

DoSamplerStateCreate

protected abstract method DoSamplerStateCreate → (2)

state ⁱⁿ : int32: The state index.
stateDesc ⁱⁿ : TSamplerState: The state description.

Creates a sampler state.

RenderException: If a graphics subsystem error has occurred.

DoShaderCreate_ByteCode

protected abstract method DoShaderCreate_ByteCode → (3)

type ⁱⁿ : int32: The shader type.
shader ⁱⁿ : int32: The shader index.
byteCode ⁱⁿ : ByteBuffer: The shader bytecode.

Consumes the shader bytecode.

RenderException: If a graphics subsystem error has occurred.

DoShaderCreate_Info

protected abstract method DoShaderCreate_Info → (1)

binary ⁱⁿ : Path: Path to the shader binary.
returns → DirectXShaderInfo: The shader information.

Reads shader information for the given shader binary.

IOException: If an I/O error has occurred.

ValidatingException: If the shader metadata has an invalid format.

PassCreateWithState

protected method PassCreateWithState → (1)

pass ⁱⁿ : int32: [>=0]
The render effect pass index.

Creates a render effect pass and applies its common render state preset.

This method simply delegates to RenderEffect.PassCreate and RenderStateAssign¹.

RenderException: If a graphics subsystem error has occurred.

SetConstantBuffer

protected abstract method SetConstantBuffer → (3)

type ⁱⁿ : int32: The shader type.
slot ⁱⁿ : int32: The shader binding slot.
buffer ⁱⁿ : int32: The buffer.

Assigns the given constant buffer to the specified shader slot.

SetParameters

protected virtual method SetParameters → (1)

forceShaderResources ⁱⁿ : bool: Force setting of all shader resource parameters via SetResource(…), regardless of their changed state?

Applies the current values of all changed effect parameters (see RenderEffectParameters.Changed²).

See also: DirectXEffect.SetShaderResource³
DirectXEffect.SetShaderResource¹
DirectXEffect.SetShaderResource²
DirectXEffect.SetShaderResourceNull
DirectXEffect.SetUnorderedAccessResource¹
DirectXEffect.SetUnorderedAccessResource²
DirectXEffect.SetUnorderedAccessResourceNull
DirectXEffect.SetValue

SetPipelineState

protected abstract method SetPipelineState → (1)

pass ⁱⁿ : int32: The pass for which to set the pipeline state or -1 to clear the state.

Sets the graphics pipeline state.

SetSamplerState

protected abstract method SetSamplerState → (3)

type ⁱⁿ : int32: The shader type.
slot ⁱⁿ : int32: The shader binding slot.
sampler ⁱⁿ : int32: The sampler state.

Assigns the given sample state to the specified shader slot.

SetShaderResource

_3 overloads

protected abstract method SetShaderResource¹ → (2)

resource ⁱⁿ : int32: The shader resource index.
texture ⁱⁿ : ITexture2D: The shader resource to set or null to clear.

Sets a shader resource.

See also: DirectXEffect.ShaderResourceIndex

protected abstract method SetShaderResource² → (2)

resource ⁱⁿ : int32: The shader resource index.
buffer ⁱⁿ : IGpuBuffer: The shader resource to set or null to clear.

Sets a shader resource.

See also: DirectXEffect.ShaderResourceIndex

protected abstract method SetShaderResource³ → (2)

resource ⁱⁿ : int32: The shader resource index.
texture ⁱⁿ : ITextureCube: The shader resource to set or null to clear.

Sets a shader resource.

See also: DirectXEffect.ShaderResourceIndex

SetShaderResourceBinding

protected method SetShaderResourceBinding → (2)

resource ⁱⁿ : int32: The shader resource index.
resourceObject ⁱⁿ : IResource: The resource object.

Derived classes may call this method generate IResource.Binding² calls.

SetShaderResourceNull

protected abstract method SetShaderResourceNull → (1)

resource ⁱⁿ : int32: The shader resource index.

Sets a shader resource to null.

See also: DirectXEffect.ShaderResourceIndex

SetUnorderedAccessResource

_2 overloads

protected abstract method SetUnorderedAccessResource¹ → (2)

resource ⁱⁿ : int32: The unordered access resource index.
buffer ⁱⁿ : IGpuBuffer: The unordered access resource to set or null to clear.

Sets the given buffer as an unordered access resource.

See also: DirectXEffect.UnorderedAccessIndex

protected abstract method SetUnorderedAccessResource² → (3)

resource ⁱⁿ : int32: The unordered access resource index.
texture ⁱⁿ : ITexture2D: The unordered access resource to set or null to clear.
mipmap ⁱⁿ : int32: The texture mipmap level to set. If the mipmap level is out of range, the resource will be set to null.

Sets the given texture as an unordered access resource.

See also: DirectXEffect.UnorderedAccessIndex

SetUnorderedAccessResourceBinding

protected method SetUnorderedAccessResourceBinding → (2)

resource ⁱⁿ : int32: The unordered access resource index.
resourceObject ⁱⁿ : IResource: The resource object.

Derived classes may call this method generate IResource.Binding² calls.

SetUnorderedAccessResourceNull

protected abstract method SetUnorderedAccessResourceNull → (1)

resource ⁱⁿ : int32: The unordered access resource index.

Sets an unordered access resource to null.

See also: DirectXEffect.UnorderedAccessIndex

SetValue

protected method SetValue → (3)

buffer ⁱⁿ : int32: [0..DirectXEffect.ConstantBufferCount-1]
The constant buffer index.
offset ⁱⁿ : int32: [>=0]
The byte offset.
length ⁱⁿ : int32: [>0]
The byte count of the value to set.
returns → ByteBuffer: The byte buffer to use for writing the value.

Sets a value in a constant buffer.

ShaderResourceIndex

protected method ShaderResourceIndex → (2)

slot ⁱⁿ : int32: The parameter slot.
element ⁱⁿ : int32: The parameter element.
returns → int32: The resource index of -1.

Returns the resource index for the given parameter slot element.

ShaderResourceSlot

protected method ShaderResourceSlot → (2)

resource ⁱⁿ : int32: [0..DirectXEffect.ShaderResourceCount-1]
The shader resource.
shaderType ⁱⁿ : int32: [0..RenderEffect.ShaderTypeCount-1]
The shader type.
returns → int32: The assigned shader slot or -1 if none.

Returns the assigned shader slot of the given resource.

UnorderedAccessIndex

protected method UnorderedAccessIndex → (2)

slot ⁱⁿ : int32: The parameter slot.
element ⁱⁿ : int32: The parameter element.
returns → int32: The resource index of -1.

Returns the resource index for the given parameter slot element.

UnorderedAccessSlot

protected method UnorderedAccessSlot → (2)

resource ⁱⁿ : int32: [0..DirectXEffect.UnorderedAccessResourceCount-1]
The shader resource.
shaderType ⁱⁿ : int32: [0..RenderEffect.ShaderTypeCount-1]
The shader type.
returns → int32: The assigned shader slot or -1 if none.

Returns the assigned shader slot of the given resource.

Protected / Attributes

blendStateMapping

protected attribute blendStateMapping → (Mapping1D<int32>)

Pass mapping for blend states:

first  := pass
second := blend-state

constantBufferMapping

protected attribute constantBufferMapping → (Mapping2D<int32>)

Shader slot mapping for constant buffers:

firstX := shader-object
firstY := shader-slot
second := constant-buffer

depthStencilStateMapping

protected attribute depthStencilStateMapping → (Mapping1D<int32>)

Pass mapping for depth/stencil states.

passBlendFactors

protected attribute passBlendFactors → (Mapping1D<Vec4F>)

Mapping from pass index to blend factors:

first    := parameter-slot
second.X := blend-factor for red channel
second.Y := blend-factor for green channel
second.Z := blend-factor for blue channel
second.W := blend-factor for alpha channel

passSampleMask

protected attribute passSampleMask → (Mapping1D<int32>)

Mapping from pass index to sample mask:

first  := pass
second := sample mask value

passStencilRef

protected attribute passStencilRef → (Mapping1D<int32>)

Mapping from pass index to stencil reference value:

first  := pass
second := depth-stencil reference value

rasterizerStateMapping

protected attribute rasterizerStateMapping → (Mapping1D<int32>)

Pass mapping for rasterizer states:

first  := pass
second := rasterizer-state

samplerStateMapping

protected attribute samplerStateMapping → (Mapping2D<int32>)

Shader slot mapping for sampler states:

firstX := shader-object
firstY := shader-slot
second := sampler-state

shaderInfos

protected attribute shaderInfos → (Mapping1D<DirectXShaderInfo>)

Mapping from shader to shader info:

first  := shader-object
second := shader-info

shaderResourceMapping

protected attribute shaderResourceMapping → (Mapping2D<int32>)

Shader slot mapping for shader resources:

firstX := shader-object
firstY := shader-resource
second := shader-slot

shaderResourceType

protected attribute shaderResourceType → (Mapping1D<int32>)

Mapping from shader resource to resource type:

first  := shader-resource
second := resource type:
          0 : unknown
          1 : texture 2D
          2 : texture-array 2D
          3 : texture CUBE
          4 : texture-array CUBE
          5 : buffer

shaderSlotCount

protected attribute shaderSlotCount → (Mapping2D<int32>)

Remembers which shader slots are in use:

firstX := shader-type
firstY := slot-type
          0 : constant-buffer
          1 : sampler-state
          2 : shader-resource
          3 : unordered-access-resource
second := number of used shader slots

unorderedAccessResourceMapping

protected attribute unorderedAccessResourceMapping → (Mapping2D<int32>)

Shader slot mapping for unordered access:

firstX := shader-object
firstY := unordered-access-resource
second := shader-slot

DirectXEffect

Description

Public / Methods

Blend​State​Apply

Blend​State​Assign

Blend​State​Create

Constant​Buffer​Assign

Constant​Buffer​Create

Constant​Buffer​Declare

Depth​Stencil​State​Apply

Depth​Stencil​State​Assign

Depth​Stencil​State​Create

Pass​State

Rasterizer​State​Apply

Rasterizer​State​Assign

Rasterizer​State​Create

Render​State​Assign

Sampler​State​Apply

Sampler​State​Assign

Sampler​State​Create

Shader​Resource​Assign

Shader​Resource​Create

Shader​Resource​Declare

Shader​Resource​Declare​With​State

Unordered​Access​Resource​Assign

Unordered​Access​Resource​Create

Unordered​Access​Resource​Declare

Public / Attributes

Blend​State​Count

Constant​Buffer​Count

Depth​Stencil​State​Count

Rasterizer​State​Count

Sampler​State​Count

Shader​Resource​Count

Unordered​Access​Resource​Count

Protected / Constructors

Direct​XEffect

Protected / Methods

Clear​Resource​Bindings

Do​Blend​State​Create

Do​Constant​Buffer​Create

Do​Constant​Buffer​Update

Do​Constant​Buffer​Update​Begin

Do​Constant​Buffer​Update​End

Do​Depth​Stencil​State​Create

Do​Rasterizer​State​Create

Do​Sampler​State​Create

Do​Shader​Create_​Byte​Code

Do​Shader​Create_​Info

Pass​Create​With​State

Set​Constant​Buffer

Set​Parameters

Set​Pipeline​State

Set​Sampler​State

Set​Shader​Resource

Set​Shader​Resource​Binding

Set​Shader​Resource​Null

Set​Unordered​Access​Resource

Set​Unordered​Access​Resource​Binding

Set​Unordered​Access​Resource​Null

Set​Value

Shader​Resource​Index

Shader​Resource​Slot

Unordered​Access​Index

Unordered​Access​Slot

Protected / Attributes

blend​State​Mapping

constant​Buffer​Mapping

depth​Stencil​State​Mapping

pass​Blend​Factors

pass​Sample​Mask

pass​Stencil​Ref

rasterizer​State​Mapping

sampler​State​Mapping

shader​Infos

shader​Resource​Mapping

shader​Resource​Type

shader​Slot​Count

unordered​Access​Resource​Mapping

BlendStateApply

BlendStateAssign

BlendStateCreate

ConstantBufferAssign

ConstantBufferCreate

ConstantBufferDeclare

DepthStencilStateApply

DepthStencilStateAssign

DepthStencilStateCreate

PassState

RasterizerStateApply

RasterizerStateAssign

RasterizerStateCreate

RenderStateAssign

SamplerStateApply

SamplerStateAssign

SamplerStateCreate

ShaderResourceAssign

ShaderResourceCreate

ShaderResourceDeclare

ShaderResourceDeclareWithState

UnorderedAccessResourceAssign

UnorderedAccessResourceCreate

UnorderedAccessResourceDeclare

BlendStateCount

ConstantBufferCount

DepthStencilStateCount

RasterizerStateCount

SamplerStateCount

ShaderResourceCount

UnorderedAccessResourceCount

DirectXEffect

ClearResourceBindings

DoBlendStateCreate

DoConstantBufferCreate

DoConstantBufferUpdate

DoConstantBufferUpdateBegin

DoConstantBufferUpdateEnd

DoDepthStencilStateCreate

DoRasterizerStateCreate

DoSamplerStateCreate

DoShaderCreate_ByteCode

DoShaderCreate_Info

PassCreateWithState

SetConstantBuffer

SetParameters

SetPipelineState

SetSamplerState

SetShaderResource

SetShaderResourceBinding

SetShaderResourceNull

SetUnorderedAccessResource

SetUnorderedAccessResourceBinding

SetUnorderedAccessResourceNull

SetValue

ShaderResourceIndex

ShaderResourceSlot

UnorderedAccessIndex

UnorderedAccessSlot

blendStateMapping

constantBufferMapping

depthStencilStateMapping

passBlendFactors

passSampleMask

passStencilRef

rasterizerStateMapping

samplerStateMapping

shaderInfos

shaderResourceMapping

shaderResourceType

shaderSlotCount

unorderedAccessResourceMapping