mirror of
https://github.com/libSDL2pp/libSDL2pp.git
synced 2025-08-05 11:56:00 -04:00
Add documentation groups for Font and Mixer
This commit is contained in:
parent
eabd23373d
commit
bc945cf8fa
@ -137,6 +137,9 @@ public:
|
|||||||
////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////
|
||||||
TTF_Font* Get() const;
|
TTF_Font* Get() const;
|
||||||
|
|
||||||
|
///@{
|
||||||
|
/// \name Attributes
|
||||||
|
|
||||||
////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////
|
||||||
/// \brief Get the rendering style of the loaded font
|
/// \brief Get the rendering style of the loaded font
|
||||||
///
|
///
|
||||||
@ -536,6 +539,11 @@ public:
|
|||||||
////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////
|
||||||
Point GetSizeUNICODE(const std::u16string& text) const;
|
Point GetSizeUNICODE(const std::u16string& text) const;
|
||||||
|
|
||||||
|
///@}
|
||||||
|
|
||||||
|
///@{
|
||||||
|
/// \name Rendering
|
||||||
|
|
||||||
////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////
|
||||||
/// \brief Render LATIN1 text using solid mode
|
/// \brief Render LATIN1 text using solid mode
|
||||||
///
|
///
|
||||||
@ -765,6 +773,8 @@ public:
|
|||||||
///
|
///
|
||||||
////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////
|
||||||
Surface RenderGlyph_Blended(Uint16 ch, SDL_Color fg);
|
Surface RenderGlyph_Blended(Uint16 ch, SDL_Color fg);
|
||||||
|
|
||||||
|
///@}
|
||||||
};
|
};
|
||||||
|
|
||||||
}
|
}
|
||||||
|
@ -120,6 +120,9 @@ public:
|
|||||||
////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////
|
||||||
Mixer& operator=(const Mixer& other) = delete;
|
Mixer& operator=(const Mixer& other) = delete;
|
||||||
|
|
||||||
|
///@{
|
||||||
|
/// \name Channels
|
||||||
|
|
||||||
////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////
|
||||||
/// \brief Set the number of channels to mix
|
/// \brief Set the number of channels to mix
|
||||||
///
|
///
|
||||||
@ -372,6 +375,11 @@ public:
|
|||||||
////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////
|
||||||
Mix_Fading GetChannelFading(int which) const;
|
Mix_Fading GetChannelFading(int which) const;
|
||||||
|
|
||||||
|
///@}
|
||||||
|
|
||||||
|
///@{
|
||||||
|
/// \name Groups
|
||||||
|
|
||||||
////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////
|
||||||
/// \brief Prevent channels from being used in default group
|
/// \brief Prevent channels from being used in default group
|
||||||
///
|
///
|
||||||
@ -494,6 +502,11 @@ public:
|
|||||||
////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////
|
||||||
void HaltGroup(int tag);
|
void HaltGroup(int tag);
|
||||||
|
|
||||||
|
///@}
|
||||||
|
|
||||||
|
///@{
|
||||||
|
/// \name Music
|
||||||
|
|
||||||
////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////
|
||||||
/// \brief Play music
|
/// \brief Play music
|
||||||
///
|
///
|
||||||
@ -652,6 +665,11 @@ public:
|
|||||||
////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////
|
||||||
void SetMusicHook(MusicHook&& hook);
|
void SetMusicHook(MusicHook&& hook);
|
||||||
|
|
||||||
|
///@}
|
||||||
|
|
||||||
|
///@{
|
||||||
|
/// \name Effects
|
||||||
|
|
||||||
// TODO: custom effects
|
// TODO: custom effects
|
||||||
|
|
||||||
////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////
|
||||||
@ -769,6 +787,8 @@ public:
|
|||||||
///
|
///
|
||||||
////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////
|
||||||
void UnsetReverseStereo(int channel);
|
void UnsetReverseStereo(int channel);
|
||||||
|
|
||||||
|
///@}
|
||||||
};
|
};
|
||||||
|
|
||||||
}
|
}
|
||||||
|
Loading…
x
Reference in New Issue
Block a user