Class UVMapProperties

Namespace

Gamelogic.Fx.Mapping.Maps

Assembly

Gamelogic.Fx.dll

Properties for rendering a UV map of the scene. See ../common/docs/map-renderers-reference-common.html#uv-map.

[Serializable]
public sealed class UVMapProperties : MapProperties

Inheritance

object

ShaderProperties

MapProperties

UVMapProperties

Inherited Members

MapProperties.BackgroundShader

MapProperties.BackgroundColor

MapProperties.SetRendererProperties(MaterialPropertyBlock, Renderer)

MapProperties.OnEnable()

ShaderProperties.Shader

ShaderProperties.RequiresDepthTexture

ShaderProperties.RequiresNormalsTexture

ShaderProperties.OnValidate()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AdjustByDistance

Whether to adjust the UV coordinates based on the renderer's distance from the camera.

public bool AdjustByDistance { get; }

Property Value

bool

AdjustByMaterialTiling

Whether to adjust the UV coordinates based on the renderer material's tiling.

public bool AdjustByMaterialTiling { get; }

Property Value

bool

AdjustByScale

Whether to adjust the UV coordinates based on scale of the game object the renderer is attached to.

public bool AdjustByScale { get; }

Property Value

bool

BackgroundShaderName

The name of the shader used to render the background when rendering this object info.

protected override string BackgroundShaderName { get; }

Property Value

string

Remarks

It is OK for this to return null if no background shader is needed, in which the BackgroundColor will appear.

This property should always return the same value during the lifetime of this MapProperties.

ShaderName

Gets the name of the shader used by this property set.

public override string ShaderName { get; }

Property Value

string

Remarks

This name is passed to the internal shader lookup system when the properties are enabled. It should match the full shader path as defined in the shader file.

UVBackgroundOffset

Offset of the UV coordinates for the background.

public Vector2 UVBackgroundOffset { get; }

Property Value

Vector2

UVBackgroundScale

Scale of the UV coordinates for the background.

public Vector2 UVBackgroundScale { get; }

Property Value

Vector2

Methods

SetBackgroundMaterialProperties(Material)

Applies background-specific properties to the background material.

public override void SetBackgroundMaterialProperties(Material material)

Parameters

material Material

The material created from BackgroundShader.

Remarks

Override this method to configure background shader uniforms such as clear color, gradients, or other map-wide background parameters.

SetMaterialProperties(Material)

Applies all shader-related properties to the given material.

public override void SetMaterialProperties(Material material)

Parameters

material Material

The material created for the post process effect, using the shader defined by ShaderName.

Remarks

Subclasses should override this method and set all relevant shader uniforms (for example, floats, vectors, colors, textures, and keywords).