documentation/3.0.0/Sprite_8hpp_source.html

//

// SFML - Simple and Fast Multimedia Library

// Copyright (C) 2007-2024 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/Drawable.hpp>

#include <SFML/Graphics/Rect.hpp>

#include <SFML/Graphics/RenderStates.hpp>

#include <SFML/Graphics/Transformable.hpp>

#include <SFML/Graphics/Vertex.hpp>


#include <array>


namespace sf

{

class Texture;


class SFML_GRAPHICS_API Sprite : public Drawable, public Transformable

{

public:

    explicit Sprite(const Texture& texture);


    explicit Sprite(const Texture&& texture) = delete;


    Sprite(const Texture& texture, const IntRect& rectangle);


    Sprite(const Texture&& texture, const IntRect& rectangle) = delete;


    void setTexture(const Texture& texture, bool resetRect = false);


    void setTexture(const Texture&& texture, bool resetRect = false) = delete;


    void setTextureRect(const IntRect& rectangle);


    void setColor(Color color);


    [[nodiscard]] const Texture& getTexture() const;


    [[nodiscard]] const IntRect& getTextureRect() const;


    [[nodiscard]] Color getColor() const;


    [[nodiscard]] FloatRect getLocalBounds() const;


    [[nodiscard]] FloatRect getGlobalBounds() const;


private:

    void draw(RenderTarget& target, RenderStates states) const override;


    void updateVertices();


    // Member data

    std::array<Vertex, 4> m_vertices;

    const Texture*        m_texture;

    IntRect               m_textureRect;

};


} // namespace sf


Drawable.hpp

Export.hpp

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

Rect.hpp

RenderStates.hpp

Transformable.hpp

Vertex.hpp

sf::Color
Utility class for manipulating RGBA colors.
Definition Color.hpp:40

sf::Drawable
Abstract base class for objects that can be drawn to a render target.
Definition Drawable.hpp:44

sf::Drawable::RenderTarget
friend class RenderTarget
Definition Drawable.hpp:53

sf::Sprite::Sprite
Sprite(const Texture &texture, const IntRect &rectangle)
Construct the sprite from a sub-rectangle of a source texture.

sf::Sprite::getTexture
const Texture & getTexture() const
Get the source texture of the sprite.

sf::Sprite::Sprite
Sprite(const Texture &texture)
Construct the sprite from a source texture.

sf::Sprite::setColor
void setColor(Color color)
Set the global color of the sprite.

sf::Sprite::setTexture
void setTexture(const Texture &texture, bool resetRect=false)
Change the source texture of the sprite.

sf::Sprite::setTextureRect
void setTextureRect(const IntRect &rectangle)
Set the sub-rectangle of the texture that the sprite will display.

sf::Sprite::Sprite
Sprite(const Texture &&texture)=delete
Disallow construction from a temporary texture.

sf::Sprite::setTexture
void setTexture(const Texture &&texture, bool resetRect=false)=delete
Disallow setting from a temporary texture.

sf::Sprite::getColor
Color getColor() const
Get the global color of the sprite.

sf::Sprite::getGlobalBounds
FloatRect getGlobalBounds() const
Get the global bounding rectangle of the entity.

sf::Sprite::Sprite
Sprite(const Texture &&texture, const IntRect &rectangle)=delete
Disallow construction from a temporary texture.

sf::Sprite::getLocalBounds
FloatRect getLocalBounds() const
Get the local bounding rectangle of the entity.

sf::Sprite::getTextureRect
const IntRect & getTextureRect() const
Get the sub-rectangle of the texture displayed by the sprite.

sf::Texture
Image living on the graphics card that can be used for drawing.
Definition Texture.hpp:56

sf::Transformable::Transformable
Transformable()=default
Default constructor.

sf
Definition AudioResource.hpp:36

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

sf::IntRect
Rect< int > IntRect
Definition Rect.hpp:146

sf::RenderStates
Define the states used for drawing to a RenderTarget
Definition RenderStates.hpp:48