diff --git a/SDL3_mixer/MUS_CMD.md b/SDL3_mixer/MUS_CMD.md deleted file mode 100644 index 4fc09445d..000000000 --- a/SDL3_mixer/MUS_CMD.md +++ /dev/null @@ -1,8 +0,0 @@ -###### (This function is part of SDL_mixer, a separate library from SDL.) -# MUS_CMD - -Please refer to [Mix_MusicType](Mix_MusicType) for details. - ----- -[CategoryAPI](CategoryAPI), [CategoryAPIEnumerators](CategoryAPIEnumerators) - diff --git a/SDL3_mixer/Mix_ClearError.md b/SDL3_mixer/Mix_ClearError.md deleted file mode 100644 index 53f5f0c4c..000000000 --- a/SDL3_mixer/Mix_ClearError.md +++ /dev/null @@ -1,22 +0,0 @@ -###### (This function is part of SDL_mixer, a separate library from SDL.) -# Mix_ClearError - -Clear last SDL_mixer error - -## Header File - -Defined in [](https://github.com/libsdl-org/SDL_mixer/blob/main/include/SDL3_mixer/SDL_mixer.h) - -## Syntax - -```c -#define Mix_ClearError SDL_ClearError -``` - -## See Also - -- [Mix_SetError](Mix_SetError) - ----- -[CategoryAPI](CategoryAPI), [CategoryAPIMacro](CategoryAPIMacro) - diff --git a/SDL3_mixer/Mix_GetSynchroValue.md b/SDL3_mixer/Mix_GetSynchroValue.md deleted file mode 100644 index 3d63fe125..000000000 --- a/SDL3_mixer/Mix_GetSynchroValue.md +++ /dev/null @@ -1,33 +0,0 @@ -###### (This function is part of SDL_mixer, a separate library from SDL.) -# Mix_GetSynchroValue - -This function does nothing, do not use. - -## Header File - -Defined in [](https://github.com/libsdl-org/SDL_mixer/blob/main/include/SDL3_mixer/SDL_mixer.h) - -## Syntax - -```c -int Mix_GetSynchroValue(void); -``` - -## Return Value - -(int) Returns -1. - -## Remarks - -This was probably meant to expose a feature, but no codecs support it, so -it only remains for binary compatibility. - -Calling this function is a legal no-op that returns -1. - -## Version - -This function is available since SDL_mixer 3.0.0. - ----- -[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction) - diff --git a/SDL3_mixer/Mix_Linked_Version.md b/SDL3_mixer/Mix_Linked_Version.md deleted file mode 100644 index 45d0630ed..000000000 --- a/SDL3_mixer/Mix_Linked_Version.md +++ /dev/null @@ -1,35 +0,0 @@ -###### (This function is part of SDL_mixer, a separate library from SDL.) -# Mix_Linked_Version - -Query the version of SDL_mixer that the program is linked against. - -## Header File - -Defined in SDL_mixer.h - -## Syntax - -```c -const SDL_Version * Mix_Linked_Version(void); - -``` - -## Return Value - -Returns a pointer to the version information. - -## Remarks - -This function gets the version of the dynamically linked SDL_mixer library. -This is separate from the SDL_MIXER_VERSION() macro, which tells you what -version of the SDL_mixer headers you compiled against. - -This returns static internal data; do not free or modify it! - -## Version - -This function is available since SDL_mixer 3.0.0. - ----- -[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction) - diff --git a/SDL3_mixer/Mix_LoadMUSType_RW.md b/SDL3_mixer/Mix_LoadMUSType_RW.md deleted file mode 100644 index ce7772dab..000000000 --- a/SDL3_mixer/Mix_LoadMUSType_RW.md +++ /dev/null @@ -1,79 +0,0 @@ -###### (This function is part of SDL_mixer, a separate library from SDL.) -# Mix_LoadMUSType_RW - -Load an audio format into a music object, assuming a specific format. - -## Syntax - -```c -Mix_Music * Mix_LoadMUSType_RW(SDL_RWops *src, Mix_MusicType type, SDL_bool freesrc); - -``` - -## Function Parameters - -| | | -| --------------- | ---------------------------------------------------------------------------------- | -| **src** | an SDL_RWops that data will be read from. | -| **type** | the type of audio data provided by `src`. | -| **freesrc** | SDL_TRUE to close/free the SDL_RWops before returning, SDL_FALSE to leave it open. | - -## Return Value - -Returns a new music object, or NULL on error. - -## Remarks - -SDL_mixer has two separate data structures for audio data. One it calls a -"chunk," which is meant to be a file completely decoded into memory up -front, and the other it calls "music" which is a file intended to be -decoded on demand. Originally, simple formats like uncompressed WAV files -were meant to be chunks and compressed things, like MP3s, were meant to be -music, and you would stream one thing for a game's music and make repeating -sound effects with the chunks. - -In modern times, this isn't split by format anymore, and most are -interchangeable, so the question is what the app thinks is worth -predecoding or not. Chunks might take more memory, but once they are loaded -won't need to decode again, whereas music always needs to be decoded on the -fly. Also, crucially, there are as many channels for chunks as the app can -allocate, but SDL_mixer only offers a single "music" channel. - -This function loads music data, and lets the application specify the type -of music being loaded, which might be useful if SDL_mixer cannot figure it -out from the data stream itself. - -Currently, the following types are supported: - -- `MUS_NONE` (SDL_mixer should guess, based on the data) -- `MUS_WAV` (Microsoft WAV files) -- `MUS_MOD` (Various tracker formats) -- `MUS_MID` (MIDI files) -- `MUS_OGG` (Ogg Vorbis files) -- `MUS_MP3` (MP3 files) -- `MUS_FLAC` (FLAC files) -- `MUS_OPUS` (Opus files) -- `MUS_WAVPACK` (WavPack files) - -If `freesrc` is SDL_TRUE, the RWops will be closed before returning, -whether this function succeeds or not. SDL_mixer reads everything it needs -from the RWops during this call in any case. - -As a convenience, there is a function to read files from disk without -having to deal with SDL_RWops: `Mix_LoadMUS("filename.mp3")` will manage -those details for you (but not let you specify the music type explicitly).. - -When done with this music, the app should dispose of it with a call to -[Mix_FreeMusic](Mix_FreeMusic)(). - -## Version - -This function is available since SDL_mixer 3.0.0. - -## Related Functions - -* [Mix_FreeMusic](Mix_FreeMusic) - ----- -[CategoryAPI](CategoryAPI) - diff --git a/SDL3_mixer/Mix_LoadMUS_RW.md b/SDL3_mixer/Mix_LoadMUS_RW.md deleted file mode 100644 index 2b1b107d6..000000000 --- a/SDL3_mixer/Mix_LoadMUS_RW.md +++ /dev/null @@ -1,66 +0,0 @@ -###### (This function is part of SDL_mixer, a separate library from SDL.) -# Mix_LoadMUS_RW - -Load a supported audio format into a music object. - -## Syntax - -```c -Mix_Music * Mix_LoadMUS_RW(SDL_RWops *src, SDL_bool freesrc); - -``` - -## Function Parameters - -| | | -| --------------- | ---------------------------------------------------------------------------------- | -| **src** | an SDL_RWops that data will be read from. | -| **freesrc** | SDL_TRUE to close/free the SDL_RWops before returning, SDL_FALSE to leave it open. | - -## Return Value - -Returns a new music object, or NULL on error. - -## Remarks - -SDL_mixer has two separate data structures for audio data. One it calls a -"chunk," which is meant to be a file completely decoded into memory up -front, and the other it calls "music" which is a file intended to be -decoded on demand. Originally, simple formats like uncompressed WAV files -were meant to be chunks and compressed things, like MP3s, were meant to be -music, and you would stream one thing for a game's music and make repeating -sound effects with the chunks. - -In modern times, this isn't split by format anymore, and most are -interchangeable, so the question is what the app thinks is worth -predecoding or not. Chunks might take more memory, but once they are loaded -won't need to decode again, whereas music always needs to be decoded on the -fly. Also, crucially, there are as many channels for chunks as the app can -allocate, but SDL_mixer only offers a single "music" channel. - -If `freesrc` is SDL_TRUE, the RWops will be closed before returning, -whether this function succeeds or not. SDL_mixer reads everything it needs -from the RWops during this call in any case. - -As a convenience, there is a function to read files from disk without -having to deal with SDL_RWops: `Mix_LoadMUS("filename.mp3")` will manage -those details for you. - -This function attempts to guess the file format from incoming data. If the -caller knows the format, or wants to force it, it should use -[Mix_LoadMUSType_RW](Mix_LoadMUSType_RW)() instead. - -When done with this music, the app should dispose of it with a call to -[Mix_FreeMusic](Mix_FreeMusic)(). - -## Version - -This function is available since SDL_mixer 3.0.0. - -## Related Functions - -* [Mix_FreeMusic](Mix_FreeMusic) - ----- -[CategoryAPI](CategoryAPI) - diff --git a/SDL3_mixer/Mix_LoadWAV_RW.md b/SDL3_mixer/Mix_LoadWAV_RW.md deleted file mode 100644 index 148fc993e..000000000 --- a/SDL3_mixer/Mix_LoadWAV_RW.md +++ /dev/null @@ -1,64 +0,0 @@ -###### (This function is part of SDL_mixer, a separate library from SDL.) -# Mix_LoadWAV_RW - -Load a supported audio format into a chunk. - -## Syntax - -```c -Mix_Chunk * Mix_LoadWAV_RW(SDL_RWops *src, SDL_bool freesrc); - -``` - -## Function Parameters - -| | | -| --------------- | ---------------------------------------------------------------------------------- | -| **src** | an SDL_RWops that data will be read from. | -| **freesrc** | SDL_TRUE to close/free the SDL_RWops before returning, SDL_FALSE to leave it open. | - -## Return Value - -Returns a new chunk, or NULL on error. - -## Remarks - -SDL_mixer has two separate data structures for audio data. One it calls a -"chunk," which is meant to be a file completely decoded into memory up -front, and the other it calls "music" which is a file intended to be -decoded on demand. Originally, simple formats like uncompressed WAV files -were meant to be chunks and compressed things, like MP3s, were meant to be -music, and you would stream one thing for a game's music and make repeating -sound effects with the chunks. - -In modern times, this isn't split by format anymore, and most are -interchangeable, so the question is what the app thinks is worth -predecoding or not. Chunks might take more memory, but once they are loaded -won't need to decode again, whereas music always needs to be decoded on the -fly. Also, crucially, there are as many channels for chunks as the app can -allocate, but SDL_mixer only offers a single "music" channel. - -If `freesrc` is SDL_TRUE, the RWops will be closed before returning, -whether this function succeeds or not. SDL_mixer reads everything it needs -from the RWops during this call in any case. - -There is a separate function (a macro, before SDL_mixer 3.0.0) to read -files from disk without having to deal with SDL_RWops: -`Mix_LoadWAV("filename.wav")` will call this function and manage those -details for you. - -When done with a chunk, the app should dispose of it with a call to -[Mix_FreeChunk](Mix_FreeChunk)(). - -## Version - -This function is available since SDL_mixer 3.0.0 - -## Related Functions - -* [Mix_LoadWAV](Mix_LoadWAV) -* [Mix_FreeChunk](Mix_FreeChunk) - ----- -[CategoryAPI](CategoryAPI) - diff --git a/SDL3_mixer/Mix_OpenAudioDevice.md b/SDL3_mixer/Mix_OpenAudioDevice.md deleted file mode 100644 index a27bf20d0..000000000 --- a/SDL3_mixer/Mix_OpenAudioDevice.md +++ /dev/null @@ -1,126 +0,0 @@ -###### (This function is part of SDL_mixer, a separate library from SDL.) -# Mix_OpenAudioDevice - -Open a specific audio device for playback. - -## Syntax - -```c -int Mix_OpenAudioDevice(int frequency, Uint16 format, int channels, int chunksize, const char* device, int allowed_changes); - -``` - -## Function Parameters - -| | | -| ----------------------- | ---------------------------------------------------------------------------- | -| **frequency** | the frequency to playback audio at (in Hz). | -| **format** | audio format, one of SDL's SDL_AUDIO_* values. | -| **channels** | number of channels (1 is mono, 2 is stereo, etc). | -| **chunksize** | audio buffer size in sample FRAMES (total samples divided by channel count). | -| **device** | the device name to open, or NULL to choose a reasonable default. | -| **allowed_changes** | Allow change flags (see SDL_AUDIO_ALLOW_* flags) | - -## Return Value - -Returns 0 if successful, -1 on error. - -## Remarks - -(A slightly simpler version of this function is available in -[Mix_OpenAudio](Mix_OpenAudio)(), which still might meet most applications' -needs.) - -An audio device is what generates sound, so the app must open one to make -noise. - -This function will check if SDL's audio system is initialized, and if not, -it will initialize it by calling `SDL_Init(SDL_INIT_AUDIO)` on your behalf. -You are free to (and encouraged to!) initialize it yourself before calling -this function, as this gives your program more control over the process. - -If you aren't particularly concerned with the specifics of the audio -device, and your data isn't in a specific format, the values you use here -can just be reasonable defaults. SDL_mixer will convert audio data you feed -it to the correct format on demand. - -That being said, if you have control of your audio data and you know its -format ahead of time, you can save CPU time by opening the audio device in -that exact format so SDL_mixer does not have to spend time converting -anything behind the scenes, and can just pass the data straight through to -the hardware. On some platforms, where the hardware only supports specific -settings, you might have to be careful to make everything match, but your -own data is often easier to control, so aim to open the device for what you -need. - -The other reason to care about specific formats: if you plan to touch the -mix buffer directly (with [Mix_SetPostMix](Mix_SetPostMix), a registered -effect, or [Mix_HookMusic](Mix_HookMusic)), you might have code that -expects it to be in a specific format, and you should specify that here. - -The audio device frequency is specified in Hz; in modern times, 48000 is -often a reasonable default. - -The audio device format is one of SDL's SDL_AUDIO_* constants. -SDL_AUDIO_S16SYS (16-bit audio) is probably a safe default. More modern -systems may prefer SDL_AUDIO_F32SYS (32-bit floating point audio). - -The audio device channels are generally 1 for mono output, or 2 for stereo, -but the brave can try surround sound configs with 4 (quad), 6 (5.1), 7 -(6.1) or 8 (7.1). - -The audio device's chunk size is the number of sample frames (one sample -per frame for mono output, two samples per frame in a stereo setup, etc) -that are fed to the device at once. The lower the number, the lower the -latency, but you risk dropouts if it gets too low. 2048 is often a -reasonable default, but your app might want to experiment with 1024 or -4096. - -You may only have one audio device open at a time; if you want to change a -setting, you must close the device and reopen it, which is not something -you can do seamlessly during playback. - -This function allows you to select specific audio hardware on the system -with the `device` parameter. If you specify NULL, SDL_mixer will choose the -best default it can on your behalf (which, in many cases, is exactly what -you want anyhow). SDL_mixer does not offer a mechanism to determine device -names to open, but you can use SDL_GetNumAudioDevices() to get a count of -available devices and then SDL_GetAudioDeviceName() in a loop to obtain a -list. If you do this, be sure to call `SDL_Init(SDL_INIT_AUDIO)` first to -initialize SDL's audio system! - -The `allowed_changes` parameter specifies what settings are flexible. These -are the `SDL_AUDIO_ALLOW_*` flags from SDL. These tell SDL_mixer that the -app doesn't mind if a specific setting changes. For example, the app might -need stereo data in Sint16 format, but if the sample rate or chunk size -changes, the app can handle that. In that case, the app would specify -`SDL_AUDIO_ALLOW_FORMAT_CHANGE|SDL_AUDIO_ALLOW_SAMPLES_CHANGE`. In this -case, if the system's hardware requires something other than the requested -format, SDL_mixer can select what the hardware demands instead of the app. -If the `SDL_AUDIO_ALLOW_` flag is not specified, SDL_mixer must convert -data behind the scenes between what the app demands and what the hardware -requires. If your app needs precisely what is requested, specify zero for -`allowed_changes`. - -If changes were allowed, the app can use [Mix_QuerySpec](Mix_QuerySpec)() -to determine the final device settings. - -If this function reports success, you are ready to start making noise! Load -some audio data and start playing! - -When done with an audio device, probably at the end of the program, the app -should dispose of the device with [Mix_CloseDevice](Mix_CloseDevice)(). - -## Version - -This function is available since SDL_mixer 2.0.2. - -## Related Functions - -* [Mix_OpenAudio](Mix_OpenAudio) -* [Mix_CloseDevice](Mix_CloseDevice) -* [Mix_QuerySpec](Mix_QuerySpec) - ----- -[CategoryAPI](CategoryAPI) - diff --git a/SDL3_mixer/Mix_OutOfMemory.md b/SDL3_mixer/Mix_OutOfMemory.md deleted file mode 100644 index 70cdfd777..000000000 --- a/SDL3_mixer/Mix_OutOfMemory.md +++ /dev/null @@ -1,18 +0,0 @@ -###### (This function is part of SDL_mixer, a separate library from SDL.) -# Mix_OutOfMemory - -Set OutOfMemory error - -## Header File - -Defined in [](https://github.com/libsdl-org/SDL_mixer/blob/main/include/SDL3_mixer/SDL_mixer.h) - -## Syntax - -```c -#define Mix_OutOfMemory SDL_OutOfMemory -``` - ----- -[CategoryAPI](CategoryAPI), [CategoryAPIMacro](CategoryAPIMacro) - diff --git a/SDL3_mixer/Mix_SetError.md b/SDL3_mixer/Mix_SetError.md deleted file mode 100644 index eec9ae54f..000000000 --- a/SDL3_mixer/Mix_SetError.md +++ /dev/null @@ -1,22 +0,0 @@ -###### (This function is part of SDL_mixer, a separate library from SDL.) -# Mix_SetError - -Report SDL_mixer errors - -## Header File - -Defined in [](https://github.com/libsdl-org/SDL_mixer/blob/main/include/SDL3_mixer/SDL_mixer.h) - -## Syntax - -```c -#define Mix_SetError SDL_SetError -``` - -## See Also - -- [Mix_GetError](Mix_GetError) - ----- -[CategoryAPI](CategoryAPI), [CategoryAPIMacro](CategoryAPIMacro) - diff --git a/SDL3_mixer/Mix_SetMusicCMD.md b/SDL3_mixer/Mix_SetMusicCMD.md deleted file mode 100644 index b72c512f7..000000000 --- a/SDL3_mixer/Mix_SetMusicCMD.md +++ /dev/null @@ -1,48 +0,0 @@ -###### (This function is part of SDL_mixer, a separate library from SDL.) -# Mix_SetMusicCMD - -Run an external command as the music stream. - -## Header File - -Defined in [](https://github.com/libsdl-org/SDL_mixer/blob/main/include/SDL3_mixer/SDL_mixer.h) - -## Syntax - -```c -bool Mix_SetMusicCMD(const char *command); -``` - -## Function Parameters - -| | | | -| ------------ | ----------- | -------- | -| const char * | **command** | command. | - -## Return Value - -(bool) Returns true on success or false on failure; call SDL_GetError() for -more information. - -## Remarks - -This halts any currently-playing music, and next time the music stream is -played, SDL_mixer will spawn a process using the command line specified in -`command`. This command is not subject to shell expansion, and beyond some -basic splitting up of arguments, is passed to execvp() on most platforms, -not system(). - -The command is responsible for generating sound; it is NOT mixed by -SDL_mixer! SDL_mixer will kill the child process if asked to halt the -music, but otherwise does not have any control over what the process does. - -You are strongly encouraged not to use this function without an extremely -good reason. - -## Version - -This function is available since SDL_mixer 3.0.0. - ----- -[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction) - diff --git a/SDL3_mixer/Mix_SetSynchroValue.md b/SDL3_mixer/Mix_SetSynchroValue.md deleted file mode 100644 index c13d266be..000000000 --- a/SDL3_mixer/Mix_SetSynchroValue.md +++ /dev/null @@ -1,39 +0,0 @@ -###### (This function is part of SDL_mixer, a separate library from SDL.) -# Mix_SetSynchroValue - -This function does nothing, do not use. - -## Header File - -Defined in [](https://github.com/libsdl-org/SDL_mixer/blob/main/include/SDL3_mixer/SDL_mixer.h) - -## Syntax - -```c -int Mix_SetSynchroValue(int value); -``` - -## Function Parameters - -| | | | -| --- | --------- | -------------------------- | -| int | **value** | this parameter is ignored. | - -## Return Value - -(int) Returns -1. - -## Remarks - -This was probably meant to expose a feature, but no codecs support it, so -it only remains for binary compatibility. - -Calling this function is a legal no-op that returns -1. - -## Version - -This function is available since SDL_mixer 3.0.0. - ----- -[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction) - diff --git a/SDL3_mixer/SDL_MIXER_COMPILEDVERSION.md b/SDL3_mixer/SDL_MIXER_COMPILEDVERSION.md deleted file mode 100644 index 866056027..000000000 --- a/SDL3_mixer/SDL_MIXER_COMPILEDVERSION.md +++ /dev/null @@ -1,27 +0,0 @@ -###### (This function is part of SDL_mixer, a separate library from SDL.) -# SDL_MIXER_COMPILEDVERSION - -This is the version number macro for the current SDL_mixer version. - -## Header File - -Defined in SDL_mixer.h - -## Syntax - -```c -#define SDL_MIXER_COMPILEDVERSION \ - SDL_VERSIONNUM(SDL_MIXER_MAJOR_VERSION, SDL_MIXER_MINOR_VERSION, SDL_MIXER_PATCHLEVEL) -``` - -## Remarks - -In versions higher than 2.9.0, the minor version overflows into the -thousands digit: for example, 2.23.0 is encoded as 4300. This macro will -not be available in SDL 3.x or SDL_mixer 3.x. - -Deprecated, use SDL_MIXER_VERSION_ATLEAST or SDL_MIXER_VERSION instead. - ----- -[CategoryAPI](CategoryAPI), [CategoryAPIMacro](CategoryAPIMacro) - diff --git a/SDL3_mixer/_Mix_Music.md b/SDL3_mixer/_Mix_Music.md deleted file mode 100644 index 30d0ac220..000000000 --- a/SDL3_mixer/_Mix_Music.md +++ /dev/null @@ -1,18 +0,0 @@ -###### (This function is part of SDL_mixer, a separate library from SDL.) -# _Mix_Music - -The internal format for a music chunk interpreted via codecs - -## Header File - -Defined in [](https://github.com/libsdl-org/SDL_mixer/blob/main/include/SDL3_mixer/SDL_mixer.h) - -## Syntax - -```c -typedef struct _Mix_Music Mix_Music; -``` - ----- -[CategoryAPI](CategoryAPI), [CategoryAPIStruct](CategoryAPIStruct) -