ID3D11VideoContext::VideoProcessorGetStreamPixelAspectRatio method (d3d11.h)

Gets the pixel aspect ratio for an input stream on the video processor.

Syntax

void VideoProcessorGetStreamPixelAspectRatio(
  [in]  ID3D11VideoProcessor *pVideoProcessor,
  [in]  UINT                 StreamIndex,
  [out] BOOL                 *pEnabled,
  [out] DXGI_RATIONAL        *pSourceAspectRatio,
  [out] DXGI_RATIONAL        *pDestinationAspectRatio
);

Parameters

[in] pVideoProcessor

A pointer to the ID3D11VideoProcessor interface. To get this pointer, call ID3D11VideoDevice::CreateVideoProcessor.

[in] StreamIndex

The zero-based index of the input stream. To get the maximum number of streams, call ID3D11VideoProcessorEnumerator::GetVideoProcessorCaps and check the MaxStreamStates structure member.

[out] pEnabled

Receives the value TRUE if the pixel aspect ratio is specified. Otherwise, receives the value FALSE.

[out] pSourceAspectRatio

A pointer to a DXGI_RATIONAL structure. If *pEnabled is TRUE, this parameter receives the pixel aspect ratio of the source rectangle.

[out] pDestinationAspectRatio

A pointer to a DXGI_RATIONAL structure. If *pEnabled is TRUE, this parameter receives the pixel aspect ratio of the destination rectangle.

Return value

None

Remarks

When the method returns, if *pEnabled is TRUE, the pSourceAspectRatio and pDestinationAspectRatio parameters contain the pixel aspect ratios. Otherwise, the default pixel aspect ratio is 1:1 (square pixels).

Requirements

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

See also

ID3D11VideoContext