ModelRendererParameters

Description

sealed class Tinman.Engine.Rendering.Effects.ModelRendererParameters

Derived from: RenderEffectParameters ^abstract

Render effect parameters for IModelRendererEffect.

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

'g_materialGloss', RenderEffectParameterType.Float, mapped to Gloss.
'g_materialEmissive', RenderEffectParameterType.Vector3, mapped to Emissive.
'g_materialReflectivity', RenderEffectParameterType.Vector3, mapped to Reflectivity.
'g_materialTranslucency', RenderEffectParameterType.Vector3, mapped to Translucency.
'g_materialAlbedo', RenderEffectParameterType.Vector4, mapped to Albedo.
'g_depthFactor', RenderEffectParameterType.Float, mapped to DepthBias.
'g_vertexColorInterpretation', RenderEffectParameterType.Vector2, mapped to VertexColorInterpretation.
'g_modelCenter', RenderEffectParameterType.Vector3, mapped to Center.
'g_modelFade', RenderEffectParameterType.Vector4, mapped to Fade.
'g_modelMatrix', RenderEffectParameterType.Matrix3x4, mapped to Matrix.
'g_modelMatrixIT', RenderEffectParameterType.Matrix3x4, mapped to MatrixInverseTranspose.
'g_material' (SlotMaterial), RenderEffectParameterType.Texture2D [9], mapped to:
#0: OpacityMap
#1: AlbedoMap
#2: DisplacementMap
#3: EmissiveMap
#4: GlossMap
#5: NormalMap
#6: OcclusionMap
#7: ReflectivityMap
#8: TranslucencyMap

Public / Constants

ChangedAlbedo

public constant ChangedAlbedo → (1:int64)

Changed flag for Albedo.

ChangedAlbedoMap

public constant ChangedAlbedoMap → (1 << 1:int64)

Changed flag for AlbedoMap.

ChangedCamera

public constant ChangedCamera → (1 << 2:int64)

Changed flag for Camera.

ChangedCenter

public constant ChangedCenter → (1 << 3:int64)

Changed flag for Center.

ChangedDepthBias

public constant ChangedDepthBias → (1 << 4:int64)

Changed flag for DepthBias.

ChangedDisplacementMap

public constant ChangedDisplacementMap → (1 << 5:int64)

Changed flag for DisplacementMap.

ChangedEmissive

public constant ChangedEmissive → (1 << 6:int64)

Changed flag for Emissive.

ChangedEmissiveMap

public constant ChangedEmissiveMap → (1 << 7:int64)

Changed flag for EmissiveMap.

ChangedFade

public constant ChangedFade → (1 << 8:int64)

Changed flag for Fade.

ChangedGloss

public constant ChangedGloss → (1 << 9:int64)

Changed flag for Gloss.

ChangedGlossMap

public constant ChangedGlossMap → (1 << 10:int64)

Changed flag for GlossMap.

ChangedLighting

public constant ChangedLighting → (1 << 11:int64)

Changed flag for Lighting.

ChangedLine

public constant ChangedLine → (1 << 12:int64)

Changed flag for Line.

ChangedMatrix

public constant ChangedMatrix → (1 << 13:int64)

Changed flag for Matrix.

ChangedMatrixInverseTranspose

public constant ChangedMatrixInverseTranspose → (1 << 14:int64)

Changed flag for MatrixInverseTranspose.

ChangedNormalMap

public constant ChangedNormalMap → (1 << 15:int64)

Changed flag for NormalMap.

ChangedOcclusionMap

public constant ChangedOcclusionMap → (1 << 16:int64)

Changed flag for OcclusionMap.

ChangedOpacityMap

public constant ChangedOpacityMap → (1 << 17:int64)

Changed flag for OpacityMap.

ChangedReflectivity

public constant ChangedReflectivity → (1 << 18:int64)

Changed flag for Reflectivity.

ChangedReflectivityMap

public constant ChangedReflectivityMap → (1 << 19:int64)

Changed flag for ReflectivityMap.

ChangedShadow

public constant ChangedShadow → (1 << 20:int64)

Changed flag for Shadow.

ChangedTranslucency

