TerrainMaterialParameters

Description

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

Derived from: RenderEffectParameters ^abstract

Shared render effect parameters for material-based texturing of the terrain.

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

'g_materialSettings', RenderEffectParameterType.Vector4 [64]
Material texture settings, indexed by material ID:
```
x := horizontal texture coordinate scale
y := vertical texture coordinate scale or 0 for planar mapping
z := horizontal displacement scale
w := vertical displacement scale or 0 for planar mapping
```
Mapped to TerrainMaterialTextureParameters.ScaleTexture and TerrainMaterialTextureParameters.ScaleDisplacement of Horizontal and Vertical.
'g_materialOrigin', RenderEffectParameterType.Vector3 [2], mapped to:
#0: Origin, return of Vec.To3F_Delta3
#1: Origin, output of Vec.To3F_Delta3
'g_materialTranslate', RenderEffectParameterType.Vector3, mapped to Offset.
'g_materialTransform', RenderEffectParameterType.Vector3
Transformation coefficients:
```
x := sin(-Rotation)
y := cos(-Rotation)
z := Radius
```
Mapped to Rotation and Radius.
'g_materialGridLines', RenderEffectParameterType.Float, mapped to GridLines.
'g_materialIds', RenderEffectParameterType.Vector4, mapped to TerrainMaterialSlotParameters.MaterialId of Slot.

'g_materialWeights', RenderEffectParameterType.Vector4
Weight mask for material IDs:

x := 1 if first material is present, 0 otherwise
y := 1 if second material is present, 0 otherwise
z := 1 if third material is present, 0 otherwise
w := 1 if fourth material is present, 0 otherwise

Mapped to TerrainMaterialSlotParameters.MaterialId of Slot.

'g_normalScale', RenderEffectParameterType.Vector2 [4]
Normal vector scale along up-direction, indexed by material slot:
```
x := normal scale for horizontal texture
y := normal scale for vertical texture
```
Mapped to TerrainMaterialSlotParameters.Scale of Slot.
'g_materialBlendH', RenderEffectParameterType.Vector4 [4]
Material albedo blend coefficients for horizontal texture, indexed by material slot:
```
x := blend factor for material albedo
y := blend factor for vertex color
z := saturation of the material albedo
w := brightness of the vertex colors
```
Mapped to TerrainMaterialSlotParameters.BlendHorizontal of Slot.
'g_materialBlendV', RenderEffectParameterType.Vector4 [4]
Material albedo blend coefficients for vertical texture, indexed by material slot:
```
x := blend factor for material albedo
y := blend factor for vertex color
z := saturation of the material albedo
w := brightness of the vertex colors
```
Mapped to TerrainMaterialSlotParameters.BlendVertical of Slot.
'g_material', RenderEffectParameterType.Texture2D [16]
The material textures (N := material index in [0..3], M := FlagMaterialCountMask).
Albedo/Reflectivity texture:
```
g_material[N * 2 + M * 0 + 0] := horizontal
g_material[N * 2 + M * 2 + 0] := vertical
```
Normal/AmbientOcclusion/Roughness texture:
```
g_material[N * 2 + M * 0 + 1] := horizontal
g_material[N * 2 + M * 2 + 1] := vertical
```
Mapped to TerrainMaterialTextureParameters.AlbedoReflectivityMap and TerrainMaterialTextureParameters.NormalAmbientRoughnessMap.

The following low-level render effect parameter slots are omitted if FlagNoDisplacement is present:

'g_displacementInfo', RenderEffectParameterType.Vector2
Information about the horizontal and vertical displacement texture arrays:
x and y are mapped to mapped to DisplacementIndex.
z maps to the width of DisplacementHorizontal.
w maps to the width of DisplacementVertical.
'g_materialHeightBlend', RenderEffectParameterType.Vector3, mapped to TerrainLayerMaterial.HeightBlend.
'g_displacementSettings', RenderEffectParameterType.Vector2, mapped to DisplacementSettings.
'g_displacement', RenderEffectParameterType.Texture2D [2]
Displacement texture arrays:
```
#0: horizontal, index by material ID minus DisplacementIndex.X
#1: vertical, index by material ID minus DisplacementIndex.Y
```
Mapped to DisplacementHorizontal and DisplacementVertical.

Public / Constants

ChangedDisplacementHorizontal

public constant ChangedDisplacementHorizontal → (1:int32)

Changed flag for DisplacementHorizontal.

ChangedDisplacementIndex

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

Changed flag for DisplacementIndex.

ChangedDisplacementSettings

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

Changed flag for DisplacementSettings.

ChangedDisplacementVertical

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

Changed flag for DisplacementVertical.

ChangedGridLines

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

Changed flag for GridLines.

ChangedHeightBlend

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

Changed flag for HeightBlend.

ChangedHorizontal

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

Changed flag for Horizontal.

ChangedOffset

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

Changed flag for Offset.

ChangedOrigin

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

Changed flag for Origin.

ChangedRadius

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

Changed flag for Radius.

ChangedRotation

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

Changed flag for Rotation.

ChangedSlot

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

Changed flag for Slot.

ChangedVertical

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

Changed flag for Vertical.

FlagMaterialCountMask

public constant FlagMaterialCountMask → (7:int32)

Bitmask for extracting the material count from the flags that have been passed to RenderEffectParameters.Declare.

The material count must be in the range [1..3].

FlagNoDisplacement

public constant FlagNoDisplacement → (8:int32)

