Function sdl2_sys::SDL_SetColorKey

source ·

pub unsafe extern "C" fn SDL_SetColorKey(
    surface: *mut SDL_Surface,
    flag: c_int,
    key: Uint32
) -> c_int

Expand description

Set the color key (transparent pixel) in a surface.

The color key defines a pixel value that will be treated as transparent in a blit. For example, one can use this to specify that cyan pixels should be considered transparent, and therefore not rendered.

It is a pixel of the format used by the surface, as generated by SDL_MapRGB().

RLE acceleration can substantially speed up blitting of images with large horizontal runs of transparent pixels. See SDL_SetSurfaceRLE() for details.

\param surface the SDL_Surface structure to update \param flag SDL_TRUE to enable color key, SDL_FALSE to disable color key \param key the transparent pixel \returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

\since This function is available since SDL 2.0.0.

\sa SDL_BlitSurface \sa SDL_GetColorKey