Class DecalSystem

Inheritance

Object

DecalSystem

Namespace: UnityEngine.Experimental.Rendering.HDPipeline

Syntax

public class DecalSystem

Fields

kInvalidIndex

Declaration

public const int kInvalidIndex = -1

Field Value

Type	Description
Int32

kNullMaterialIndex

Declaration

public const int kNullMaterialIndex = 2147483647

Field Value

Type	Description
Int32

m_AllocationSuccess

Declaration

public bool m_AllocationSuccess

Field Value

Type	Description
Boolean

m_BaseColor

Declaration

public static Vector4[] m_BaseColor

Field Value

Type	Description
Vector4[]

m_BoundingDistances

Declaration

public static float[] m_BoundingDistances

Field Value

Type	Description
Single[]

m_Bounds

Declaration

public static SFiniteLightBound[] m_Bounds

Field Value

Type	Description
SFiniteLightBound[]

m_DecalDatas

Declaration

public static DecalData[] m_DecalDatas

Field Value

Type	Description
DecalData[]

m_DecalDatasCount

Declaration

public static int m_DecalDatasCount

Field Value

Type	Description
Int32

m_DecalMesh

Declaration

public static Mesh m_DecalMesh

Field Value

Type	Description
Mesh

m_DecalsVisibleThisFrame

Declaration

public static int m_DecalsVisibleThisFrame

Field Value

Type	Description
Int32

m_DiffuseTextureScaleBias

Declaration

public static DecalSystem.TextureScaleBias[] m_DiffuseTextureScaleBias

Field Value

Type	Description
DecalSystem.TextureScaleBias[]

m_LightVolumes

Declaration

public static LightVolumeData[] m_LightVolumes

Field Value

Type	Description
LightVolumeData[]

m_MaskTextureScaleBias

Declaration

public static DecalSystem.TextureScaleBias[] m_MaskTextureScaleBias

Field Value

Type	Description
DecalSystem.TextureScaleBias[]

m_NormalTextureScaleBias

Declaration

public static DecalSystem.TextureScaleBias[] m_NormalTextureScaleBias

Field Value

Type	Description
DecalSystem.TextureScaleBias[]

m_PrevAllocationSuccess

Declaration

public bool m_PrevAllocationSuccess

Field Value

Type	Description
Boolean

s_MaterialDecalPassNames

Declaration

public static readonly string[] s_MaterialDecalPassNames

Field Value

Type	Description
String[]

s_MaterialSGDecalPassNames

Declaration

public static readonly string[] s_MaterialSGDecalPassNames

Field Value

Type	Description
String[]

Properties

Atlas

Declaration

public Texture2DAtlas Atlas { get; }

Property Value

Type	Description
Texture2DAtlas

CurrentCamera

Declaration

public Camera CurrentCamera { get; set; }

Property Value

Type	Description
Camera

DrawDistance

Declaration

public int DrawDistance { get; }

Property Value

Type	Description
Int32

instance

Declaration

public static DecalSystem instance { get; }

Property Value

Type	Description
DecalSystem

perChannelMask

Declaration

public bool perChannelMask { get; }

Property Value

Type	Description
Boolean

Methods

AddDecal(Transform, Matrix4x4, Single, Single, Vector4, Boolean, Material, Int32, Single)

Declaration

public DecalSystem.DecalHandle AddDecal(Transform transform, Matrix4x4 sizeOffset, float drawDistance, float fadeScale, Vector4 uvScaleBias, bool affectsTransparency, Material material, int layerMask, float fadeFactor)

Parameters

Type	Name	Description
Transform	transform
Matrix4x4	sizeOffset
Single	drawDistance
Single	fadeScale
Vector4	uvScaleBias
Boolean	affectsTransparency
Material	material
Int32	layerMask
Single	fadeFactor

Returns

Type	Description
DecalSystem.DecalHandle

AddDecal(Vector3, Quaternion, Vector3, Matrix4x4, Single, Single, Vector4, Boolean, Material, Int32, Single)

Declaration

public DecalSystem.DecalHandle AddDecal(Vector3 position, Quaternion rotation, Vector3 scale, Matrix4x4 sizeOffset, float drawDistance, float fadeScale, Vector4 uvScaleBias, bool affectsTransparency, Material material, int layerMask, float fadeFactor)

Parameters

Type	Name	Description
Vector3	position
Quaternion	rotation
Vector3	scale
Matrix4x4	sizeOffset
Single	drawDistance
Single	fadeScale
Vector4	uvScaleBias
Boolean	affectsTransparency
Material	material
Int32	layerMask
Single	fadeFactor

