Edit

IPresentationManager::CancelPresentsFrom method (presentation.h)

  • Article

Cancels any previously issued and still in-flight presents that have not yet displayed, and whose Present IDs are at least the passed in presentIdToCancelFrom.

Syntax

HRESULT CancelPresentsFrom(
  UINT64 presentIdToCancelFrom
);

Parameters

presentIdToCancelFrom

Type: UINT64

The identifier of the present from which to cancel presents that have been issued but not yet displayed.

Return value

Type: HRESULT

If the function succeeds, it returns S_OK; otherwise, it returns an HRESULT value that indicates the error.

Remarks

If any presents in the past have already been displayed, this call will not fail - those presents will simply not be canceled. The present retiring fence will not be signaled for any canceled presents, because when presents are canceled, they don't affect the currently displayed present or cause it to begin the retiring process. For this reason, it is suggested that after performing a present, an application queries buffer available events to find an available buffer to issue on the first present after a cancel. Once that present is queued, it allows the previously displayed present to begin the retiring process, and signal the present retiring fence.

Requirements

Requirement Value
Minimum supported client Windows Build 22000
Minimum supported server Windows Build 22000
Header presentation.h
Library dcomp.lib
DLL dcomp.dll

See also

IPresentationBuffer::GetAvailableEvent