Trait alto::SourceTrait [−] [src]

pub unsafe trait SourceTrait<'d: 'c, 'c> {
    fn context(&self) -> &Context<'d>;
    fn as_raw(&self) -> ALuint;
    fn state(&self) -> AltoResult<SourceState>;
    fn play(&mut self) -> AltoResult<()>;
    fn pause(&mut self) -> AltoResult<()>;
    fn stop(&mut self) -> AltoResult<()>;
    fn rewind(&mut self) -> AltoResult<()>;
    fn relative(&self) -> AltoResult<bool>;
    fn set_relative(&mut self, _: bool) -> AltoResult<()>;
    fn gain(&self) -> AltoResult<f32>;
    fn set_gain(&mut self, _: f32) -> AltoResult<()>;
    fn min_gain(&self) -> AltoResult<f32>;
    fn set_min_gain(&mut self, _: f32) -> AltoResult<()>;
    fn max_gain(&self) -> AltoResult<f32>;
    fn set_max_gain(&mut self, _: f32) -> AltoResult<()>;
    fn reference_distance(&self) -> AltoResult<f32>;
    fn set_reference_distance(&mut self, _: f32) -> AltoResult<()>;
    fn rolloff_factor(&self) -> AltoResult<f32>;
    fn set_rolloff_factor(&mut self, _: f32) -> AltoResult<()>;
    fn max_distance(&self) -> AltoResult<f32>;
    fn set_max_distance(&mut self, _: f32) -> AltoResult<()>;
    fn pitch(&self) -> AltoResult<f32>;
    fn set_pitch(&mut self, _: f32) -> AltoResult<()>;
    fn position<V: From<[f32; 3]>>(&self) -> AltoResult<V>;
    fn set_position<V: Into<[f32; 3]>>(&mut self, _: V) -> AltoResult<()>;
    fn velocity<V: From<[f32; 3]>>(&self) -> AltoResult<V>;
    fn set_velocity<V: Into<[f32; 3]>>(&mut self, _: V) -> AltoResult<()>;
    fn direction<V: From<[f32; 3]>>(&self) -> AltoResult<V>;
    fn set_direction<V: Into<[f32; 3]>>(&mut self, _: V) -> AltoResult<()>;
    fn cone_inner_angle(&self) -> AltoResult<f32>;
    fn set_cone_inner_angle(&mut self, _: f32) -> AltoResult<()>;
    fn cone_outer_angle(&self) -> AltoResult<f32>;
    fn set_cone_outer_angle(&mut self, _: f32) -> AltoResult<()>;
    fn cone_outer_gain(&self) -> AltoResult<f32>;
    fn set_cone_outer_gain(&mut self, _: f32) -> AltoResult<()>;
    fn sec_offset(&self) -> AltoResult<f32>;
    fn set_sec_offset(&mut self, _: f32) -> AltoResult<()>;
    fn sample_offset(&self) -> AltoResult<ALint>;
    fn set_sample_offset(&mut self, _: ALint) -> AltoResult<()>;
    fn byte_offset(&self) -> AltoResult<ALint>;
    fn set_byte_offset(&mut self, _: ALint) -> AltoResult<()>;
    fn soft_sec_offset_latency(&self) -> AltoResult<(f64, f64)>;
    fn soft_sample_frac_offset_latency(&self) -> AltoResult<(i32, i32, i64)>;
    fn soft_sec_length(&self) -> AltoResult<f32>;
    fn soft_sample_length(&self) -> AltoResult<ALint>;
    fn soft_byte_length(&self) -> AltoResult<ALint>;
    fn soft_direct_channels(&self) -> AltoResult<bool>;
    fn set_soft_direct_channels(&mut self, _: bool) -> AltoResult<()>;
    fn distance_model(&self) -> AltoResult<DistanceModel>;
    fn set_distance_model(&mut self, _: DistanceModel) -> AltoResult<()>;
    fn set_direct_filter<F: FilterTrait<'d, 'c>>(&mut self,
                                                 value: &F)
                                                 -> AltoResult<()>;
    fn clear_direct_filter(&mut self) -> AltoResult<()>;
    fn set_auxiliary_send(&mut self,
                          send: ALint,
                          value: &mut AuxEffectSlot<'d, 'c>)
                          -> AltoResult<()>;
    fn set_auxiliary_send_filter<F: FilterTrait<'d, 'c>>(&mut self,
                                                         send: ALint,
                                                         slot: &mut AuxEffectSlot<'d, 'c>,
                                                         filter: &F)
                                                         -> AltoResult<()>;
    fn clear_auxiliary_send(&mut self, send: ALint) -> AltoResult<()>;
    fn air_absorption_factor(&self) -> AltoResult<f32>;
    fn set_air_absorption_factor(&mut self, _: f32) -> AltoResult<()>;
    fn room_rolloff_factor(&self) -> AltoResult<f32>;
    fn set_room_rolloff_factor(&mut self, _: f32) -> AltoResult<()>;
    fn cone_outer_gainhf(&self) -> AltoResult<f32>;
    fn set_cone_outer_gainhf(&mut self, _: f32) -> AltoResult<()>;
    fn direct_filter_gainhf_auto(&self) -> AltoResult<bool>;
    fn set_direct_filter_gainhf_auto(&mut self, _: bool) -> AltoResult<()>;
}

