encounter
/
SDL
mirror of https://github.com/encounter/SDL.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Sync wiki -> header

This commit is contained in:
SDL Wiki Bot 2021-09-26 02:32:05 +00:00
parent 7becc41495
commit 7a1690eb63
1 changed files with 0 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
include/SDL_surface.h
View File

@ -312,29 +312,6 @@ extern DECLSPEC void SDLCALL SDL_UnlockSurface(SDL_Surface * surface);
* Alternitavely, you might also use the macro SDL_LoadBMP to load a bitmap * 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. * from a file, convert it to an SDL_Surface and then close the file.
* *
* === Code Example ===
*
* ```c++
* const char *image_path = "myimage.bmp";
*
* /* "rb" will "read binary" files */
* SDL_RWops *file = SDL_RWFromFile(image_path, "rb");
*
* /* freesrc is true so the file automatically closes */
* SDL_Surface *image = SDL_LoadBMP_RW(file, SDL_TRUE);
*
* /* 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);
* ```
*
* \param src the data stream for the surface * \param src the data stream for the surface
* \param freesrc non-zero to close the stream after being read * \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 * \returns a pointer to a new SDL_Surface structure or NULL if there was an