D3DKMTCheckOcclusion function

The D3DKMTCheckOcclusion function verifies whether the client area of a window is occluded.

Syntax


NTSTATUS APIENTRY D3DKMTCheckOcclusion(
  _In_ const D3DKMT_CHECKOCCLUSION *pData
);

Parameters

pData [in]

A pointer to a D3DKMT_CHECKOCCLUSION structure that describes parameters for checking occlusion.

Return value

D3DKMTCheckOcclusion returns one of the following values:

Return codeDescription
STATUS_SUCCESS

The client area of the window is not occluded.

STATUS_GRAPHICS_PRESENT_OCCLUDED

The client area of the window is occluded.

STATUS_INVALID_PARAMETER

Parameters were validated and determined to be incorrect.

 

This function might also return other NTSTATUS values.

Remarks

The handle to the window that is checked for occlusion must be valid. A window is not occluded if a part of its client area lies on a unowned video present network (VidPn) source, if its client area is an empty rectangular area (RECT), or if desktop composition is running.

Requirements

Target platform

Universal

Version

Available in Windows Vista and later versions of the Windows operating systems.

Header

D3dkmthk.h (include D3dkmthk.h)

Library

Gdi32.lib

DLL

Gdi32.dll

See also

D3DKMT_CHECKOCCLUSION

 

 

Send comments about this topic to Microsoft

Show: