Browse Source

docs: warn not to destroy an SDL_AudioStream during its callback.

Fixes #15871.

(cherry picked from commit 0b692f64b034145382c0fb1eacafa6cd11aaf148)
Ryan C. Gordon 2 days ago
parent
commit
db6d9d5c01
1 changed files with 2 additions and 0 deletions
  1. 2 0
      include/SDL3/SDL_audio.h

+ 2 - 0
include/SDL3/SDL_audio.h

@@ -1854,6 +1854,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_UnlockAudioStream(SDL_AudioStream *stream);
  * appropriate, but the system goes on with the data currently available to it
  * appropriate, but the system goes on with the data currently available to it
  * if this callback does nothing.
  * if this callback does nothing.
  *
  *
+ * Do not call SDL_DestroyAudioStream() on `stream` during this callback.
+ *
  * \param stream the SDL audio stream associated with this callback.
  * \param stream the SDL audio stream associated with this callback.
  * \param additional_amount the amount of data, in bytes, that is needed right
  * \param additional_amount the amount of data, in bytes, that is needed right
  *                          now.
  *                          now.