glfwSetCursorPos

Sets the position of the cursor, relative to the content area of the window.

This function sets the position, in screen coordinates, of the cursor relative to the upper-left corner of the content area of the specified window. The window must have input focus. If the window does not have input focus when this function is called, it fails silently.

__Do not use this function__ to implement things like camera controls. GLFW already provides the GLFW_CURSOR_DISABLED cursor mode that hides the cursor, transparently re-centers it and provides unconstrained cursor motion. See @ref glfwSetInputMode for more information.

If the cursor mode is GLFW_CURSOR_DISABLED then the cursor position is unconstrained and limited only by the minimum and maximum values of a double.

extern (C) @nogc nothrow __gshared
void
glfwSetCursorPos
(,
double xpos
,
double ypos
)

Parameters

window GLFWwindow*

The desired window.

xpos double

The desired x-coordinate, relative to the left edge of the content area.

ypos double

The desired y-coordinate, relative to the top edge of the content area.

Errors: Possible errors include @ref GLFW_NOT_INITIALIZED and @ref GLFW_PLATFORM_ERROR.

@remark @wayland This function will only work when the cursor mode is GLFW_CURSOR_DISABLED, otherwise it will do nothing.

Thread Safety

This function must only be called from the main thread.

@sa @ref cursor_pos @sa @ref glfwGetCursorPos

Meta

Since

Added in version 3.0. Replaces glfwSetMousePos.

Ingroup: input