Edit

WICImageParameters structure (wincodec.h)

  • Article

This defines parameters that you can use to override the default parameters normally used when encoding an image.

Syntax

typedef struct WICImageParameters {
  D2D1_PIXEL_FORMAT PixelFormat;
  FLOAT             DpiX;
  FLOAT             DpiY;
  FLOAT             Top;
  FLOAT             Left;
  UINT32            PixelWidth;
  UINT32            PixelHeight;
} WICImageParameters;

Members

PixelFormat

The pixel format to which the image is processed before it is written to the encoder.

DpiX

The DPI in the x dimension.

DpiY

The DPI in the y dimension.

Top

The top corner in pixels of the image space to be encoded to the destination.

Left

The left corner in pixels of the image space to be encoded to the destination.

PixelWidth

The width in pixels of the part of the image to write.

PixelHeight

The height in pixels of the part of the image to write.

Remarks

If this parameter is not passed to the encoding API, the encoder uses these settings.

Note  The parameters as specified can't result in a scale. The encoder can use a larger portion of the input image based on the passed in DPI and the pixel width and height.
 

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps | UWP apps]
Minimum supported server Windows Server 2012 [desktop apps | UWP apps]
Header wincodec.h

See also

IWICImageEncoder