IVideoWindow::GetMaxIdealImageSize

Microsoft DirectX 8.1 (C++)

The GetMaxIdealImageSize method retrieves the maximum ideal image size for the video image.

Syntax

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

Parameters

pWidth

[out] Pointer to a variable that receives the maximum ideal width, in pixels.

pHeight

[out] Pointer to a variable that receives the maximum ideal height, in pixels.

Return Values

Possible return values include the following:

Value	Description
E_POINTER	NULL pointer.
S_FALSE	Could not retrieve a maximum image size.
S_OK	Success.
VFW_E_WRONG_STATE	Filter is stopped.

Remarks

The maximum ideal size may differ from the native video size, because the video hardware might have specific stretching requirements.

This method returns S_FALSE under various circumstances:

The filter is using an IOverlay transport.
UseWhenFullScreen mode is on. (See IDirectDrawVideo::UseWhenFullScreen.)
The video surface has no maximum overlay stretch. (The dwMaxOverlayStretch member of the DDCAPS structure is zero. See IDirectDrawVideo::GetCaps.)

See Also