487 lines
19 KiB
C++
487 lines
19 KiB
C++
////////////////////////////////////////////////////////////
|
|
//
|
|
// SFML - Simple and Fast Multimedia Library
|
|
// Copyright (C) 2007-2025 Laurent Gomila (laurent@sfml-dev.org)
|
|
//
|
|
// 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.
|
|
//
|
|
////////////////////////////////////////////////////////////
|
|
|
|
#pragma once
|
|
|
|
////////////////////////////////////////////////////////////
|
|
// Headers
|
|
////////////////////////////////////////////////////////////
|
|
#include <SFML/Graphics/Export.hpp>
|
|
|
|
#include <SFML/Graphics/Color.hpp>
|
|
#include <SFML/Graphics/Drawable.hpp>
|
|
#include <SFML/Graphics/PrimitiveType.hpp>
|
|
#include <SFML/Graphics/Rect.hpp>
|
|
#include <SFML/Graphics/RenderStates.hpp>
|
|
#include <SFML/Graphics/Transformable.hpp>
|
|
#include <SFML/Graphics/VertexArray.hpp>
|
|
|
|
#include <SFML/System/String.hpp>
|
|
#include <SFML/System/Vector2.hpp>
|
|
|
|
#include <cstddef>
|
|
#include <cstdint>
|
|
|
|
|
|
namespace sf
|
|
{
|
|
class Font;
|
|
class RenderTarget;
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Graphical text that can be drawn to a render target
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
class SFML_GRAPHICS_API Text : public Drawable, public Transformable
|
|
{
|
|
public:
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Enumeration of the string drawing styles
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
enum Style
|
|
{
|
|
Regular = 0, //!< Regular characters, no style
|
|
Bold = 1 << 0, //!< Bold characters
|
|
Italic = 1 << 1, //!< Italic characters
|
|
Underlined = 1 << 2, //!< Underlined characters
|
|
StrikeThrough = 1 << 3 //!< Strike through characters
|
|
};
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Construct the text from a string, font and size
|
|
///
|
|
/// Note that if the used font is a bitmap font, it is not
|
|
/// scalable, thus not all requested sizes will be available
|
|
/// to use. This needs to be taken into consideration when
|
|
/// setting the character size. If you need to display text
|
|
/// of a certain size, make sure the corresponding bitmap
|
|
/// font that supports that size is used.
|
|
///
|
|
/// \param string Text assigned to the string
|
|
/// \param font Font used to draw the string
|
|
/// \param characterSize Base size of characters, in pixels
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
Text(const Font& font, String string = "", unsigned int characterSize = 30);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Disallow construction from a temporary font
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
Text(const Font&& font, String string = "", unsigned int characterSize = 30) = delete;
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Set the text's string
|
|
///
|
|
/// The `string` argument is a `sf::String`, which can
|
|
/// automatically be constructed from standard string types.
|
|
/// So, the following calls are all valid:
|
|
/// \code
|
|
/// text.setString("hello");
|
|
/// text.setString(L"hello");
|
|
/// text.setString(std::string("hello"));
|
|
/// text.setString(std::wstring(L"hello"));
|
|
/// \endcode
|
|
/// A text's string is empty by default.
|
|
///
|
|
/// \param string New string
|
|
///
|
|
/// \see `getString`
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
void setString(const String& string);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Set the text's font
|
|
///
|
|
/// The `font` argument refers to a font that must
|
|
/// exist as long as the text uses it. Indeed, the text
|
|
/// doesn't store its own copy of the font, but rather keeps
|
|
/// a pointer to the one that you passed to this function.
|
|
/// If the font is destroyed and the text tries to
|
|
/// use it, the behavior is undefined.
|
|
///
|
|
/// \param font New font
|
|
///
|
|
/// \see `getFont`
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
void setFont(const Font& font);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Disallow setting from a temporary font
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
void setFont(const Font&& font) = delete;
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Set the character size
|
|
///
|
|
/// The default size is 30.
|
|
///
|
|
/// Note that if the used font is a bitmap font, it is not
|
|
/// scalable, thus not all requested sizes will be available
|
|
/// to use. This needs to be taken into consideration when
|
|
/// setting the character size. If you need to display text
|
|
/// of a certain size, make sure the corresponding bitmap
|
|
/// font that supports that size is used.
|
|
///
|
|
/// \param size New character size, in pixels
|
|
///
|
|
/// \see `getCharacterSize`
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
void setCharacterSize(unsigned int size);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Set the line spacing factor
|
|
///
|
|
/// The default spacing between lines is defined by the font.
|
|
/// This method enables you to set a factor for the spacing
|
|
/// between lines. By default the line spacing factor is 1.
|
|
///
|
|
/// \param spacingFactor New line spacing factor
|
|
///
|
|
/// \see `getLineSpacing`
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
void setLineSpacing(float spacingFactor);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Set the letter spacing factor
|
|
///
|
|
/// The default spacing between letters is defined by the font.
|
|
/// This factor doesn't directly apply to the existing
|
|
/// spacing between each character, it rather adds a fixed
|
|
/// space between them which is calculated from the font
|
|
/// metrics and the character size.
|
|
/// Note that factors below 1 (including negative numbers) bring
|
|
/// characters closer to each other.
|
|
/// By default the letter spacing factor is 1.
|
|
///
|
|
/// \param spacingFactor New letter spacing factor
|
|
///
|
|
/// \see `getLetterSpacing`
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
void setLetterSpacing(float spacingFactor);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Set the text's style
|
|
///
|
|
/// You can pass a combination of one or more styles, for
|
|
/// example `sf::Text::Bold | sf::Text::Italic`.
|
|
/// The default style is `sf::Text::Regular`.
|
|
///
|
|
/// \param style New style
|
|
///
|
|
/// \see `getStyle`
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
void setStyle(std::uint32_t style);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Set the fill color of the text
|
|
///
|
|
/// By default, the text's fill color is opaque white.
|
|
/// Setting the fill color to a transparent color with an outline
|
|
/// will cause the outline to be displayed in the fill area of the text.
|
|
///
|
|
/// \param color New fill color of the text
|
|
///
|
|
/// \see `getFillColor`
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
void setFillColor(Color color);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Set the outline color of the text
|
|
///
|
|
/// By default, the text's outline color is opaque black.
|
|
///
|
|
/// \param color New outline color of the text
|
|
///
|
|
/// \see `getOutlineColor`
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
void setOutlineColor(Color color);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Set the thickness of the text's outline
|
|
///
|
|
/// By default, the outline thickness is 0.
|
|
///
|
|
/// Be aware that using a negative value for the outline
|
|
/// thickness will cause distorted rendering.
|
|
///
|
|
/// \param thickness New outline thickness, in pixels
|
|
///
|
|
/// \see `getOutlineThickness`
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
void setOutlineThickness(float thickness);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Get the text's string
|
|
///
|
|
/// The returned string is a `sf::String`, which can automatically
|
|
/// be converted to standard string types. So, the following
|
|
/// lines of code are all valid:
|
|
/// \code
|
|
/// sf::String s1 = text.getString();
|
|
/// std::string s2 = text.getString();
|
|
/// std::wstring s3 = text.getString();
|
|
/// \endcode
|
|
///
|
|
/// \return Text's string
|
|
///
|
|
/// \see `setString`
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
[[nodiscard]] const String& getString() const;
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Get the text's font
|
|
///
|
|
/// The returned reference is const, which means that you
|
|
/// cannot modify the font when you get it from this function.
|
|
///
|
|
/// \return Reference to the text's font
|
|
///
|
|
/// \see `setFont`
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
[[nodiscard]] const Font& getFont() const;
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Get the character size
|
|
///
|
|
/// \return Size of the characters, in pixels
|
|
///
|
|
/// \see `setCharacterSize`
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
[[nodiscard]] unsigned int getCharacterSize() const;
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Get the size of the letter spacing factor
|
|
///
|
|
/// \return Size of the letter spacing factor
|
|
///
|
|
/// \see `setLetterSpacing`
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
[[nodiscard]] float getLetterSpacing() const;
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Get the size of the line spacing factor
|
|
///
|
|
/// \return Size of the line spacing factor
|
|
///
|
|
/// \see `setLineSpacing`
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
[[nodiscard]] float getLineSpacing() const;
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Get the text's style
|
|
///
|
|
/// \return Text's style
|
|
///
|
|
/// \see `setStyle`
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
[[nodiscard]] std::uint32_t getStyle() const;
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Get the fill color of the text
|
|
///
|
|
/// \return Fill color of the text
|
|
///
|
|
/// \see `setFillColor`
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
[[nodiscard]] Color getFillColor() const;
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Get the outline color of the text
|
|
///
|
|
/// \return Outline color of the text
|
|
///
|
|
/// \see `setOutlineColor`
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
[[nodiscard]] Color getOutlineColor() const;
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Get the outline thickness of the text
|
|
///
|
|
/// \return Outline thickness of the text, in pixels
|
|
///
|
|
/// \see `setOutlineThickness`
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
[[nodiscard]] float getOutlineThickness() const;
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Return the position of the `index`-th character
|
|
///
|
|
/// This function computes the visual position of a character
|
|
/// from its index in the string. The returned position is
|
|
/// in global coordinates (translation, rotation, scale and
|
|
/// origin are applied).
|
|
/// If `index` is out of range, the position of the end of
|
|
/// the string is returned.
|
|
///
|
|
/// \param index Index of the character
|
|
///
|
|
/// \return Position of the character
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
[[nodiscard]] Vector2f findCharacterPos(std::size_t index) const;
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Get the local bounding rectangle of the entity
|
|
///
|
|
/// The returned rectangle is in local coordinates, which means
|
|
/// that it ignores the transformations (translation, rotation,
|
|
/// scale, ...) that are applied to the entity.
|
|
/// In other words, this function returns the bounds of the
|
|
/// entity in the entity's coordinate system.
|
|
///
|
|
/// \return Local bounding rectangle of the entity
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
[[nodiscard]] FloatRect getLocalBounds() const;
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Get the global bounding rectangle of the entity
|
|
///
|
|
/// The returned rectangle is in global coordinates, which means
|
|
/// that it takes into account the transformations (translation,
|
|
/// rotation, scale, ...) that are applied to the entity.
|
|
/// In other words, this function returns the bounds of the
|
|
/// text in the global 2D world's coordinate system.
|
|
///
|
|
/// \return Global bounding rectangle of the entity
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
[[nodiscard]] FloatRect getGlobalBounds() const;
|
|
|
|
private:
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Draw the text to a render target
|
|
///
|
|
/// \param target Render target to draw to
|
|
/// \param states Current render states
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
void draw(RenderTarget& target, RenderStates states) const override;
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Make sure the text's geometry is updated
|
|
///
|
|
/// All the attributes related to rendering are cached, such
|
|
/// that the geometry is only updated when necessary.
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
void ensureGeometryUpdate() const;
|
|
|
|
////////////////////////////////////////////////////////////
|
|
// Member data
|
|
////////////////////////////////////////////////////////////
|
|
String m_string; //!< String to display
|
|
const Font* m_font{}; //!< Font used to display the string
|
|
unsigned int m_characterSize{30}; //!< Base size of characters, in pixels
|
|
float m_letterSpacingFactor{1.f}; //!< Spacing factor between letters
|
|
float m_lineSpacingFactor{1.f}; //!< Spacing factor between lines
|
|
std::uint32_t m_style{Regular}; //!< Text style (see Style enum)
|
|
Color m_fillColor{Color::White}; //!< Text fill color
|
|
Color m_outlineColor{Color::Black}; //!< Text outline color
|
|
float m_outlineThickness{0.f}; //!< Thickness of the text's outline
|
|
mutable VertexArray m_vertices{PrimitiveType::Triangles}; //!< Vertex array containing the fill geometry
|
|
mutable VertexArray m_outlineVertices{PrimitiveType::Triangles}; //!< Vertex array containing the outline geometry
|
|
mutable FloatRect m_bounds; //!< Bounding rectangle of the text (in local coordinates)
|
|
mutable bool m_geometryNeedUpdate{}; //!< Does the geometry need to be recomputed?
|
|
mutable std::uint64_t m_fontTextureId{}; //!< The font texture id
|
|
};
|
|
|
|
} // namespace sf
|
|
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \class sf::Text
|
|
/// \ingroup graphics
|
|
///
|
|
/// `sf::Text` is a drawable class that allows to easily display
|
|
/// some text with custom style and color on a render target.
|
|
///
|
|
/// It inherits all the functions from `sf::Transformable`:
|
|
/// position, rotation, scale, origin. It also adds text-specific
|
|
/// properties such as the font to use, the character size,
|
|
/// the font style (bold, italic, underlined and strike through), the
|
|
/// text color, the outline thickness, the outline color, the character
|
|
/// spacing, the line spacing and the text to display of course.
|
|
/// It also provides convenience functions to calculate the
|
|
/// graphical size of the text, or to get the global position
|
|
/// of a given character.
|
|
///
|
|
/// `sf::Text` works in combination with the `sf::Font` class, which
|
|
/// loads and provides the glyphs (visual characters) of a given font.
|
|
///
|
|
/// The separation of `sf::Font` and `sf::Text` allows more flexibility
|
|
/// and better performances: indeed a `sf::Font` is a heavy resource,
|
|
/// and any operation on it is slow (often too slow for real-time
|
|
/// applications). On the other side, a `sf::Text` is a lightweight
|
|
/// object which can combine the glyphs data and metrics of a `sf::Font`
|
|
/// to display any text on a render target.
|
|
///
|
|
/// It is important to note that the `sf::Text` instance doesn't
|
|
/// copy the font that it uses, it only keeps a reference to it.
|
|
/// Thus, a `sf::Font` must not be destructed while it is
|
|
/// used by a `sf::Text` (i.e. never write a function that
|
|
/// uses a local `sf::Font` instance for creating a text).
|
|
///
|
|
/// See also the note on coordinates and undistorted rendering in `sf::Transformable`.
|
|
///
|
|
/// Usage example:
|
|
/// \code
|
|
/// // Open a font
|
|
/// const sf::Font font("arial.ttf");
|
|
///
|
|
/// // Create a text
|
|
/// sf::Text text(font, "hello");
|
|
/// text.setCharacterSize(30);
|
|
/// text.setStyle(sf::Text::Bold);
|
|
/// text.setFillColor(sf::Color::Red);
|
|
///
|
|
/// // Draw it
|
|
/// window.draw(text);
|
|
/// \endcode
|
|
///
|
|
/// \see `sf::Font`, `sf::Transformable`
|
|
///
|
|
////////////////////////////////////////////////////////////
|