Function steam_audio::ffi::iplCreatePanningEffect [] [src]

pub unsafe extern "C" fn iplCreatePanningEffect(
    renderer: IPLhandle,
    inputFormat: IPLAudioFormat,
    outputFormat: IPLAudioFormat,
    effect: *mut IPLhandle
) -> IPLerror

Creates a Panning Effect object. This can be used to render a point source on surround speakers, or using Ambisonics.

\param renderer Handle to a Binaural Renderer object. \param inputFormat The format of the audio buffers that will be passed as input to this effect. All subsequent calls to \c ::iplApplyPanningEffect for this effect object must use \c IPLAudioBuffer objects with the same format as specified here. The input format must not be Ambisonics. \param outputFormat The format of the audio buffers which will be used to retrieve the output from this effect. All subsequent calls to \c ::iplApplyPanningEffect for this effect object must use \c IPLAudioBuffer objects with the same format as specified here. Any valid audio format may be specified as the output format. \param effect [out] Handle to the created Panning Effect object.

\return Status code indicating whether or not the operation succeeded.