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:

Public / Constants

Changed​Camera


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

Changed flag for Camera.

Changed​Center


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

Changed flag for Center.

Changed​Depth​Layer


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

Changed flag for DepthLayer.

Changed​Fade


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

Changed flag for Fade.

Changed​Lighting


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

Changed flag for Lighting.

Changed​Line


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

Changed flag for Line.

Changed​Material


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

Changed flag for Material.

Changed​Matrix


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

Changed flag for Matrix.

Changed​Matrix​Inverse​Transpose


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

Changed flag for MatrixInverseTranspose.

Changed​Shadow


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

Changed flag for Shadow.

Changed​Tangent​Mask


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

Changed flag for TangentMask.

Changed​Vertex​Color


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

Changed flag for VertexColor.

Flag​No​Sample​Frequency


public constant FlagNoSampleFrequency → (1:int32)

Disables use of sample-frequency pixel shaders.

Pass​Count


public constant PassCount → (62:int32)

The number of render passes.

Public / Constructors

Model​Renderer​Parameters


public constructor ModelRendererParameters → (1)

featureLevel in : LineFeatureLevel

The required feature level.

Creates a new instance of ModelRendererParameters.

Public / Methods

Pass​Cull


[Pure]
public static method PassCull → (1)

pass in : int32

[0..ModelRendererParameters.PassCount-1]
The pass index.

returns → int32

The cull mode, see PassIndex.

Returns the cull mode of the given pass.

Pass​Index


[Pure]
public static method PassIndex → (4)

mode in : int32

[0..5]
The pass mode:
0 : mode for rendering opaque geometry (pixel frequency)
1 : mode for rendering opaque geometry (sample frequency)
2 : mode for rendering transparent geometry (alpha-blending)
3 : mode for rendering transparent geometry (order-independent)
4 : mode for rendering shadow maps
5 : mode for rendering thick lines
If sample frequency is not supported, using mode 0 or mode 1 will produce identical results.

instanced in : bool

Render instanced geometry?

wireframe in : bool

Render in wireframe mode?

cull in : 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.

Pass​Instanced


public static method PassInstanced → (1)

pass in : int32

[0..ModelRendererParameters.PassCount-1]
The pass index.

returns → bool

The instanced flag, see PassIndex.

Returns the instanced flag of the given pass.

Pass​Mode


[Pure]
public static method PassMode → (1)

pass in : int32

[0..ModelRendererParameters.PassCount-1]
The render pass index.

returns → int32

The render pass mode, see PassIndex.

Returns the mode of the given pass.

Pass​Wireframe


public static method PassWireframe → (1)

pass in : int32

[0..ModelRendererParameters.PassCount-1]
The pass index.

returns → bool

The wireframe flag, see PassIndex.

Returns the wireframe flag of the given pass.

Public / Attributes

Camera


public readonly attribute Camera → (CameraParameters)

The aggregated camera parameters.

Center


public attribute Center → (get,set)

value : Vec3D

The center coordinates.

Coordinates of model center.

The default value is Vec3F.Zero.

Depth​Layer


public attribute DepthLayer → (get,set)

value : int32

The depth layer offset value.

Apply a per-pixel depth layer offset value before computing logarithmic depth?

The default value is 0.

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.

Lighting


public readonly attribute Lighting → (LightingParameters)

The aggregated lighting parameters.

Line


public readonly attribute Line → (LineParameters)

The aggregated line parameters.

Material


public readonly attribute Material → (MaterialParameters)

The aggregated material parameters.

Matrix


public attribute Matrix → (get,set)

value : Mat4F

The transformation matrix.

Model-to-world transformation matrix.

Defaults to Mat4F.Zero.

Matrix​Inverse​Transpose


public attribute MatrixInverseTranspose → (get,set)

value : Mat4F

The transformation matrix.

Inverse transpose of model-to-world transformation matrix.

Defaults to Mat4F.Zero.

Shadow


public readonly attribute Shadow → (ShadowParameters)

The aggregated shadow parameters.

Tangent​Mask


Indicates whether normals, tangent or bitangent are available (1) or not (0).

Defaults to Vec3F.Zero.

Vertex​Color


public attribute VertexColor → (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.