public constant ChangedTranslucency → (1 << 21:int64)

Changed flag for Translucency.

ChangedTranslucencyMap

public constant ChangedTranslucencyMap → (1 << 22:int64)

Changed flag for TranslucencyMap.

ChangedVertexColorInterpretation

public constant ChangedVertexColorInterpretation → (1 << 23:int64)

Changed flag for VertexColorInterpretation.

PassCount

public constant PassCount → (38:int32)

The number of render passes.

See also: ModelRendererParameters.PassIndex

Public / Constructors

ModelRendererParameters

public constructor ModelRendererParameters → (1)

featureLevel ⁱⁿ : LineFeatureLevel: The required feature level.

Creates a new instance of ModelRendererParameters.

Public / Methods

PassCull

[Pure]
public static method PassCull → (1)

pass ⁱⁿ : int32: [0..ModelRendererParameters.PassCount-1]
The pass index.
returns → int32: The cull mode, see PassIndex.

Returns the cull mode of the given pass.

See also: ModelPartFlags.BackFaces
ModelPartFlags.FrontFaces

PassIndex

[Pure]
public static method PassIndex → (4)

mode ⁱⁿ : int32: [0..3]
The pass mode:
0 : mode for rendering opaque geometry
1 : mode for rendering transparent geometry
2 : mode for rendering shadow maps
3 : mode for rendering thick lines
instanced ⁱⁿ : bool: Render instanced geometry?
wireframe ⁱⁿ : bool: Render in wireframe mode?
cull ⁱⁿ : int32: [-1..1]
The cull mode:
-1 : cull front-faces
0 : disable culling
+1 : cull back-faces
returns → int32: The pass index.

Returns the pass index.

See also: ModelRendererParameters.PassMode
ModelRendererParameters.PassInstanced
ModelRendererParameters.PassWireframe
ModelRendererParameters.PassCull

PassInstanced

public static method PassInstanced → (1)

pass ⁱⁿ : int32: [0..ModelRendererParameters.PassCount-1]
The pass index.
returns → bool: The instanced flag, see PassIndex.

Returns the instanced flag of the given pass.

See also: IGeometryBuffer.Instances

PassMode

[Pure]
public static method PassMode → (1)

pass ⁱⁿ : int32: [0..ModelRendererParameters.PassCount-1]
The render pass index.
returns → int32: The render pass mode, see PassIndex.

Returns the mode of the given pass.

PassWireframe

public static method PassWireframe → (1)

pass ⁱⁿ : int32: [0..ModelRendererParameters.PassCount-1]
The pass index.
returns → bool: The wireframe flag, see PassIndex.

Returns the wireframe flag of the given pass.

See also: ModelRenderer.Wireframe

Public / Attributes

Albedo

public attribute Albedo → (get,set)

value : int64: The color value, see Colors.

See IMaterial.Albedo.

The default value is 0.

See also: ModelRendererParameters.ChangedAlbedo

AlbedoMap

public attribute AlbedoMap → (get,set)

value : ITexture2D: The texture map.

See IMaterial.AlbedoMap.

The default value is null.

See also: ModelRendererParameters.ChangedAlbedoMap

Camera

public readonly attribute Camera → (CameraParameters)

The aggregated camera parameters.

See also: ModelRendererParameters.ChangedCamera

Center

public attribute Center → (get,set)

value : Vec3D: The center coordinates.

Coordinates of model center.

The default value is Vec3F.Zero.

See also: ModelRendererParameters.ChangedCenter

DepthBias

public attribute DepthBias → (get,set)

value : bool: The depth factor.

Apply a per-pixel depth bias value before computing logarithmic depth?

The default value is false.

See also: ModelRendererParameters.ChangedDepthBias

DisplacementMap

public attribute DisplacementMap → (get,set)

value : ITexture2D: The texture map.

See IMaterial.DisplacementMap.

The default value is null.

See also: ModelRendererParameters.ChangedDisplacementMap

Emissive

public attribute Emissive → (get,set)

value : int64: The color value, see Colors.

See IMaterial.Emissive.

The default value is 0.

See also: ModelRendererParameters.ChangedEmissive

