documentation/3.0.1/Transform_8hpp_source.html

//

// 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/Rect.hpp>


#include <SFML/System/Vector2.hpp>


#include <array>


namespace sf

{

class Angle;


class Transform

{

public:

    constexpr Transform() = default;


    constexpr Transform(float a00, float a01, float a02, float a10, float a11, float a12, float a20, float a21, float a22);


    [[nodiscard]] constexpr const float* getMatrix() const;


    [[nodiscard]] constexpr Transform getInverse() const;


    [[nodiscard]] constexpr Vector2f transformPoint(Vector2f point) const;


    [[nodiscard]] constexpr FloatRect transformRect(const FloatRect& rectangle) const;


    constexpr Transform& combine(const Transform& transform);


    constexpr Transform& translate(Vector2f offset);


    SFML_GRAPHICS_API Transform& rotate(Angle angle);


    SFML_GRAPHICS_API Transform& rotate(Angle angle, Vector2f center);


    constexpr Transform& scale(Vector2f factors);


    constexpr Transform& scale(Vector2f factors, Vector2f center);


    // Static member data

    // NOLINTNEXTLINE(readability-identifier-naming)

    static const Transform Identity;


private:

    // Member data

    // clang-format off

    std::array<float, 16> m_matrix{1.f, 0.f, 0.f, 0.f,

                                   0.f, 1.f, 0.f, 0.f,

                                   0.f, 0.f, 1.f, 0.f,

                                   0.f, 0.f, 0.f, 1.f};

    // clang-format off

};


[[nodiscard]] constexpr Transform operator*(const Transform& left, const Transform& right);


constexpr Transform& operator*=(Transform& left, const Transform& right);


[[nodiscard]] constexpr Vector2f operator*(const Transform& left, Vector2f right);


[[nodiscard]] constexpr bool operator==(const Transform& left, const Transform& right);


[[nodiscard]] constexpr bool operator!=(const Transform& left, const Transform& right);


} // namespace sf


#include <SFML/Graphics/Transform.inl>


Export.hpp

SFML_GRAPHICS_API
#define SFML_GRAPHICS_API
Definition Graphics/Export.hpp:42

Rect.hpp

Vector2.hpp

sf::Angle
Represents an angle value.
Definition Angle.hpp:35

sf::Transform::operator*
constexpr Vector2f operator*(const Transform &left, Vector2f right)
Overload of binary operator* to transform a point.

sf::Transform::operator*=
constexpr Transform & operator*=(Transform &left, const Transform &right)
Overload of binary operator*= to combine two transforms.

sf::Transform::Transform
constexpr Transform(float a00, float a01, float a02, float a10, float a11, float a12, float a20, float a21, float a22)
Construct a transform from a 3x3 matrix.

sf::Transform::transformPoint
constexpr Vector2f transformPoint(Vector2f point) const
Transform a 2D point.

sf::Transform::scale
constexpr Transform & scale(Vector2f factors, Vector2f center)
Combine the current transform with a scaling.

sf::Transform::operator!=
constexpr bool operator!=(const Transform &left, const Transform &right)
Overload of binary operator!= to compare two transforms.

sf::Transform::rotate
Transform & rotate(Angle angle)
Combine the current transform with a rotation.

sf::Transform::Transform
constexpr Transform()=default
Default constructor.

sf::Transform::transformRect
constexpr FloatRect transformRect(const FloatRect &rectangle) const
Transform a rectangle.

sf::Transform::translate
constexpr Transform & translate(Vector2f offset)
Combine the current transform with a translation.

sf::Transform::operator==
constexpr bool operator==(const Transform &left, const Transform &right)
Overload of binary operator== to compare two transforms.

sf::Transform::Identity
static const Transform Identity
The identity transform (does nothing)
Definition Transform.hpp:265

sf::Transform::scale
constexpr Transform & scale(Vector2f factors)
Combine the current transform with a scaling.

sf::Transform::rotate
Transform & rotate(Angle angle, Vector2f center)
Combine the current transform with a rotation.

sf::Transform::combine
constexpr Transform & combine(const Transform &transform)
Combine the current transform with another one.

sf::Transform::getInverse
constexpr Transform getInverse() const
Return the inverse of the transform.

sf::Transform::getMatrix
constexpr const float * getMatrix() const
Return the transform as a 4x4 matrix.

sf::Transform::operator*
constexpr Transform operator*(const Transform &left, const Transform &right)
Overload of binary operator* to combine two transforms.

sf
Definition AudioResource.hpp:36

sf::FloatRect
Rect< float > FloatRect
Definition Rect.hpp:147

sf::Vector2f
Vector2< float > Vector2f
Definition Vector2.hpp:210