The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ID3D11VideoContext::VideoProcessorSetStreamPixelAspectRatio method

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

Syntax

C++


void VideoProcessorSetStreamPixelAspectRatio(
  [in]       ID3D11VideoProcessor *pVideoProcessor,
  [in]       UINT                 StreamIndex,
  [in]       BOOL                 Enable,
  [in] const DXGI_RATIONAL        *pSourceAspectRatio,
  [in] const DXGI_RATIONAL        *pDestinationAspectRatio
);

Parameters

pVideoProcessor [in]: A pointer to the ID3D11VideoProcessor interface. To get this pointer, call ID3D11VideoDevice::CreateVideoProcessor.
StreamIndex [in]: The zero-based index of the input stream. To get the maximum number of streams, call ID3D11VideoProcessorEnumerator::GetVideoProcessorCaps and check the MaxStreamStates structure member.
Enable [in]: Specifies whether the pSourceAspectRatio and pDestinationAspectRatio parameters contain valid values. Otherwise, the pixel aspect ratios are unspecified.
pSourceAspectRatio [in]: A pointer to a DXGI_RATIONAL structure that contains the pixel aspect ratio of the source rectangle. If Enable is FALSE, this parameter can be NULL.
pDestinationAspectRatio [in]: A pointer to a DXGI_RATIONAL structure that contains the pixel aspect ratio of the destination rectangle. If Enable is FALSE, this parameter can be NULL.

Return value

This method does not return a value.

Remarks

This function can only be called if the driver reports the D3D11_VIDEO_PROCESSOR_FEATURE_CAPS_PIXEL_ASPECT_RATIO capability. If this capability is not set, this function will have no effect.

Pixel aspect ratios of the form 0/n and n/0 are not valid.

The default pixel aspect ratio is 1:1 (square pixels).

Requirements

Minimum supported client	Windows 8 [desktop apps \| Windows Store apps]
Minimum supported server	Windows Server 2012 [desktop apps \| Windows Store apps]
Minimum supported phone	Windows Phone 8
Header	D3d11.h