RenderEffectComponents

Description

abstract class Tinman.Engine.Rendering.Effects.RenderEffectComponents

Derived from

IRenderEffectComponents

Extended by

DirectXEffect_Components abstract

Abstract base class for IRenderEffectComponents.

This class provide common functionality, for example parsing of shader specification strings.

Protected / Constructors

Render​Effect​Components

protected constructor RenderEffectComponents → (1)

effect in : RenderEffect

[not-null]
The render effect.

Creates a new instance of RenderEffectComponents.

Protected / Methods

Shader​Buffer

protected abstract method ShaderBuffer → (1)

name in : string

See name of IRenderEffectComponents.Resource.

Declares a shader buffer resource.

RenderException

If a graphics subsystem error has occurred.

Shader​Constants

protected abstract method ShaderConstants → (1)

name in : string

See name of IRenderEffectComponents.Buffer.

The render effect is using a constant buffer of the given name.

RenderException

If a graphics subsystem error has occurred.

Shader​Name

[EmptyBody]
protected virtual method ShaderName → (4)

name in : string

The shader file name, to be passed to RenderEffect.ShaderCreate, as specified via IRenderEffectComponents.Pass.

shaderType in : int32

The common shader type, see ShaderType.

shaderTypes in : int32

A bitmask that indicates which shaders are present in the enclosing pass:
1 : Vertex Shader
2 : Tessellation Patch Shader
4 : Tessellation Vertex Shader
8 : Geometry Shader
16 : Pixel Shader
32 : Compute Shader

sampleFrequency in : bool

true if the Pixel Shader of the pass is running at sample frequency,
false if there is no Pixel Shader or it runs a pixel frequency.

returns → string

The shader file name to use.

Determines the file name to use for creating a shader.

Shader​Pass

protected abstract method ShaderPass → (2)

pass in : int32

The render pass.

state in : RenderStatePreset

The render state preset.

Creates a render effect with the given render state preset.

RenderException

If a graphics subsystem error has occurred.

Shader​Resource

protected abstract method ShaderResource → (3)

name in : string

See name of IRenderEffectComponents.Resource resp. IRenderEffectComponents.Texture.

state in : SamplerStatePreset

The sampler state preset for automatic setup or SamplerStatePreset.None for manual setup.

sampler in : string

See sampler of IRenderEffectComponents.Texture. Will be null for manual state setup.

Declares a shader resource with automatic or manual state setup.

RenderException

If a graphics subsystem error has occurred.

Shader​Type

protected abstract method ShaderType → (1)

shader in : int32

The common shader type:
0 : Vertex Shader
1 : Tessellation Patch Shader
2 : Tessellation Vertex Shader
3 : Geometry Shader
4 : Pixel Shader
5 : Compute Shader

returns → int32

The specific shader type or -1 if not supported.

Translates the given common shader type to one of the specific shader types.

Shader​Vertex

protected abstract method ShaderVertex → (5)

name in : string

See name of IRenderEffectComponents.Vertex2.

data in : int32

See data of IRenderEffectComponents.Vertex2.

usage in : VertexElementUsage

See usage of IRenderEffectComponents.Vertex2. Will never be VertexElementUsage.Unknown.

first in : int32

See first of IRenderEffectComponents.Vertex2.

count in : int32

See count of IRenderEffectComponents.Vertex2.

Declares an input vertex attribute.

RenderException

If a graphics subsystem error has occurred.

Protected / Attributes

Shader​Suffix

protected abstract attribute ShaderSuffix → (get)

value : string

[not-empty]
The file suffix.

The name suffix of shader files.