Class LightLoop

Inheritance

Object

LightLoop

Namespace: UnityEngine.Experimental.Rendering.HDPipeline

Syntax

public class LightLoop

Constructors

LightLoop()

Declaration

public LightLoop()

Fields

k_BoxCullingExtentThreshold

Declaration

public static readonly Vector3 k_BoxCullingExtentThreshold

Field Value

Type	Description
Vector3

k_HasNativeQuadSupport

Declaration

public const bool k_HasNativeQuadSupport = false

Field Value

Type	Description
Boolean

k_MaxAreaLightsOnScreen

Declaration

public const int k_MaxAreaLightsOnScreen = 64

Field Value

Type	Description
Int32

k_MaxDecalsOnScreen

Declaration

public const int k_MaxDecalsOnScreen = 512

Field Value

Type	Description
Int32

k_MaxDirectionalLightsOnScreen

Declaration

public const int k_MaxDirectionalLightsOnScreen = 16

Field Value

Type	Description
Int32

k_MaxEnvLightsOnScreen

Declaration

public const int k_MaxEnvLightsOnScreen = 64

Field Value

Type	Description
Int32

k_MaxLightsOnScreen

Declaration

public const int k_MaxLightsOnScreen = 656

Field Value

Type	Description
Int32

k_MaxPunctualLightsOnScreen

Declaration

public const int k_MaxPunctualLightsOnScreen = 512

Field Value

Type	Description
Int32

k_PreferFragment

Declaration

public static bool k_PreferFragment

Field Value

Type	Description
Boolean

k_ThreadGroupOptimalSize

Declaration

public const int k_ThreadGroupOptimalSize = 64

Field Value

Type	Description
Int32

m_MaxAreaLightsOnScreen

Declaration

public int m_MaxAreaLightsOnScreen

Field Value

Type	Description
Int32

m_MaxDecalsOnScreen

Declaration

public int m_MaxDecalsOnScreen

Field Value

Type	Description
Int32

m_MaxDirectionalLightsOnScreen

Declaration

public int m_MaxDirectionalLightsOnScreen

Field Value

Type	Description
Int32

m_MaxEnvLightsOnScreen

Declaration

public int m_MaxEnvLightsOnScreen

Field Value

Type	Description
Int32

m_MaxLightsOnScreen

Declaration

public int m_MaxLightsOnScreen

Field Value

Type	Description
Int32

m_MaxPunctualLightsOnScreen

Declaration

public int m_MaxPunctualLightsOnScreen

Field Value

Type	Description
Int32

s_FlipMatrixLHSRHS

Declaration

public static readonly Matrix4x4 s_FlipMatrixLHSRHS

Field Value

Type	Description
Matrix4x4

s_UseCascadeBorders

Declaration

public static readonly bool s_UseCascadeBorders

Field Value

Type	Description
Boolean

Properties

areaLightCookieManager

Declaration

public LTCAreaLightCookieManager areaLightCookieManager { get; }

Property Value

Type	Description
LTCAreaLightCookieManager

areaLightCount

Declaration

public int areaLightCount { get; }

Property Value

Type	Description
Int32

cookieTexArray

Declaration

public TextureCache2D cookieTexArray { get; }

Property Value

Type	Description
TextureCache2D

cubeCookieTexArray

Declaration

public TextureCacheCubemap cubeCookieTexArray { get; }

Property Value

Type	Description
TextureCacheCubemap

directionalLightDatas

Declaration

public ComputeBuffer directionalLightDatas { get; }

Property Value

Type	Description
ComputeBuffer

lightDatas

Declaration

public ComputeBuffer lightDatas { get; }

Property Value

Type	Description
ComputeBuffer

Methods

AddBoxVolumeDataAndBound(OrientedBBox, LightCategory, LightFeatureFlags, Matrix4x4, Boolean)

Declaration

