Struct ProbeArray 

pub struct ProbeArray(/* private fields */);

An array of sound probes.

Each probe has a position and a radius of influence.

ProbeArray is a reference-counted handle to an underlying Steam Audio object. Cloning it is cheap; it produces a new handle pointing to the same underlying object, while incrementing a reference count. The underlying object is destroyed when all handles are dropped.

Implementations

impl ProbeArray

pub fn try_new(context: &Context) -> Result<Self, SteamAudioError>

Creates a new probe array and returns a handle to it.

Errors

Returns SteamAudioError if creation fails.

pub fn generate_probes( &mut self, scene: &Scene, probe_params: &ProbeGenerationParams, )

Generates probes and adds them to the probe array.

pub fn num_probes(&self) -> usize

Returns the number of probes in the probe array.

pub fn probe(&self, index: usize) -> Result<Sphere, ProbeArrayError>

Returns the probe at a given index in the probe array.

Errors

Returns ProbeArrayError::ProbeIndexOutOfBounds if index is out of bounds.

pub fn probes(&self) -> impl Iterator<Item = Sphere> + '_

Returns an iterator over the probes contained in the array.

pub const fn raw_ptr(&self) -> IPLProbeArray

Returns the raw FFI pointer to the underlying probe array.

This is intended for internal use and advanced scenarios.

pub const fn raw_ptr_mut(&mut self) -> &mut IPLProbeArray

Returns a mutable reference to the raw FFI pointer.

This is intended for internal use and advanced scenarios.

Trait Implementations

impl Clone for ProbeArray

fn clone(&self) -> Self

Retains an additional reference to the probe array.

The returned ProbeArray shares the same underlying Steam Audio object.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProbeArray

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for ProbeArray

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl From<ProbeArray> for ProbeArray

Available on crate feature bevy only.

fn from(probe_array: ProbeArray) -> Self

Converts to this type from the input type.

impl Hash for ProbeArray

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ProbeArray

fn eq(&self, other: &ProbeArray) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ProbeArray

impl Send for ProbeArray

impl StructuralPartialEq for ProbeArray

impl Sync for ProbeArray