Function sdl2_sys::SDL_LoadBMP_RW

source ยท 
pub unsafe extern "C" fn SDL_LoadBMP_RW(
    src: *mut SDL_RWops,
    freesrc: c_int,
) -> *mut SDL_Surface
Expand description

Load a BMP image from a seekable SDL data stream.

The new surface should be freed with SDL_FreeSurface(). Not doing so will result in a memory leak.

src is an open SDL_RWops buffer, typically loaded with SDL_RWFromFile. Alternitavely, you might also use the macro SDL_LoadBMP to load a bitmap from a file, convert it to an SDL_Surface and then close the file.

\param src the data stream for the surface \param freesrc non-zero to close the stream after being read \returns a pointer to a new SDL_Surface structure or NULL if there was an error; call SDL_GetError() for more information.

\since This function is available since SDL 2.0.0.

\sa SDL_FreeSurface \sa SDL_RWFromFile \sa SDL_LoadBMP \sa SDL_SaveBMP_RW