SDL_ConvertPixels

Copy a block of pixels of one format to another format.

Header File

Syntax

bool SDL_ConvertPixels(int width, int height, SDL_PixelFormat src_format, const void *src, int src_pitch, SDL_PixelFormat dst_format, void *dst, int dst_pitch);

Function Parameters

int	width	the width of the block to copy, in pixels.
int	height	the height of the block to copy, in pixels.
SDL_PixelFormat	src_format	an SDL_PixelFormat value of the `src` pixels format.
const void *	src	a pointer to the source pixels.
int	src_pitch	the pitch of the source pixels, in bytes.
SDL_PixelFormat	dst_format	an SDL_PixelFormat value of the `dst` pixels format.
void *	dst	a pointer to be filled in with new pixel data.
int	dst_pitch	the pitch of the destination pixels, in bytes.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Thread Safety

The same destination pixels should not be used from two threads at once. It is safe to use the same source pixels from multiple threads.

Version

This function is available since SDL 3.2.0.