Returns

Type	Description
DecalSystem.DecalHandle

AddTexture(CommandBuffer, DecalSystem.TextureScaleBias)

Declaration

public void AddTexture(CommandBuffer cmd, DecalSystem.TextureScaleBias textureScaleBias)

Parameters

Type	Name	Description
CommandBuffer	cmd
DecalSystem.TextureScaleBias	textureScaleBias

BeginCull(DecalSystem.CullRequest)

Declaration

public void BeginCull(DecalSystem.CullRequest request)

Parameters

Type	Name	Description
DecalSystem.CullRequest	request

Cleanup()

Declaration

public void Cleanup()

CreateDrawData()

Declaration

public void CreateDrawData()

EndCull(DecalSystem.CullRequest, DecalSystem.CullResult)

Declaration

public void EndCull(DecalSystem.CullRequest cullRequest, DecalSystem.CullResult cullResults)

Parameters

Type	Name	Description
DecalSystem.CullRequest	cullRequest
DecalSystem.CullResult	cullResults

IsHDRenderPipelineDecal(String)

Declaration

public static bool IsHDRenderPipelineDecal(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Boolean

LoadCullResults(DecalSystem.CullResult)

Declaration

public void LoadCullResults(DecalSystem.CullResult cullResult)

Parameters

Type	Name	Description
DecalSystem.CullResult	cullResult

RemoveDecal(DecalSystem.DecalHandle)

Declaration

public void RemoveDecal(DecalSystem.DecalHandle handle)

Parameters

Type	Name	Description
DecalSystem.DecalHandle	handle

RenderDebugOverlay(HDCamera, CommandBuffer, DebugDisplaySettings, ref Single, ref Single, Single, Single)

Declaration

public void RenderDebugOverlay(HDCamera hdCamera, CommandBuffer cmd, DebugDisplaySettings debugDisplaySettings, ref float x, ref float y, float overlaySize, float width)

Parameters

Type	Name	Description
HDCamera	hdCamera
CommandBuffer	cmd
DebugDisplaySettings	debugDisplaySettings
Single	x
Single	y
Single	overlaySize
Single	width

RenderForwardEmissive(CommandBuffer)

Declaration

public void RenderForwardEmissive(CommandBuffer cmd)

Parameters

Type	Name	Description
CommandBuffer	cmd

RenderIntoDBuffer(CommandBuffer)

Declaration

public void RenderIntoDBuffer(CommandBuffer cmd)

Parameters

Type	Name	Description
CommandBuffer	cmd

SetAtlas(CommandBuffer)

Declaration

public void SetAtlas(CommandBuffer cmd)

Parameters

Type	Name	Description
CommandBuffer	cmd

UpdateCachedData(Transform, Matrix4x4, Single, Single, Vector4, Boolean, DecalSystem.DecalHandle, Int32, Single)

Declaration

public void UpdateCachedData(Transform transform, Matrix4x4 sizeOffset, float drawDistance, float fadeScale, Vector4 uvScaleBias, bool affectsTransparency, DecalSystem.DecalHandle handle, int layerMask, float fadeFactor)

Parameters

Type	Name	Description
Transform	transform
Matrix4x4	sizeOffset
Single	drawDistance
Single	fadeScale
Vector4	uvScaleBias
Boolean	affectsTransparency
DecalSystem.DecalHandle	handle
Int32	layerMask
Single	fadeFactor

UpdateCachedData(Vector3, Quaternion, Matrix4x4, Single, Single, Vector4, Boolean, DecalSystem.DecalHandle, Int32, Single)

Declaration

public void UpdateCachedData(Vector3 position, Quaternion rotation, Matrix4x4 sizeOffset, float drawDistance, float fadeScale, Vector4 uvScaleBias, bool affectsTransparency, DecalSystem.DecalHandle handle, int layerMask, float fadeFactor)

Parameters

Type	Name	Description
Vector3	position
Quaternion	rotation
Matrix4x4	sizeOffset
Single	drawDistance
Single	fadeScale
Vector4	uvScaleBias
Boolean	affectsTransparency
DecalSystem.DecalHandle	handle
Int32	layerMask
Single	fadeFactor

UpdateCachedMaterialData()

Declaration

public void UpdateCachedMaterialData()

UpdateTextureAtlas(CommandBuffer)

Declaration

public void UpdateTextureAtlas(CommandBuffer cmd)

Parameters

Type	Name	Description
CommandBuffer	cmd