Skip to content

Commit

Permalink
SDL_mixer.h: document Mix_StartTrack and Mix_GetNumTracks properly.
Browse files Browse the repository at this point in the history
  • Loading branch information
sezero committed Nov 30, 2023
1 parent 2317c5b commit 9fb9fce
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion include/SDL3_mixer/SDL_mixer.h
Original file line number Diff line number Diff line change
Expand Up @@ -2318,8 +2318,30 @@ extern DECLSPEC int SDLCALL Mix_PausedMusic(void);
*/
extern DECLSPEC int SDLCALL Mix_ModMusicJumpToOrder(int order);

/* Tracks */
/**
* Start a track in music object.
*
* This only applies to GME music formats.
*
* \param music the music object.
* \param track the track number to play. 0 is the first track.
* \returns 0 if successful, or -1 if failed or isn't implemented.
*
* \since This function is available since SDL_mixer 3.0.0.
*/
extern DECLSPEC int SDLCALL Mix_StartTrack(Mix_Music *music, int track);

/**
* Get number of tracks in music object.
*
* This only applies to GME music formats.
*
* \param music the music object.
* \returns number of tracks if successful, or -1 if failed or isn't
* implemented.
*
* \since This function is available since SDL_mixer 3.0.0.
*/
extern DECLSPEC int SDLCALL Mix_GetNumTracks(Mix_Music *music);

/**
Expand Down

0 comments on commit 9fb9fce

Please sign in to comment.