|
Size: 864
Comment: update content - standard return value
|
← Revision 9 as of 2020-07-24 17:18:55 ⇥
Size: 1250
Comment: Typo fix
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 3: | Line 3: |
| ||<tablewidth="100%" style="color: #FF0000;" :> DRAFT|| | |
| Line 6: | Line 5: |
| Use this function to save a surface to a file. | Use this function to save a surface to a BMP file. |
| Line 17: | Line 16: |
| ||'''surface'''||^a pointer to the [[SDL_Surface]] to save^|| ||'''file'''||^a pointer to the file to fill with the surface data^|| |
||'''surface'''||the [[SDL_Surface]] structure containing the image to be saved|| ||'''file'''||the file to be saved to|| |
| Line 25: | Line 24: |
| You can add your code example here | ... SDL_Surface *sfc = ... ... if(SDL_SaveBMP(sfc, "somefile.bmp") != 0) { // Error saving bitmap printf("SDL_SaveBMP failed: %s\n", SDL_GetError()); } |
| Line 29: | Line 39: |
| ''You can add useful comments here'' | Surfaces with a 24-bit, 32-bit and paletted 8-bit format get saved in the BMP directly. Other RGB formats with 8-bit or higher get converted to a 24-bit surface or, if they have an alpha mask or a colorkey, to a 32-bit surface before they are saved. YUV and paletted 1-bit and 4-bit formats are not supported. |
SDL_SaveBMP
Use this function to save a surface to a BMP file.
Contents
Syntax
int SDL_SaveBMP(SDL_Surface* surface,
const char* file)
Function Parameters
surface |
the SDL_Surface structure containing the image to be saved |
file |
the file to be saved to |
Return Value
Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.
Code Examples
...
SDL_Surface *sfc = ...
...
if(SDL_SaveBMP(sfc, "somefile.bmp") != 0)
{
// Error saving bitmap
printf("SDL_SaveBMP failed: %s\n", SDL_GetError());
}
Remarks
Surfaces with a 24-bit, 32-bit and paletted 8-bit format get saved in the BMP directly. Other RGB formats with 8-bit or higher get converted to a 24-bit surface or, if they have an alpha mask or a colorkey, to a 32-bit surface before they are saved. YUV and paletted 1-bit and 4-bit formats are not supported.
