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:

'g_material', RenderEffectParameterType.Texture2D [13], mapped to MaterialPartParameters.Map via Index* constants.
'g_materialDebug', RenderEffectParameterType.Int, mapped to Debug.
'g_materialLut', RenderEffectParameterType.Texture2D, mapped to LookupTable.
'g_materialBaseColor', RenderEffectParameterType.Vector4, mapped to IMaterialPart.Value of BaseColor.
'g_materialDisplacement', RenderEffectParameterType.Float, mapped to IMaterialPart.Value of Displacement.
'g_materialEmissive', RenderEffectParameterType.Vector3, mapped to IMaterialPart.Value of Emissive.
'g_materialGlossinessOrRoughness', RenderEffectParameterType.Float, mapped to IMaterialPart.Value of Glossiness or Roughness, depending on Metalness.
'g_materialInfo', RenderEffectParameterType.Vector4 [13], mapped via Index* constants to:
Vec4F.X : MaterialPartParameters.Flags / MaterialFlags.Extra
Vec4F.Y : MaterialPartParameters.Channel
Vec4F.Z : MaterialPartParameters.Flags / MaterialFlags.ClampU, MaterialFlags.MirrorU
Vec4F.W : MaterialPartParameters.Flags / MaterialFlags.ClampV, MaterialFlags.MirrorV
'g_materialMetalness', RenderEffectParameterType.Float, mapped to IMaterialPart.Value of Metalness.
'g_materialNormal', RenderEffectParameterType.Float, mapped to IMaterialPart.Value of Normal.
'g_materialOcclusion', RenderEffectParameterType.Float, mapped to IMaterialPart.Value of Occlusion.
'g_materialOpacity', RenderEffectParameterType.Float, mapped to IMaterialPart.Value of Opacity.
'g_materialReflectivity', RenderEffectParameterType.Vector3, mapped to IMaterialPart.Value of Reflectivity.
'g_materialRefraction', RenderEffectParameterType.Float, mapped to IMaterialPart.Value of Refraction.
'g_materialSpecularity', RenderEffectParameterType.Float, mapped to IMaterialPart.Value of Specularity.
'g_materialTranslucency', RenderEffectParameterType.Vector3, mapped to IMaterialPart.Value of Translucency.
'g_materialTransmission', RenderEffectParameterType.Float, mapped to IMaterialPart.Value of Transmission.

Public / Constants

ChangedBaseColor

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

Changed flag for BaseColor.

ChangedDebug

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

Changed flag for Debug.

ChangedDisplacement

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

Changed flag for Displacement.

ChangedEmissive

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

Changed flag for Emissive.

ChangedGlossiness

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

Changed flag for Glossiness.

ChangedLookupTable

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

Changed flag for LookupTable.

ChangedMetalness

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

Changed flag for Metalness.

ChangedNormal

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

Changed flag for Normal.

ChangedOcclusion

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

Changed flag for Occlusion.

ChangedOpacity

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

Changed flag for Opacity.

ChangedReflectivity

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

Changed flag for Reflectivity.

ChangedRefraction

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

Changed flag for Refraction.

ChangedRoughness

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

Changed flag for Roughness.

ChangedSpecularity

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

Changed flag for Specularity.

ChangedTranslucency

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

Changed flag for Translucency.

ChangedTransmission

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

Changed flag for Transmission.

CountDebug

public constant CountDebug → (13:int32)

The number of debug modes.

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

DebugBaseColor

public constant DebugBaseColor → (1:int32)

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

See also: MaterialParameters.Debug

DebugDiffuse

public constant DebugDiffuse → (2:int32)

Shows the final diffuse reflection.

See also: MaterialParameters.Debug

DebugEmissive

public constant DebugEmissive → (3:int32)

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

See also: MaterialParameters.Debug

DebugLookup

public constant DebugLookup → (4:int32)

Shows the reflectance function lookup table (see ModelTexture.LookupTable), sampled by (dot,roughness), where dot if the dot product between the eye and normal vectors and roughness is IMaterial.Roughness.

See also: MaterialParameters.Debug

DebugNormal

public constant DebugNormal → (5:int32)

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

See also: MaterialParameters.Debug

DebugOcclusionRoughnessMetalness

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

DebugOpacityTransmissionSpecularity

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.

DebugReflectivity

public constant DebugReflectivity → (8:int32)

Shows the final reflectivity (see IMaterial.Reflectivity).

See also: MaterialParameters.Debug

DebugSpecular

public constant DebugSpecular → (9:int32)

Shows the final specular reflection.

See also: MaterialParameters.Debug

DebugTangentMask

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

DebugTextureCoords0

public constant DebugTextureCoords0 → (11:int32)

Shows the UV-coordinates of the first texture coordinate set.

The color channels have the following meaning:
Red : The U-coordinate in the range [0..1],
Green : The V-coordinate in the range [0..1]

DebugTextureCoords1

public constant DebugTextureCoords1 → (12:int32)

Shows the UV-coordinates of the second texture coordinate set.

The color channels have the following meaning:
Red : The U-coordinate in the range [0..1],
Green : The V-coordinate in the range [0..1]

DebugTranslucency

public constant DebugTranslucency → (13:int32)

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

See also: MaterialParameters.Debug

IndexBaseColor

public constant IndexBaseColor → (0:int32)

Array index of BaseColor for MaterialPartParameters.Flags.

IndexDisplacement

public constant IndexDisplacement → (11:int32)

Array index of Displacement.

IndexEmissive

public constant IndexEmissive → (1:int32)

Array index of Emissive.

IndexGlossinessOrRoughness

public constant IndexGlossinessOrRoughness → (2:int32)

Array index of Glossiness / Roughness.

IndexMetalness

public constant IndexMetalness → (3:int32)

Array index of Metalness.

IndexNormal

public constant IndexNormal → (4:int32)

Array index of Normal.

IndexOcclusion

public constant IndexOcclusion → (5:int32)

Array index of Occlusion.

IndexOpacity

public constant IndexOpacity → (6:int32)

Array index of Opacity.

IndexReflectivity

public constant IndexReflectivity → (7:int32)

Array index of Reflectivity.

IndexSpecularity

public constant IndexSpecularity → (8:int32)

Array index of Specularity.

IndexTranslucency

public constant IndexTranslucency → (9:int32)

Array index of Translucency.

IndexTransmission

public constant IndexTransmission → (10:int32)

Array index of Transmission.

Public / Constructors