devela::_dep::sdl3::hint::names

Constant BMP_SAVE_LEGACY_FORMAT

pub const BMP_SAVE_LEGACY_FORMAT: &'static str;
Available on crate feature dep_sdl3 only.
Expand description

Prevent SDL from using version 4 of the bitmap header when saving BMPs.

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.

The variable can be set to the following values:

  • “0”: 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. (default)
  • “1”: 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 hint can be set anytime.

§Availability

This hint is available since SDL 3.2.0.