WICLeadSubFormatFlags Enumerated Type

Specifies a type of flags for a LEAD sub-format for an IWICLeadBitmapEncoder.

Syntax


typedef enum WICLeadSubFormatFlags{ WICLeadFlagNone = 0, WICLeadFlagProgressive = 0x00000001, WICLeadFlagCmpQualityFactorPredefined = 0x00000002, WICLeadFlagQualityFactor = 0x00000004, WICLeadFlagMultiPage = 0x00000008, WICLeadFlagStamp = 0x00000010, WICLeadFlagLosslessJpeg = 0x00000020, WICLeadFlagJpeg2000Basic = 0x00000040, WICLeadFlagJpeg2000Advanced = 0x00000080, WICLeadFlagPngQualityFactor = 0x00000100, WICLeadFlagAbcQualityFactor = 0x00000200, WICLeadFlagEcwQualityFactor = 0x00000400, WICLeadFlagJpeg2000AlphaChannel = 0x00000800, WICLeadFlagJbig2Support = 0x00001000, WICLeadFlagXpsPngQualityFactor = 0x00002000, WICLeadFlagXpsJpegQualityFactor = 0x00004000, WICLeadFlagJpeg2000QualityFactor = 0x00008000, WICLeadFlagHdpQualityFactor = 0x00010000, WICLeadFlagInterlaced = 0x00020000, WICLeadFlagDither = 0x00040000, } WICLeadSubFormatFlags;

            typedef enum WICLeadSubFormatFlags{
                  WICLeadFlagNone                       = 0,
                  WICLeadFlagProgressive                = 0x00000001,
                  WICLeadFlagCmpQualityFactorPredefined = 0x00000002,
                  WICLeadFlagQualityFactor              = 0x00000004,
                  WICLeadFlagMultiPage                  = 0x00000008,
                  WICLeadFlagStamp                      = 0x00000010,
                  WICLeadFlagLosslessJpeg               = 0x00000020,
                  WICLeadFlagJpeg2000Basic              = 0x00000040,
                  WICLeadFlagJpeg2000Advanced           = 0x00000080,
                  WICLeadFlagPngQualityFactor           = 0x00000100,
                  WICLeadFlagAbcQualityFactor           = 0x00000200,
                  WICLeadFlagEcwQualityFactor           = 0x00000400,
                  WICLeadFlagJpeg2000AlphaChannel       = 0x00000800,
                  WICLeadFlagJbig2Support               = 0x00001000,
                  WICLeadFlagXpsPngQualityFactor        = 0x00002000,
                  WICLeadFlagXpsJpegQualityFactor       = 0x00004000,
                  WICLeadFlagJpeg2000QualityFactor      = 0x00008000,
                  WICLeadFlagHdpQualityFactor           = 0x00010000,
                  WICLeadFlagInterlaced                 = 0x00020000,
                  WICLeadFlagDither                     = 0x00040000,
            } WICLeadSubFormatFlags;

Constants

The flags for a sub-format identify additional settings for an encoder that can be changed through the encoder property bag. Sub-format flags are obtained by calling the IWICLeadBitmapEncoder::GetSubformatFlags method. The following table summarizes the list of sub-format flags and their meaning:

WICLeadSubFormatFlags Meaning See

WICLeadFlagNone No flag

WICLeadFlagProgressive Sub-format can be progressive. Passes property bag item
IWICLeadBitmapEncoder::GetProgressiveOptions
IWICLeadBitmapEncoder::GetProgressiveOptionsFriendlyName

WICLeadFlagCmpQualityFactorPredefined Sub-format supports the Cmp pre-defined quality factors. WICLeadCmpQualityFactorPredefined
IWICLeadBitmapEncoder::GetQualityFactorPredefined
IWICLeadBitmapEncoder::GetQualityFactorPredefinedFriendlyName

WICLeadFlagQualityFactor Sub-format supports a quality factor. IWICLeadBitmapEncoder::GetQualityFactorRange
QualityFactor property bag item and the LEAD Bitmap Encoder Property Bag