public void AddBoxVolumeDataAndBound(OrientedBBox obb, LightCategory category, LightFeatureFlags featureFlags, Matrix4x4 worldToView, bool xrInstancingEnabled)

Parameters

Type	Name	Description
OrientedBBox	obb
LightCategory	category
LightFeatureFlags	featureFlags
Matrix4x4	worldToView
Boolean	xrInstancingEnabled

AllocResolutionDependentBuffers(Int32, Int32, Int32)

Declaration

public void AllocResolutionDependentBuffers(int width, int height, int viewCount)

Parameters

Type	Name	Description
Int32	width
Int32	height
Int32	viewCount

Build(HDRenderPipelineAsset, IBLFilterBSDF[])

Declaration

public void Build(HDRenderPipelineAsset hdAsset, IBLFilterBSDF[] iBLFilterBSDFArray)

Parameters

Type	Name	Description
HDRenderPipelineAsset	hdAsset
IBLFilterBSDF[]	iBLFilterBSDFArray

BuildGPULightLists(HDCamera, CommandBuffer, RenderTargetIdentifier, RenderTargetIdentifier, Boolean)

Declaration

public void BuildGPULightLists(HDCamera hdCamera, CommandBuffer cmd, RenderTargetIdentifier cameraDepthBufferRT, RenderTargetIdentifier stencilTextureRT, bool skyEnabled)

Parameters

Type	Name	Description
HDCamera	hdCamera
CommandBuffer	cmd
RenderTargetIdentifier	cameraDepthBufferRT
RenderTargetIdentifier	stencilTextureRT
Boolean	skyEnabled

BuildGPULightListsCommon(HDCamera, CommandBuffer, RenderTargetIdentifier, RenderTargetIdentifier, Boolean)

Declaration

public void BuildGPULightListsCommon(HDCamera hdCamera, CommandBuffer cmd, RenderTargetIdentifier cameraDepthBufferRT, RenderTargetIdentifier stencilTextureRT, bool skyEnabled)

Parameters

Type	Name	Description
HDCamera	hdCamera
CommandBuffer	cmd
RenderTargetIdentifier	cameraDepthBufferRT
RenderTargetIdentifier	stencilTextureRT
Boolean	skyEnabled

Cleanup()

Declaration

public void Cleanup()

CopyStencilBufferForMaterialClassification(CommandBuffer, RTHandleSystem.RTHandle, RTHandleSystem.RTHandle, Material)

Declaration

public static void CopyStencilBufferForMaterialClassification(CommandBuffer cmd, RTHandleSystem.RTHandle depthStencilBuffer, RTHandleSystem.RTHandle stencilCopyBuffer, Material copyStencilMaterial)

Parameters

Type	Name	Description
CommandBuffer	cmd
RTHandleSystem.RTHandle	depthStencilBuffer
RTHandleSystem.RTHandle	stencilCopyBuffer
Material	copyStencilMaterial

CopyStencilBufferIfNeeded(CommandBuffer, HDCamera, SharedRTManager)

Declaration

public void CopyStencilBufferIfNeeded(CommandBuffer cmd, HDCamera hdCamera, SharedRTManager sharedRTManager)

Parameters

Type	Name	Description
CommandBuffer	cmd
HDCamera	hdCamera
SharedRTManager	sharedRTManager

GetBigTileLightList()

Declaration

public ComputeBuffer GetBigTileLightList()

Returns

Type	Description
ComputeBuffer

GetContactShadowMask(Boolean)

Declaration

public int GetContactShadowMask(bool contactShadowEnabled)

Parameters

Type	Name	Description
Boolean	contactShadowEnabled

Returns

Type	Description
Int32

GetCurrentShadowCount()

Declaration

public int GetCurrentShadowCount()

Returns

Type	Description
Int32

GetCurrentSunLight()

Declaration

public Light GetCurrentSunLight()

Returns

Type	Description
Light

GetDirectionalLightData(CommandBuffer, GPULightType, VisibleLight, Light, HDAdditionalLightData, AdditionalShadowData, Int32, Int32, DebugDisplaySettings, Int32)

