Share via


CBaseControlWindow::GetMaxIdealImageSize

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

Retrieves the maximum ideal image size.

Syntax

HRESULT GetMaxIdealImageSize(
  long* pWidth,
  long* pHeight
);

Parameters

  • pWidth
    Maximum ideal width, in pixels.
  • pHeight
    Maximum ideal height, in pixels.

Return Value

Returns an HRESULT value.

Remarks

Various renderers have performance restrictions on the size of images they can display.

Although they should still function properly when requested to display images larger than the specified maximum, renderers can nominate the minimum and maximum ideal sizes through the IVideoWindow interface.

This interface can be called only when the filter graph is paused or running, because it is not until then that resources are allocated and the renderer can recognize its restrictions.

If no restrictions exist, the renderer fills in the pWidth and pHeight parameters with the native video dimensions and returns S_FALSE.

If restrictions exist, the restricted width and height are entered, and the member function returns S_OK.

The dimensions apply to the size of the destination video and not to the overall window size. So, when calculating the size of the window to set, account for the current window styles (for example, WS_CAPTION and WS_BORDER).

Requirements

Windows Embedded CE Windows CE 3.0 and later
Windows Mobile Windows Mobile Version 5.0 and later
Note Microsoft DirectShow applications and DirectShow filters have different include file and Library requirements
For more information, see Setting Up the Build Environment