Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


RayTracingAccelerationStructure

A data structure used to represent the geometry in the Scene for GPU ray tracing.
Read time 2 minutesLast updated 6 days ago

Definition

public sealed class RayTracingAccelerationStructure : IDisposable

Remarks

Constructors

Methods

Method

Description

AddInstanceAdds a ray tracing instance to the RayTracingAccelerationStructure.
AddInstancesAdds an array of ray tracing Mesh instances to the RayTracingAccelerationStructure.
AddVFXInstancesAdds the ray tracing instances associated with a VFXRenderer to the RayTracingAccelerationStructure.
BuildBuilds acceleration structures on the GPU. Allocates any GPU memory required for storing acceleration structure data.
ClearInstancesRemoves all ray tracing instances from the RayTracingAccelerationStructure.
CullInstancesPopulates the RayTracingAccelerationStructure with ray tracing instances that Unity associates with Renderers in the Scene by using filtering and culling parameters.
DisposeDestroys this RayTracingAccelerationStructure and frees the GPU memory used for storing acceleration structure data.
GetInstanceCountReturns the number of ray tracing instances in the RayTracingAccelerationStructure.
GetSizeReturns the total size of this RayTracingAccelerationStructure in GPU memory in bytes.
ReleaseDestroys this RayTracingAccelerationStructure and frees the GPU memory used for storing acceleration structure data.
RemoveInstanceRemoves a ray tracing instance associated with an axis-aligned bounding box (AABBs) GraphicsBuffer or a Mesh instance from this RayTracingAccelerationStructure.
RemoveVFXInstancesRemove the ray tracing instances associated with a VFXRenderer from the RayTracingAccelerationStructure.
UpdateInstanceIDUpdates the instance ID of a ray tracing instance.
UpdateInstanceMaskUpdates the instance mask of a ray tracing instance.
UpdateInstancePropertyBlockUpdates per ray tracing instance Material properties.
UpdateInstanceTransformUpdates the transformation of a ray tracing instance.

Structs

Struct

Description

RayTracingAccelerationStructure.BuildSettingsContains options for building a RayTracingAccelerationStructure.
RayTracingAccelerationStructure.SettingsDefines whether Unity or the user updates a RayTracingAccelerationStructure. Also provides additional filtering and acceleration structure build options.

Enums

Enum

Description

RayTracingAccelerationStructure.ManagementModeDefines whether Unity updates a RayTracingAccelerationStructure automatically, or if the user updates it manually via API.
RayTracingAccelerationStructure.RayTracingModeMaskAn enum controlling which RayTracingModes a Renderer must have in order to be added to the RayTracingAccelerationStructure.