Version: 2021.2
LanguageEnglish
  • C#
Experimental: this API is experimental and might be changed or removed in the future.

RayTracingAccelerationStructure.UpdateInstanceID

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 UpdateInstanceID(Renderer renderer, uint instanceID);

Description

Updates the instance ID of a ray tracing instance associated with the Renderer passed as argument.

Ray tracing instances in the acceleration structure contain an user-defined instance ID. This instance ID can be accessed in HLSL using InstanceID() intrinsic and provides a way to access additional per-instance custom data. Note that this function is available only in closest hit, any hit, and intersection shaders.

By default, if an instance ID is not specified when calling RayTracingAccelerationStructure.AddInstance function, Unity will assign a instance ID lower than the value returned by the RayTracingAccelerationStructure.GetInstanceCount function.

Note that building the acceleration structure on the GPU has to be triggered by calling RayTracingAccelerationStructure.Build or CommandBuffer.BuildRayTracingAccelerationStructure.

See Also: RayTracingAccelerationStructure.RemoveInstance.