plucky (3) SDL_LoadBMP.3.gz

NAME

       SDL_LoadBMP - Load a BMP image from a file.

HEADER FILE

       Defined in SDL3/SDL_surface.h

SYNOPSIS

       #include "SDL3/SDL.h"

       SDL_Surface * SDL_LoadBMP(const char *file);

DESCRIPTION

       The new surface should be freed with

       SDL_DestroySurface (). Not doing so will result in a memory leak.

FUNCTION PARAMETERS

       file   the BMP file to load.

RETURN VALUE

       ( SDL_Surface
        *) Returns a pointer to a new

       SDL_Surface
        structure or NULL on failure; call

       SDL_GetError () for more information.

AVAILABILITY

       This function is available since SDL 3.2.0.

SEE ALSO

       •(3), SDL_DestroySurface(3), •(3), SDL_LoadBMP_IO(3), •(3), SDL_SaveBMP(3)