Expand Minimize

VideoProcessorSetStreamPixelAspectRatio function

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

Syntax


VOID APIENTRY* VideoProcessorSetStreamPixelAspectRatio(
  _In_  D3D10DDI_HDEVICE hDevice,
  _In_  D3D11_1DDI_HVIDEOPROCESSOR hVideoProcessor,
  _In_  UINT StreamIndex,
  _In_  BOOL Enable,
  _In_  const DXGI_RATIONAL *pSourceRatio,
  _In_  const DXGI_RATIONAL *pDestRatio
);

Parameters

hDevice [in]

A handle to the display device (graphics context).

hVideoProcessor [in]

A handle to the video processor object that was created through a call to the CreateVideoProcessor function.

StreamIndex [in]

The zero-based index of the input stream.

Enable [in]

If TRUE, the pSourceRatio and pDestinationRatio parameters contain valid values. Otherwise, the pixel aspect ratios are unspecified.

pSourceRatio [in]

A pointer to a DXGI_RATIONAL structure that contains the pixel aspect ratio of the source rectangle.

Note  If the Enable parameter is FALSE, this parameter can be NULL.

pDestRatio [in]

A pointer to a DXGI_RATIONAL structure that contains the pixel aspect ratio of the destination rectangle.

Note  If the Enable parameter is FALSE, this parameter can be NULL.

Return value

This function does not return a value.

Remarks

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

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

The driver reports its ability to support the pixel aspect ratio capability in the D3D11_1DDI_VIDEO_PROCESSOR_CAPS structure that is returned through the GetVideoProcessorCaps function. If the driver supports the D3D11_1DDI_VIDEO_PROCESSOR_FEATURE_CAPS_PIXEL_ASPECT_RATIO capability, the VideoProcessorSetStreamAlpha can be called to set the pixel aspect ratios for an input stream of the video processor.

Note  If the driver does not support the D3D11_1DDI_VIDEO_PROCESSOR_FEATURE_CAPS_PIXEL_ASPECT_RATIO capability, the Microsoft Direct3D runtime does not call the VideoProcessorSetStreamAlpha function.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Header

D3d10umddi.h (include D3d10umddi.h)

See also

CreateVideoProcessor
D3D11_1DDI_VIDEO_PROCESSOR_CAPS
GetVideoProcessorCaps

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft