Version: 2023.1
LanguageEnglish
  • C#

RayTracingInstanceCullingTest

struct in UnityEngine.Rendering

/

Implemented in:UnityEngine.CoreModule

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

A testing configuration used in RayTracingAccelerationStructure.CullInstances for adding Renderers to an acceleration structure based on their layer, ShadowCastingMode and Material type.

Typically, each ray tracing effect can use a dedicated RayTracingInstanceCullingTest configuration.

If the test passes, the value of instanceMask will be ORed into a final 8-bit ray tracing instance mask. When casting rays on the GPU using TraceRay HLSL function, the instanceInclusionMask argument of TraceRay is ANDed with the final 8-bit instance mask to include or reject ray tracing instances during acceleration structure traversal.

See Also: RayTracingAccelerationStructure.

Properties

allowAlphaTestedMaterialsWhether to allow Renderers that use alpha tested Materials.
allowOpaqueMaterialsWhether to allow Renderers that use opaque Materials.
allowTransparentMaterialsWhether to allow Renderers that use transparent Materials.
allowVisualEffectsWhether to allow VFXRenderers.
instanceMaskAn instance mask which affects ray-instance masking during ray tracing on the GPU.
layerMaskA value that indicates which layers are accepted by this testing configuration.
shadowCastingModeMaskA value that indicates which ShadowCastingMode values are acccepted by this testing configuration.