Welcome to
www.tdxlibrary.org
Home of the
the TDx_Library...
"RAD DirectX"
for
C++ Builder
...
- Description
The TDx_Draw::EnumSurfaces method will enumerate any existing or possible surfaces compatible with a specfied surface description.
Calling this method triggers the TDx_Draw::OnEnumSurfaces() event.
When DDENUMSURFACES_CANBECREATED is set in the Flags parameter, an attempt is made to create a temporary surface meeting the enumeration critera.
When DDENUMSURFACES_DOESEXIST is set in the Flags parameter, the reference count of each enumerated surface will be incremented.
If you don't wish to utilize those surfaces, use TDx_DrawSurface::Release() to remove them after each enumeration is performed.
If the method call fails, the OnError event will be triggered with one of the following values:
DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS
- Parameters
Flags
The Flags parameter defines flags indicating how the enumeration is to employ the information referenced by the SD parameter of this method.
The described effect applies when the flag is set.
-
DDENUMSURFACES_ALL
All surfaces that meet the search criterion will be enumerated.
DDENUMSURFACES_DOESEXIST must also be set.
DDENUMSURFACES_CANBECREATED
The first surface that meets the search criterion and can be created will be enumerated.
DDENUMSURFACES_MATCH must also be set.
DDENUMSURFACES_DOESEXIST
Only surfaces that already exist and meet the search criterion will be enumerated.
DDENUMSURFACES_MATCH
Only surfaces that match the surface description referenced by the SD parameter of this method will be enumerated.
DDENUMSURFACES_NOMATCH
Only surfaces that do not match the surface description referenced by the SD parameter of this method will be enumerated.
The SurfaceDesc parameter references a TDDSurfaceDesc component defining the surface description to use for the enumeration.
This parameter may be NULL when DDENUMSURFACES_ALL is set in the Flags parameter of this method.
Context
The Context parameter references an application defined object passed to the TDx_Draw::EnumSurfacesCallback() event for each surface enumerated.
- See Also
- Top
TDx_Draw_Library v2.00 Component Reference
|
|
|
[ TDx_Draw::EnumSurfaces() ] [ next: EvaluateMode() ] [ prev: EnumDisplayModes() ] public:
virtual bool __fastcall EnumSurfaces( dword pFlags, TDDSurfaceDesc* pSurfaceDesc, void* pContext );
TDX_DRAW::ENUMSURFACES()
[ component method ]
If you would like to submit additions or improvements to this page, click: darren_john_dwyer@hotmail.com. |
|