IRenderEffectParameters

Description

interface Tinman.Engine.Rendering.IRenderEffectParameters

Derived from: IRenderEffectBase
Extended by: ITerrainEffect
RenderEffect ^abstract

Base interface for classes that represent a render effect that provides a standardized set of low-level parameter slots, which may be used across different rendering APIs.

Low-level parameter slots are declared by calling the RenderEffectParameters.Declare method on the RenderEffectParameters object that is owned by a render effect. Usually, this is done in the constructor of the respective implementation class of the IRenderEffectParameters interface.

Each low-level parameter slot may be declared only once. However, declaring the same parameter multiple times (i.e. repeatedly calling the ParameterDeclare method with identical arguments) is allowed.

When writing values to low-level parameters, the slot index -1 may be passed. In this case, the respective method will return silently. This simplifies handling of low-level parameters that are available conditionally.

Public / Methods

ParameterBuffer

public method ParameterBuffer → (3)

slot ⁱⁿ : int32: [-1..IRenderEffectParameters.ParameterSlotCount-1]
The parameter slot or -1 to skip.
element ⁱⁿ : int32: [>=0]
The parameter element index.
buffer ⁱⁿ : IGpuBuffer: The buffer to set.

Writes a value into a low-level parameter slot.

See also: RenderEffectParameterType.Buffer

ParameterDeclare

public method ParameterDeclare → (3)

type ⁱⁿ : RenderEffectParameterType: The parameter type.
name ⁱⁿ : string: [not-empty]
The parameter name.
size ^opt : int32 = 0: [>=0]
The parameter array size or 0 for non-arrays.
returns → int32: The slot index of the declared low-level parameter.

Declares a low-level parameter slot, which allows an implementation to verify that the given parameter information corresponds to the actual parameter declaration in the compiled shader program.

It is valid to declare the same parameter multiple times. In this case, the same slot index will be returned for each method call. Two parameters are considered to be the same if their names are equal.

RenderException: If another parameter with the given name ⁱⁿ has already been defined with a different type ⁱⁿ and/or size ^opt or if a graphics subsystem error has occurred.

ParameterFloat

public method ParameterFloat → (3)

slot ⁱⁿ : int32: [-1..IRenderEffectParameters.ParameterSlotCount-1]
The parameter slot or -1 to skip.
element ⁱⁿ : int32: [>=0]
The parameter element index.
value ⁱⁿ : float32: The parameter value.

Writes a value into a low-level parameter slot.

See also: RenderEffectParameterType.Float

ParameterIndex

[Pure]
public method ParameterIndex → (1)

name ⁱⁿ : string: The parameter name that has been passed to ParameterDeclare.
returns → int32: The index of the low-level parameter slot or -1 if name ⁱⁿ does not match the name of a declared parameter.

Returns the index of a declared low-level parameter slot.

ParameterInfo

[Pure]
public method ParameterInfo → (1)

slot ⁱⁿ : int32: [0..IRenderEffectParameters.ParameterSlotCount-1]
The parameter slot index.
returns → ParameterSlot: The information or null if not declared.

Returns information about a declared low-level parameter slot.

ParameterInt

public method ParameterInt → (3)

slot ⁱⁿ : int32: [-1..IRenderEffectParameters.ParameterSlotCount-1]
The parameter slot or -1 to skip.
element ⁱⁿ : int32: [>=0]
The parameter element index.
value ⁱⁿ : int32: The parameter value.

Writes a value into a low-level parameter slot.

See also: RenderEffectParameterType.Int

ParameterMatrix2x2

public method ParameterMatrix2x2 → (3)

slot ⁱⁿ : int32: [-1..IRenderEffectParameters.ParameterSlotCount-1]
The parameter slot or -1 to skip.
element ⁱⁿ : int32: [>=0]
The parameter element index.
value ⁱⁿ : Mat2F: The parameter value.

Writes a value into a low-level parameter slot.

See also: RenderEffectParameterType.Matrix2x2

ParameterMatrix3x3

public method ParameterMatrix3x3 → (3)

slot ⁱⁿ : int32: [-1..IRenderEffectParameters.ParameterSlotCount-1]
The parameter slot or -1 to skip.
element ⁱⁿ : int32: [>=0]
The parameter element index.
value ⁱⁿ : Mat3F: The parameter value.

Writes a value into a low-level parameter slot.

See also: RenderEffectParameterType.Matrix3x3

ParameterMatrix3x4

public method ParameterMatrix3x4 → (3)

slot ⁱⁿ : int32: [-1..IRenderEffectParameters.ParameterSlotCount-1]
The parameter slot or -1 to skip.
element ⁱⁿ : int32: [>=0]
The parameter element index.
value ⁱⁿ : Mat4F: The parameter value.

Writes a value into a low-level parameter slot.

