kray/raylib/Mouse

Mouse

object Mouse

The current mouse and cursor state.

Types

Button

value class Button

Represents a mouse button that can be pressed.

Cursor

value class Cursor

The currently displayed icon over the cursor.

Properties

deltaX

val deltaX: Float

The mouse movement along the X axis between frames.

deltaY

val deltaY: Float

The mouse movement along the Y axis between frames.

isCursorEnabled

var isCursorEnabled: Boolean

Whether the cursor is enabled on the screen.

isCursorHidden

var isCursorHidden: Boolean

Whether the cursor is hidden.

isCursorOnScreen

val isCursorOnScreen: Boolean

Indicates whether the cursor is currently on the screen.

mouseX

var mouseX: Int

The current X position of the mouse.

mouseY

var mouseY: Int

The current Y position of the mouse.

wheelX

val wheelX: Float

The X movement for the mouse wheel.

wheelY

val wheelY: Float

The Y movement for the mouse wheel.

Functions

isDown

fun isDown(button: Mouse.Button): ERROR CLASS: Unresolved name: IsMouseButtonDown

Whether a mouse button is currently in down state, or being pressed.

isPressed

fun isPressed(button: Mouse.Button): ERROR CLASS: Unresolved name: IsMouseButtonPressed

Whether a mouse button was pressed once.

isReleased

fun isReleased(button: Mouse.Button): ERROR CLASS: Unresolved name: IsMouseButtonReleased

Whether a mouse button was released once.

isUp

fun isUp(button: Mouse.Button): ERROR CLASS: Unresolved name: IsMouseButtonUp

Whether a mouse button is currently in up state, or is not being pressed.

setCursor

fun setCursor(cursor: Mouse.Cursor): ERROR CLASS: Unresolved name: SetMouseCursor

Sets the icon of the mouse.

setScale

fun setScale(x: Float, y: Float): ERROR CLASS: Unresolved name: SetMouseScale

Sets the size scale of the mouse pointer.