MaterialParameters

Description

sealed class Tinman.Engine.Rendering.Effects.Shared.MaterialParameters

Derived from

RenderEffectParameters abstract

Shared render effect parameters for IMaterial objects.

The following low-level render effect parameter slots are always defined:

Public / Constants

Changed​Base​Color

public constant ChangedBaseColor → (1 << 0:int32)

Changed flag for BaseColor.

Changed​Debug

public constant ChangedDebug → (1 << 1:int32)

Changed flag for Debug.

Changed​Displacement

public constant ChangedDisplacement → (1 << 2:int32)

Changed flag for Displacement.

Changed​Emissive

public constant ChangedEmissive → (1 << 3:int32)

Changed flag for Emissive.

Changed​Glossiness

public constant ChangedGlossiness → (1 << 4:int32)

Changed flag for Glossiness.

Changed​Lookup​Table

public constant ChangedLookupTable → (1 << 5:int32)

Changed flag for LookupTable.

Changed​Metalness

public constant ChangedMetalness → (1 << 6:int32)

Changed flag for Metalness.

Changed​Normal

public constant ChangedNormal → (1 << 7:int32)

Changed flag for Normal.

Changed​Occlusion

public constant ChangedOcclusion → (1 << 8:int32)

Changed flag for Occlusion.

Changed​Opacity

public constant ChangedOpacity → (1 << 9:int32)

Changed flag for Opacity.

Changed​Reflectivity

public constant ChangedReflectivity → (1 << 10:int32)

Changed flag for Reflectivity.

Changed​Refraction

public constant ChangedRefraction → (1 << 11:int32)

Changed flag for Refraction.

Changed​Roughness

public constant ChangedRoughness → (1 << 12:int32)

Changed flag for Roughness.

Changed​Specularity

public constant ChangedSpecularity → (1 << 13:int32)

Changed flag for Specularity.

Changed​Translucency

public constant ChangedTranslucency → (1 << 14:int32)

Changed flag for Translucency.

Changed​Transmission

public constant ChangedTransmission → (1 << 15:int32)

Changed flag for Transmission.

Count​Debug

public constant CountDebug → (11:int32)

The number of debug modes.

The debug mode codes are in the range [1..N], where N is this constant.

Debug​Base​Color

public constant DebugBaseColor → (1:int32)

Shows the final base color (see IMaterial.BaseColor).

See also

MaterialParameters.Debug

Debug​Diffuse

public constant DebugDiffuse → (2:int32)

Shows the final diffuse reflection.

See also

MaterialParameters.Debug

Debug​Emissive

public constant DebugEmissive → (3:int32)

Shows the final emissive color (see IMaterial.Emissive).

See also

MaterialParameters.Debug

Debug​Lookup

public constant DebugLookup → (4:int32)

Shows the reflectance function lookup table.

See also

MaterialParameters.Debug

Debug​Normal

public constant DebugNormal → (5:int32)

Shows the final normal vectors in light-space (see IMaterial.Normal).

See also

MaterialParameters.Debug

Debug​Occlusion​Roughness​Metalness

public constant DebugOcclusionRoughnessMetalness → (6:int32)

Shows the final occlusion (see IMaterial.Occlusion), the final roughness (see IMaterial.Roughness) and the final metalness value (see IMaterial.Metalness) in the red, green and blue channels, respectively.

See also

MaterialParameters.Debug

Debug​Opacity​Transmission​Specularity

public constant DebugOpacityTransmissionSpecularity → (7:int32)

Shows the final inverse opacity (see IMaterial.Opacity), final transmission (see IMaterial.Transmission) and the final inverse specularity (see IMaterial.Specularity) in the red, green and blue channels, respectively.

Debug​Reflectivity

public constant DebugReflectivity → (8:int32)

Shows the final reflectivity (see IMaterial.Reflectivity).

See also

MaterialParameters.Debug

Debug​Specular

public constant DebugSpecular → (9:int32)

Shows the final specular reflection.

See also

MaterialParameters.Debug

Debug​Tangent​Mask

public constant DebugTangentMask → (10:int32)

Shows a color code that indicates whether normal, tangent and bitangent vectors are computed by the GPU, instead of being sources from model data.

The color channels have the following meaning:
Red : ModelVertexFormat.TangentX is computed by the GPU,
Green : ModelVertexFormat.TangentY is computed by the GPU,
Blue : ModelVertexFormat.Normal is computed by the GPU

See also

MaterialParameters.Debug

Debug​Translucency

