 Important: |
|---|
| This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist. |
The DDSCAPSstructure defines the capabilities of a DirectDrawSurface object. This structure is part of the DDCAPSand DDSURFACEDESCstructures.
typedef struct _DDSCAPS{
DWORD
dwCaps
;
} DDSCAPS, FAR* LPDDSCAPS;
Members
- dwCaps
- Capabilities of the surface. One or more of the following flags
is raised:
DDSCAPS_3D Unsupported. Use the DDSCAPS_3DDEVICE instead. DDSCAPS_3DDEVICE Indicates that this surface can be used for 3-D rendering. Applications can use this flag to ensure that a device that can only render to a certain heap has off-screen surfaces allocated from the correct heap. If this flag is set for a heap, the surface is not allocated from that heap. DDSCAPS_ALLOCONLOAD Indicates that memory for the surface is not allocated until the surface is loaded by using the IDirect3DTexture2::Load. DDSCAPS_ALPHA Indicates that this surface contains alpha-only information. DDSCAPS_BACKBUFFER Indicates that this surface is the back buffer of a surface flipping structure. Typically, this capability is set by the CreateSurfacemethod when the DDSCAPS_FLIP flag is used. Only the surface that immediately precedes the DDSCAPS_FRONTBUFFER surface has this capability set. The other surfaces are identified as back buffers by the presence of the DDSCAPS_FLIP flag, their attachment order, and the absence of the DDSCAPS_FRONTBUFFER and DDSCAPS_BACKBUFFER capabilities. If this capability is sent to the CreateSurfacemethod, a stand-alone back buffer is being created. After this method is called, this surface could be attached to a front buffer, another back buffer, or both to form a flipping surface structure. For more information, see IDirectDrawSurface5::AddAttachedSurface. DirectDraw supports an arbitrary number of surfaces in a flipping structure. DDSCAPS_COMPLEX Indicates that a complex surface is being described. A complex surface results in the creation of more than one surface. The additional surfaces are attached to the root surface. The complex structure can be destroyed only by destroying the root. DDSCAPS_FLIP Indicates that this surface is a part of a surface flipping structure. When this capability is passed to the CreateSurfacemethod, a front buffer and one or more back buffers are created. DirectDraw sets the DDSCAPS_FRONTBUFFER bit on the front-buffer surface and the DDSCAPS_BACKBUFFER bit on the surface adjacent to the front-buffer surface. The dwBackBufferCountmember of the DDSURFACEDESCstructure must be set to at least 1 for the method call to succeed. The DDSCAPS_COMPLEX capability must always be set when creating multiple surfaces by using the CreateSurfacemethod. DDSCAPS_FRONTBUFFER Indicates that this surface is the front buffer of a surface flipping structure. This flag is typically set by the CreateSurfacemethod when the DDSCAPS_FLIP capability is set. If this capability is sent to the CreateSurfacemethod, a stand-alone front buffer is created. This surface will not have the DDSCAPS_FLIP capability. It can be attached to other back buffers to form a flipping structure by using IDirectDrawSurface5::AddAttachedSurface. DDSCAPS_HWCODEC Indicates that this surface should be able to have a stream decompressed to it by the hardware. DDSCAPS_LIVEVIDEO Indicates that this surface should be able to receive live video. DDSCAPS_LOCALVIDMEM Indicates that this surface exists in true, local video memory rather than non-local video memory. If this flag is specified then DDSCAPS_VIDEOMEMORY must be specified as well. This flag cannot be used with the DDSCAPS_NONLOCALVIDMEM flag. DDSCAPS_MIPMAP Indicates that this surface is one level of a mipmap. This surface will be attached to other DDSCAPS_MIPMAP surfaces to form the mipmap. This can be done explicitly by creating a number of surfaces and attaching them by using the IDirectDrawSurface5::AddAttachedSurfacemethod, or implicitly by the CreateSurfacemethod. If this capability is set, DDSCAPS_TEXTURE must also be set. DDSCAPS_MODEX Indicates that this surface is either a 320×200 or a 320×240 Mode X surface. DDSCAPS_NONLOCALVIDMEM Indicates that this surface exists in non-local video memory rather than true, local video memory. If this flag is specified, then DDSCAPS_VIDEOMEMORY flag must be specified as well. This cannot be used with the DDSCAPS_LOCALVIDMEM flag. DDSCAPS_OFFSCREENPLAIN Indicates that this surface is any off-screen surface that is not an overlay, texture, Z-buffer, front-buffer, back-buffer, or alpha surface. It is used to identify plain surfaces. DDSCAPS_OPTIMIZED Not currently implemented. Indicates that this surface will be an optimized surface and will be created with no underlying video memory until loaded. This flag is must be used with the DDSCAPS_TEXTURE flag. DDSCAPS_OVERLAY Indicates that this surface is an overlay. It may or may not be directly visible depending on whether it is currently being overlaid onto the primary surface. DDSCAPS_VISIBLE can be used to determine if it is being overlaid at the moment. DDSCAPS_OWNDC Indicates that this surface will have a device context (DC) association for a long period. DDSCAPS_PALETTE Indicates that this device driver allows unique DirectDrawPalette objects to be created and attached to this surface. DDSCAPS_PRIMARYSURFACE Indicates the surface is the primary surface. It represents what is seen by the user at the moment. DDSCAPS_PRIMARYSURFACELEFT Indicates that this surface is the primary surface for the left eye. It represents what is seen by the user's left eye at the moment. When this surface is created, the surface with the DDSCAPS_PRIMARYSURFACE capability represents what is seen by the user's right eye. DDSCAPS_STANDARDVGAMODE Indicates that this surface is a standard VGA mode surface, and not a Mode X surface. This flag cannot be used in combination with the DDSCAPS_MODEX flag. DDSCAPS_SYSTEMMEMORY Indicates that this surface memory was allocated in system memory. DDSCAPS_TEXTURE Indicates that this surface can be used as a 3-D texture. It does not indicate whether the surface is being used for that purpose. DDSCAPS_VIDEOMEMORY Indicates that this surface exists in display memory. DDSCAPS_VIDEOPORT Indicates that this surface can receive data from a video port. DDSCAPS_VISIBLE Indicates that changes made to this surface are immediately visible. It is always set for the primary surface, as well as for overlays while they are being overlaid, and texture maps while they are being textured. DDSCAPS_WRITEONLY Indicates that only write access is permitted to the surface. Read access from the surface may generate a general protection (GP) fault, but the read results from this surface will not be meaningful. DDSCAPS_ZBUFFER Indicates that this surface is the Z-buffer. The Z-buffer contains information that cannot be displayed. Instead, it contains bit-depth information that is used to determine which pixels are visible and which are obscured. Requirements
Runs on Versions Declared in Windows CE OS 2.12 or later. Version 2.12 requires DXPAK 1.0 or later. ddraw.h