Edit

D3DKMT_PRESENTHISTORYTOKEN structure (d3dkmthk.h)

  • Article

The D3DKMT_PRESENTHISTORYTOKEN structure identifies a type of present operation.

Syntax

typedef struct _D3DKMT_PRESENTHISTORYTOKEN
{
    D3DKMT_PRESENT_MODEL  Model;
    UINT                  TokenSize;

#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8)
    UINT64                CompositionBindingId;
#endif

    union
    {
        D3DKMT_FLIPMODEL_PRESENTHISTORYTOKEN        Flip;
        D3DKMT_BLTMODEL_PRESENTHISTORYTOKEN         Blt;
        D3DKMT_VISTABLTMODEL_PRESENTHISTORYTOKEN    VistaBlt;
        D3DKMT_GDIMODEL_PRESENTHISTORYTOKEN         Gdi;
        D3DKMT_FENCE_PRESENTHISTORYTOKEN            Fence;
        D3DKMT_GDIMODEL_SYSMEM_PRESENTHISTORYTOKEN  GdiSysMem;
        D3DKMT_COMPOSITION_PRESENTHISTORYTOKEN      Composition;
        D3DKMT_FLIPMANAGER_PRESENTHISTORYTOKEN      FlipManager;
#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1)
        D3DKMT_SURFACECOMPLETE_PRESENTHISTORYTOKEN  SurfaceComplete;
#endif
    }
    Token;
} D3DKMT_PRESENTHISTORYTOKEN;

Members

[in] Model

A D3DKMT_PRESENT_MODEL enum value that indicates the model for a present operation.

[in] TokenSize

The size, in bytes, of the present history token including the value in the Model member. When you submit a token, you should set TokenSize to zero. When the ICD calls D3DKMTGetPresentHistory to retrieve present history, the runtime initializes TokenSize. You can then use the value in TokenSize to go to the next token in the present-history buffer.

A present history token is a data packet that the rendering app submits to inform the Desktop Window Manager (DWM) that rendering is complete and the swap chain back buffer is ready to be presented.

CompositionBindingId

The identifier of the active bound buffer of the composition surface.

Supported starting with Windows 8.

Token

A present history token.

[in/out] Token.Flip

A D3DKMT_FLIPMODEL_PRESENTHISTORYTOKEN structure that identifies a flip present-history operation. The Token union that is contained in D3DKMT_PRESENTHISTORYTOKEN holds this structure if the Model member is D3DKMT_PM_REDIRECTED_FLIP.

[in/out] Token.Blt

A D3DKMT_BLTMODEL_PRESENTHISTORYTOKEN structure that identifies a bit-block transfer (bitblt) present-history operation. The union that is contained in D3DKMT_PRESENTHISTORYTOKEN holds a structure of this type if the Model member is D3DKMT_PM_REDIRECTED_BLT.

[in/out] Token.VistaBlt

A ULONGLONG value that identifies a Windows Vista bit-block transfer (bitblt) present-history operation. The union that is contained in D3DKMT_PRESENTHISTORYTOKEN holds a value of this type if the Model member is D3DKMT_PM_REDIRECTED_VISTABLT.

[in/out] Token.Gdi

A D3DKMT_GDIMODEL_PRESENTHISTORYTOKEN structure that identifies a GDI present-history operation. The union that is contained in D3DKMT_PRESENTHISTORYTOKEN holds a structure of this type if the Model member is D3DKMT_PM_REDIRECTED_GDI.

[in/out] Token.Fence

A D3DKMT_FENCE_PRESENTHISTORYTOKEN structure that identifies a fence present-history operation. The union that is contained in D3DKMT_PRESENTHISTORYTOKEN holds a structure of this type if the Model member is D3DKMT_PM_SCREENCAPTUREFENCE.

[in/out] Token.GdiSysMem

A D3DKMT_GDIMODEL_SYSMEM_PRESENTHISTORYTOKEN structure that identifies a GDI system present-history operation. The union that is contained in D3DKMT_PRESENTHISTORYTOKEN holds a structure of this type if the Model member is D3DKMT_PM_REDIRECTED_GDI_SYSMEM.

[in/out] Token.Composition

A D3DKMT_COMPOSITION_PRESENTHISTORYTOKEN structure that identifies a composition swap chain present-history operation. This type of presentation is used for XAML-based apps.

Supported starting with Windows 8.1.

Token.FlipManager

A D3DKMT_FLIPMANAGER_PRESENTHISTORYTOKEN structure that identifies a flip manager operation.

Token.SurfaceComplete

A D3DKMT_SURFACECOMPLETE_PRESENTHISTORYTOKEN structure that identifies a surface complete operation.

Supported starting with Windows 10, version 1607.

Requirements

Requirement Value
Minimum supported client D3DKMT_PRESENTHISTORYTOKEN is supported beginning with the Windows 7 operating system.
Header d3dkmthk.h (include D3dkmthk.h)

See also

D3DKMT_PRESENT_MODEL

D3DKMTGetPresentHistory

D3DKMT_FLIPMODEL_PRESENTHISTORYTOKEN

D3DKMT_BLTMODEL_PRESENTHISTORYTOKEN

D3DKMT_GDIMODEL_PRESENTHISTORYTOKEN

D3DKMT_FENCE_PRESENTHISTORYTOKEN

D3DKMT_GDIMODEL_SYSMEM_PRESENTHISTORYTOKEN

D3DKMT_COMPOSITION_PRESENTHISTORYTOKEN

D3DKMT_FLIPMANAGER_PRESENTHISTORYTOKEN

D3DKMT_SURFACECOMPLETE_PRESENTHISTORYTOKEN