|
Size: 1208
Comment: update formatting - enums, structs, the/an
|
← Revision 8 as of 2016-10-08 22:35:29 ⇥
Size: 1244
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 seekable SDL data source (memory or file). | Use this function to save a surface to a seekable SDL data stream (memory or file) in BMP format. |
| Line 18: | Line 17: |
| ||'''surface'''||the [[SDL_Surface]] structure to be saved|| ||'''dst'''||a data source to save to|| ||'''freedst'''||non-zero to close the source after being written|| |
||'''surface'''||the [[SDL_Surface]] structure containing the image to be saved|| ||'''dst'''||a data stream to save to|| ||'''freedst'''||non-zero to close the stream after being written|| |
| Line 22: | Line 21: |
| <<Color2(green,Why is it free''dst'' and it's the ''source'' that is closed? Why not free''src''? There is no page for SDL_RWops. Should there be? Should it be specifically mentioned in the param anyway?)>> | |
| Line 33: | Line 31: |
| ''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. |
| Line 36: | Line 34: |
| .[[SDL_LoadBMP_RW]] ??? | .[[SDL_LoadBMP_RW]] |
SDL_SaveBMP_RW
Use this function to save a surface to a seekable SDL data stream (memory or file) in BMP format.
Contents
Syntax
int SDL_SaveBMP_RW(SDL_Surface* surface,
SDL_RWops* dst,
int freedst)
Function Parameters
surface |
the SDL_Surface structure containing the image to be saved |
dst |
a data stream to save to |
freedst |
non-zero to close the stream after being written |
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.