Declaration

public bool GetDirectionalLightData(CommandBuffer cmd, GPULightType gpuLightType, VisibleLight light, Light lightComponent, HDAdditionalLightData additionalLightData, AdditionalShadowData additionalShadowData, int lightIndex, int shadowIndex, DebugDisplaySettings debugDisplaySettings, int sortedIndex)

Parameters

Type	Name	Description
CommandBuffer	cmd
GPULightType	gpuLightType
VisibleLight	light
Light	lightComponent
HDAdditionalLightData	additionalLightData
AdditionalShadowData	additionalShadowData
Int32	lightIndex
Int32	shadowIndex
DebugDisplaySettings	debugDisplaySettings
Int32	sortedIndex

Returns

Type	Description
Boolean

GetEnvLightData(CommandBuffer, HDCamera, HDProbe, DebugDisplaySettings)

Declaration

public bool GetEnvLightData(CommandBuffer cmd, HDCamera hdCamera, HDProbe probe, DebugDisplaySettings debugDisplaySettings)

Parameters

Type	Name	Description
CommandBuffer	cmd
HDCamera	hdCamera
HDProbe	probe
DebugDisplaySettings	debugDisplaySettings

Returns

Type	Description
Boolean

GetEnvLightVolumeDataAndBound(HDProbe, LightVolumeType, Matrix4x4, Camera.StereoscopicEye)

Declaration

public void GetEnvLightVolumeDataAndBound(HDProbe probe, LightVolumeType lightVolumeType, Matrix4x4 worldToView, Camera.StereoscopicEye eyeIndex = null)

Parameters

Type	Name	Description
HDProbe	probe
LightVolumeType	lightVolumeType
Matrix4x4	worldToView
Camera.StereoscopicEye	eyeIndex

GetFeatureVariantsEnabled()

Declaration

public bool GetFeatureVariantsEnabled()

Returns

Type	Description
Boolean

GetLightColor(VisibleLight)

Declaration

public Vector3 GetLightColor(VisibleLight light)

Parameters

Type	Name	Description
VisibleLight	light

Returns

Type	Description
Vector3

GetLightData(CommandBuffer, HDShadowSettings, Camera, GPULightType, VisibleLight, Light, HDAdditionalLightData, AdditionalShadowData, Int32, Int32, ref Vector3, DebugDisplaySettings)

Declaration

public bool GetLightData(CommandBuffer cmd, HDShadowSettings shadowSettings, Camera camera, GPULightType gpuLightType, VisibleLight light, Light lightComponent, HDAdditionalLightData additionalLightData, AdditionalShadowData additionalShadowData, int lightIndex, int shadowIndex, ref Vector3 lightDimensions, DebugDisplaySettings debugDisplaySettings)

Parameters

Type	Name	Description
CommandBuffer	cmd
HDShadowSettings	shadowSettings
Camera	camera
GPULightType	gpuLightType
VisibleLight	light
Light	lightComponent
HDAdditionalLightData	additionalLightData
AdditionalShadowData	additionalShadowData
Int32	lightIndex
Int32	shadowIndex
Vector3	lightDimensions
DebugDisplaySettings	debugDisplaySettings

Returns

Type	Description
Boolean

GetLightVolumeDataAndBound(LightCategory, GPULightType, LightVolumeType, VisibleLight, LightData, Vector3, Matrix4x4, Camera.StereoscopicEye)

Declaration

public void GetLightVolumeDataAndBound(LightCategory lightCategory, GPULightType gpuLightType, LightVolumeType lightVolumeType, VisibleLight light, LightData lightData, Vector3 lightDimensions, Matrix4x4 worldToView, Camera.StereoscopicEye eyeIndex = null)

Parameters