Capabilities common to both static and streaming sources.

Required Methods

`fn context(&self) -> &Context<'d>`

The context from which this source was created.

`fn as_raw(&self) -> ALuint`

Raw handle as provided by OpenAL.

`fn state(&self) -> AltoResult<SourceState>`

alGetSourcei(AL_SOURCE_STATE)

`fn play(&mut self) -> AltoResult<()>`

alSourcePlay()

`fn pause(&mut self) -> AltoResult<()>`

alSourcePause()

`fn stop(&mut self) -> AltoResult<()>`

alSourceStop()

`fn rewind(&mut self) -> AltoResult<()>`

alSourceRewind()

`fn relative(&self) -> AltoResult<bool>`

alGetSourcei(AL_SOURCE_RELATIVE)

`fn set_relative(&mut self, _: bool) -> AltoResult<()>`

alSourcei(AL_SOURCE_RELATIVE)

`fn gain(&self) -> AltoResult<f32>`

alGetSourcef(AL_GAIN)

`fn set_gain(&mut self, _: f32) -> AltoResult<()>`

alSourcef(AL_GAIN)

`fn min_gain(&self) -> AltoResult<f32>`

alGetSourcef(AL_MIN_GAIN)

`fn set_min_gain(&mut self, _: f32) -> AltoResult<()>`

alSourcef(AL_MIN_GAIN)

`fn max_gain(&self) -> AltoResult<f32>`

alGetSourcef(AL_MAX_GAIN)

`fn set_max_gain(&mut self, _: f32) -> AltoResult<()>`

alSourcef(AL_MAX_GAIN)

`fn reference_distance(&self) -> AltoResult<f32>`

alGetSourcef(AL_REFERENCE_DISTANCE)

`fn set_reference_distance(&mut self, _: f32) -> AltoResult<()>`

alSourcef(AL_REFERENCE_DISTANCE)

`fn rolloff_factor(&self) -> AltoResult<f32>`

alGetSourcef(AL_ROLLOFF_FACTOR)

`fn set_rolloff_factor(&mut self, _: f32) -> AltoResult<()>`

alSourcef(AL_ROLLOFF_FACTOR)

`fn max_distance(&self) -> AltoResult<f32>`

alGetSourcef(AL_MAX_DISTANCE)

`fn set_max_distance(&mut self, _: f32) -> AltoResult<()>`

alSourcef(AL_MAX_DISTANCE)

`fn pitch(&self) -> AltoResult<f32>`

alGetSourcef(AL_PITCH)

`fn set_pitch(&mut self, _: f32) -> AltoResult<()>`

alSourcef(AL_PITCH)

`fn position<V: From<[f32; 3]>>(&self) -> AltoResult<V>`

alGetSourcefv(AL_POSITION)

`fn set_position<V: Into<[f32; 3]>>(&mut self, _: V) -> AltoResult<()>`

alSourcefv(AL_POSITION)

`fn velocity<V: From<[f32; 3]>>(&self) -> AltoResult<V>`

alGetSourcefv(AL_VELOCITY)

`fn set_velocity<V: Into<[f32; 3]>>(&mut self, _: V) -> AltoResult<()>`

alSourcefv(AL_VELOCITY)

`fn direction<V: From<[f32; 3]>>(&self) -> AltoResult<V>`

alGetSourcefv(AL_DIRECTION)

`fn set_direction<V: Into<[f32; 3]>>(&mut self, _: V) -> AltoResult<()>`

alSourcefv(AL_DIRECTION)

`fn cone_inner_angle(&self) -> AltoResult<f32>`

alGetSourcef(AL_CONE_INNER_ANGLE)

`fn set_cone_inner_angle(&mut self, _: f32) -> AltoResult<()>`

alSourcef(AL_CONE_INNER_ANGLE)

`fn cone_outer_angle(&self) -> AltoResult<f32>`

alGetSourcef(AL_CONE_OUTER_ANGLE)

`fn set_cone_outer_angle(&mut self, _: f32) -> AltoResult<()>`

alSourcef(AL_CONE_OUTER_ANGLE)

`fn cone_outer_gain(&self) -> AltoResult<f32>`

alGetSourcef(AL_CONE_OUTER_GAIN)

`fn set_cone_outer_gain(&mut self, _: f32) -> AltoResult<()>`

alSourcef(AL_CONE_OUTER_GAIN)

`fn sec_offset(&self) -> AltoResult<f32>`

alGetSourcef(AL_SEC_OFFSET)

`fn set_sec_offset(&mut self, _: f32) -> AltoResult<()>`

alSourcef(AL_SEC_OFFSET)

`fn sample_offset(&self) -> AltoResult<ALint>`

alSetSourcei(AL_SAMPLE_OFFSET)

