Function SDL_PremultiplyAlpha

pub unsafe extern "C" fn SDL_PremultiplyAlpha(
    width: i32,
    height: i32,
    src_format: SDL_PixelFormat,
    src: *const c_void,
    src_pitch: i32,
    dst_format: SDL_PixelFormat,
    dst: *mut c_void,
    dst_pitch: i32,
    linear: bool,
) -> bool
Available on crate feature dep_sdl3 only.
Expand description

Premultiply the alpha on a block of pixels.

This is safe to use with src == dst, but not for other overlapping areas.

§Parameters

  • width: the width of the block to convert, in pixels.
  • height: the height of the block to convert, 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 premultiplied pixel data.
  • dst_pitch: the pitch of the destination pixels, in bytes.
  • linear: true to convert from sRGB to linear space for the alpha multiplication, false to do multiplication in sRGB space.

§Return value

Returns true on success or false on failure; call SDL_GetError() for more information.

§Availability

This function is available since SDL 3.2.0.