Type	Name	Description
LightCategory	lightCategory
GPULightType	gpuLightType
LightVolumeType	lightVolumeType
VisibleLight	light
LightData	lightData
Vector3	lightDimensions
Matrix4x4	worldToView
Camera.StereoscopicEye	eyeIndex

GetNumTileBigTileX(HDCamera)

Declaration

public int GetNumTileBigTileX(HDCamera hdCamera)

Parameters

Type	Name	Description
HDCamera	hdCamera

Returns

Type	Description
Int32

GetNumTileBigTileY(HDCamera)

Declaration

public int GetNumTileBigTileY(HDCamera hdCamera)

Parameters

Type	Name	Description
HDCamera	hdCamera

Returns

Type	Description
Int32

GetNumTileFtplX(HDCamera)

Declaration

public int GetNumTileFtplX(HDCamera hdCamera)

Parameters

Type	Name	Description
HDCamera	hdCamera

Returns

Type	Description
Int32

HasLightToCull()

Declaration

public bool HasLightToCull()

Returns

Type	Description
Boolean

IsBakedShadowMaskLight(Light)

Declaration

public bool IsBakedShadowMaskLight(Light light)

Parameters

Type	Name	Description
Light	light

Returns

Type	Description
Boolean

NeedResize(Int32)

Declaration

public bool NeedResize(int viewCount)

Parameters

Type	Name	Description
Int32	viewCount

Returns

Type	Description
Boolean

NewFrame(FrameSettings)

Declaration

public void NewFrame(FrameSettings frameSettings)

Parameters

Type	Name	Description
FrameSettings	frameSettings

PrepareLightsForGPU(CommandBuffer, HDCamera, CullingResults, HDProbeCullingResults, DensityVolumeList, DebugDisplaySettings, AOVRequestData)

Declaration

public bool PrepareLightsForGPU(CommandBuffer cmd, HDCamera hdCamera, CullingResults cullResults, HDProbeCullingResults hdProbeCullingResults, DensityVolumeList densityVolumes, DebugDisplaySettings debugDisplaySettings, AOVRequestData aovRequest)

Parameters

Type	Name	Description
CommandBuffer	cmd
HDCamera	hdCamera
CullingResults	cullResults
HDProbeCullingResults	hdProbeCullingResults
DensityVolumeList	densityVolumes
DebugDisplaySettings	debugDisplaySettings
AOVRequestData	aovRequest

Returns

Type	Description
Boolean

PushGlobalParams(HDCamera, CommandBuffer)

Declaration

public void PushGlobalParams(HDCamera hdCamera, CommandBuffer cmd)

Parameters

Type	Name	Description
HDCamera	hdCamera
CommandBuffer	cmd

ReleaseResolutionDependentBuffers()

Declaration

public void ReleaseResolutionDependentBuffers()

RenderContactShadows(HDCamera, RTHandleSystem.RTHandle, RenderTargetIdentifier, Int32, CommandBuffer)

Declaration

public void RenderContactShadows(HDCamera hdCamera, RTHandleSystem.RTHandle contactShadowRT, RenderTargetIdentifier depthTexture, int firstMipOffsetY, CommandBuffer cmd)

Parameters

Type	Name	Description
HDCamera	hdCamera
RTHandleSystem.RTHandle	contactShadowRT
RenderTargetIdentifier	depthTexture
Int32	firstMipOffsetY
CommandBuffer	cmd

RenderDebugOverlay(HDCamera, CommandBuffer, DebugDisplaySettings, ref Single, ref Single, Single, Single, CullingResults, RTHandleSystem.RTHandle)

Declaration

public void RenderDebugOverlay(HDCamera hdCamera, CommandBuffer cmd, DebugDisplaySettings debugDisplaySettings, ref float x, ref float y, float overlaySize, float width, CullingResults cullResults, RTHandleSystem.RTHandle finalRT)

Parameters

Type	Name	Description
HDCamera	hdCamera
CommandBuffer	cmd
DebugDisplaySettings	debugDisplaySettings
Single	x
Single	y
Single	overlaySize
Single	width
CullingResults	cullResults
RTHandleSystem.RTHandle	finalRT

