Version: Unity 6 Preview (6000.0)
LanguageEnglish
  • C#

ComputeShader.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

Switch to Manual

Declaration

public void SetRayTracingAccelerationStructure(int kernelIndex, int nameID, Rendering.RayTracingAccelerationStructure accelerationStructure);

Declaration

public void SetRayTracingAccelerationStructure(int kernelIndex, string name, Rendering.RayTracingAccelerationStructure accelerationStructure);

Parameters

kernelIndex For which kernel the RayTracingAccelerationStructure is being set. See FindKernel.
nameID Property name ID, use Shader.PropertyToID to get it.
accelerationStructure The RayTracingAccelerationStructure object to bind.
name Resource name in shader code.

Description

Sets a RayTracingAccelerationStructure to be used for Inline Ray Tracing (Ray Queries).

Use SystemInfo.supportsInlineRayTracing to check at runtime if Inline Ray Tracing is supported by the system.

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: CommandBuffer.SetGlobalRayTracingAccelerationStructure, SystemInfo.supportsInlineRayTracing.