diff --git a/SDL2pp/Font.hh b/SDL2pp/Font.hh index e932c84..b5a9ab7 100644 --- a/SDL2pp/Font.hh +++ b/SDL2pp/Font.hh @@ -87,15 +87,15 @@ public: //////////////////////////////////////////////////////////// Font(RWops& rwops, int ptsize = 0, long index = 0); - //////////////////////////////////////////////////////////// - /// \brief Destructor - /// - /// \see https://www.libsdl.org/projects/SDL_ttf/docs/SDL_ttf.html#SEC18 - /// - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// + /// \brief Destructor + /// + /// \see https://www.libsdl.org/projects/SDL_ttf/docs/SDL_ttf.html#SEC18 + /// + //////////////////////////////////////////////////////////// virtual ~Font(); - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Move constructor /// /// \param[in] other SDL2pp::Font object to move data from @@ -129,7 +129,7 @@ public: //////////////////////////////////////////////////////////// Font& operator=(const Font&) = delete; - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Get pointer to managed TTF_Font structure /// /// \returns Pointer to managed TTF_Font structure @@ -137,7 +137,7 @@ public: //////////////////////////////////////////////////////////// TTF_Font* Get() const; - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Get the rendering style of the loaded font /// /// \returns The style as a bitmask composed of the following masks: @@ -150,7 +150,7 @@ public: //////////////////////////////////////////////////////////// int GetStyle() const; - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Set the rendering style of the loaded font /// /// \param[in] style The style as a bitmask composed of the following masks: @@ -184,7 +184,7 @@ public: //////////////////////////////////////////////////////////// Font& SetStyle(int style = TTF_STYLE_NORMAL); - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Get the current outline size of the loaded font /// /// \returns The size of the outline currently set on the font, in pixels @@ -194,7 +194,7 @@ public: //////////////////////////////////////////////////////////// int GetOutline() const; - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Set the outline pixel width of the loaded font /// /// \param[in] outline The size of outline desired, in pixels. @@ -211,7 +211,7 @@ public: //////////////////////////////////////////////////////////// Font& SetOutline(int outline = 0); - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Get the current hinting setting of the loaded font /// /// \returns The hinting type matching one of the following defined values: @@ -223,7 +223,7 @@ public: //////////////////////////////////////////////////////////// int GetHinting() const; - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Set the hinting of the loaded font /// /// \param[in] hinting The hinting setting desired, which is one of: @@ -246,7 +246,7 @@ public: //////////////////////////////////////////////////////////// Font& SetHinting(int hinting = TTF_HINTING_NORMAL); - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Get the current kerning setting of the loaded font /// /// \returns False if kerning is disabled. True when enabled. @@ -257,7 +257,7 @@ public: //////////////////////////////////////////////////////////// bool GetKerning() const; - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Set whether to use kerning when rendering the loaded font /// /// \param[in] allowed False to disable kerning, true to enable kerning. @@ -277,7 +277,7 @@ public: //////////////////////////////////////////////////////////// Font& SetKerning(bool allowed = true); - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Get the maximum pixel height of all glyphs of the loaded font /// /// \returns The maximum pixel height of all glyphs in the font @@ -293,7 +293,7 @@ public: //////////////////////////////////////////////////////////// int GetHeight() const; - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Get the maximum pixel ascent of all glyphs of the loaded font /// /// \returns The maximum pixel ascent of all glyphs in the font @@ -313,7 +313,7 @@ public: //////////////////////////////////////////////////////////// int GetAscent() const; - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Get the maximum pixel descent of all glyphs of the loaded font /// /// \returns The maximum pixel height of all glyphs in the font @@ -334,7 +334,7 @@ public: //////////////////////////////////////////////////////////// int GetDescent() const; - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Get the recommended pixel height of a rendered line of text of the loaded font /// /// \returns The maximum pixel height of all glyphs in the font @@ -346,7 +346,7 @@ public: //////////////////////////////////////////////////////////// int GetLineSkip() const; - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Get the number of faces ("sub-fonts") available in the loaded font /// /// \returns The number of faces in the font @@ -361,7 +361,7 @@ public: //////////////////////////////////////////////////////////// int GetNumFaces() const; - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Test if the current font face of the loaded font is a fixed width font /// /// \returns True if font is a fixed width font. False if not a fixed width font @@ -380,7 +380,7 @@ public: //////////////////////////////////////////////////////////// bool IsFixedWidth() const; - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Get the current font face family name from the loaded font /// /// \returns The current family name of of the face of the font, or NullOpt perhaps @@ -392,7 +392,7 @@ public: //////////////////////////////////////////////////////////// Optional GetFamilyName() const; - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Get the current font face style name from the loaded font /// /// \returns The current style name of of the face of the font, or NullOpt perhaps @@ -404,7 +404,7 @@ public: //////////////////////////////////////////////////////////// Optional GetStyleName() const; - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Get the status of the availability of the glyph from the loaded font /// /// \param[in] ch Unicode character to test glyph availability of @@ -416,7 +416,7 @@ public: //////////////////////////////////////////////////////////// int IsGlyphProvided(Uint16 ch) const; - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Get glyph metrics of the UNICODE char /// /// \param[out] ch UNICODE char to get the glyph metrics for @@ -434,7 +434,7 @@ public: //////////////////////////////////////////////////////////// void GetGlyphMetrics(Uint16 ch, int& minx, int& maxx, int& miny, int& maxy, int& advance) const; - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Get rect part of glyph metrics of the UNICODE char /// /// \param[in] ch UNICODE char to get the glyph metrics for @@ -449,7 +449,7 @@ public: //////////////////////////////////////////////////////////// Rect GetGlyphRect(Uint16 ch) const; - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Get advance part of glyph metrics of the UNICODE char /// /// \param[in] ch UNICODE char to get the glyph metrics for @@ -464,7 +464,7 @@ public: //////////////////////////////////////////////////////////// int GetGlyphAdvance(Uint16 ch) const; - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Calculate the resulting surface size of the LATIN1 encoded text rendered using font /// /// \param[in] text String to size up @@ -482,7 +482,7 @@ public: //////////////////////////////////////////////////////////// Point GetSizeText(const std::string& text) const; - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Calculate the resulting surface size of the UTF8 encoded text rendered using font /// /// \param[in] text UTF8 encoded string to size up @@ -500,7 +500,7 @@ public: //////////////////////////////////////////////////////////// Point GetSizeUTF8(const std::string& text) const; - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Calculate the resulting surface size of the UNICODE encoded text rendered using font /// /// \param[in] text UNICODE null terminated string to size up @@ -518,7 +518,7 @@ public: //////////////////////////////////////////////////////////// Point GetSizeUNICODE(const Uint16* text) const; - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Render LATIN1 text using solid mode /// /// \param[in] text LATIN1 string to render @@ -533,7 +533,7 @@ public: //////////////////////////////////////////////////////////// Surface RenderText_Solid(const std::string& text, SDL_Color fg); - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Render UTF8 text using solid mode /// /// \param[in] text UTF8 string to render @@ -548,7 +548,7 @@ public: //////////////////////////////////////////////////////////// Surface RenderUTF8_Solid(const std::string& text, SDL_Color fg); - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Render UNICODE encoded text using solid mode /// /// \param[in] text UNICODE encoded string to render @@ -563,7 +563,7 @@ public: //////////////////////////////////////////////////////////// Surface RenderUNICODE_Solid(const Uint16* text, SDL_Color fg); - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Render the glyph for UNICODE character using solid mode /// /// \param[in] ch UNICODE character to render @@ -578,7 +578,7 @@ public: //////////////////////////////////////////////////////////// Surface RenderGlyph_Solid(Uint16 ch, SDL_Color fg); - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Render LATIN1 text using shaded mode /// /// \param[in] text LATIN1 string to render @@ -594,7 +594,7 @@ public: //////////////////////////////////////////////////////////// Surface RenderText_Shaded(const std::string& text, SDL_Color fg, SDL_Color bg); - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Render UTF8 text using shaded mode /// /// \param[in] text UTF8 string to render @@ -610,7 +610,7 @@ public: //////////////////////////////////////////////////////////// Surface RenderUTF8_Shaded(const std::string& text, SDL_Color fg, SDL_Color bg); - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Render UNICODE encoded text using shaded mode /// /// \param[in] text UNICODE encoded string to render @@ -626,7 +626,7 @@ public: //////////////////////////////////////////////////////////// Surface RenderUNICODE_Shaded(const Uint16* text, SDL_Color fg, SDL_Color bg); - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Render the glyph for UNICODE character using shaded mode /// /// \param[in] ch UNICODE character to render @@ -642,7 +642,7 @@ public: //////////////////////////////////////////////////////////// Surface RenderGlyph_Shaded(Uint16 ch, SDL_Color fg, SDL_Color bg); - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Render LATIN1 text using blended mode /// /// \param[in] text LATIN1 string to render @@ -657,7 +657,7 @@ public: //////////////////////////////////////////////////////////// Surface RenderText_Blended(const std::string& text, SDL_Color fg); - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Render UTF8 text using blended mode /// /// \param[in] text UTF8 string to render @@ -672,7 +672,7 @@ public: //////////////////////////////////////////////////////////// Surface RenderUTF8_Blended(const std::string& text, SDL_Color fg); - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Render UNICODE encoded text using blended mode /// /// \param[in] text UNICODE encoded string to render @@ -687,7 +687,7 @@ public: //////////////////////////////////////////////////////////// Surface RenderUNICODE_Blended(const Uint16* text, SDL_Color fg); - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Render the glyph for UNICODE character using blended mode /// /// \param[in] ch UNICODE character to render diff --git a/SDL2pp/Surface.hh b/SDL2pp/Surface.hh index bebf407..1703713 100644 --- a/SDL2pp/Surface.hh +++ b/SDL2pp/Surface.hh @@ -227,15 +227,15 @@ public: Surface(const std::string& filename); #endif - //////////////////////////////////////////////////////////// - /// \brief Destructor - /// - /// \see http://wiki.libsdl.org/SDL_FreeSurface - /// - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// + /// \brief Destructor + /// + /// \see http://wiki.libsdl.org/SDL_FreeSurface + /// + //////////////////////////////////////////////////////////// virtual ~Surface(); - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Move constructor /// /// \param[in] other SDL2pp::Surface object to move data from @@ -269,7 +269,7 @@ public: //////////////////////////////////////////////////////////// Surface& operator=(const Surface&) = delete; - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Get pointer to managed SDL_Surface structure /// /// \returns Pointer to managed SDL_Surface structure @@ -277,7 +277,7 @@ public: //////////////////////////////////////////////////////////// SDL_Surface* Get() const; - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Copy an existing surface into a new one that is /// optimized for blitting to a surface of a specified pixel format /// @@ -290,7 +290,7 @@ public: //////////////////////////////////////////////////////////// Surface Convert(const SDL_PixelFormat& format); - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Copy an existing surface to a new surface of the specified format /// /// \param[in] pixel_format One of the enumerated values in SDL_PixelFormatEnum @@ -303,7 +303,7 @@ public: //////////////////////////////////////////////////////////// Surface Convert(Uint32 pixel_format); - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Fast surface copy to a destination surface /// /// \param[in] srcrect Rectangle to be copied, or NullOpt to copy the entire surface @@ -317,7 +317,7 @@ public: //////////////////////////////////////////////////////////// void Blit(const Optional& srcrect, Surface& dst, const Rect& dstrect); - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Scaled surface copy to a destination surface /// /// \param[in] srcrect Rectangle to be copied, or NullOpt to copy the entire surface @@ -341,7 +341,7 @@ public: /// \see http://wiki.libsdl.org/SDL_LockSurface /// //////////////////////////////////////////////////////////// - LockHandle Lock(); + LockHandle Lock(); //////////////////////////////////////////////////////////// /// \brief Get the clipping rectangle for a surface diff --git a/SDL2pp/Texture.hh b/SDL2pp/Texture.hh index b0f49a6..290893c 100644 --- a/SDL2pp/Texture.hh +++ b/SDL2pp/Texture.hh @@ -184,7 +184,7 @@ public: }; public: - //////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////// /// \brief Construct from existing SDL_Texture structure /// /// \param[in] texture Existing SDL_Texture to manage