IWICLeadBitmapEncoder::GetSubFormatFlags Method

Gets the encoder sub-format flags for a particular sub-format and pixel format.

Syntax


`HRESULT GetSubFormatFlags( WICPixelFormatGUID guidPixelFormat, UINT uSubFormatIndex, WICLeadSubFormatFlags *puFlags );`

Parameters


guidPixelFormat [in] The pixel format GUID that the encoder is using. uSubFormatIndex [in] An index into the sub-format array that is returned from GetSubFormats. puFlags [in,out] A pointer that receives the flags supported by the encoder sub-format and pixel format.

Return Values

Returns S_OK if successful, or an error value otherwise.

Remarks

This method returns the WICLeadSubFormatFlags for a particular sub-format of a LEAD encoder.

You must first call GetSubFormats to get the array of valid sub-formats for the particular LEAD encoder. Then call GetSubFormatFlags on a particular member of the sub-format array to get the flags for the sub-format. The sub-format flags will be a logical "or" of zero or more of the WICLeadSubFormatFlags. Note that the uSubFormatIndex argument is an index into the sub-format array, and NOT a WICLeadSubFormat constant.

The (sub-format)/(sub-format flag) pair is unique, and has a name that is obtained by calling the GetSubFormatFriendlyName method. For more information, see 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