#include <SFML/Graphics/Export.h>
#include <SFML/Graphics/Color.h>
#include <SFML/Graphics/Rect.h>
#include <SFML/Graphics/Types.h>
#include <SFML/System/Buffer.h>
#include <SFML/System/InputStream.h>
#include <SFML/System/Vector2.h>
#include <stddef.h>

Functions
sfImage *	sfImage_create (unsigned int width, unsigned int height)
	Create an image.

sfImage *	sfImage_createFromColor (unsigned int width, unsigned int height, sfColor color)
	Create an image and fill it with a unique color.

sfImage *	sfImage_createFromPixels (unsigned int width, unsigned int height, const sfUint8 *pixels)
	Create an image from an array of pixels.

sfImage *	sfImage_createFromFile (const char *filename)
	Create an image from a file on disk.

sfImage *	sfImage_createFromMemory (const void *data, size_t size)
	Create an image from a file in memory.

sfImage *	sfImage_createFromStream (sfInputStream *stream)
	Create an image from a custom stream.

sfImage *	sfImage_copy (const sfImage *image)
	Copy an existing image.

void	sfImage_destroy (sfImage *image)
	Destroy an existing image.

sfBool	sfImage_saveToFile (const sfImage image, const char filename)
	Save an image to a file on disk.

sfBool	sfImage_saveToMemory (const sfImage image, sfBuffer output, const char *format)
	Save the image to a buffer in memory.

sfVector2u	sfImage_getSize (const sfImage *image)
	Return the size of an image.

void	sfImage_createMaskFromColor (sfImage *image, sfColor color, sfUint8 alpha)
	Create a transparency mask from a specified color-key.

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.

void	sfImage_setPixel (sfImage *image, unsigned int x, unsigned int y, sfColor color)
	Change the color of a pixel in an image.

sfColor	sfImage_getPixel (const sfImage *image, unsigned int x, unsigned int y)
	Get the color of a pixel in an image.

const sfUint8 *	sfImage_getPixelsPtr (const sfImage *image)
	Get a read-only pointer to the array of pixels of an image.

void	sfImage_flipHorizontally (sfImage *image)
	Flip an image horizontally (left <-> right)

void	sfImage_flipVertically (sfImage *image)
	Flip an image vertically (top <-> bottom)

Function Documentation

◆ sfImage_copy()

sfImage * sfImage_copy ( const sfImage * image )

Copy an existing image.

Parameters

image Image to copy

Returns: Copied object

◆ 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.

This function does a slow pixel copy and should not be used intensively. It can be used to prepare a complex static image from several others, but if you need this kind of feature in real-time you'd better use sfRenderTexture.

If sourceRect is empty, the whole image is copied. If applyAlpha is set to true, the transparency of source pixels is applied. If it is false, the pixels are copied unchanged with their alpha value.

Parameters

image	Image object
source	Source image to copy
destX	X coordinate of the destination position
destY	Y coordinate of the destination position
sourceRect	Sub-rectangle of the source image to copy
applyAlpha	Should the copy take in account the source transparency?

◆ sfImage_create()

sfImage * sfImage_create	(	unsigned int	width,
		unsigned int	height
	)

Create an image.

This image is filled with black pixels.

Parameters

width	Width of the image
height	Height of the image

Returns: A new sfImage object

◆ sfImage_createFromColor()

sfImage * sfImage_createFromColor	(	unsigned int	width,
		unsigned int	height,
		sfColor	color
	)

Create an image and fill it with a unique color.

Parameters

width	Width of the image
height	Height of the image
color	Fill color

Returns: A new sfImage object

◆ sfImage_createFromFile()

sfImage * sfImage_createFromFile ( const char * filename )

Create an image from a file on disk.

The supported image formats are bmp, png, tga, jpg, gif, psd, hdr and pic. Some format options are not supported, like progressive jpeg. If this function fails, the image is left unchanged.

Parameters

filename Path of the image file to load

Returns: A new sfImage object, or NULL if it failed

◆ sfImage_createFromMemory()

sfImage * sfImage_createFromMemory	(	const void *	data,
		size_t	size
	)

Create an image from a file in memory.

The supported image formats are bmp, png, tga, jpg, gif, psd, hdr and pic. Some format options are not supported, like progressive jpeg. If this function fails, the image is left unchanged.

Parameters

data	Pointer to the file data in memory
size	Size of the data to load, in bytes

Returns: A new sfImage object, or NULL if it failed

◆ sfImage_createFromPixels()

sfImage * sfImage_createFromPixels	(	unsigned int	width,
		unsigned int	height,
		const sfUint8 *	pixels
	)

Create an image from an array of pixels.

