This is new wiki software and old wiki content. It's a work in progress!
Here's the explanation.
Be gentle, report bugs, leave feedback on pages, or just edit them yourself! Thanks!

SDL Wiki

SDL_LoadBMP

Load a BMP image from a file path.

Syntax

SDL_Surface* SDL_LoadBMP(const char* file)

Function Parameters

file

the file containing a BMP image

Return Value

Returns a pointer to a new SDL_Surface structure or NULL if there was an error; call SDL_GetError() for more information.

Remarks

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

SDL_LoadBMP is a pre-processor macro defined to call SDL_LoadBMP_RW() with an automatically closed file loaded by SDL_RWFromFile().

Code Examples

const char *image_path = "myimage.bmp";
SDL_Surface *image = SDL_LoadBMP(image_path);

/* Let the user know if the file failed to load */
if (!image) {
    printf("Failed to load image at %s: %s\n", image_path, SDL_GetError());
    return;
}

/* Do something with image here. */

/* Make sure to eventually release the surface resource */
SDL_FreeSurface(image);
SDL_FreeSurface
SDL_LoadBMP_RW
SDL_RWFromFile
SDL_SaveBMP

CategoryAPI, CategorySurface


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.