Function SDL_LockAudioStream
pub unsafe extern "C" fn SDL_LockAudioStream(
stream: *mut SDL_AudioStream,
) -> bool
dep_sdl3
only.Expand description
Lock an audio stream for serialized access.
Each SDL_AudioStream
has an internal mutex it uses to protect its data
structures from threading conflicts. This function allows an app to lock
that mutex, which could be useful if registering callbacks on this stream.
One does not need to lock a stream to use in it most cases, as the stream manages this lock internally. However, this lock is held during callbacks, which may run from arbitrary threads at any time, so if an app needs to protect shared data during those callbacks, locking the stream guarantees that the callback is not running while the lock is held.
As this is just a wrapper over SDL_LockMutex
for an internal lock; it has
all the same attributes (recursive locks are allowed, etc).
§Parameters
stream
: the audio stream to lock.
§Return value
Returns true on success or false on failure; call SDL_GetError()
for more
information.
§Thread safety
It is safe to call this function from any thread.
§Availability
This function is available since SDL 3.2.0.