Share via

IDirectDrawVideo::GetSurfaceType

  • Article

This method retrieves the actual surface type as a DirectShow DirectDraw Surface (AMDDS) definition.

HRESULT GetSurfaceType(
  DWORD* pSurfaceType
);

Parameters

  • pSurfaceType
    Field filled in with one bit setting selected from the following list of AMDDS definitions.
    Definition Description
    AMDDS_NONE No use for DCI/DirectDraw.
    AMDDS_DCIPS Use DCI primary surface.
    AMDDS_PS Use DirectDraw primary surface.
    AMDDS_RGBOVR RGB overlay surfaces.
    AMDDS_YUVOVR YUV overlay surfaces.
    AMDDS_RGBOFF RGB off-screen surfaces.
    AMDDS_YUVOFF YUV off-screen surfaces.
    AMDDS_RGBFLP RGB flipping surfaces.
    AMDDS_YUVFLP YUV flipping surfaces.
    AMDDS_ALL All the previous flags.
    AMDDS_DEFAULT
    AMDDS_ALL    		 Use all available surfaces.
    AMDDS_YUV (AMDDS_YUVOFF | AMDDS_YUVOVR | AMDDS_YUVFLP).
    AMDDS_RGB (AMDDS_RGBOFF | AMDDS_RGBOVR | AMDDS_RGBFLP).
    AMDDS_PRIMARY (AMDDS_DCIPS | AMDDS_PS).

Return Values

Returns an HRESULT value.

Remarks

It is not always easy to discover which kind of surface is being used by looking at a DDSURFACEDESC structure. Therefore, an application can call GetSurfaceType to retrieve the surface type. The field will be filled in with one bit setting selected from the preceding list of AMDDS definitions.

Requirements

DirectShow applications and DirectShow filters have different include file and link library requirements. See Setting Up the Build Environment for more information.

OS Versions: Windows CE 2.12 and later. Version 2.12 requires DXPAK 1.0 or later.
Header:

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.