See also: RenderEffectParameterType.Matrix3x4

ParameterMatrix4x4

public method ParameterMatrix4x4 → (3)

slot ⁱⁿ : int32: [-1..IRenderEffectParameters.ParameterSlotCount-1]
The parameter slot or -1 to skip.
element ⁱⁿ : int32: [>=0]
The parameter element index.
value ⁱⁿ : Mat4F: The parameter value.

Writes a value into a low-level parameter slot.

See also: RenderEffectParameterType.Matrix4x4

ParameterTexture

_2 overloads

public method ParameterTexture¹ → (3)

slot ⁱⁿ : int32: [-1..IRenderEffectParameters.ParameterSlotCount-1]
The parameter slot or -1 to skip.
element ⁱⁿ : int32: [>=0]
The parameter element index.
texture ⁱⁿ : ITexture2D: The texture to set.

Writes a value into a low-level parameter slot.

See also: RenderEffectParameterType.Texture2D

public method ParameterTexture² → (3)

slot ⁱⁿ : int32: [-1..IRenderEffectParameters.ParameterSlotCount-1]
The parameter slot or -1 to skip.
element ⁱⁿ : int32: [>=0]
The parameter element index.
texture ⁱⁿ : ITextureCube: The texture to set.

Writes a value into a low-level parameter slot.

See also: RenderEffectParameterType.TextureCube

ParameterTextureNull

public method ParameterTextureNull → (2)

slot ⁱⁿ : int32: [-1..IRenderEffectParameters.ParameterSlotCount-1]
The parameter slot or -1 to skip.
element ⁱⁿ : int32: [>=0]
The parameter element index.

Writes a null value into a low-level parameter slot.

See also: RenderEffectParameterType.Texture2D
RenderEffectParameterType.TextureCube

ParameterUsage

[Pure]
public method ParameterUsage → (2)

slot ⁱⁿ : int32: [0..IRenderEffectParameters.ParameterSlotCount-1]
The parameter slot.
pass ⁱⁿ : int32: [0..IRenderEffectBase.PassCount-1]
The render pass index.
returns → bool: true if the low-level parameter slot is used by pass ⁱⁿ, false if not.

Returns whether the given low-level parameter slot is used by the given pass or not.

ParameterUsages

[Pure]
public method ParameterUsages → ()

returns → ParameterSlotUsage [ ]: The usages.

Returns the low-level parameter slot usages.

ParameterVector2

public method ParameterVector2 → (3)

slot ⁱⁿ : int32: [-1..IRenderEffectParameters.ParameterSlotCount-1]
The parameter slot or -1 to skip.
element ⁱⁿ : int32: [>=0]
The parameter element index.
value ⁱⁿ : Vec2F: The parameter value.

Writes a value into a low-level parameter slot.

See also: RenderEffectParameterType.Vector2

ParameterVector3

public method ParameterVector3 → (3)

slot ⁱⁿ : int32: [-1..IRenderEffectParameters.ParameterSlotCount-1]
The parameter slot or -1 to skip.
element ⁱⁿ : int32: [>=0]
The parameter element index.
value ⁱⁿ : Vec3F: The parameter value.

Writes a value into a low-level parameter slot.

See also: RenderEffectParameterType.Vector3

ParameterVector4

public method ParameterVector4 → (3)

slot ⁱⁿ : int32: [-1..IRenderEffectParameters.ParameterSlotCount-1]
The parameter slot or -1 to skip.
element ⁱⁿ : int32: [>=0]
The parameter element index.
value ⁱⁿ : Vec4F: The parameter value.

Writes a value into a low-level parameter slot.

See also: RenderEffectParameterType.Vector4

Public / Attributes

ParameterSlotCount

public attribute ParameterSlotCount → (get)

value : int32: [>=0]
The number of parameter slots.

The number of low-level parameter slots.

IRenderEffectParameters

Description

Public / Methods

Parameter​Buffer

Parameter​Declare

Parameter​Float

Parameter​Index

Parameter​Info

Parameter​Int

Parameter​Matrix2x2

Parameter​Matrix3x3

Parameter​Matrix3x4

Parameter​Matrix4x4

Parameter​Texture

Parameter​Texture​Null

Parameter​Usage

Parameter​Usages

Parameter​Vector2

Parameter​Vector3

Parameter​Vector4

Public / Attributes

Parameter​Slot​Count

ParameterBuffer

ParameterDeclare

ParameterFloat

ParameterIndex

ParameterInfo

ParameterInt

ParameterMatrix2x2

ParameterMatrix3x3

ParameterMatrix3x4

ParameterMatrix4x4

ParameterTexture

ParameterTextureNull

ParameterUsage

ParameterUsages

ParameterVector2

ParameterVector3

ParameterVector4

ParameterSlotCount