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

SDL_ConvertPixels

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

Header File

Defined in <SDL3/SDL_surface.h>

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 false on success or false on failure; call SDL_GetError() for more information.

Version

This function is available since SDL 3.1.3.

See Also


CategoryAPI, CategoryAPIFunction, CategorySurface


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.