EmissiveMap

public attribute EmissiveMap → (get,set)

value : ITexture2D: The texture map.

See IMaterial.EmissiveMap.

The default value is null.

See also: ModelRendererParameters.ChangedEmissiveMap

Fade

public attribute Fade → (get,set)

value : Vec4F: The coefficient vector.

Coefficients to use for fading models:

x := min distance
y := max distance
z := min falloff
w := max falloff

Defaults to Vec4F.Zero.

See also: ModelRendererParameters.ChangedFade

Gloss

public attribute Gloss → (get,set)

value : float32: The gloss value.

See IMaterial.Gloss.

Defaults to 0.

See also: ModelRendererParameters.ChangedGloss

GlossMap

public attribute GlossMap → (get,set)

value : ITexture2D: The texture map.

See IMaterial.GlossMap.

Defaults to null.

See also: ModelRendererParameters.ChangedGlossMap

Lighting

public readonly attribute Lighting → (LightingParameters)

The aggregated lighting parameters.

See also: ModelRendererParameters.ChangedLighting

Line

public readonly attribute Line → (LineParameters)

The aggregated line parameters.

See also: ModelRendererParameters.ChangedLine

Matrix

public attribute Matrix → (get,set)

value : Mat4F: The transformation matrix.

Model-to-world transformation matrix.

Defaults to Mat4F.Zero.

See also: ModelRendererParameters.ChangedMatrix

MatrixInverseTranspose

public attribute MatrixInverseTranspose → (get,set)

value : Mat4F: The transformation matrix.

Inverse transpose of model-to-world transformation matrix.

Defaults to Mat4F.Zero.

See also: ModelRendererParameters.ChangedMatrixInverseTranspose

NormalMap

public attribute NormalMap → (get,set)

value : ITexture2D: The texture map.

See IMaterial.NormalMap.

Defaults to null.

See also: ModelRendererParameters.ChangedNormalMap

OcclusionMap

public attribute OcclusionMap → (get,set)

value : ITexture2D: The texture map.

See IMaterial.OcclusionMap.

Defaults to null.

See also: ModelRendererParameters.ChangedOcclusionMap

OpacityMap

public attribute OpacityMap → (get,set)

value : ITexture2D: The texture map.

See IMaterial.OpacityMap.

Defaults to null.

See also: ModelRendererParameters.ChangedOpacityMap

Reflectivity

public attribute Reflectivity → (get,set)

value : int64: The color value, see Colors.

See IMaterial.Reflectivity.

Defaults to 0.

See also: ModelRendererParameters.ChangedReflectivity

ReflectivityMap

public attribute ReflectivityMap → (get,set)

value : ITexture2D: The texture map.

See IMaterial.ReflectivityMap.

Defaults to null.

See also: ModelRendererParameters.ChangedReflectivityMap

Shadow

public readonly attribute Shadow → (ShadowParameters)

The aggregated shadow parameters.

See also: ModelRendererParameters.ChangedShadow

SlotMaterial

public attribute SlotMaterial → (get)

value : int32: The slot index or -1 if not declared.

Index of a low-level parameter slot.

Translucency

public attribute Translucency → (get,set)

value : int64: The color value, see Colors.

See IMaterial.Translucency.

Defaults to 0.

See also: ModelRendererParameters.ChangedTranslucency

TranslucencyMap

public attribute TranslucencyMap → (get,set)

value : ITexture2D: The texture map.

See IMaterial.TranslucencyMap.

Defaults to null.

See also: ModelRendererParameters.ChangedTranslucencyMap

VertexColorInterpretation

public attribute VertexColorInterpretation → (get,set)

value : Vec2F: The vertex color interpretation.

Defines how vertex colors shall be interpreted:

x ==  0 => Ignore vertex color for rendering.
x == +1 => Use vertex color (compressed sRGB) to modulate albedo.
y == -1 => Use vertex alpha as ambient occlusion.
y ==  0 => Ignore vertex alpha for rendering.
y == +1 => Use vertex alpha as transparency.

Defaults to Vec2F.Zero.

See also: ModelRendererParameters.ChangedVertexColorInterpretation