Direct3DDevice8.SetCursorPosition

Sets the cursor position and update options.

object.SetCursorPosition( _ 
    XScreenSpace As Long, _ 
    YScreenSpace As Long
    Flags As CONST_D3DSCPFLAGS)

Parts

object

Object expression that resolves to a Direct3DDevice8 object.

XScreenSpace

The new X-position of the cursor in screen-space coordinates. See Remarks.

YScreenSpace

The new Y-position of the cursor in screen-space coordinates. See Remarks.

Flags

Specifies the update options for the cursor. Currently, only one flag is defined.

D3DCURSOR_IMMEDIATE_UPDATE

Update cursor at the refresh rate.

If this flag is specified, the system guarantees that the cursor will be updated at a minimum of half the display refresh rate but never more frequently than the display refresh rate. Otherwise, the method delays cursor updates until the next Direct3DDevice8.Present call. Not setting this flag usually results in better performance than if the flag is set. However, applications should set this flag if the rate of calls to Present is low enough that users would notice a significant delay in cursor motion. This flag has no effect in a windowed mode application. Some video cards implement hardware color cursors. This flag doesn't have an effect on these cards either.

Error Codes

If the method fails, an error is raised and Err.Number can be set to D3DERR_INVALIDCALL.

For information on trapping errors, see the Microsoft® Visual Basic® Error Handling topic.

Remarks

When running in full-screen mode, screen-space coordinates are the back buffer coordinates appropriately scaled to the current display mode. When running in windowed mode, screen-space coordinates are the desktop coordinates. The cursor image is drawn at the specified position minus the hotspot offset specified by the Direct3DDevice8.SetCursorProperties method.

If the cursor has been hidden by Direct3DDevice8.ShowCursor, then the cursor is not drawn.

See Also

Direct3DDevice8.SetCursorProperties, Direct3DDevice8.ShowCursor