`fn set_sample_offset(&mut self, _: ALint) -> AltoResult<()>`

alSourcei(AL_SAMPLE_OFFSET)

`fn byte_offset(&self) -> AltoResult<ALint>`

alSetSourcei(AL_BYTE_OFFSET)

`fn set_byte_offset(&mut self, _: ALint) -> AltoResult<()>`

alSourcei(AL_BYTE_OFFSET)

`fn soft_sec_offset_latency(&self) -> AltoResult<(f64, f64)>`

alGetSourcedvSOFT(AL_SEC_OFFSET_LATENCY_SOFT) Requires AL_SOFT_source_latency

`fn soft_sample_frac_offset_latency(&self) -> AltoResult<(i32, i32, i64)>`

alGetSourcei16vSOFT(AL_SAMPLE_OFFSET_LATENCY_SOFT) Requires AL_SOFT_source_latency

`fn soft_sec_length(&self) -> AltoResult<f32>`

alGetSourcef(AL_SEC_LENGTH_SOFT) Requires AL_SOFT_source_length

`fn soft_sample_length(&self) -> AltoResult<ALint>`

alGetSourcei(AL_SAMPLE_LENGTH_SOFT) Requires AL_SOFT_source_length

`fn soft_byte_length(&self) -> AltoResult<ALint>`

alGetSourcei(AL_BYTE_LENGTH_SOFT) Requires AL_SOFT_source_length

`fn soft_direct_channels(&self) -> AltoResult<bool>`

alGetSourcei(AL_DIRECT_CHANNELS_SOFT) Requires AL_SOFT_direct_channels

`fn set_soft_direct_channels(&mut self, _: bool) -> AltoResult<()>`

alSourcei(AL_DIRECT_CHANNELS_SOFT) Requires AL_SOFT_direct_channels

`fn distance_model(&self) -> AltoResult<DistanceModel>`

alGetSourcei(AL_DISTANCE_MODEL) Requires AL_EXT_source_distance_model

`fn set_distance_model(&mut self, _: DistanceModel) -> AltoResult<()>`

alSourcei(AL_DISTANCE_MODEL) Requires AL_EXT_source_distance_model

`fn set_direct_filter<F: FilterTrait<'d, 'c>>(&mut self, value: &F) -> AltoResult<()>`

alSourcei(AL_DIRECT_FILTER) Requires ALC_EXT_EFX

`fn clear_direct_filter(&mut self) -> AltoResult<()>`

alSourcei(AL_DIRECT_FILTER) Requires ALC_EXT_EFX

`fn set_auxiliary_send(&mut self, send: ALint, value: &mut AuxEffectSlot<'d, 'c>) -> AltoResult<()>`

alSourceiv(AL_AUXILIARY_SEND_FILTER) Requires ALC_EXT_EFX

fn set_auxiliary_send_filter<F: FilterTrait<'d, 'c>>(&mut self, send: ALint, slot: &mut AuxEffectSlot<'d, 'c>, filter: &F) -> AltoResult<()>

alSourceiv(AL_AUXILIARY_SEND_FILTER) Requires ALC_EXT_EFX

`fn clear_auxiliary_send(&mut self, send: ALint) -> AltoResult<()>`

alSourceiv(AL_AUXILIARY_SEND_FILTER) Requires ALC_EXT_EFX

`fn air_absorption_factor(&self) -> AltoResult<f32>`

alGetSourcef(AL_AIR_ABSORPTION_FACTOR) Requires ALC_EXT_EFX

`fn set_air_absorption_factor(&mut self, _: f32) -> AltoResult<()>`

alSourcef(AL_AIR_ABSORPTION_FACTOR) Requires ALC_EXT_EFX

`fn room_rolloff_factor(&self) -> AltoResult<f32>`

alGetSourcef(AL_ROOM_ROLLOFF_FACTOR) Requires ALC_EXT_EFX

`fn set_room_rolloff_factor(&mut self, _: f32) -> AltoResult<()>`

alSourcef(AL_ROOM_ROLLOFF_FACTOR) Requires ALC_EXT_EFX

`fn cone_outer_gainhf(&self) -> AltoResult<f32>`

alGetSourcef(AL_CONE_OUTER_GAINHF) Requires ALC_EXT_EFX

`fn set_cone_outer_gainhf(&mut self, _: f32) -> AltoResult<()>`

alSourcef(AL_CONE_OUTER_GAINHF) Requires ALC_EXT_EFX

`fn direct_filter_gainhf_auto(&self) -> AltoResult<bool>`

alGetSourcei(AL_DIRECT_FILTER_GAINHF_AUTO) Requires ALC_EXT_EFX

`fn set_direct_filter_gainhf_auto(&mut self, _: bool) -> AltoResult<()>`

alSourcei(AL_DIRECT_FILTER_GAINHF_AUTO) Requires ALC_EXT_EFX

Implementors

impl<'d: 'c, 'c> SourceTrait<'d, 'c> for StaticSource<'d, 'c>
impl<'d: 'c, 'c> SourceTrait<'d, 'c> for StreamingSource<'d, 'c>