Documentation of SFML 2.5.1

Image.hpp
1 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
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_IMAGE_HPP
26 #define SFML_IMAGE_HPP
27 
29 // Headers
31 #include <SFML/Graphics/Export.hpp>
32 #include <SFML/Graphics/Color.hpp>
33 #include <SFML/Graphics/Rect.hpp>
34 #include <string>
35 #include <vector>
36 
37 
38 namespace sf
39 {
40 class InputStream;
41 
46 class SFML_GRAPHICS_API Image
47 {
48 public:
49 
56  Image();
57 
62  ~Image();
63 
72  void create(unsigned int width, unsigned int height, const Color& color = Color(0, 0, 0));
73 
87  void create(unsigned int width, unsigned int height, const Uint8* pixels);
88 
104  bool loadFromFile(const std::string& filename);
105 
122  bool loadFromMemory(const void* data, std::size_t size);
123 
139  bool loadFromStream(InputStream& stream);
140 
156  bool saveToFile(const std::string& filename) const;
157 
164  Vector2u getSize() const;
165 
177  void createMaskFromColor(const Color& color, Uint8 alpha = 0);
178 
199  void copy(const Image& source, unsigned int destX, unsigned int destY, const IntRect& sourceRect = IntRect(0, 0, 0, 0), bool applyAlpha = false);
200 
215  void setPixel(unsigned int x, unsigned int y, const Color& color);
216 
232  Color getPixel(unsigned int x, unsigned int y) const;
233 
247  const Uint8* getPixelsPtr() const;
248 
253  void flipHorizontally();
254 
259  void flipVertically();
260 
261 private:
262 
264  // Member data
266  Vector2u m_size;
267  std::vector<Uint8> m_pixels;
268 };
269 
270 } // namespace sf
271 
272 
273 #endif // SFML_IMAGE_HPP
274 
275 
Utility class for manipulating RGBA colors.
Definition: Color.hpp:40
Abstract class for custom file input streams.
Definition: InputStream.hpp:41
Class for loading, manipulating and saving images.
Definition: Image.hpp:46