WICLeadFlagMultiPage Sub-format can store multiple pages. IWICBitmapEncoder::CreateNewFrame IWICBitmapEncoder::Commit

WICLeadFlagStamp Sub-format supports storage of a bitmap stamp. IWICBItmapEncoder::SetThumbnail

WICLeadFlagLosslessJpeg Sub-format supports lossless JPEG compression. N/A

WICLeadFlagJpeg2000Basic Sub-format supports basic JPEG 2000 compression. N/A

WICLeadFlagJpeg2000Advanced Sub-format supports advanced JPEG 2000 compression. N/A

WICLeadFlagPngQualityFactor Sub-format supports the PNG qualitity factor range of 0..9. IWICLeadBitmapEncoder::GetQualityFactorRange
LEAD Bitmap Encoder Property Bag and the QualityFactor property bag item

WICLeadFlagAbcQualityFactor Sub-format supports Abc predefined quality factors. IWICLeadBitmapEncoder::GetQualityFactorPredefined IWICLeadBitmapEncoder::GetQualityFactorPredefinedFriendlyName
LEAD Bitmap Encoder Property Bag and the QualityFactor property bag item

WICLeadFlagEcwQualityFactor Sub-format supports the Ecw quality factor range of 1..100. IWICLeadBitmapEncoder::GetQualityFactorRange
LEAD Bitmap Encoder Property Bag and the QualityFactor property bag item

WICLeadFlagJpeg2000AlphaChannel Sub-format supports a JPEG 2000 alpha channel. N/A

WICLeadFlagJbig2Support Sub-format supports JBIG2 compression. N/A

WICLeadFlagXpsPngQualityFactor Sub-format supports the PNG quality factor range of 0..9. IWICLeadBitmapEncoder::GetQualityFactorRange
LEAD Bitmap Encoder Property Bag and the QualityFactor property bag item

WICLeadFlagXpsJpegQualityFactor Sub-format supports the JPEG quality factor range of 0..9. IWICLeadBitmapEncoder::GetQualityFactorRange
LEAD Bitmap Encoder Property Bag and the QualityFactor property bag item

WICLeadFlagJpeg2000QualityFactor Sub-format supports the JPEG2000 quality factor range of -1..255. IWICLeadBitmapEncoder::GetQualityFactorRange
LEAD Bitmap Encoder Property Bag and the QualityFactor property bag item

WICLeadFlagHdpQualityFactor Sub-format supports the JPEG XR / HD Photo File (Hdp) quality factor range of 1..255. IWICLeadBitmapEncoder::GetQualityFactorRange
LEAD Bitmap Encoder Property Bag and the QualityFactor property bag item

WICLeadFlagInterlaced Sub-format supports the interlaced option Interlaced property of the LEAD Bitmap Encoder Property Bag

WICLeadFlagDither When encoding this sub-format, apply a dithering type IWICLeadDitherTypes
IWICLeadBitmapEncoder::GetDitherTypes
IWICLeadBitmapEncoder::GetDitherTypeFriendlyName

