SFML - Simple and Fast Multimedia Library

SFML 2.6.0

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

Loading...
Searching...
No Matches
Image.hpp
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2023 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
38namespace sf
39{
40class InputStream;
41
46 class SFML_GRAPHICS_API Image
47{
48public:
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
174 bool saveToMemory(std::vector<sf::Uint8>& output, const std::string& format) const;
175
182 Vector2u getSize() const;
183
195 void createMaskFromColor(const Color& color, Uint8 alpha = 0);
196
221 void copy(const Image& source, unsigned int destX, unsigned int destY, const IntRect& sourceRect = IntRect(0, 0, 0, 0), bool applyAlpha = false);
222
237 void setPixel(unsigned int x, unsigned int y, const Color& color);
238
254 Color getPixel(unsigned int x, unsigned int y) const;
255
269 const Uint8* getPixelsPtr() const;
270
275 void flipHorizontally();
276
281 void flipVertically();
282
283private:
284
286 // Member data
288 Vector2u m_size;
289 std::vector<Uint8> m_pixels;
290};
291
292} // namespace sf
293
294
295#endif // SFML_IMAGE_HPP
296
297
sf::Color
Utility class for manipulating RGBA colors.
Definition Color.hpp:41
sf::Image
Class for loading, manipulating and saving images.
Definition Image.hpp:47
sf::Image::~Image
~Image()
Destructor.
sf::Image::create
void create(unsigned int width, unsigned int height, const Uint8 *pixels)
Create the image from an array of pixels.
sf::Image::loadFromStream
bool loadFromStream(InputStream &stream)
Load the image from a custom stream.
sf::Image::createMaskFromColor
void createMaskFromColor(const Color &color, Uint8 alpha=0)
Create a transparency mask from a specified color-key.
sf::Image::create
void create(unsigned int width, unsigned int height, const Color &color=Color(0, 0, 0))
Create the image and fill it with a unique color.
sf::Image::getPixelsPtr
const Uint8 * getPixelsPtr() const
Get a read-only pointer to the array of pixels.
sf::Image::saveToFile
bool saveToFile(const std::string &filename) const
Save the image to a file on disk.
sf::Image::flipHorizontally
void flipHorizontally()
Flip the image horizontally (left <-> right)
sf::Image::flipVertically
void flipVertically()
Flip the image vertically (top <-> bottom)
sf::Image::getSize
Vector2u getSize() const
Return the size (width and height) of the image.
sf::Image::loadFromFile
bool loadFromFile(const std::string &filename)
Load the image from a file on disk.
sf::Image::setPixel
void setPixel(unsigned int x, unsigned int y, const Color &color)
Change the color of a pixel.
sf::Image::loadFromMemory
bool loadFromMemory(const void *data, std::size_t size)
Load the image from a file in memory.
sf::Image::copy
void copy(const Image &source, unsigned int destX, unsigned int destY, const IntRect &sourceRect=IntRect(0, 0, 0, 0), bool applyAlpha=false)
Copy pixels from another image onto this one.
sf::Image::Image
Image()
Default constructor.
sf::Image::getPixel
Color getPixel(unsigned int x, unsigned int y) const
Get the color of a pixel.
sf::Image::saveToMemory
bool saveToMemory(std::vector< sf::Uint8 > &output, const std::string &format) const
Save the image to a buffer in memory.
sf::InputStream
Abstract class for custom file input streams.
Definition InputStream.hpp:42
sf::Rect< int >
sf::Vector2< unsigned int >