public constant DebugTranslucency → (11:int32)

Shows the final translucent color (see IMaterial.Translucency).

See also

MaterialParameters.Debug

Index​Base​Color

public constant IndexBaseColor → (0:int32)

Array index of BaseColor for MaterialPartParameters.Coords.

Index​Displacement

public constant IndexDisplacement → (11:int32)

Array index of Displacement.

Index​Emissive

public constant IndexEmissive → (1:int32)

Array index of Emissive.

Index​Glossiness​Or​Roughness

public constant IndexGlossinessOrRoughness → (2:int32)

Array index of Glossiness / Roughness.

Index​Metalness

public constant IndexMetalness → (3:int32)

Array index of Metalness.

Index​Normal

public constant IndexNormal → (4:int32)

Array index of Normal.

Index​Occlusion

public constant IndexOcclusion → (5:int32)

Array index of Occlusion.

Index​Opacity

public constant IndexOpacity → (6:int32)

Array index of Opacity.

Index​Reflectivity

public constant IndexReflectivity → (7:int32)

Array index of Reflectivity.

Index​Specularity

public constant IndexSpecularity → (8:int32)

Array index of Specularity.

Index​Translucency

public constant IndexTranslucency → (9:int32)

Array index of Translucency.

Index​Transmission

public constant IndexTransmission → (10:int32)

Array index of Transmission.

Public / Constructors

Material​Parameters

public constructor MaterialParameters → ()

Creates a new instance of MaterialParameters.

Public / Methods

Debug​Mnemonic

2 overloads

[Pure]
public static method DebugMnemonic1 → (1)

debug in : int32

The debug mode.

returns → string

The debug mode mnemonic (exactly three upper-case letters) or null iff debug in is not a debug mode code.

Returns a human-understandable mnemonic for the given debug mode.

[Pure]
public static method DebugMnemonic2 → (1)

mnemonic in : string

The mnemonic, as returned by DebugMnemonic1.

returns → int32

The debug mode code (see Debug* constants) or 0 iff mnemonic in is not recognized.

Returns the debug mode for the given human-understandable mnemonic.

Public / Attributes

Base​Color

public readonly attribute BaseColor → (MaterialPartParameters<ColorF>)

See IMaterial.BaseColor.

Debug

public attribute Debug → (get,set)

value : int32

The debug mode, which may be one of the Debug* constants or 0 to disable.

Enables or disables the material debug mode.

Defaults to 0, which disabled debug mode.

See also

MaterialParameters.ChangedDebug

Displacement

public readonly attribute Displacement → (MaterialPartParameters<float32>)

See IMaterial.Displacement.

Emissive

public readonly attribute Emissive → (MaterialPartParameters<ColorF>)

See IMaterial.Emissive.

Glossiness

public readonly attribute Glossiness → (MaterialPartParameters<float32>)

See IMaterial.Glossiness.

Lookup​Table

public attribute LookupTable → (get,set)

value : ITexture2D

The lookup table.

The lookup table to use for lighting calculations.

See also

ModelTexture.LookupTable

Metalness

public readonly attribute Metalness → (MaterialPartParameters<float32>)

See IMaterial.Metalness.

Normal

public readonly attribute Normal → (MaterialPartParameters<float32>)

See IMaterial.Normal.

Occlusion

public readonly attribute Occlusion → (MaterialPartParameters<float32>)

See IMaterial.Occlusion.

Opacity

public readonly attribute Opacity → (MaterialPartParameters<float32>)

See IMaterial.Opacity.

Reflectivity

public readonly attribute Reflectivity → (MaterialPartParameters<ColorF>)

See IMaterial.Reflectivity.

Refraction

public attribute Refraction → (get,set)

value : float32

The refraction value.

See IMaterial.Refraction.

Roughness

public readonly attribute Roughness → (MaterialPartParameters<float32>)

See IMaterial.Roughness.

Slot​Material

public attribute SlotMaterial → (get)

value : int32

The slot index or -1 if not declared.

Index of a low-level parameter slot.

Slot​Material​Lut

public attribute SlotMaterialLut → (get)

value : int32

The slot index or -1 if not declared.

Index of a low-level parameter slot.

Specularity

public readonly attribute Specularity → (MaterialPartParameters<float32>)

See IMaterial.Specularity.

Translucency

public readonly attribute Translucency → (MaterialPartParameters<ColorF>)

See IMaterial.Translucency.

Transmission

public readonly attribute Transmission → (MaterialPartParameters<float32>)

See IMaterial.Transmission.