WICLeadSubFormatFlags	Meaning	See
WICLeadFlagNone	No flag
WICLeadFlagProgressive	Sub-format can be progressive.	Passes property bag item IWICLeadBitmapEncoder::GetProgressiveOptions IWICLeadBitmapEncoder::GetProgressiveOptionsFriendlyName
WICLeadFlagCmpQualityFactorPredefined	Sub-format supports the Cmp pre-defined quality factors.	WICLeadCmpQualityFactorPredefined IWICLeadBitmapEncoder::GetQualityFactorPredefined IWICLeadBitmapEncoder::GetQualityFactorPredefinedFriendlyName
WICLeadFlagQualityFactor	Sub-format supports a quality factor.	IWICLeadBitmapEncoder::GetQualityFactorRange QualityFactor property bag item and the LEAD Bitmap Encoder Property Bag
WICLeadFlagMultiPage	Sub-format can store multiple pages.	IWICBitmapEncoder::CreateNewFrame IWICBitmapEncoder::Commit
WICLeadFlagStamp	Sub-format supports storage of a bitmap stamp.	IWICBItmapEncoder::SetThumbnail
WICLeadFlagLosslessJpeg	Sub-format supports lossless JPEG compression.	N/A
WICLeadFlagJpeg2000Basic	Sub-format supports basic JPEG 2000 compression.	N/A
WICLeadFlagJpeg2000Advanced	Sub-format supports advanced JPEG 2000 compression.	N/A
WICLeadFlagPngQualityFactor	Sub-format supports the PNG qualitity factor range of 0..9.	IWICLeadBitmapEncoder::GetQualityFactorRange LEAD Bitmap Encoder Property Bag and the QualityFactor property bag item
WICLeadFlagAbcQualityFactor	Sub-format supports Abc predefined quality factors.	IWICLeadBitmapEncoder::GetQualityFactorPredefined IWICLeadBitmapEncoder::GetQualityFactorPredefinedFriendlyName LEAD Bitmap Encoder Property Bag and the QualityFactor property bag item
WICLeadFlagEcwQualityFactor	Sub-format supports the Ecw quality factor range of 1..100.	IWICLeadBitmapEncoder::GetQualityFactorRange LEAD Bitmap Encoder Property Bag and the QualityFactor property bag item
WICLeadFlagJpeg2000AlphaChannel	Sub-format supports a JPEG 2000 alpha channel.	N/A
WICLeadFlagJbig2Support	Sub-format supports JBIG2 compression.	N/A
WICLeadFlagXpsPngQualityFactor	Sub-format supports the PNG quality factor range of 0..9.	IWICLeadBitmapEncoder::GetQualityFactorRange LEAD Bitmap Encoder Property Bag and the QualityFactor property bag item
WICLeadFlagXpsJpegQualityFactor	Sub-format supports the JPEG quality factor range of 0..9.	IWICLeadBitmapEncoder::GetQualityFactorRange LEAD Bitmap Encoder Property Bag and the QualityFactor property bag item
WICLeadFlagJpeg2000QualityFactor	Sub-format supports the JPEG2000 quality factor range of -1..255.	IWICLeadBitmapEncoder::GetQualityFactorRange LEAD Bitmap Encoder Property Bag and the QualityFactor property bag item
WICLeadFlagHdpQualityFactor	Sub-format supports the JPEG XR / HD Photo File (Hdp) quality factor range of 1..255.	IWICLeadBitmapEncoder::GetQualityFactorRange LEAD Bitmap Encoder Property Bag and the QualityFactor property bag item
WICLeadFlagInterlaced	Sub-format supports the interlaced option	Interlaced property of the LEAD Bitmap Encoder Property Bag
WICLeadFlagDither	When encoding this sub-format, apply a dithering type	IWICLeadDitherTypes IWICLeadBitmapEncoder::GetDitherTypes IWICLeadBitmapEncoder::GetDitherTypeFriendlyName

Remarks

The SubFormat is one of the property bag items of the LEAD Bitmap Encoder Property Bag of LEAD encoder objects. When creating any of the LEAD encoders, the SubFormat property bag item defaults to one of the constants in this enumeration. Every LEAD encoder supports one or more sub-formats in the WICLeadSubformat enumeration. For more information, refer to IWICLeadBitmapEncoder::GetSubFormats.

Example

For an example, refer to the IWICLeadBitmapEncoder::GetSubFormats method.

References

LEAD WIC-Enabled Codecs Overview
Registering a LEAD WIC-Enabled Codec
LEAD Bitmap Encoder Property Bag
LEAD Bitmap Encoder Property Bag: JPEG2000 Specific Options
LEAD Bitmap Encoder Property Bag: JBIG2 Specific Options
LEAD Bitmap Encoder Property Bag: XPS Specific Options