SDL_ConvertPixels

Function SDL_ConvertPixels 

Source
pub unsafe extern "C" fn SDL_ConvertPixels(
    width: c_int,
    height: c_int,
    src_format: SDL_PixelFormat,
    src: *const c_void,
    src_pitch: c_int,
    dst_format: SDL_PixelFormat,
    dst: *mut c_void,
    dst_pitch: c_int,
) -> bool
Expand description

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

§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