D3DKMT_FLIPMODEL_PRESENTHISTORYTOKEN structure (d3dkmthk.h)

The D3DKMT_FLIPMODEL_PRESENTHISTORYTOKEN structure identifies a flip present-history operation.

Syntax

typedef struct _D3DKMT_FLIPMODEL_PRESENTHISTORYTOKEN {
  D3DKMT_ALIGN64 UINT64                     FenceValue;
  D3DKMT_ALIGN64 ULONG64                    hLogicalSurface;
  D3DKMT_ALIGN64 D3DKMT_UINT_PTR            dxgContext;
  D3DDDI_VIDEO_PRESENT_SOURCE_ID            VidPnSourceId;
  UINT                                      SwapChainIndex;
  D3DKMT_ALIGN64 UINT64                     PresentLimitSemaphoreId;
  D3DDDI_FLIPINTERVAL_TYPE                  FlipInterval;
  D3DKMT_FLIPMODEL_PRESENTHISTORYTOKENFLAGS Flags;
  D3DKMT_ALIGN64 LONG64                     hCompSurf;
  LUID                                      compSurfLuid;
  D3DKMT_ALIGN64 UINT64                     confirmationCookie;
  D3DKMT_ALIGN64 UINT64                     CompositionSyncKey;
  UINT                                      RemainingTokens;
  RECT                                      ScrollRect;
  POINT                                     ScrollOffset;
  UINT                                      PresentCount;
  FLOAT                                     RevealColor[4];
  D3DDDI_ROTATION                           Rotation;
  union {
    D3DKMT_SCATTERBLTS ScatterBlts;
    struct {
      HANDLE                   hSyncObject;
      D3DDDI_HDR_METADATA_TYPE HDRMetaDataType;
      union {
        D3DDDI_HDR_METADATA_HDR10     HDRMetaDataHDR10;
        D3DDDI_HDR_METADATA_HDR10PLUS HDRMetaDataHDR10Plus;
      };
    };
  };
  UINT                                      InkCookie;
  RECT                                      SourceRect;
  UINT                                      DestWidth;
  UINT                                      DestHeight;
  RECT                                      TargetRect;
  FLOAT                                     Transform[6];
  UINT                                      CustomDuration;
  D3DDDI_FLIPINTERVAL_TYPE                  CustomDurationFlipInterval;
  UINT                                      PlaneIndex;
  D3DDDI_COLOR_SPACE_TYPE                   ColorSpace;
  D3DKMT_DIRTYREGIONS                       DirtyRegions;
} D3DKMT_FLIPMODEL_PRESENTHISTORYTOKEN;

Members

FenceValue

[in] A 64-bit value that specifies the fence value that is used for the flip.

hLogicalSurface

[in] A 64-bit value that specifies the handle to a logical surface.

dxgContext

The DirectX graphics context.

VidPnSourceId

The zero-based identification number of the video present source in a path of a video present network (VidPN) topology that the monitor is connected to.

SwapChainIndex

[in] The index of the surface in the swap chain that is used for the flip.

PresentLimitSemaphoreId

[in] A 64-bit value that identifies the present-limit semaphore.

FlipInterval

[in] A D3DDDI_FLIPINTERVAL_TYPE-typed value that indicates the flip interval (that is, if the flip occurs after zero, one, two, three, or four vertical syncs).

Flags

[in] A D3DKMT_FLIPMODEL_PRESENTHISTORYTOKENFLAGS structure that identifies, in bit-field flags, attributes of a flip present-history operation.

hCompSurf

This member is reserved and should be set to zero.

Supported starting with Windows 8.

compSurfLuid

LUID for the composition surface.

confirmationCookie

Confirmation cookie.

CompositionSyncKey

This member is reserved and should be set to zero.

Supported starting with Windows 8.

RemainingTokens

This member is reserved and should be set to zero.

Supported starting with Windows 8.

ScrollRect

This member is reserved and should be set to zero.

Supported starting with Windows 8.

ScrollOffset

This member is reserved and should be set to zero.

Supported starting with Windows 8.

PresentCount

This member is reserved and should be set to zero.

Supported starting with Windows 8.

RevealColor[4]

This member is reserved and should be set to zero.

Supported starting with Windows 8.

Rotation

This member is reserved and should be set to zero.

Supported starting with Windows 8.

ScatterBlts

This member is reserved and should be set to zero.

Supported starting with Windows 8.

hSyncObject

This member is reserved and should be set to zero.

Supported starting with Windows 8.

HDRMetaDataType

HDRMetaDataHDR10

HDRMetaDataHDR10Plus

InkCookie

Cookie for token's ink.

SourceRect

The source rectangle.

DestWidth

The destination width.

DestHeight

The destination height.

TargetRect

The target rectangle.

Transform[6]

Transformation matrix.

CustomDuration

Custom duration of the transition.

CustomDurationFlipInterval

Custom interval of the transition.

PlaneIndex

Index of the plane.

ColorSpace

The color space of the data.

DirtyRegions

[in] A D3DKMT_DIRTYREGIONS structure that identifies the active rectangles (dirty regions) of the flip surface.

Requirements

Requirement	Value
Minimum supported client	Windows 7
Header	d3dkmthk.h (include D3dkmthk.h)

See also

D3DKMT_FLIPMODEL_PRESENTHISTORYTOKENFLAGS

D3DDDI_FLIPINTERVAL_TYPE

D3DKMT_PRESENTHISTORYTOKEN

D3DKMT_DIRTYREGIONS