Browse Source

Sync SDL3 wiki -> header

[ci skip]
SDL Wiki Bot 1 month ago
parent
commit
603118c340
1 changed files with 7 additions and 1 deletions
  1. 7 1
      include/SDL3/SDL_audio.h

+ 7 - 1
include/SDL3/SDL_audio.h

@@ -1067,7 +1067,13 @@ extern SDL_DECLSPEC SDL_AudioStream * SDLCALL SDL_CreateAudioStream(const SDL_Au
  * The application can hang any data it wants here, but the following
  * The application can hang any data it wants here, but the following
  * properties are understood by SDL:
  * properties are understood by SDL:
  *
  *
- * - `SDL_PROP_AUDIOSTREAM_AUTO_CLEANUP_BOOLEAN`: if true (the default), the stream be automatically cleaned up when the audio subsystem quits. If set to false, the streams will persist beyond that. This property is ignored for streams created through SDL_OpenAudioDeviceStream(), and will always be cleaned up. Streams that are not cleaned up will still be unbound from devices when the audio subsystem quits. This property was added in SDL 3.4.0.
+ * - `SDL_PROP_AUDIOSTREAM_AUTO_CLEANUP_BOOLEAN`: if true (the default), the
+ *   stream be automatically cleaned up when the audio subsystem quits. If set
+ *   to false, the streams will persist beyond that. This property is ignored
+ *   for streams created through SDL_OpenAudioDeviceStream(), and will always
+ *   be cleaned up. Streams that are not cleaned up will still be unbound from
+ *   devices when the audio subsystem quits. This property was added in SDL
+ *   3.4.0.
  *
  *
  * \param stream the SDL_AudioStream to query.
  * \param stream the SDL_AudioStream to query.
  * \returns a valid property ID on success or 0 on failure; call
  * \returns a valid property ID on success or 0 on failure; call