rayGenFunctionName | The name of the ray generation shader. |
width | The width of the ray generation shader thread grid. |
height | The height of the ray generation shader thread grid. |
depth | The depth of the ray generation shader thread grid. |
camera | Optional parameter used to setup camera-related built-in shader variables. |
Dispatches this RayTracingShader.
When a ray generation shader is executed, the GPU launches a 3D grid of threads. In HLSL, the values of width, height and depth can be retrieved using DispatchRaysDimensions() function. To retrieve the index of the ray generation shader invocation, DispatchRaysIndex() HLSL function can be used.
Width, height and depth must be above zero and width*height*depth <= 2^30.
When an optional Camera is specified as parameter, the built-in shader variables related to the Camera, Screen and Time are set up. Check Built-in shader variables for a complete list of these variables.
A RayTracingShader only supports the following shader types: ray generation, miss and callable.
#include "UnityShaderVariables.cginc"
#pragma max_recursion_depth 1
// Input RaytracingAccelerationStructure g_SceneAccelStruct; float g_Zoom; //Mathf.Tan(Mathf.Deg2Rad * Camera.main.fieldOfView * 0.5f)
// Output RWTexture2D<float4> g_Output;
struct RayPayload { float4 color; };
[shader("miss")] void MainMissShader(inout RayPayload payload : SV_RayPayload) { payload.color = float4(0, 0, 0, 1); }
[shader("raygeneration")] void MainRayGenShader() { uint2 launchIndex = DispatchRaysIndex().xy; uint2 launchDim = DispatchRaysDimensions().xy;
float2 frameCoord = float2(launchIndex.x, launchDim.y - launchIndex.y - 1) + float2(0.5, 0.5);
float2 ndcCoords = frameCoord / float2(launchDim.x - 1, launchDim.y - 1);
ndcCoords = ndcCoords * 2 - float2(1, 1); ndcCoords = ndcCoords * g_Zoom;
float aspectRatio = (float)launchDim.x / (float)launchDim.y;
float3 viewDirection = normalize(float3(ndcCoords.x * aspectRatio, ndcCoords.y, 1));
// Rotate the ray from view space to world space. float3 rayDirection = normalize(mul((float3x3)unity_CameraToWorld, viewDirection));
RayDesc ray; ray.Origin = _WorldSpaceCameraPos; ray.Direction = rayDirection; ray.TMin = 0.0f; ray.TMax = 1000.0f;
RayPayload payload; payload.color = float4(1, 1, 1, 1);
uint missShaderIndex = 0; TraceRay(g_SceneAccelStruct, 0, 0xFF, 0, 1, missShaderIndex, ray, payload);
g_Output[frameCoord] = payload.color; }
In this ray generation shader example, you calculate a ray direction based on the current 2D thread index returned by the DispatchRaysIndex()
function.
The output is white if there is a ray/triangle intersection. When there is no intersection, the GPU executes MainMissShader and the output is black.
This example uses the unity_CameraToWorld
built-in shader variable. You must specify a Camera as an argument for the Dispatch
function to set this value correctly.
Additional resources: SystemInfo.supportsRayTracingShaders, RayTracingAccelerationStructure.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.