Version: 2023.2
LanguageEnglish
  • C#

CommandBuffer.SetRayTracingAccelerationStructure

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 SetRayTracingAccelerationStructure(Rendering.RayTracingShader rayTracingShader, string name, Rendering.RayTracingAccelerationStructure rayTracingAccelerationStructure);

Declaration

public void SetRayTracingAccelerationStructure(Rendering.RayTracingShader rayTracingShader, int nameID, Rendering.RayTracingAccelerationStructure rayTracingAccelerationStructure);

Declaration

public void SetRayTracingAccelerationStructure(ComputeShader computeShader, int kernelIndex, int nameID, Rendering.RayTracingAccelerationStructure rayTracingAccelerationStructure);

Declaration

public void SetRayTracingAccelerationStructure(ComputeShader computeShader, int kernelIndex, string name, Rendering.RayTracingAccelerationStructure rayTracingAccelerationStructure);

Parameters

rayTracingShader The RayTracingShader to set parameter for.
name The name of the acceleration structure in the shader code.
nameID Property name ID. Use Shader.PropertyToID to get this ID.
rayTracingAccelerationStructure The RayTracingAccelerationStructure object to be set.
computeShader The ComputeShader object to set the parameter for.
kernelIndex Which kernel the acceleration structure is being set for.

Description

Adds a command to set the RayTracingAccelerationStructure to be used in a RayTracingShader or a ComputeShader.

When using a RayTracingShader, the RayTracingAccelerationStructure specified as argument is visible globally in all ray tracing shader types (e.g. closest hit, any hit, miss, etc.).

When using a ComputeShader, it binds a RayTracingAccelerationStructure to a ComputeShader kernel to be used for Inline Ray Tracing (Ray Queries). This functionality is available on platforms where this feature is supported. Use SystemInfo.supportsInlineRayTracing to check this.

In compute shaders, ray queries can be used to perform acceleration structure traversal and geometry intersection tests. To access this functionality, the HLSL code needs to be compiled using #pragma require inlineraytracing.

#include "UnityRayQuery.cginc"

#pragma require inlineraytracing #pragma kernel CSRayQueryTest

RaytracingAccelerationStructure g_AccelStruct; RWTexture2D<float> g_Output;

[numthreads(8,4,1)] void CSRayQueryTest (uint3 id : SV_DispatchThreadID) { const uint rayFlags = RAY_FLAG_ACCEPT_FIRST_HIT_AND_END_SEARCH; UnityRayQuery<rayFlags> rayQuery;

RayDesc ray; ray.Origin = float3(0, 0, 0); ray.Direction = float3(0, 1, 0); ray.TMin = 0; ray.TMax = 10000;

rayQuery.TraceRayInline(g_AccelStruct, rayFlags, 0xff, ray); rayQuery.Proceed();

g_Output[id.xy] = (rayQuery.CommittedStatus() == COMMITTED_TRIANGLE_HIT) ? 1.0 : 0.0; }

This is a simple compute shader that checks if a ray with the origin at (0, 0, 0) and direction (0, 1, 0) intersects any geometry consisting of triangles. The g_AccelStruct shader object can be bound using the SetRayTracingAccelerationStructure function. The compute shader can be dispatched if SystemInfo.supportsInlineRayTracing is true.

Additional resources: RayTracingAccelerationStructure, SystemInfo.supportsRayTracingShaders, SystemInfo.supportsInlineRayTracing.