Function in ldk_os.h

ldk_os_mouse_button_down

Test whether the button was pressed during the current input update.

LDK_API bool ldk_os_mouse_button_down(
 LDKMouseState *state,
 LDKMouseButton button
);

Parameters

LDKMouseState *state
Input snapshot or state object to query.
LDKMouseButton button
Mouse or input button to query.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_os.h

ldk_os_mouse_button_is_pressed

Test whether the button is currently held.

LDK_API bool ldk_os_mouse_button_is_pressed(
 LDKMouseState *state,
 LDKMouseButton button
);

Parameters

LDKMouseState *state
Input snapshot or state object to query.
LDKMouseButton button
Mouse or input button to query.

Returns

True when the queried condition holds; false otherwise.

Function in ldk_os.h

ldk_os_mouse_button_up

Test whether the button was released during the current input update.

LDK_API bool ldk_os_mouse_button_up(
 LDKMouseState *state,
 LDKMouseButton button
);

Parameters

LDKMouseState *state
Input snapshot or state object to query.
LDKMouseButton button
Mouse or input button to query.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_os.h

ldk_os_mouse_cursor_relative

Get the mouse cursor position relative to the active client area.

LDK_API LDKPoint ldk_os_mouse_cursor_relative(LDKMouseState *state);

Parameters

LDKMouseState *state
Input snapshot or state object to query.

Returns

The resulting point.

Function in ldk_os.h

ldk_os_mouse_state_get

Get the OS mouse state.

LDK_API void ldk_os_mouse_state_get(LDKMouseState *outState);

Parameters

LDKMouseState *outState
Receives the requested input state snapshot.
Function in ldk_os.h

ldk_os_mouse_wheel_delta

Get the accumulated mouse wheel movement in the input snapshot.

LDK_API i32 ldk_os_mouse_wheel_delta(LDKMouseState *state);

Parameters

LDKMouseState *state
Input snapshot or state object to query.

Returns

The resulting integer value.