IDirectDrawVideo::GetSurfaceType method (amvideo.h)
[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
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_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 | 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 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
Requirement | Value |
---|---|
Minimum supported client | Windows 2000 Professional [desktop apps only] |
Minimum supported server | Windows 2000 Server [desktop apps only] |
Target Platform | Windows |
Header | amvideo.h (include Dshow.h) |
Library | Strmiids.lib |