documentation/1.6/Sprite_8hpp_source.html

//

// SFML - Simple and Fast Multimedia Library

// Copyright (C) 2007-2009 Laurent Gomila (laurent.gom@gmail.com)

//

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

//


#ifndef SFML_SPRITE_HPP

#define SFML_SPRITE_HPP


// Headers

#include <SFML/System/Resource.hpp>

#include <SFML/Graphics/Drawable.hpp>

#include <SFML/Graphics/Rect.hpp>


namespace sf

{

class Image;


class SFML_API Sprite : public Drawable

{

public :


    Sprite();


    explicit Sprite(const Image& Img, const Vector2f& Position = Vector2f(0, 0), const Vector2f& Scale = Vector2f(1, 1), float Rotation = 0.f, const Color& Col = Color(255, 255, 255, 255));


    void SetImage(const Image& Img);


    void SetSubRect(const IntRect& SubRect);


    void Resize(float Width, float Height);


    void Resize(const Vector2f& Size);


    void FlipX(bool Flipped);


    void FlipY(bool Flipped);


    const Image* GetImage() const;


    const IntRect& GetSubRect() const;


    Vector2f GetSize() const;


    Color GetPixel(unsigned int X, unsigned int Y) const;


protected :


    virtual void Render(RenderTarget& Target) const;


private :


    // Member data

    ResourcePtr<Image> myImage;

    IntRect            mySubRect;

    bool               myIsFlippedX;

    bool               myIsFlippedY;

};


} // namespace sf


#endif // SFML_SPRITE_HPP

SFML_API
#define SFML_API
Definition Config.hpp:114

Drawable.hpp

Rect.hpp

Resource.hpp

sf::Color
Color is an utility class for manipulating 32-bits RGBA colors.
Definition Color.hpp:41

sf::Drawable::Scale
void Scale(float FactorX, float FactorY)
Scale the object (take 2 values).

sf::Drawable::Drawable
Drawable(const Vector2f &Position=Vector2f(0, 0), const Vector2f &Scale=Vector2f(1, 1), float Rotation=0.f, const Color &Col=Color(255, 255, 255, 255))
Default constructor.

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

sf::Image
Image is the low-level class for loading and manipulating images.
Definition Image.hpp:47

sf::ResourcePtr
Safe pointer to a T resource (inheriting from sf::Resource<T>), its pointer is automatically reseted ...
Definition Resource.hpp:117

sf::Sprite::GetPixel
Color GetPixel(unsigned int X, unsigned int Y) const
Get the color of a given pixel in the sprite (point is in local coordinates).

sf::Sprite::FlipX
void FlipX(bool Flipped)
Flip the sprite horizontally.

sf::Sprite::SetImage
void SetImage(const Image &Img)
Change the image of the sprite.

sf::Sprite::Resize
void Resize(float Width, float Height)
Resize the sprite (by changing its scale factors) (take 2 values).

sf::Sprite::SetSubRect
void SetSubRect(const IntRect &SubRect)
Set the sub-rectangle of the sprite inside the source image.

sf::Sprite::GetImage
const Image * GetImage() const
Get the source image of the sprite.

sf::Sprite::Render
virtual void Render(RenderTarget &Target) const
/see Drawable::Render

sf::Sprite::Sprite
Sprite(const Image &Img, const Vector2f &Position=Vector2f(0, 0), const Vector2f &Scale=Vector2f(1, 1), float Rotation=0.f, const Color &Col=Color(255, 255, 255, 255))
Construct the sprite from a source image.

sf::Sprite::GetSubRect
const IntRect & GetSubRect() const
Get the sub-rectangle of the sprite inside the source image.

sf::Sprite::Resize
void Resize(const Vector2f &Size)
Resize the sprite (by changing its scale factors) (take a 2D vector).

sf::Sprite::FlipY
void FlipY(bool Flipped)
Flip the sprite vertically.

sf::Sprite::Sprite
Sprite()
Default constructor.

sf::Sprite::GetSize
Vector2f GetSize() const
Get the sprite size.

sf
Definition AudioResource.hpp:35

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

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