Edit

DD_WAITFORVPORTSYNCDATA structure (ddrawint.h)

  • Article

The DD_WAITFORVPORTSYNCDATA structure contains the information required for the driver to synchronize the video port extensions (VPE) object.

Syntax

typedef struct _DD_WAITFORVPORTSYNCDATA {
  PDD_DIRECTDRAW_LOCAL lpDD;
  PDD_VIDEOPORT_LOCAL  lpVideoPort;
  DWORD                dwFlags;
  DWORD                dwLine;
  DWORD                dwTimeOut;
  HRESULT              ddRVal;
  VOID                 *UpdateVideoPort;
} *PDD_WAITFORVPORTSYNCDATA, DD_WAITFORVPORTSYNCDATA;

Members

lpDD

Points to a DD_DIRECTDRAW_LOCAL structure that is relevant to the current Microsoft DirectDraw process only.

lpVideoPort

Points to a DD_VIDEOPORT_LOCAL structure that represents this VPE object.

dwFlags

Indicates the condition for which the driver should wait. This member can be one of the following values:

Flag Meaning
DDVPWAIT_BEGIN The driver should return at the beginning of the next V-sync.
DDVPWAIT_END The driver should return at the end of the next/current V-sync.
DDVPWAIT_LINE The driver should return at the beginning of the line specified in dwLine.

dwLine

Specifies the line number on which the driver should synchronize when dwFlags is DDVPWAIT_LINE. The driver should ignore this member when dwFlags is set to DDVPWAIT_BEGIN or DDVPWAIT_END.

dwTimeOut

Specifies the maximum amount of time the driver should wait, in milliseconds, before timing out.

ddRVal

Specifies the location in which the driver writes the return value of the DdVideoPortWaitForSync callback. A return code of DD_OK indicates success. For more information, see Return Values for DirectDraw.

UpdateVideoPort

Used by the DirectDraw API and should not be filled in by the driver.

Requirements

Requirement Value
Header ddrawint.h (include Winddi.h)

See also

DdVideoPortWaitForSync