Skip to content

Commit

Permalink
Sync SDL3_mixer header -> wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
SDLWikiBot committed Sep 18, 2024
1 parent da3df15 commit f5f4d1b
Show file tree
Hide file tree
Showing 30 changed files with 102 additions and 103 deletions.
6 changes: 3 additions & 3 deletions SDL3_mixer/Mix_EachSoundFont.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Defined in [<SDL3_mixer/SDL_mixer.h>](https://github.com/libsdl-org/SDL_mixer/bl
## Syntax

```c
SDL_bool Mix_EachSoundFont(Mix_EachSoundFontCallback function, void *data);
bool Mix_EachSoundFont(Mix_EachSoundFontCallback function, void *data);
```
## Function Parameters
Expand All @@ -22,8 +22,8 @@ SDL_bool Mix_EachSoundFont(Mix_EachSoundFontCallback function, void *data);
## Return Value
(SDL_bool) Returns SDL_TRUE if callback ever returned SDL_TRUE, SDL_FALSE
on error or if the callback never returned SDL_TRUE.
(bool) Returns true if callback ever returned true, false on error or if
the callback never returned true.
## Remarks
Expand Down
6 changes: 3 additions & 3 deletions SDL3_mixer/Mix_FadeInMusic.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Defined in [<SDL3_mixer/SDL_mixer.h>](https://github.com/libsdl-org/SDL_mixer/bl
## Syntax

```c
SDL_bool Mix_FadeInMusic(Mix_Music *music, int loops, int ms);
bool Mix_FadeInMusic(Mix_Music *music, int loops, int ms);
```
## Function Parameters
Expand All @@ -23,8 +23,8 @@ SDL_bool Mix_FadeInMusic(Mix_Music *music, int loops, int ms);
## Return Value
(SDL_bool) Returns SDL_TRUE on success or SDL_FALSE on failure; call
SDL_GetError() for more information.
(bool) Returns true on success or false on failure; call SDL_GetError() for
more information.
## Remarks
Expand Down
6 changes: 3 additions & 3 deletions SDL3_mixer/Mix_FadeInMusicPos.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Defined in [<SDL3_mixer/SDL_mixer.h>](https://github.com/libsdl-org/SDL_mixer/bl
## Syntax

```c
SDL_bool Mix_FadeInMusicPos(Mix_Music *music, int loops, int ms, double position);
bool Mix_FadeInMusicPos(Mix_Music *music, int loops, int ms, double position);
```
## Function Parameters
Expand All @@ -24,8 +24,8 @@ SDL_bool Mix_FadeInMusicPos(Mix_Music *music, int loops, int ms, double position
## Return Value
(SDL_bool) Returns SDL_TRUE on success or SDL_FALSE on failure; call
SDL_GetError() for more information.
(bool) Returns true on success or false on failure; call SDL_GetError() for
more information.
## Remarks
Expand Down
6 changes: 3 additions & 3 deletions SDL3_mixer/Mix_FadeOutMusic.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Defined in [<SDL3_mixer/SDL_mixer.h>](https://github.com/libsdl-org/SDL_mixer/bl
## Syntax

```c
SDL_bool Mix_FadeOutMusic(int ms);
bool Mix_FadeOutMusic(int ms);
```
## Function Parameters
Expand All @@ -21,8 +21,8 @@ SDL_bool Mix_FadeOutMusic(int ms);
## Return Value
(SDL_bool) Returns SDL_TRUE if music was scheduled to fade, SDL_FALSE
otherwise. If no music is currently playing, this returns SDL_FALSE.
(bool) Returns true if music was scheduled to fade, false otherwise. If no
music is currently playing, this returns false.
## Remarks
Expand Down
6 changes: 3 additions & 3 deletions SDL3_mixer/Mix_GroupChannel.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Defined in [<SDL3_mixer/SDL_mixer.h>](https://github.com/libsdl-org/SDL_mixer/bl
## Syntax

```c
SDL_bool Mix_GroupChannel(int which, int tag);
bool Mix_GroupChannel(int which, int tag);
```
## Function Parameters
Expand All @@ -22,8 +22,8 @@ SDL_bool Mix_GroupChannel(int which, int tag);
## Return Value
(SDL_bool) Returns SDL_TRUE on success or SDL_FALSE on failure; call
SDL_GetError() for more information.
(bool) Returns true on success or false on failure; call SDL_GetError() for
more information.
## Remarks
Expand Down
6 changes: 3 additions & 3 deletions SDL3_mixer/Mix_GroupChannels.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Defined in [<SDL3_mixer/SDL_mixer.h>](https://github.com/libsdl-org/SDL_mixer/bl
## Syntax

```c
SDL_bool Mix_GroupChannels(int from, int to, int tag);
bool Mix_GroupChannels(int from, int to, int tag);
```
## Function Parameters
Expand All @@ -23,8 +23,8 @@ SDL_bool Mix_GroupChannels(int from, int to, int tag);
## Return Value
(SDL_bool) Returns SDL_TRUE on success or SDL_FALSE on failure; call
SDL_GetError() for more information.
(bool) Returns true on success or false on failure; call SDL_GetError() for
more information.
## Remarks
Expand Down
6 changes: 3 additions & 3 deletions SDL3_mixer/Mix_HasChunkDecoder.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Defined in [<SDL3_mixer/SDL_mixer.h>](https://github.com/libsdl-org/SDL_mixer/bl
## Syntax

```c
SDL_bool Mix_HasChunkDecoder(const char *name);
bool Mix_HasChunkDecoder(const char *name);
```
## Function Parameters
Expand All @@ -21,8 +21,8 @@ SDL_bool Mix_HasChunkDecoder(const char *name);
## Return Value
(SDL_bool) Returns SDL_TRUE if a decoder by that name is available,
SDL_FALSE otherwise.
(bool) Returns true if a decoder by that name is available, false
otherwise.
## Remarks
Expand Down
6 changes: 3 additions & 3 deletions SDL3_mixer/Mix_HasMusicDecoder.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Defined in [<SDL3_mixer/SDL_mixer.h>](https://github.com/libsdl-org/SDL_mixer/bl
## Syntax

```c
SDL_bool Mix_HasMusicDecoder(const char *name);
bool Mix_HasMusicDecoder(const char *name);
```
## Function Parameters
Expand All @@ -21,8 +21,8 @@ SDL_bool Mix_HasMusicDecoder(const char *name);
## Return Value
(SDL_bool) Returns SDL_TRUE if a decoder by that name is available,
SDL_FALSE otherwise.
(bool) Returns true if a decoder by that name is available, false
otherwise.
## Remarks
Expand Down
18 changes: 9 additions & 9 deletions SDL3_mixer/Mix_LoadMUSType_IO.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ Defined in [<SDL3_mixer/SDL_mixer.h>](https://github.com/libsdl-org/SDL_mixer/bl
## Syntax

```c
Mix_Music * Mix_LoadMUSType_IO(SDL_IOStream *src, Mix_MusicType type, SDL_bool closeio);
Mix_Music * Mix_LoadMUSType_IO(SDL_IOStream *src, Mix_MusicType type, bool closeio);
```
## Function Parameters
| | | |
| ------------------------------ | ----------- | -------------------------------------------------------------------------------- |
| SDL_IOStream * | **src** | an SDL_IOStream that data will be read from. |
| [Mix_MusicType](Mix_MusicType) | **type** | the type of audio data provided by `src`. |
| SDL_bool | **closeio** | SDL_TRUE to close the SDL_IOStream before returning, SDL_FALSE to leave it open. |
| | | |
| ------------------------------ | ----------- | ------------------------------------------------------------------------ |
| SDL_IOStream * | **src** | an SDL_IOStream that data will be read from. |
| [Mix_MusicType](Mix_MusicType) | **type** | the type of audio data provided by `src`. |
| bool | **closeio** | true to close the SDL_IOStream before returning, false to leave it open. |
## Return Value
Expand Down Expand Up @@ -58,9 +58,9 @@ Currently, the following types are supported:
- `MUS_OPUS` (Opus files)
- `MUS_WAVPACK` (WavPack files)
If `closeio` is SDL_TRUE, the IOStream will be closed before returning,
whether this function succeeds or not. SDL_mixer reads everything it needs
from the IOStream during this call in any case.
If `closeio` is true, the IOStream will be closed before returning, whether
this function succeeds or not. SDL_mixer reads everything it needs from the
IOStream during this call in any case.
As a convenience, there is a function to read files from disk without
having to deal with SDL_IOStream: `Mix_LoadMUS("filename.mp3")` will manage
Expand Down
16 changes: 8 additions & 8 deletions SDL3_mixer/Mix_LoadMUS_IO.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ Defined in [<SDL3_mixer/SDL_mixer.h>](https://github.com/libsdl-org/SDL_mixer/bl
## Syntax

```c
Mix_Music * Mix_LoadMUS_IO(SDL_IOStream *src, SDL_bool closeio);
Mix_Music * Mix_LoadMUS_IO(SDL_IOStream *src, bool closeio);
```
## Function Parameters
| | | |
| -------------- | ----------- | -------------------------------------------------------------------------------- |
| SDL_IOStream * | **src** | an SDL_IOStream that data will be read from. |
| SDL_bool | **closeio** | SDL_TRUE to close the SDL_IOStream before returning, SDL_FALSE to leave it open. |
| | | |
| -------------- | ----------- | ------------------------------------------------------------------------ |
| SDL_IOStream * | **src** | an SDL_IOStream that data will be read from. |
| bool | **closeio** | true to close the SDL_IOStream before returning, false to leave it open. |
## Return Value
Expand All @@ -41,9 +41,9 @@ 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 `closeio` is SDL_TRUE, the IOStream will be closed before returning,
whether this function succeeds or not. SDL_mixer reads everything it needs
from the IOStream during this call in any case.
If `closeio` is true, the IOStream will be closed before returning, whether
this function succeeds or not. SDL_mixer reads everything it needs from the
IOStream during this call in any case.
As a convenience, there is a function to read files from disk without
having to deal with SDL_IOStream: `Mix_LoadMUS("filename.mp3")` will manage
Expand Down
2 changes: 1 addition & 1 deletion SDL3_mixer/Mix_LoadWAV.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ When done with a chunk, the app should dispose of it with a call to
Note that before SDL_mixer 3.0.0, this function was a macro that called
[Mix_LoadWAV_IO](Mix_LoadWAV_IO)(), creating a IOStream and setting
`closeio` to SDL_TRUE. This macro has since been promoted to a proper API
`closeio` to true. This macro has since been promoted to a proper API
function. Older binaries linked against a newer SDL_mixer will still call
[Mix_LoadWAV_IO](Mix_LoadWAV_IO) directly, as they are using the macro,
which was available since the dawn of time.
Expand Down
16 changes: 8 additions & 8 deletions SDL3_mixer/Mix_LoadWAV_IO.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ Defined in [<SDL3_mixer/SDL_mixer.h>](https://github.com/libsdl-org/SDL_mixer/bl
## Syntax

```c
Mix_Chunk * Mix_LoadWAV_IO(SDL_IOStream *src, SDL_bool closeio);
Mix_Chunk * Mix_LoadWAV_IO(SDL_IOStream *src, bool closeio);
```
## Function Parameters
| | | |
| -------------- | ----------- | -------------------------------------------------------------------------------- |
| SDL_IOStream * | **src** | an SDL_IOStream that data will be read from. |
| SDL_bool | **closeio** | SDL_TRUE to close the SDL_IOStream before returning, SDL_FALSE to leave it open. |
| | | |
| -------------- | ----------- | ------------------------------------------------------------------------ |
| SDL_IOStream * | **src** | an SDL_IOStream that data will be read from. |
| bool | **closeio** | true to close the SDL_IOStream before returning, false to leave it open. |
## Return Value
Expand All @@ -41,9 +41,9 @@ 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 `closeio` is SDL_TRUE, the IOStream will be closed before returning,
whether this function succeeds or not. SDL_mixer reads everything it needs
from the IOStream during this call in any case.
If `closeio` is true, the IOStream will be closed before returning, whether
this function succeeds or not. SDL_mixer reads everything it needs from the
IOStream 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_IOStream:
Expand Down
6 changes: 3 additions & 3 deletions SDL3_mixer/Mix_ModMusicJumpToOrder.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Defined in [<SDL3_mixer/SDL_mixer.h>](https://github.com/libsdl-org/SDL_mixer/bl
## Syntax

```c
SDL_bool Mix_ModMusicJumpToOrder(int order);
bool Mix_ModMusicJumpToOrder(int order);
```
## Function Parameters
Expand All @@ -21,8 +21,8 @@ SDL_bool Mix_ModMusicJumpToOrder(int order);
## Return Value
(SDL_bool) Returns SDL_TRUE on success or SDL_FALSE on failure; call
SDL_GetError() for more information.
(bool) Returns true on success or false on failure; call SDL_GetError() for
more information.
## Remarks
Expand Down
6 changes: 3 additions & 3 deletions SDL3_mixer/Mix_OpenAudio.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Defined in [<SDL3_mixer/SDL_mixer.h>](https://github.com/libsdl-org/SDL_mixer/bl
## Syntax

```c
SDL_bool Mix_OpenAudio(SDL_AudioDeviceID devid, const SDL_AudioSpec *spec);
bool Mix_OpenAudio(SDL_AudioDeviceID devid, const SDL_AudioSpec *spec);
```
## Function Parameters
Expand All @@ -22,8 +22,8 @@ SDL_bool Mix_OpenAudio(SDL_AudioDeviceID devid, const SDL_AudioSpec *spec);
## Return Value
(SDL_bool) Returns SDL_TRUE on success or SDL_FALSE on failure; call
SDL_GetError() for more information.
(bool) Returns true on success or false on failure; call SDL_GetError() for
more information.
## Remarks
Expand Down
4 changes: 2 additions & 2 deletions SDL3_mixer/Mix_PausedMusic.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ Defined in [<SDL3_mixer/SDL_mixer.h>](https://github.com/libsdl-org/SDL_mixer/bl
## Syntax

```c
SDL_bool Mix_PausedMusic(void);
bool Mix_PausedMusic(void);
```
## Return Value
(SDL_bool) Return SDL_TRUE if music is paused, SDL_FALSE otherwise.
(bool) Return true if music is paused, false otherwise.
## Version
Expand Down
6 changes: 3 additions & 3 deletions SDL3_mixer/Mix_PlayMusic.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Defined in [<SDL3_mixer/SDL_mixer.h>](https://github.com/libsdl-org/SDL_mixer/bl
## Syntax

```c
SDL_bool Mix_PlayMusic(Mix_Music *music, int loops);
bool Mix_PlayMusic(Mix_Music *music, int loops);
```
## Function Parameters
Expand All @@ -22,8 +22,8 @@ SDL_bool Mix_PlayMusic(Mix_Music *music, int loops);
## Return Value
(SDL_bool) Returns SDL_TRUE on success or SDL_FALSE on failure; call
SDL_GetError() for more information.
(bool) Returns true on success or false on failure; call SDL_GetError() for
more information.
## Remarks
Expand Down
4 changes: 2 additions & 2 deletions SDL3_mixer/Mix_PlayingMusic.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ Defined in [<SDL3_mixer/SDL_mixer.h>](https://github.com/libsdl-org/SDL_mixer/bl
## Syntax

```c
SDL_bool Mix_PlayingMusic(void);
bool Mix_PlayingMusic(void);
```
## Return Value
(SDL_bool) Returns SDL_TRUE if music is playing, SDL_FALSE otherwise.
(bool) Returns true if music is playing, false otherwise.
## Remarks
Expand Down
5 changes: 2 additions & 3 deletions SDL3_mixer/Mix_QuerySpec.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Defined in [<SDL3_mixer/SDL_mixer.h>](https://github.com/libsdl-org/SDL_mixer/bl
## Syntax

```c
SDL_bool Mix_QuerySpec(int *frequency, SDL_AudioFormat *format, int *channels);
bool Mix_QuerySpec(int *frequency, SDL_AudioFormat *format, int *channels);
```
## Function Parameters
Expand All @@ -23,8 +23,7 @@ SDL_bool Mix_QuerySpec(int *frequency, SDL_AudioFormat *format, int *channels);
## Return Value
(SDL_bool) Returns SDL_TRUE if the audio device has been opened, SDL_TRUE
otherwise.
(bool) Returns true if the audio device has been opened, true otherwise.
## Remarks
Expand Down
Loading

0 comments on commit f5f4d1b

Please sign in to comment.