Skip to content

LiteFX::Rendering::IRayTracingPipeline::maxPayloadSize

Returns the maximum size of a single ray payload.

Synopsis

Declared in <litefx/rendering_api.hpp>

[[dllimport, dllexport]] virtual UInt32 maxPayloadSize() const noexcept = 0;

Description

A ray payload is the data that is passed down the TraceRay function call chain. It can be zero, if [Ray Payload] Qualifiers](https://microsoft.github.io/DirectX-Specs/d3d/Raytracing.html#payload-access-qualifiers) are used. Otherwise it must be set to the largest ray payload size used in the ray-tracing pipeline.

This property can currently not be queried from reflection.

Return Value

The maximum size of a single ray payload.