Edit

Share via

IDXGIInfoQueue::GetRetrievalFilter method (dxgidebug.h)

  • Article

Gets the retrieval filter at the top of the retrieval-filter stack.

Syntax

HRESULT GetRetrievalFilter(
  [in]            DXGI_DEBUG_ID          Producer,
  [out, optional] DXGI_INFO_QUEUE_FILTER *pFilter,
  [in, out]       SIZE_T                 *pFilterByteLength
);

Parameters

[in] Producer

A DXGI_DEBUG_ID value that identifies the entity that gets the filter.

[out, optional] pFilter

A pointer to a DXGI_INFO_QUEUE_FILTER structure that describes the filter.

[in, out] pFilterByteLength

A pointer to a variable that receives the size, in bytes, of the filter description to which pFilter points. If pFilter is NULL, GetRetrievalFilter outputs the size of the retrieval filter.

Return value

Returns S_OK if successful; an error code otherwise. For a list of error codes, see DXGI_ERROR.

Remarks

Note  This API requires the Windows Software Development Kit (SDK) for Windows 8.
 

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 dxgidebug.h
DLL DXGIDebug.dll

See also

IDXGIInfoQueue