mirror of
https://github.com/libSDL2pp/libSDL2pp.git
synced 2025-08-03 19:05:59 -04:00
306 lines
10 KiB
C++
306 lines
10 KiB
C++
/*
|
|
libSDL2pp - C++11 bindings/wrapper for SDL2
|
|
Copyright (C) 2014 Dmitry Marakasov <amdmi3@amdmi3.ru>
|
|
|
|
This software is provided 'as-is', without any express or implied
|
|
warranty. In no event will the authors be held liable for any damages
|
|
arising from the use of this software.
|
|
|
|
Permission is granted to anyone to use this software for any purpose,
|
|
including commercial applications, and to alter it and redistribute it
|
|
freely, subject to the following restrictions:
|
|
|
|
1. The origin of this software must not be misrepresented; you must not
|
|
claim that you wrote the original software. If you use this software
|
|
in a product, an acknowledgment in the product documentation would be
|
|
appreciated but is not required.
|
|
2. Altered source versions must be plainly marked as such, and must not be
|
|
misrepresented as being the original software.
|
|
3. This notice may not be removed or altered from any source distribution.
|
|
*/
|
|
|
|
#ifndef SDL2PP_FONT_HH
|
|
#define SDL2PP_FONT_HH
|
|
|
|
#include <string>
|
|
|
|
#include <SDL2/SDL_ttf.h>
|
|
|
|
#include <SDL2pp/Surface.hh>
|
|
|
|
namespace SDL2pp {
|
|
|
|
class RWops;
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Holder of a loaded font
|
|
///
|
|
/// \ingroup ttf
|
|
///
|
|
/// \headerfile SDL2pp/Font.hh
|
|
///
|
|
/// \see https://www.libsdl.org/projects/SDL_ttf/docs/SDL_ttf.html#SEC56
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
class Font {
|
|
private:
|
|
TTF_Font* font_; ///< Contained TTF_Font structure
|
|
|
|
public:
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Loads font from .ttf or .fon file
|
|
///
|
|
/// \param file Pointer File name to load font from
|
|
/// \param ptsize Point size (based on 72DPI) to load font as. This basically translates to pixel height
|
|
/// \param index Choose a font face from a file containing multiple font faces. The first face is always index 0
|
|
///
|
|
/// \throws SDL2pp::Exception
|
|
///
|
|
/// \see https://www.libsdl.org/projects/SDL_ttf/docs/SDL_ttf.html#SEC14
|
|
/// \see https://www.libsdl.org/projects/SDL_ttf/docs/SDL_ttf.html#SEC16
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
Font(const std::string& file, int ptsize = 0, long index = 0);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Loads font with RWops
|
|
///
|
|
/// \param RWops RWops to load font from
|
|
/// \param ptsize Point size (based on 72DPI) to load font as. This basically translates to pixel height
|
|
/// \param index Choose a font face from a file containing multiple font faces. The first face is always index 0
|
|
///
|
|
/// \throws SDL2pp::Exception
|
|
///
|
|
/// \see https://www.libsdl.org/projects/SDL_ttf/docs/SDL_ttf.html#SEC15
|
|
/// \see https://www.libsdl.org/projects/SDL_ttf/docs/SDL_ttf.html#SEC17
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
Font(RWops& rwops, int ptsize = 0, long index = 0);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Destructor
|
|
///
|
|
/// \see https://www.libsdl.org/projects/SDL_ttf/docs/SDL_ttf.html#SEC18
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
virtual ~Font();
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Move constructor
|
|
///
|
|
/// \param other SDL2pp::Font object to move data from
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
Font(Font&& other) noexcept;
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Move assignment
|
|
///
|
|
/// \param other SDL2pp::Font object to move data from
|
|
///
|
|
/// \returns Reference to self
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
Font& operator=(Font&& other) noexcept;
|
|
|
|
// Deleted copy constructor and assignment
|
|
Font(const Font&) = delete;
|
|
Font& operator=(const Font&) = delete;
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Get pointer to contained TTF_Font structure
|
|
///
|
|
/// \returns Pointer to contained TTF_Font structure
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
TTF_Font* Get() const;
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Render LATIN1 text using solid mode
|
|
///
|
|
/// \param text LATIN1 string to render
|
|
/// \param fg Color to render the text in
|
|
///
|
|
/// \returns Surface containing rendered text
|
|
///
|
|
/// \throws SDL2pp::Exception
|
|
///
|
|
/// \see https://www.libsdl.org/projects/SDL_ttf/docs/SDL_ttf.html#SEC43
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
Surface RenderText_Solid(const std::string& text, SDL_Color fg);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Render UTF8 text using solid mode
|
|
///
|
|
/// \param text UTF8 string to render
|
|
/// \param fg Color to render the text in
|
|
///
|
|
/// \returns Surface containing rendered text
|
|
///
|
|
/// \throws SDL2pp::Exception
|
|
///
|
|
/// \see https://www.libsdl.org/projects/SDL_ttf/docs/SDL_ttf.html#SEC44
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
Surface RenderUTF8_Solid(const std::string& text, SDL_Color fg);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Render UNICODE encoded text using solid mode
|
|
///
|
|
/// \param text UNICODE encoded string to render
|
|
/// \param fg Color to render the text in
|
|
///
|
|
/// \returns Surface containing rendered text
|
|
///
|
|
/// \throws SDL2pp::Exception
|
|
///
|
|
/// \see https://www.libsdl.org/projects/SDL_ttf/docs/SDL_ttf.html#SEC45
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
Surface RenderUNICODE_Solid(const Uint16* text, SDL_Color fg);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Render the glyph for UNICODE character using solid mode
|
|
///
|
|
/// \param ch UNICODE character to render
|
|
/// \param fg Color to render the glyph in
|
|
///
|
|
/// \returns Surface containing rendered text
|
|
///
|
|
/// \throws SDL2pp::Exception
|
|
///
|
|
/// \see https://www.libsdl.org/projects/SDL_ttf/docs/SDL_ttf.html#SEC46
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
Surface RenderGlyph_Solid(Uint16 ch, SDL_Color fg);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Render LATIN1 text using shaded mode
|
|
///
|
|
/// \param text LATIN1 string to render
|
|
/// \param fg Color to render the text in
|
|
/// \param bg Color to render the background box in
|
|
///
|
|
/// \returns Surface containing rendered text
|
|
///
|
|
/// \throws SDL2pp::Exception
|
|
///
|
|
/// \see https://www.libsdl.org/projects/SDL_ttf/docs/SDL_ttf.html#SEC47
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
Surface RenderText_Shaded(const std::string& text, SDL_Color fg, SDL_Color bg);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Render UTF8 text using shaded mode
|
|
///
|
|
/// \param text UTF8 string to render
|
|
/// \param fg Color to render the text in
|
|
/// \param bg Color to render the background box in
|
|
///
|
|
/// \returns Surface containing rendered text
|
|
///
|
|
/// \throws SDL2pp::Exception
|
|
///
|
|
/// \see https://www.libsdl.org/projects/SDL_ttf/docs/SDL_ttf.html#SEC48
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
Surface RenderUTF8_Shaded(const std::string& text, SDL_Color fg, SDL_Color bg);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Render UNICODE encoded text using shaded mode
|
|
///
|
|
/// \param text UNICODE encoded string to render
|
|
/// \param fg Color to render the text in
|
|
/// \param bg Color to render the background box in
|
|
///
|
|
/// \returns Surface containing rendered text
|
|
///
|
|
/// \throws SDL2pp::Exception
|
|
///
|
|
/// \see https://www.libsdl.org/projects/SDL_ttf/docs/SDL_ttf.html#SEC49
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
Surface RenderUNICODE_Shaded(const Uint16* text, SDL_Color fg, SDL_Color bg);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Render the glyph for UNICODE character using shaded mode
|
|
///
|
|
/// \param ch UNICODE character to render
|
|
/// \param fg Color to render the glyph in
|
|
/// \param bg Color to render the background box in
|
|
///
|
|
/// \returns Surface containing rendered text
|
|
///
|
|
/// \throws SDL2pp::Exception
|
|
///
|
|
/// \see https://www.libsdl.org/projects/SDL_ttf/docs/SDL_ttf.html#SEC50
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
Surface RenderGlyph_Shaded(Uint16 ch, SDL_Color fg, SDL_Color bg);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Render LATIN1 text using blended mode
|
|
///
|
|
/// \param text LATIN1 string to render
|
|
/// \param fg Color to render the text in
|
|
///
|
|
/// \returns Surface containing rendered text
|
|
///
|
|
/// \throws SDL2pp::Exception
|
|
///
|
|
/// \see https://www.libsdl.org/projects/SDL_ttf/docs/SDL_ttf.html#SEC51
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
Surface RenderText_Blended(const std::string& text, SDL_Color fg);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Render UTF8 text using blended mode
|
|
///
|
|
/// \param text UTF8 string to render
|
|
/// \param fg Color to render the text in
|
|
///
|
|
/// \returns Surface containing rendered text
|
|
///
|
|
/// \throws SDL2pp::Exception
|
|
///
|
|
/// \see https://www.libsdl.org/projects/SDL_ttf/docs/SDL_ttf.html#SEC48
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
Surface RenderUTF8_Blended(const std::string& text, SDL_Color fg);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Render UNICODE encoded text using blended mode
|
|
///
|
|
/// \param text UNICODE encoded string to render
|
|
/// \param fg Color to render the text in
|
|
///
|
|
/// \returns Surface containing rendered text
|
|
///
|
|
/// \throws SDL2pp::Exception
|
|
///
|
|
/// \see https://www.libsdl.org/projects/SDL_ttf/docs/SDL_ttf.html#SEC49
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
Surface RenderUNICODE_Blended(const Uint16* text, SDL_Color fg);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Render the glyph for UNICODE character using blended mode
|
|
///
|
|
/// \param ch UNICODE character to render
|
|
/// \param fg Color to render the glyph in
|
|
///
|
|
/// \returns Surface containing rendered text
|
|
///
|
|
/// \throws SDL2pp::Exception
|
|
///
|
|
/// \see https://www.libsdl.org/projects/SDL_ttf/docs/SDL_ttf.html#SEC50
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
Surface RenderGlyph_Blended(Uint16 ch, SDL_Color fg);
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|