Struct Vca 

pub struct Vca { /* private fields */ }

Available on crate feature studio only.

Represents a global mixer VCA.

Implementations

impl Vca

pub unsafe fn from_ffi(value: *mut FMOD_STUDIO_VCA) -> Self

Safety

value must be a valid pointer either aquired from Self::as_ptr or FMOD.

Panics

Panics if value is null.

pub fn as_ptr(self) -> *mut FMOD_STUDIO_VCA

Converts self into its raw representation.

impl Vca

pub fn set_volume(&self, volume: c_float) -> Result<()>

Sets the volume level.

The VCA volume level is used to linearly modulate the levels of the buses and VCAs which it controls.

pub fn get_volume(&self) -> Result<(c_float, c_float)>

Retrieves the volume level.

The final combined volume returned in the second tuple field combines the user value set using Vca::set_volume with the result of any automation or modulation applied to the VCA. The final combined volume is calculated asynchronously when the Studio system updates.

impl Vca

pub fn get_id(&self) -> Result<Guid>

Retrieves the GUID.

pub fn get_path(&self) -> Result<Utf8CString>

Retrieves the path.

The strings bank must be loaded prior to calling this function, otherwise FMOD_RESULT::FMOD_ERR_EVENT_NOTFOUND is returned.

pub fn is_valid(&self) -> bool

Checks that the VCA reference is valid.

Trait Implementations

impl Clone for Vca

fn clone(&self) -> Vca

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Vca

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

Formats the value using the given formatter.

impl From<Vca> for *mut FMOD_STUDIO_VCA

fn from(value: Vca) -> Self

Converts to this type from the input type.

impl Hash for Vca

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 Vca

fn eq(&self, other: &Vca) -> 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 Copy for Vca

impl Eq for Vca

impl Send for Vca

Available on non-crate feature thread-unsafe only.

impl StructuralPartialEq for Vca

impl Sync for Vca

Available on non-crate feature thread-unsafe only.