IDirectDrawVideo::GetSurfaceType method

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

Syntax


HRESULT GetSurfaceType(
   DWORD *pSurfaceType
);

Parameters

pSurfaceType

Pointer to variable that receives a bitwise-OR of one or more of the following values.

Value Description
AMDDS_NONENo use for DCI/DirectDraw.
AMDDS_DCIPSUse DCI primary surface.
AMDDS_PSUse DirectDraw primary surface.
AMDDS_RGBOVRRGB overlay surfaces.
AMDDS_YUVOVRYUV overlay surfaces.
AMDDS_RGBOFFRGB off-screen surfaces.
AMDDS_YUVOFFYUV off-screen surfaces.
AMDDS_RGBFLPRGB flipping surfaces.
AMDDS_YUVFLPYUV flipping surfaces.
AMDDS_ALLAll the previous flags.
AMDDS_DEFAULTUse 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 value

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

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Amvideo.h (include Dshow.h)

Library

Strmiids.lib

See also

Error and Success Codes
IDirectDrawVideo Interface

 

 

Show: