Edit

Share via

IDXGIDecodeSwapChain::PresentBuffer method (dxgi1_3.h)

  • Article

Presents a frame on the output adapter. The frame is a subresource of the IDXGIResource object that was used to create the decode swap chain.

Syntax

HRESULT PresentBuffer(
  UINT BufferToPresent,
  UINT SyncInterval,
  UINT Flags
);

Parameters

BufferToPresent

An index indicating which member of the subresource array to present.

SyncInterval

An integer that specifies how to synchronize presentation of a frame with the vertical blank.

For the bit-block transfer (bitblt) model (DXGI_SWAP_EFFECT_DISCARD or DXGI_SWAP_EFFECT_SEQUENTIAL), values are:

  • 0 - The presentation occurs immediately, there is no synchronization.
  • 1,2,3,4 - Synchronize presentation after the nth vertical blank.
For the flip model (DXGI_SWAP_EFFECT_FLIP_SEQUENTIAL), values are:
  • 0 - Cancel the remaining time on the previously presented frame and discard this frame if a newer frame is queued.
  • n > 0 - Synchronize presentation for at least n vertical blanks.

Flags

An integer value that contains swap-chain presentation options. These options are defined by the DXGI_PRESENT constants.

The DXGI_PRESENT_USE_DURATION flag must be set if a custom present duration (custom refresh rate) is being used.

Return value

This method returns S_OK on success, or it returns one of the following error codes:

Requirements

Requirement Value
Minimum supported client Windows 8.1 [desktop apps only]
Minimum supported server Windows Server 2012 R2 [desktop apps only]
Target Platform Windows
Header dxgi1_3.h
Library Dxgi.lib

See also

IDXGIDecodeSwapChain