Function steam_audio::ffi::iplCreateEnvironmentalRenderer [] [src]

pub unsafe extern "C" fn iplCreateEnvironmentalRenderer(
    context: IPLhandle,
    environment: IPLhandle,
    renderingSettings: IPLRenderingSettings,
    outputFormat: IPLAudioFormat,
    threadCreateCallback: IPLSimulationThreadCreateCallback,
    threadDestroyCallback: IPLSimulationThreadDestroyCallback,
    renderer: *mut IPLhandle
) -> IPLerror

Creates an Environmental Renderer object.

\param context The Context object used by the audio engine. \param environment Handle to an Environment object provided by the game engine. It is up to your application to pass this handle from the game engine to the audio engine. \param renderingSettings An \c IPLRenderingSettings object describing the audio pipeline's DSP processing parameters. These properties must remain constant throughout the lifetime of your application. \param outputFormat The audio format of the output buffers passed to any subsequent call to \c ::iplGetMixedEnvironmentalAudio. This format must not be changed once it is set during the call to this function. \param threadCreateCallback Pointer to a function that will be called when the internal simulation thread is created. May be NULL. \param threadDestroyCallback Pointer to a function that will be called when the internal simulation thread is destroyed. May be NULL. \param renderer [out] Handle to the created Environmental Renderer object.

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