ID3D11VideoContext1::VideoProcessorGetBehaviorHints method (d3d11_1.h)

Returns driver hints that indicate which of the video processor operations are best performed using multi-plane overlay hardware rather than ID3D11VideoContext::VideoProcessorBlt method.

Syntax

HRESULT VideoProcessorGetBehaviorHints(
  [in]  ID3D11VideoProcessor                             *pVideoProcessor,
  [in]  UINT                                             OutputWidth,
  [in]  UINT                                             OutputHeight,
  [in]  DXGI_FORMAT                                      OutputFormat,
  [in]  UINT                                             StreamCount,
  [in]  const D3D11_VIDEO_PROCESSOR_STREAM_BEHAVIOR_HINT *pStreams,
  [out] UINT                                             *pBehaviorHints
);

Parameters

[in] pVideoProcessor

Type: ID3D11VideoProcessor*

A pointer to the ID3D11VideoProcessor interface.

[in] OutputWidth

Type: UINT

The width of the output stream.

[in] OutputHeight

Type: UINT

The height of the output stream.

[in] OutputFormat

Type: DXGI_FORMAT

The format of the output stream.

[in] StreamCount

Type: UINT

The number of input streams to process.

[in] pStreams

Type: const D3D11_VIDEO_PROCESSOR_STREAM_BEHAVIOR_HINT*

An array of structures that specifies the format of each input stream and whether each stream should be used when computing behavior hints.

[out] pBehaviorHints

Type: UINT*

A pointer to a bitwise OR combination of D3D11_VIDEO_PROCESSOR_BEHAVIOR_HINTS values indicating which video processor operations would best be performed using multi-plane overlay hardware rather than the ID3D11VideoContext::VideoProcessorBlt method.

Return value

Type: HRESULT

This method returns one of the following error codes.

S_OK	The operation completed successfully.
E_INVALIDARG	An invalid parameter was passed or this function was called using an invalid calling pattern.
E_OUTOFMEMORY	There is insufficient memory to complete the operation.

Remarks

This method computes the behavior hints using the current state of the video processor as set by the "SetOutput" and "SetStream" methods of ID3D11VideoContext and ID3D11VideoContext1. You must set the proper state before calling this method to ensure that the returned hints contain useful data.

Requirements

Requirement	Value
Minimum supported client	Windows 10 [desktop apps only]
Minimum supported server	Windows Server 2016 [desktop apps only]
Target Platform	Windows
Header	d3d11_1.h

See also

ID3D11VideoContext1