When present, low-level render effect parameter slots that are related to displacement mapping will be omitted.

See also: RenderEffectParameters.Declare

ModifierAdd

public constant ModifierAdd → (0:int32)

Render effect pass modifier for additive blending.

See also: TerrainMaterialParameters.ModifierBlend

ModifierBlend

public constant ModifierBlend → (1:int32)

Render effect pass modifier for alpha-blending.

See also: TerrainMaterialParameters.ModifierAdd

ModifierMax

public constant ModifierMax → (1:int32)

Maximum render effect pass modifier.

Public / Constructors

TerrainMaterialParameters

public constructor TerrainMaterialParameters → ()

Creates a new instance of TerrainMaterialParameters.

Public / Attributes

DisplacementHorizontal

public attribute DisplacementHorizontal → (get,set)

value : ITexture2D: The texture array, indexed by material ID minus Vec2I.X of DisplacementIndex.

The texture array for horizontal displacement textures.

Defaults to null.

See also: TerrainMaterialParameters.ChangedDisplacementHorizontal

DisplacementIndex

public attribute DisplacementIndex → (get,set)

value : Vec2I: The texture array indices: Vec2I.X for DisplacementHorizontal, Vec2I.Y for DisplacementVertical.

Material ID of the first slice of the displacement texture arrays.

Defaults to Vec2I.Zero.

See also: TerrainMaterialParameters.ChangedDisplacementIndex

DisplacementSettings

public attribute DisplacementSettings → (get,set)

value : Vec2F: The displacement settings:
Vec2F.X: the uniform displacement scale factor.
Vec2F.Y: the tessellation threshold, in screen pixels.

Settings for terrain displacement.

Defaults to (0,1).

See also: TerrainMaterialParameters.ChangedDisplacementSettings

DisplacementVertical

public attribute DisplacementVertical → (get,set)

value : ITexture2D: The texture array, indexed by material ID minus Vec2I.Y of DisplacementIndex.

The texture array for vertical displacement textures.

Defaults to null.

See also: TerrainMaterialParameters.ChangedDisplacementVertical

GridLines

public attribute GridLines → (get,set)

value : float32: [>=0]
The grid-line step in material space or 0 to disable.

Shows or hides grid-lines for material space.

Defaults to 0.

HeightBlend

public attribute HeightBlend → (get,set)

value : Vec3F: The coefficient vector, see TerrainLayerMaterial.HeightBlend.

Coefficients for height-based blending of material textures.

Defaults to Vec3F.Zero.

Horizontal

public readonly attribute Horizontal → (RenderEffectParameterArray<TerrainMaterialTextureParameters>)

The terrain texture parameters for the horizontal plane, indexed by material ID.

See also: TerrainMaterialParameters.ChangedHorizontal

Offset

public attribute Offset → (get,set)

value : Vec3F: The offset vector, in material-space.

The material-space offset.

See also: TerrainMaterialParameters.ChangedOffset

Origin

public attribute Origin → (get,set)

value : Vec3D: The texture origin.

Point in terrain-space that is subtracted from the vertex position before calculating material coordinates.

Defaults to Vec3D.Zero.

See also: TerrainMaterialParameters.ChangedOrigin

Radius

public attribute Radius → (get,set)

value : float32: The radius, in terrain-space.

The geocentric terrain radius.

Defaults to 0.

Rotation

public attribute Rotation → (get,set)

value : float64: The rotation angle, in radians.

The material-space rotation.

Defaults to 0.

Slot

public readonly attribute Slot → (RenderEffectParameterArray<TerrainMaterialSlotParameters>)

The parameters for each terrain material slot.

Vertical

public readonly attribute Vertical → (RenderEffectParameterArray<TerrainMaterialTextureParameters>)

The terrain texture parameters for the vertical planes, indexed by material ID.

A terrain material will be rendered with planar texture mapping iff its vertical texture is empty (see TerrainMaterialTextureParameters.IsEmpty). Otherwise, it will be rendered with tri-planar texture mapping.

See also: TerrainMaterialParameters.ChangedVertical

TerrainMaterialParameters

Description

Public / Constants

Changed​Displacement​Horizontal

Changed​Displacement​Index

Changed​Displacement​Settings

Changed​Displacement​Vertical

Changed​Grid​Lines

Changed​Height​Blend

Changed​Horizontal

Changed​Offset

Changed​Origin

Changed​Radius

Changed​Rotation

Changed​Slot

Changed​Vertical

Flag​Material​Count​Mask

Flag​No​Displacement

Modifier​Add

Modifier​Blend

Modifier​Max

Public / Constructors

Terrain​Material​Parameters

Public / Attributes

Displacement​Horizontal

Displacement​Index

Displacement​Settings

Displacement​Vertical

Grid​Lines

Height​Blend

Horizontal

Offset

Origin

Radius

Rotation

Slot

Vertical

ChangedDisplacementHorizontal

ChangedDisplacementIndex

ChangedDisplacementSettings

ChangedDisplacementVertical

ChangedGridLines

ChangedHeightBlend

ChangedHorizontal

ChangedOffset

ChangedOrigin

ChangedRadius

ChangedRotation

ChangedSlot

ChangedVertical

FlagMaterialCountMask

FlagNoDisplacement

ModifierAdd

ModifierBlend

ModifierMax

TerrainMaterialParameters

DisplacementHorizontal

DisplacementIndex

DisplacementSettings

DisplacementVertical

GridLines

HeightBlend