CSFML 2.6.1

- Main Page
- Related Pages
- Classes
- Files

- File List
- File Members

Loading...
Searching...
No Matches
Image.h
Go to the documentation of this file.
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2024 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_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/Buffer.h>
36#include <SFML/System/InputStream.h>
37#include <SFML/System/Vector2.h>
38#include <stddef.h>
39
40
52 CSFML_GRAPHICS_API sfImage* sfImage_create(unsigned int width, unsigned int height);
53
64 CSFML_GRAPHICS_API sfImage* sfImage_createFromColor(unsigned int width, unsigned int height, sfColor color);
65
81 CSFML_GRAPHICS_API sfImage* sfImage_createFromPixels(unsigned int width, unsigned int height, const sfUint8* pixels);
82
96 CSFML_GRAPHICS_API sfImage* sfImage_createFromFile(const char* filename);
97
112 CSFML_GRAPHICS_API sfImage* sfImage_createFromMemory(const void* data, size_t size);
113
127 CSFML_GRAPHICS_API sfImage* sfImage_createFromStream(sfInputStream* stream);
128
137 CSFML_GRAPHICS_API sfImage* sfImage_copy(const sfImage* image);
138
145 CSFML_GRAPHICS_API void sfImage_destroy(sfImage* image);
146
163 CSFML_GRAPHICS_API sfBool sfImage_saveToFile(const sfImage* image, const char* filename);
164
182 CSFML_GRAPHICS_API sfBool sfImage_saveToMemory(const sfImage* image, sfBuffer* output, const char* format);
183
192 CSFML_GRAPHICS_API sfVector2u sfImage_getSize(const sfImage* image);
193
206 CSFML_GRAPHICS_API void sfImage_createMaskFromColor(sfImage* image, sfColor color, sfUint8 alpha);
207
229 CSFML_GRAPHICS_API void sfImage_copyImage(sfImage* image, const sfImage* source, unsigned int destX, unsigned int destY, sfIntRect sourceRect, sfBool applyAlpha);
230
244 CSFML_GRAPHICS_API void sfImage_setPixel(sfImage* image, unsigned int x, unsigned int y, sfColor color);
245
260 CSFML_GRAPHICS_API sfColor sfImage_getPixel(const sfImage* image, unsigned int x, unsigned int y);
261
277 CSFML_GRAPHICS_API const sfUint8* sfImage_getPixelsPtr(const sfImage* image);
278
285 CSFML_GRAPHICS_API void sfImage_flipHorizontally(sfImage* image);
286
293 CSFML_GRAPHICS_API void sfImage_flipVertically(sfImage* image);
294
295
296#endif // SFML_IMAGE_H
Buffer.h
Color.h
sfBool
int sfBool
Definition Config.h:153
sfUint8
unsigned char sfUint8
Definition Config.h:168
Export.h
CSFML_GRAPHICS_API
#define CSFML_GRAPHICS_API
Definition Graphics/Export.h:43
Types.h
sfImage
struct sfImage sfImage
Definition Graphics/Types.h:32
sfImage_create
sfImage * sfImage_create(unsigned int width, unsigned int height)
Create an image.
sfImage_createFromPixels
sfImage * sfImage_createFromPixels(unsigned int width, unsigned int height, const sfUint8 *pixels)
Create an image from an array of pixels.
sfImage_flipHorizontally
void sfImage_flipHorizontally(sfImage *image)
Flip an image horizontally (left <-> right)
sfImage_createFromStream
sfImage * sfImage_createFromStream(sfInputStream *stream)
Create an image from a custom stream.
sfImage_saveToFile
sfBool sfImage_saveToFile(const sfImage *image, const char *filename)
Save an image to a file on disk.
sfImage_getPixelsPtr
const sfUint8 * sfImage_getPixelsPtr(const sfImage *image)
Get a read-only pointer to the array of pixels of an image.
sfImage_getSize
sfVector2u sfImage_getSize(const sfImage *image)
Return the size of an image.
sfImage_setPixel
void sfImage_setPixel(sfImage *image, unsigned int x, unsigned int y, sfColor color)
Change the color of a pixel in an image.
sfImage_saveToMemory
sfBool sfImage_saveToMemory(const sfImage *image, sfBuffer *output, const char *format)
Save the image to a buffer in memory.
sfImage_createFromColor
sfImage * sfImage_createFromColor(unsigned int width, unsigned int height, sfColor color)
Create an image and fill it with a unique color.
sfImage_createFromFile
sfImage * sfImage_createFromFile(const char *filename)
Create an image from a file on disk.
sfImage_getPixel
sfColor sfImage_getPixel(const sfImage *image, unsigned int x, unsigned int y)
Get the color of a pixel in an image.
sfImage_flipVertically
void sfImage_flipVertically(sfImage *image)
Flip an image vertically (top <-> bottom)
sfImage_copy
sfImage * sfImage_copy(const sfImage *image)
Copy an existing image.
sfImage_copyImage
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_destroy
void sfImage_destroy(sfImage *image)
Destroy an existing image.
sfImage_createFromMemory
sfImage * sfImage_createFromMemory(const void *data, size_t size)
Create an image from a file in memory.
sfImage_createMaskFromColor
void sfImage_createMaskFromColor(sfImage *image, sfColor color, sfUint8 alpha)
Create a transparency mask from a specified color-key.
InputStream.h
Rect.h
sfBuffer
struct sfBuffer sfBuffer
Definition System/Types.h:29
Vector2.h
sfColor
Utility class for manpulating RGBA colors.
Definition Color.h:39
sfInputStream
Set of callbacks that allow users to define custom file streams.
Definition InputStream.h:45
sfIntRect
Definition Rect.h:49
sfVector2u
2-component vector of unsigned integers
Definition Vector2.h:50