SDL_ConvertPixelsAndColorspace

Function SDL_ConvertPixelsAndColorspace 

Source
pub unsafe extern "C" fn SDL_ConvertPixelsAndColorspace(
    width: c_int,
    height: c_int,
    src_format: SDL_PixelFormat,
    src_colorspace: SDL_Colorspace,
    src_properties: SDL_PropertiesID,
    src: *const c_void,
    src_pitch: c_int,
    dst_format: SDL_PixelFormat,
    dst_colorspace: SDL_Colorspace,
    dst_properties: SDL_PropertiesID,
    dst: *mut c_void,
    dst_pitch: c_int,
) -> bool
Expand description

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

§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_colorspace: an SDL_Colorspace value describing the colorspace of the src pixels.
  • src_properties: an SDL_PropertiesID with additional source color properties, or 0.
  • 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_colorspace: an SDL_Colorspace value describing the colorspace of the dst pixels.
  • dst_properties: an SDL_PropertiesID with additional destination color properties, or 0.
  • 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