The pixel array is assumed to contain 32-bits RGBA pixels, and have the given width and height. If not, this is an undefined behaviour. If pixels is null, an empty image is created.

Parameters

width	Width of the image
height	Height of the image
pixels	Array of pixels to copy to the image

Returns: A new sfImage object

◆ sfImage_createFromStream()

sfImage * sfImage_createFromStream ( sfInputStream * stream )

Create an image from a custom stream.

The supported image formats are bmp, png, tga, jpg, gif, psd, hdr and pic. Some format options are not supported, like progressive jpeg. If this function fails, the image is left unchanged.

Parameters

stream Source stream to read from

Returns: A new sfImage object, or NULL if it failed

◆ sfImage_createMaskFromColor()

void sfImage_createMaskFromColor	(	sfImage *	image,
		sfColor	color,
		sfUint8	alpha
	)

Create a transparency mask from a specified color-key.

This function sets the alpha value of every pixel matching the given color to alpha (0 by default), so that they become transparent.

Parameters

image	Image object
color	Color to make transparent
alpha	Alpha value to assign to transparent pixels

◆ sfImage_destroy()

void sfImage_destroy ( sfImage * image )

Destroy an existing image.

Parameters

image Image to delete

◆ sfImage_flipHorizontally()

void sfImage_flipHorizontally ( sfImage * image )

Flip an image horizontally (left <-> right)

Parameters

image Image object

◆ sfImage_flipVertically()

void sfImage_flipVertically ( sfImage * image )

Flip an image vertically (top <-> bottom)

Parameters

image Image object

◆ sfImage_getPixel()

sfColor sfImage_getPixel	(	const sfImage *	image,
		unsigned int	x,
		unsigned int	y
	)

Get the color of a pixel in an image.

This function doesn't check the validity of the pixel coordinates, using out-of-range values will result in an undefined behaviour.

Parameters

image	Image object
x	X coordinate of pixel to get
y	Y coordinate of pixel to get

Returns: Color of the pixel at coordinates (x, y)

◆ sfImage_getPixelsPtr()

const sfUint8 * sfImage_getPixelsPtr ( const sfImage * image )

Get a read-only pointer to the array of pixels of an image.

The returned value points to an array of RGBA pixels made of 8 bits integers components. The size of the array is getWidth() * getHeight() * 4. Warning: the returned pointer may become invalid if you modify the image, so you should never store it for too long. If the image is empty, a null pointer is returned.

Parameters

image Image object

Returns: Read-only pointer to the array of pixels

◆ sfImage_getSize()

sfVector2u sfImage_getSize ( const sfImage * image )

Return the size of an image.

Parameters

image Image object

Returns: Size in pixels

◆ sfImage_saveToFile()

sfBool sfImage_saveToFile	(	const sfImage *	image,
		const char *	filename
	)

Save an image to a file on disk.

The format of the image is automatically deduced from the extension. The supported image formats are bmp, png, tga and jpg. The destination file is overwritten if it already exists. This function fails if the image is empty.

Parameters

image	Image object
filename	Path of the file to save

Returns: sfTrue if saving was successful

See also: sfImage_saveToMemory

◆ sfImage_saveToMemory()

sfBool sfImage_saveToMemory	(	const sfImage *	image,
		sfBuffer *	output,
		const char *	format
	)

Save the image to a buffer in memory.

The format of the image must be specified. The supported image formats are bmp, png, tga and jpg. This function fails if the image is empty, or if the format was invalid.

Parameters

image	Image object
output	Buffer to fill with encoded data
format	Encoding format to use

Returns: sfTrue if saving was successful

See also: sfImage_saveToFile

◆ sfImage_setPixel()

void sfImage_setPixel	(	sfImage *	image,
		unsigned int	x,
		unsigned int	y,
		sfColor	color
	)

Change the color of a pixel in an image.

This function doesn't check the validity of the pixel coordinates, using out-of-range values will result in an undefined behaviour.

Parameters

image	Image object
x	X coordinate of pixel to change
y	Y coordinate of pixel to change
color	New color of the pixel

Functions

Function Documentation

◆ sfImage_copy()

◆ sfImage_copyImage()

◆ sfImage_create()

◆ sfImage_createFromColor()

◆ sfImage_createFromFile()

◆ sfImage_createFromMemory()

◆ sfImage_createFromPixels()

◆ sfImage_createFromStream()

◆ sfImage_createMaskFromColor()

◆ sfImage_destroy()

◆ sfImage_flipHorizontally()

◆ sfImage_flipVertically()

◆ sfImage_getPixel()

◆ sfImage_getPixelsPtr()

◆ sfImage_getSize()

◆ sfImage_saveToFile()

◆ sfImage_saveToMemory()

◆ sfImage_setPixel()