DDSURFACEDESC2 structure

The DDSURFACEDESC2 structure contains a description of a surface to be created by the driver.

Syntax

typedef struct _DDSURFACEDESC2 {
  DWORD      dwSize;
  DWORD      dwFlags;
  DWORD      dwHeight;
  DWORD      dwWidth;
  union {
    LONG  lPitch;
    DWORD dwLinearSize;
  };
  union {
    DWORD dwBackBufferCount;
    DWORD dwDepth;
  };
  union {
    DWORD dwMipMapCount;
    DWORD dwRefreshRate;
    DWORD dwSrcVBHandle;
  };
  DWORD      dwAlphaBitDepth;
  DWORD      dwReserved;
  LPVOID     lpSurface;
  union {
    DDCOLORKEY ddckCKDestOverlay;
    DWORD      dwEmptyFaceColor;
  };
  DDCOLORKEY ddckCKDestBlt;
  DDCOLORKEY ddckCKSrcOverlay;
  DDCOLORKEY ddckCKSrcBlt;
  union {
    DDPIXELFORMAT ddpfPixelFormat;
    DWORD         dwFVF;
  };
  DDSCAPS2   ddsCaps;
  DWORD      dwTextureStage;
} DDSURFACEDESC2;

Members

• dwSize
  Specifies the size in bytes of this DDSURFACEDESC2 structure. This member must be initialized before the structure is used.

• dwFlags
  Specifies a set of flags that determine what members of the DDSURFACEDESC2 structure contain valid data. This member can be one or more of the following flags:

  Flag	Meaning
  DDSD_ALL	All input members contain valid data.
  DDSD_ALPHABITDEPTH	The dwAlphaBitDepth member is valid.
  DDSD_BACKBUFFERCOUNT	The dwBackBufferCount member is valid.
  DDSD_CAPS	The ddsCaps member is valid.
  DDSD_CKDESTBLT	The ddckCKDestBlt member is valid.
  DDSD_CKDESTOVERLAY	The ddckCKDestOverlay member is valid.
  DDSD_CKSRCBLT	The ddckCKSrcBlt member is valid.
  DDSD_CKSRCOVERLAY	The ddckCKSrcOverlay member is valid.
  DDSD_FVF	The dwFVF member is valid.
  DDSD_HEIGHT	The dwHeight member is valid.
  DDSD_LINEARSIZE	The dwLinearSize member is valid.
  DDSD_LPSURFACE	The lpSurface member is valid.
  DDSD_MIPMAPCOUNT	The dwMipMapCount member is valid.
  DDSD_PITCH	The lPitch member is valid.
  DDSD_PIXELFORMAT	The ddpfPixelFormat member is valid.
  DDSD_REFRESHRATE	The dwRefreshRate member is valid.
  DDSD_SRCVBHANDLE	The dwSrcVBHandle member is valid.
  DDSD_TEXTURESTAGE	The dwTextureStage member is valid.
  DDSD_WIDTH	The dwWidth member is valid.
  DDSD_ZBUFFERBITDEPTH	This flag is not used in DDSURFACEDESC2. It is only used in DDSURFACEDESC.

   

• dwHeight
  Specifies the height of surface in pixels.

• dwWidth
  Specifies the width of the surface in pixels.

• lPitch
  Specifies the number of bytes between the beginnings of two adjacent scan lines; that is, the number of bytes to add to the beginning address of one scan line to reach the beginning address of the next scan line below it. The driver's DdCreateSurface callback must return this value.

• dwLinearSize
  Specifies the size in bytes of a formless, late-allocated, optimized surface.

• dwBackBufferCount
  Specifies the number of back buffers associated with the surface.

• dwDepth
  The bit-depth if this is a volume texture.

• dwMipMapCount
  Specifies the number of mipmap levels.

• dwRefreshRate
  Specifies the refresh rate in hertz of the monitor (used when the display mode is described).

• dwSrcVBHandle
  Specifies the source used in IDirect3DVertexBuffer7::Optimize (described in the Microsoft Direct3D SDK documentation).

• dwAlphaBitDepth
  Specifies the depth of the alpha buffer in bits per pixel.

• dwReserved
  Reserved and should be set to zero.

• lpSurface
  Specifies the address of the associated surface memory.

• ddckCKDestOverlay
  Specifies the color key for destination overlay use.

• dwEmptyFaceColor
  Specifies the physical color for empty cube map faces.

• ddckCKDestBlt
  Specifies the color key for destination blit use.

• ddckCKSrcOverlay
  Specifies the color key for source overlay use.

• ddckCKSrcBlt
  Specifies the color key for source blit use.

• ddpfPixelFormat
  Specifies a DDPIXELFORMAT structure that describes the pixel format of the surface.

• dwFVF
  Specifies the Flexible Vertex Format (FVF) for the vertex buffers.

• ddsCaps
  Specifies a DDSCAPS structure that contains the DirectDraw surface capabilities.

• dwTextureStage
  Specifies the stage in the multitexture cascade. For more information, see Texture Stages.

Remarks

The relevant members differ for each potential type of surface. This structure is typically created and initialized by an application.

Requirements

Header

Ddraw.h (include Ddraw.h)

See also

DdCreateSurface

DDPIXELFORMAT

DDSCAPS

 

 

Send comments about this topic to Microsoft