Function steam_audio::ffi::iplCreateEnvironment [−] [src]

pub unsafe extern "C" fn iplCreateEnvironment(
    context: IPLhandle, 
    computeDevice: IPLhandle, 
    simulationSettings: IPLSimulationSettings, 
    scene: IPLhandle, 
    probeManager: IPLhandle, 
    environment: *mut IPLhandle
) -> IPLerror

Creates an Environment object. It is necessary to call this function even if you are not using the sound propagation features of Phonon.

\param context The Context object used by the game engine. \param computeDevice Handle to a Compute Device object. Only required if using Radeon Rays for ray tracing, or if using TrueAudio Next for convolution, may be \c NULL otherwise. \param simulationSettings The settings to use for simulation. This must be the same settings passed to \c ::iplCreateScene or \c ::iplLoadFinalizedScene, whichever was used to create the Scene object passed in the \c scene parameter to this function. \param scene The Scene object. If created using \c ::iplCreateScene, then \c ::iplFinalizeScene must have been called on the Scene object before passing it to this function. May be \c NULL, in which case only direct sound will be simulated, without occlusion or any other indirect sound propagation. \param probeManager The Probe Manager object. May be \c NULL if not using baked data. \param environment [out] Handle to the created Environment object.

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