Expand Minimize

DXGI_DDI_ARG_PRESENT1 structure

Describes a resource to display. Used with the pfnPresent1(DXGI) function by Windows Display Driver Model (WDDM) 1.3 and later user-mode display drivers.

Syntax


typedef struct DXGI_DDI_ARG_PRESENT1 {
  DXGI_DDI_HRESOURCE                hSurface;
  const DXGI_DDI_ARG_PRESENTSURFACE *phSurfacesToPresent;
  UINT                              SurfacesToPresent;
  DXGI_DDI_HRESOURCE                hDstResource;
  UINT                              DstSubResourceIndex;
  void                              *pDXGIContext;
  DXGI_DDI_PRESENT_FLAGS            Flags;
  DXGI_DDI_FLIP_INTERVAL_TYPE       FlipInterval;
  UINT                              Reserved;
  const RECT                        *pDirtyRects;
  UINT                              DirtyRects;
} DXGI_DDI_ARG_PRESENT1;

Members

hSurface

[in] A handle to the display device (graphics context) on which the driver performs the presentation. The Direct3D runtime passes this handle to the driver in the hDrvDevice member of the D3D10DDIARG_CREATEDEVICE structure when the runtime calls the driver's CreateDevice(D3D10) function to create the display device.

phSurfacesToPresent

[in] An array of non-NULL handles and zero-based indices to the source resource to display or to release. phSurfacesToPresent is always a valid handle for a resource to display.

SurfacesToPresent

[in] The array of surfaces to be presented. Must not be zero.

hDstResource

[in] A handle to the destination resource to display to. hDstResource can be NULL if the destination is unknown; kernel mode will determine the destination just before sending the hardware command stream through DMA to the graphics processor.

When many resource are being presented, hDstResource will be NULL, and the driver must only translate the last source resource handle for use with the pfnPresentCb function.

DstSubResourceIndex

[in] The zero-based index into the destination resource, which the handle in the hDstResource member specifies. The DstSubResourceIndex index indicates the subresource or surface to display to.

pDXGIContext

[in] A handle to the DXGI context. This handle is opaque to the driver. The driver must pass the handle in this member as the pDXGIContext member of the DXGIDDICB_PRESENT structure when the driver calls the pfnPresentCbDXGI function.

Flags

[in] A DXGI_DDI_PRESENT_FLAGS structure that identifies, in bit-field flags, how to perform the present operation.

FlipInterval

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

Reserved

This member is reserved and should be set to zero.

pDirtyRects

[in] A pointer to an array of dirty rectangles (RECTs), relative to the source rectangle SrcRect, that indicate the portion of the overlay plane that has changed.

The driver can use this member to perform optimizations, though it's not required to use the dirty rectangle info. However, the driver should never fail a function call based on the provided dirty rectangles.

DirtyRects

[in] The number of dirty rectangles in the array pointed to by pDirtyRects.

Requirements

Minimum supported client

Windows 8.1

Minimum supported server

Windows Server 2012 R2

Version

WDDM 1.3 and later

Header

Dxgiddi.h (include D3d10umddi.h)

See also

CreateDevice(D3D10)
DXGI_DDI_FLIP_INTERVAL_TYPE
DXGI_DDI_PRESENT_FLAGS
DXGIDDICB_PRESENT
pfnPresent1(DXGI)
pfnPresentCb
pfnPresentCbDXGI
RECT

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft