Skip to main content
Version: 20 Mar 2024

MLAudioRaycastResult

Module: Audio / Audio Definitions / Acoustics / Spatial Sound

ID-tracked result for a single raycast operation. More...

#include <ml_audio.h>

Public Attributes

TypeName
MLHandlesource_id
MLHandleimage_id
uint32_tleg_index
MLAudioRaycastray
MLAudioObstructionobstruction

Detailed Description

struct MLAudioRaycastResult;

ID-tracked result for a single raycast operation.

API Level:

  • 20

Public Attributes Documentation

source_id

MLHandle source_id;
TypeDescription
MLHandleInteger handle type used to reference many things returned by the API, instead of returning pointers directly. Use MLHandleIsValid() to check if a handle is valid or not.

Internal identifier.


image_id

MLHandle image_id;
TypeDescription
MLHandleInteger handle type used to reference many things returned by the API, instead of returning pointers directly. Use MLHandleIsValid() to check if a handle is valid or not.

Internal identifier.


leg_index

uint32_t leg_index;

Internal identifier.


ray

MLAudioRaycast ray;
TypeDescription
MLAudioRaycastTwo points in space describing a ray.

Raycast tested for obstruction.


obstruction

MLAudioObstruction obstruction;
TypeDescription
MLAudioObstructionObstruction along a ray.

Result of obstruction test.