|
Size: 851
Comment: create page, add content (8/22 changeset 4864)
|
Size: 1076
Comment: Updated with content from header file.
|
| 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 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 21: | Line 20: |
| Returns 0 if successful or -1 if there was an error; call [[SDL_GetError]]() for more information. | Returns 0 on success or a negative error code on failure; call [[SDL_GetError]]() for more information. |
| Line 29: | Line 28: |
| ''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
You can add your code example here
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.
