IDXGISwapChain1::Present1 Method

Presents a rendered image to the user.

Syntax

public:
HRESULT Present1(
         UINT SyncInterval,
         UINT PresentFlags,
         const DXGI_PRESENT_PARAMETERS *pPresentParameters
)

Parameters

SyncInterval
Type: UINT

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.

For an example that shows how sync-interval values affect a flip presentation queue, see Remarks.

If the update region straddles more than one output (each represented by IDXGIOutput), Present1 performs the synchronization to the output that contains the largest subrectangle of the target window’s client area.

PresentFlags
Type: UINT

An integer value that contains swap-chain presentation options. These options are defined by the DXGI_PRESENT constants, including the additional DXGI_PRESENT constants that are documented in the Flags parameter of DXGIXPresentArray.

pPresentParameters
Type: DXGI_PRESENT_PARAMETERS *

[in] The presentation parameters, as a pointer to DXGI_PRESENT_PARAMETERS.

Return value

Type: HRESULT

Returns one of the following DXGI_ERROR.

Remarks

The recommended present method for Xbox One is DXGIXPresentArray.

For more information about using Present1, see IDXGISwapChain::Present.

Requirements

Header: Declared in d3d11_x.h (dxgi1_2.h on other Windows platforms).