Class rayx::Tracer¶

Public Functions¶

Type	Name
	Tracer (const DeviceConfig & deviceConfig=DeviceConfig().enableBestDevice()) Construct a new Tracer object.
Rays	trace (const Group & group, const Sequential sequential=Sequential::No, const ObjectMask & objectRecordMask=ObjectMask::all(), const RayAttrMask attrRecordMask=RayAttrMask::All, std::optional< int > maxEvents=std::nullopt, std::optional< int > maxBatchSize=std::nullopt) Trace rays through the given group.

Public Functions Documentation¶

function Tracer¶

Construct a new Tracer object.

rayx::Tracer::Tracer (
    const DeviceConfig & deviceConfig=DeviceConfig ().enableBestDevice()
)

Parameters:

deviceConfig Configuration for the device to be used for tracing

function trace¶

Trace rays through the given group.

Rays rayx::Tracer::trace (
    const Group & group,
    const Sequential sequential=Sequential::No,
    const ObjectMask & objectRecordMask=ObjectMask::all(),
    const RayAttrMask attrRecordMask=RayAttrMask::All,
    std::optional< int > maxEvents=std::nullopt,
    std::optional< int > maxBatchSize=std::nullopt
)

Parameters:

group The group to trace rays through
sequential Whether to trace rays sequentially or non-sequentially
objectRecordMask Object record mask specifying which sources and elements to record
attrRecordMask Attributes to record for each ray
maxEvents Optional maximum number of events to trace per ray (only used in non-sequential tracing)
maxBatchSize Optional maximum batch size for tracing

Returns:

A Rays struct containing the traced ray attributes, specified by attrRecordMask and filtered by objectRecordMask

The documentation for this class was generated from the following file Intern/rayx-core/src/Tracer/Tracer.h