BLFormatInfo Struct Reference [¶]
Provides a detailed information about a pixel format. Use bl_format_info array to get an information of Blend2D native pixel formats.
Public Members
BLFormatFlags flags
uint8_t sizes[4]
uint8_t shifts[4]
}
uint8_t r_size
uint8_t g_size
uint8_t b_size
uint8_t a_size
uint8_t r_shift
uint8_t g_shift
uint8_t b_shift
uint8_t a_shift
}
BLRgba32* palette
};
Member Functions
void init(uint32_t depth_, BLFormatFlags flags_, const uint8_t sizes_[4], const uint8_t shifts_[4]) noexcept
BLResult BLFormatInfo::query(BLFormat format)noexcept[¶]
Query Blend2D format and copy it to this format info, see BLFormat.
Copies data from bl_format_info() to this BLFormatInfo struct and returns BL_SUCCESS if the format was valid, otherwise the BLFormatInfo is reset and BL_ERROR_INVALID_VALUE is returned.
Note
The BL_FORMAT_NONE is considered invalid format, thus if it's passed to query() the return value would be BL_ERROR_INVALID_VALUE.
BLResult BLFormatInfo::sanitize()noexcept[¶]
Sanitize this BLFormatInfo.
Sanitizer verifies whether the format is valid and updates the format information about flags to values that Blend2D expects. For example format flags are properly examined and simplified if possible, byte-swap is implicitly performed for formats where a single component matches one byte, etc...