RenderDeferredLighting(HDCamera, CommandBuffer, DebugDisplaySettings, RenderTargetIdentifier[], RenderTargetIdentifier, RenderTargetIdentifier, LightLoop.LightingPassOptions)

Declaration

public void RenderDeferredLighting(HDCamera hdCamera, CommandBuffer cmd, DebugDisplaySettings debugDisplaySettings, RenderTargetIdentifier[] colorBuffers, RenderTargetIdentifier depthStencilBuffer, RenderTargetIdentifier depthTexture, LightLoop.LightingPassOptions options)

Parameters

Type	Name	Description
HDCamera	hdCamera
CommandBuffer	cmd
DebugDisplaySettings	debugDisplaySettings
RenderTargetIdentifier[]	colorBuffers
RenderTargetIdentifier	depthStencilBuffer
RenderTargetIdentifier	depthTexture
LightLoop.LightingPassOptions	options

RenderForward(Camera, CommandBuffer, Boolean)

Declaration

public void RenderForward(Camera camera, CommandBuffer cmd, bool renderOpaque)

Parameters

Type	Name	Description
Camera	camera
CommandBuffer	cmd
Boolean	renderOpaque

RenderScreenSpaceShadows(HDCamera, RTHandleSystem.RTHandle, CommandBuffer)

Declaration

public void RenderScreenSpaceShadows(HDCamera hdCamera, RTHandleSystem.RTHandle deferredShadowRT, CommandBuffer cmd)

Parameters

Type	Name	Description
HDCamera	hdCamera
RTHandleSystem.RTHandle	deferredShadowRT
CommandBuffer	cmd

RenderShadows(ScriptableRenderContext, CommandBuffer, CullingResults, HDCamera)

Declaration

public void RenderShadows(ScriptableRenderContext renderContext, CommandBuffer cmd, CullingResults cullResults, HDCamera hdCamera)

Parameters

Type	Name	Description
ScriptableRenderContext	renderContext
CommandBuffer	cmd
CullingResults	cullResults
HDCamera	hdCamera

SetContactShadowsTexture(HDCamera, RTHandleSystem.RTHandle, CommandBuffer)

Declaration

public void SetContactShadowsTexture(HDCamera hdCamera, RTHandleSystem.RTHandle contactShadowsRT, CommandBuffer cmd)

Parameters

Type	Name	Description
HDCamera	hdCamera
RTHandleSystem.RTHandle	contactShadowsRT
CommandBuffer	cmd

UpdateCullingParameters(ref ScriptableCullingParameters)

Declaration

public void UpdateCullingParameters(ref ScriptableCullingParameters cullingParams)

Parameters

Type	Name	Description
ScriptableCullingParameters	cullingParams

UpdateStencilBufferForSSRExclusion(CommandBuffer, RTHandleSystem.RTHandle, RTHandleSystem.RTHandle, Material)

Declaration

public static void UpdateStencilBufferForSSRExclusion(CommandBuffer cmd, RTHandleSystem.RTHandle depthStencilBuffer, RTHandleSystem.RTHandle stencilCopyBuffer, Material copyStencilMaterial)

Parameters

Type	Name	Description
CommandBuffer	cmd
RTHandleSystem.RTHandle	depthStencilBuffer
RTHandleSystem.RTHandle	stencilCopyBuffer
Material	copyStencilMaterial

WillRenderContactShadow()

Declaration

public bool WillRenderContactShadow()

Returns

Type	Description
Boolean

WillRenderScreenSpaceShadows()

Declaration

public bool WillRenderScreenSpaceShadows()

Returns

Type	Description
Boolean

WorldToCamera(Camera)

Declaration

public static Matrix4x4 WorldToCamera(Camera camera)

Parameters

Type	Name	Description
Camera	camera

Returns

Type	Description
Matrix4x4