mirrors/SFML
1
0
Fork 0
mirror of https://github.com/SFML/SFML.git synced 2024-11-28 22:31:09 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix sf::Rect docs

Browse Source
This commit is contained in:
Chris Thrasher 2023-02-18 23:01:18 -07:00
parent 0e1d33f910
commit 5bd3722598
4 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
include/SFML/Graphics/Rect.hpp
View File

@ -46,7 +46,7 @@ public:
/// \brief Default constructor /// \brief Default constructor
/// ///
/// Creates an empty rectangle (it is equivalent to calling /// Creates an empty rectangle (it is equivalent to calling
/// Rect(0, 0, 0, 0)). /// Rect({0, 0}, {0, 0})).
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
constexpr Rect(); constexpr Rect();
@ -191,7 +191,7 @@ using FloatRect = Rect<float>;
/// \li The left and top edges are included in the rectangle's area /// \li The left and top edges are included in the rectangle's area
/// \li The right (left + width) and bottom (top + height) edges are excluded from the rectangle's area /// \li The right (left + width) and bottom (top + height) edges are excluded from the rectangle's area
/// ///
/// This means that sf::IntRect(0, 0, 1, 1) and sf::IntRect(1, 1, 1, 1) /// This means that sf::IntRect({0, 0}, {1, 1}) and sf::IntRect({1, 1}, {1, 1})
/// don't intersect. /// don't intersect.
/// ///
/// sf::Rect is a template and may be used with any numeric type, but /// sf::Rect is a template and may be used with any numeric type, but

2
include/SFML/Graphics/Sprite.hpp
View File

@ -279,7 +279,7 @@ private:
/// // Create a sprite /// // Create a sprite
/// sf::Sprite sprite; /// sf::Sprite sprite;
/// sprite.setTexture(texture); /// sprite.setTexture(texture);
/// sprite.setTextureRect(sf::IntRect(10, 10, 50, 30)); /// sprite.setTextureRect(sf::IntRect({10, 10}, {50, 30}));
/// sprite.setColor(sf::Color(255, 255, 255, 200)); /// sprite.setColor(sf::Color(255, 255, 255, 200));
/// sprite.setPosition(100, 25); /// sprite.setPosition(100, 25);
/// ///

2
include/SFML/Graphics/Transform.hpp
View File

@ -382,7 +382,7 @@ constexpr Vector2f operator*(const Transform& left, const Vector2f& right);
/// ///
/// // use the result to transform stuff... /// // use the result to transform stuff...
/// sf::Vector2f point = transform.transformPoint(10, 20); /// sf::Vector2f point = transform.transformPoint(10, 20);
/// sf::FloatRect rect = transform.transformRect(sf::FloatRect(0, 0, 10, 100)); /// sf::FloatRect rect = transform.transformRect(sf::FloatRect({0, 0}, {10, 100}));
/// \endcode /// \endcode
/// ///
/// \see sf::Transformable, sf::RenderStates /// \see sf::Transformable, sf::RenderStates

6
include/SFML/Graphics/View.hpp
View File

@ -108,7 +108,7 @@ public:
/// view are displayed, expressed as a factor (between 0 and 1) /// view are displayed, expressed as a factor (between 0 and 1)
/// of the size of the RenderTarget to which the view is applied. /// of the size of the RenderTarget to which the view is applied.
/// For example, a view which takes the left side of the target would /// For example, a view which takes the left side of the target would
/// be defined with View.setViewport(sf::FloatRect(0, 0, 0.5, 1)). /// be defined with View.setViewport(sf::FloatRect({0.f, 0.f}, {0.5f, 1.f})).
/// By default, a view has a viewport which covers the entire target. /// By default, a view has a viewport which covers the entire target.
/// ///
/// \param viewport New viewport rectangle /// \param viewport New viewport rectangle
@ -278,13 +278,13 @@ private:
/// sf::View view; /// sf::View view;
/// ///
/// // Initialize the view to a rectangle located at (100, 100) and with a size of 400x200 /// // Initialize the view to a rectangle located at (100, 100) and with a size of 400x200
/// view.reset(sf::FloatRect(100, 100, 400, 200)); /// view.reset(sf::FloatRect({100, 100}, {400, 200}));
/// ///
/// // Rotate it by 45 degrees /// // Rotate it by 45 degrees
/// view.rotate(sf::degrees(45)); /// view.rotate(sf::degrees(45));
/// ///
/// // Set its target viewport to be half of the window /// // Set its target viewport to be half of the window
/// view.setViewport(sf::FloatRect(0.f, 0.f, 0.5f, 1.f)); /// view.setViewport(sf::FloatRect({0.f, 0.f}, {0.5f, 1.f}));
/// ///
/// // Apply it /// // Apply it
/// window.setView(view); /// window.setView(view);