Version: 2023.2
LanguageEnglish
  • C#

RayTracingAccelerationStructure.AddVFXInstances

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

Declaration

public void AddVFXInstances(Renderer targetRenderer, uint[] vfxSystemMasks);

Parameters

targetRenderer The Renderer to add to the RayTracingAccelerationStructure.
vfxSystemMasks An array of 8-bit masks you can use to selectively intersect ray-traced VFX systems associated with the target Renderer with rays that only pass the mask. All rays are enabled (0xff) by default.

Description

Adds the ray tracing instances associated with a VFXRenderer to the RayTracingAccelerationStructure.

Ray tracing instances in the acceleration structure contain an 8-bit user defined instance mask. The TraceRay() HLSL function has an 8-bit input parameter, InstanceInclusionMask which gets ANDed with the instance mask from any ray tracing instance that is a candidate for intersection during acceleration structure traversal on the GPU. If the result of the AND operation is zero, the intersection is ignored.

One VFXRenderer can have more than one ray tracing instance if it contains multiple output contexts. This method adds all the instances of outputs which enable ray tracing, with the masks specified in vfxSystemMasks.