TDx_DrawSurface::GetAttachedSurface() Reference

BCB-Tools.com

Home of
RAD DirectX

C++ Builder wrapping DirectX

...

Please Register

So we can
create more

the TDx_Library
the TDx9_Library

TDx_Draw_Library v1.90 Component Reference

Component: TDX_DRAWSURFACE::GETATTACHEDSURFACE()

[ TDx_DrawSurface ] [ next: GetBltStatus() ] [ prev: FreePrivateData() ]

public:
virtual bool __fastcall GetAttachedSurface( TDDSCaps* pSCaps, TDx_DrawSurface* pAttachedSurface );

If you would like to submit additions or improvements to this page, click: admin@bcb-tools.com.

DESCRIPTION

Top Parameters See Also

The TDx_DrawSurface::GetAttachedSurface method will retrieve an attached surface with the specified capabilities, incrementing its reference count.

This method will fail if multiple surfaces match the specified capabilities. If this occurs, use TDx_DrawSurface::EnumAttachedSurfaces() to obtain the surface you seek.

If the method call fails, the OnError event will be triggered with one of the following values:
DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS
DDERR_NOTFOUND
DDERR_SURFACELOST

PARAMETERS

Top See Also

SCaps
The SCaps parameter references a TDDSCaps component defining the desired surface's capabilities.

AttachedSurface
The AttachedSurface parameter will reference the retrieved surface if this method returns successfully.