public:
     virtual bool __fastcall GetOverlayPosition( long* pX, long* pY );

• Description
• Parameters
• See Also

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

The TDx_DrawSurface::GetOverlayPosition method will retrieve the current display coordinates of an overlay surface.

This method will fail unless the surface is a visible, active surface with DDSCAPS_OVERLAY set.

If the method call fails, the OnError event will be triggered with one of the following values:
DDERR_GENERIC
DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS
DDERR_INVALIDPOSITION
DDERR_NOOVERLAYDEST
DDERR_NOTAOVERLAYSURFACE
DDERR_OVERLAYNOTVISIBLE
DDERR_SURFACELOST

X
The X parameter will reference the overlay's X axis display coordinate if this method returns successfully.

Y
The Y parameter will reference the overlay's Y axis display coordinate if this method returns successfully.

TDx_DrawSurface
TDx_DrawSurface::OnSurfaceLost()