SDL_ConvertPixels - Man Page
Copy a block of pixels of one format to another format.
Header File
Defined in SDL3/SDL_surface.h
Synopsis
#include "SDL3/SDL.h" 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
- width
the width of the block to copy, in pixels.
- height
the height of the block to copy, in pixels.
- src_format
an SDL_PixelFormat
value of the src pixels format.- src
a pointer to the source pixels.
- src_pitch
the pitch of the source pixels, in bytes.
- dst_format
an SDL_PixelFormat
value of the dst pixels format.- dst
a pointer to be filled in with new pixel data.
- dst_pitch
the pitch of the destination pixels, in bytes.
Return Value
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.
Availability
This function is available since SDL 3.2.0.
See Also
Referenced By
SDL_ConvertPixelsAndColorspace(3).
SDL 3.2.10 Simple Directmedia Layer SDL3 FUNCTIONS