(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_ConvertPixelsAndColorspace

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

Header File

Syntax

bool SDL_ConvertPixelsAndColorspace(int width, int height, SDL_PixelFormat src_format, SDL_Colorspace src_colorspace, SDL_PropertiesID src_properties, const void *src, int src_pitch, SDL_PixelFormat dst_format, SDL_Colorspace dst_colorspace, SDL_PropertiesID dst_properties, 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.
SDL_Colorspace	src_colorspace	an SDL_ColorSpace value describing the colorspace of the `src` pixels.
SDL_PropertiesID	src_properties	an SDL_PropertiesID with additional source color properties, or 0.
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.
SDL_Colorspace	dst_colorspace	an SDL_ColorSpace value describing the colorspace of the `dst` pixels.
SDL_PropertiesID	dst_properties	an SDL_PropertiesID with additional destination color properties, or 0.
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 false on success or false on failure; call SDL_GetError() for more information.

Version

This function is available since SDL 3.1.3.