Documentation of SFML 1.6

Warning: this page refers to an old version of SFML. Click here to switch to the latest version.
Sprite.hpp
1 
2 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2009 Laurent Gomila (laurent.gom@gmail.com)
5 //
6 // This software is provided 'as-is', without any express or implied warranty.
7 // In no event will the authors be held liable for any damages arising from the use of this software.
8 //
9 // Permission is granted to anyone to use this software for any purpose,
10 // including commercial applications, and to alter it and redistribute it freely,
11 // subject to the following restrictions:
12 //
13 // 1. The origin of this software must not be misrepresented;
14 // you must not claim that you wrote the original software.
15 // If you use this software in a product, an acknowledgment
16 // in the product documentation would be appreciated but is not required.
17 //
18 // 2. Altered source versions must be plainly marked as such,
19 // and must not be misrepresented as being the original software.
20 //
21 // 3. This notice may not be removed or altered from any source distribution.
22 //
24 
25 #ifndef SFML_SPRITE_HPP
26 #define SFML_SPRITE_HPP
27 
29 // Headers
31 #include <SFML/System/Resource.hpp>
32 #include <SFML/Graphics/Drawable.hpp>
33 #include <SFML/Graphics/Rect.hpp>
34 
35 
36 namespace sf
37 {
38 class Image;
39 
44 class SFML_API Sprite : public Drawable
45 {
46 public :
47 
52  Sprite();
53 
64  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));
65 
72  void SetImage(const Image& Img);
73 
81  void SetSubRect(const IntRect& SubRect);
82 
91  void Resize(float Width, float Height);
92 
100  void Resize(const Vector2f& Size);
101 
108  void FlipX(bool Flipped);
109 
116  void FlipY(bool Flipped);
117 
124  const Image* GetImage() const;
125 
132  const IntRect& GetSubRect() const;
133 
140  Vector2f GetSize() const;
141 
152  Color GetPixel(unsigned int X, unsigned int Y) const;
153 
154 protected :
155 
160  virtual void Render(RenderTarget& Target) const;
161 
162 private :
163 
165  // Member data
167  ResourcePtr<Image> myImage;
168  IntRect mySubRect;
169  bool myIsFlippedX;
170  bool myIsFlippedY;
171 };
172 
173 } // namespace sf
174 
175 
176 #endif // SFML_SPRITE_HPP