DRAFT |
SDL_HINT_BMP_SAVE_LEGACY_FORMAT
A hint that specifies whether SDL should not use version 4 of the bitmap header when saving BMPs.
Contents
Values
0 |
version 4 of the bitmap header will be used when saving BMPs |
1 |
version 4 of the bitmap header will not be used when saving BMPs |
Default
By default SDL will use version 4 of the bitmap header when saving BMPs.
Code Examples
You can add your code example here
Remarks
The bitmap header version 4 is required for proper alpha channel support and SDL will use it when required. Should this not be desired, this hint can force the use of the 40 byte header version which is supported everywhere.
If the hint is not set then surfaces with a colorkey or an alpha channel are saved to a 32-bit BMP file with an alpha mask. SDL will use the bitmap header version 4 and set the alpha mask accordingly. This is the default behavior since SDL 2.0.5.
If the hint is set then surfaces with a colorkey or an alpha channel are saved to a 32-bit BMP file without an alpha mask. The alpha channel data will be in the file, but applications are going to ignore it. This was the default behavior before SDL 2.0.5.
Version
This hint is available since SDL 2.0.5.
