CSFML

- Main Page
- Data Structures
- Files

- File List
- Globals

Image.h
Go to the documentation of this file.
1 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2013 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_IMAGE_H
26 #define SFML_IMAGE_H
27
29 // Headers
31 #include <SFML/Graphics/Export.h>
32 #include <SFML/Graphics/Color.h>
33 #include <SFML/Graphics/Rect.h>
34 #include <SFML/Graphics/Types.h>
35 #include <SFML/System/InputStream.h>
36 #include <SFML/System/Vector2.h>
37 #include <stddef.h>
38
39
51 CSFML_GRAPHICS_API sfImage* sfImage_create(unsigned int width, unsigned int height);
52
63 CSFML_GRAPHICS_API sfImage* sfImage_createFromColor(unsigned int width, unsigned int height, sfColor color);
64
80 CSFML_GRAPHICS_API sfImage* sfImage_createFromPixels(unsigned int width, unsigned int height, const sfUint8* pixels);
81
95 CSFML_GRAPHICS_API sfImage* sfImage_createFromFile(const char* filename);
96
111 CSFML_GRAPHICS_API sfImage* sfImage_createFromMemory(const void* data, size_t size);
112
126 CSFML_GRAPHICS_API sfImage* sfImage_createFromStream(sfInputStream* stream);
127
136 CSFML_GRAPHICS_API sfImage* sfImage_copy(const sfImage* image);
137
144 CSFML_GRAPHICS_API void sfImage_destroy(sfImage* image);
145
160 CSFML_GRAPHICS_API sfBool sfImage_saveToFile(const sfImage* image, const char* filename);
161
170 CSFML_GRAPHICS_API sfVector2u sfImage_getSize(const sfImage* image);
171
184 CSFML_GRAPHICS_API void sfImage_createMaskFromColor(sfImage* image, sfColor color, sfUint8 alpha);
185
207 CSFML_GRAPHICS_API void sfImage_copyImage(sfImage* image, const sfImage* source, unsigned int destX, unsigned int destY, sfIntRect sourceRect, sfBool applyAlpha);
208
222 CSFML_GRAPHICS_API void sfImage_setPixel(sfImage* image, unsigned int x, unsigned int y, sfColor color);
223
238 CSFML_GRAPHICS_API sfColor sfImage_getPixel(const sfImage* image, unsigned int x, unsigned int y);
239
255 CSFML_GRAPHICS_API const sfUint8* sfImage_getPixelsPtr(const sfImage* image);
256
263 CSFML_GRAPHICS_API void sfImage_flipHorizontally(sfImage* image);
264
271 CSFML_GRAPHICS_API void sfImage_flipVertically(sfImage* image);
272
273
274 #endif // SFML_IMAGE_H
CSFML_GRAPHICS_API
#define CSFML_GRAPHICS_API
Definition: Graphics/Export.h:43
sfImage_createFromPixels
CSFML_GRAPHICS_API sfImage * sfImage_createFromPixels(unsigned int width, unsigned int height, const sfUint8 *pixels)
Create an image from an array of pixels.
sfIntRect
Definition: Rect.h:46
sfImage_flipVertically
CSFML_GRAPHICS_API void sfImage_flipVertically(sfImage *image)
Flip an image vertically (top <-> bottom)
sfImage_createFromMemory
CSFML_GRAPHICS_API sfImage * sfImage_createFromMemory(const void *data, size_t size)
Create an image from a file in memory.
Export.h
sfImage_copyImage
CSFML_GRAPHICS_API void sfImage_copyImage(sfImage *image, const sfImage *source, unsigned int destX, unsigned int destY, sfIntRect sourceRect, sfBool applyAlpha)
Copy pixels from an image onto another.
sfImage_createMaskFromColor
CSFML_GRAPHICS_API void sfImage_createMaskFromColor(sfImage *image, sfColor color, sfUint8 alpha)
Create a transparency mask from a specified color-key.
sfImage_getPixel
CSFML_GRAPHICS_API sfColor sfImage_getPixel(const sfImage *image, unsigned int x, unsigned int y)
Get the color of a pixel in an image.
sfInputStream
Set of callbacks that allow users to define custom file streams.
Definition: InputStream.h:44
sfImage_createFromFile
CSFML_GRAPHICS_API sfImage * sfImage_createFromFile(const char *filename)
Create an image from a file on disk.
InputStream.h
sfImage_getSize
CSFML_GRAPHICS_API sfVector2u sfImage_getSize(const sfImage *image)
Return the size of an image.
sfBool
int sfBool
Definition: Config.h:106
sfImage_createFromStream
CSFML_GRAPHICS_API sfImage * sfImage_createFromStream(sfInputStream *stream)
Create an image from a custom stream.
sfVector2u
2-component vector of unsigned integers
Definition: Vector2.h:49
sfColor
Utility class for manpulating RGBA colors.
Definition: Color.h:38
Vector2.h
sfImage_flipHorizontally
CSFML_GRAPHICS_API void sfImage_flipHorizontally(sfImage *image)
Flip an image horizontally (left <-> right)
sfImage_getPixelsPtr
CSFML_GRAPHICS_API const sfUint8 * sfImage_getPixelsPtr(const sfImage *image)
Get a read-only pointer to the array of pixels of an image.
sfImage
struct sfImage sfImage
Definition: Graphics/Types.h:32
sfImage_saveToFile
CSFML_GRAPHICS_API sfBool sfImage_saveToFile(const sfImage *image, const char *filename)
Save an image to a file on disk.
Types.h
Color.h
sfUint8
unsigned char sfUint8
Definition: Config.h:121
sfImage_createFromColor
CSFML_GRAPHICS_API sfImage * sfImage_createFromColor(unsigned int width, unsigned int height, sfColor color)
Create an image and fill it with a unique color.
sfImage_create
CSFML_GRAPHICS_API sfImage * sfImage_create(unsigned int width, unsigned int height)
Create an image.
Rect.h
sfImage_setPixel
CSFML_GRAPHICS_API void sfImage_setPixel(sfImage *image, unsigned int x, unsigned int y, sfColor color)
Change the color of a pixel in an image.
sfImage_copy
CSFML_GRAPHICS_API sfImage * sfImage_copy(const sfImage *image)
Copy an existing image.
sfImage_destroy
CSFML_GRAPHICS_API void sfImage_destroy(sfImage *image)
Destroy an existing image.