Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


UpdateInstanceMask

Updates the instance mask of a ray tracing instance.
Read time 1 minuteLast updated 5 days ago

Definition

UpdateInstanceMask(Renderer, uint)

Updates the instance mask of a ray tracing instance.
public void UpdateInstanceMask(Renderer renderer, uint mask)

Parameters

renderer

The Renderer associated with the ray tracing instance.

mask

The new mask.

UpdateInstanceMask(int, uint)

Updates the instance mask of a ray tracing instance.
public void UpdateInstanceMask(int handle, uint mask)

Parameters

handle

The handle associated with an AABB or Mesh ray tracing instance.

mask

The new mask.

Remarks

Pass along a new mask and the handle RayTracingAccelerationStructure.AddInstance returns in order to update ray tracing mask associated with an axis-aligned bounding box (AABB) GraphicsBuffer or a Mesh.
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 GPU ignores the intersection.
Note that building the acceleration structure on the GPU has to be triggered by calling RayTracingAccelerationStructure.Build or CommandBuffer.BuildRayTracingAccelerationStructure.