User Input Hook Callbacks

Optional user-supplied callbacks invoked after the library's own internal event processing. More...

Typedefs
typedef void(BGI_CALL *	WxbgiCharHook) (unsigned int codepoint)
	User hook fired after each printable Unicode character input event.
typedef void(BGI_CALL *	WxbgiCursorPosHook) (int x, int y)
	User hook fired after every mouse cursor movement.
typedef void(BGI_CALL *	WxbgiKeyHook) (int key, int scancode, int action, int mods)
	User hook fired after each key press, repeat, or release event.
typedef void(BGI_CALL *	WxbgiMouseButtonHook) (int button, int action, int mods)
	User hook fired after each mouse button press or release.
typedef void(BGI_CALL *	WxbgiScrollHook) (double xoffset, double yoffset)
	User hook fired after each mouse scroll (wheel) event.

Detailed Description

Optional user-supplied callbacks invoked after the library's own internal event processing.

Register hooks with wxbgi_set_key_hook(), wxbgi_set_char_hook(), wxbgi_set_cursor_pos_hook(), and wxbgi_set_mouse_button_hook(). Pass NULL to any registration function to remove the hook.

Warning

Hooks fire while the library's internal mutex is held. They must not call any wxbgi_* function — doing so will deadlock. Safe operations: update your own variables, set flags, call non-wxbgi code.

Typedef Documentation

WxbgiCharHook

typedef void(BGI_CALL * WxbgiCharHook) (unsigned int codepoint)

User hook fired after each printable Unicode character input event.

codepoint is the Unicode code point (1–255 used by this library; values outside that range are silently dropped before the hook is invoked).

WxbgiCursorPosHook

typedef void(BGI_CALL * WxbgiCursorPosHook) (int x, int y)

User hook fired after every mouse cursor movement.

x and y are the new cursor position in window pixels, origin at the top-left corner of the client area.

WxbgiKeyHook

typedef void(BGI_CALL * WxbgiKeyHook) (int key, int scancode, int action, int mods)

User hook fired after each key press, repeat, or release event.

Parameters mirror the GLFW key callback: key is the GLFW key constant (e.g. GLFW_KEY_ESCAPE), scancode is the raw OS scancode, action is one of WXBGI_KEY_PRESS / WXBGI_KEY_RELEASE / WXBGI_KEY_REPEAT, and mods is a bitfield of WXBGI_MOD_SHIFT, WXBGI_MOD_CTRL, WXBGI_MOD_ALT.

WxbgiMouseButtonHook

typedef void(BGI_CALL * WxbgiMouseButtonHook) (int button, int action, int mods)

User hook fired after each mouse button press or release.

button is WXBGI_MOUSE_LEFT, WXBGI_MOUSE_RIGHT, or WXBGI_MOUSE_MIDDLE. action is WXBGI_KEY_PRESS or WXBGI_KEY_RELEASE. mods is a bitfield of modifier keys.

WxbgiScrollHook

typedef void(BGI_CALL * WxbgiScrollHook) (double xoffset, double yoffset)

User hook fired after each mouse scroll (wheel) event.

xoffset is the horizontal scroll delta; yoffset is the vertical scroll delta. Positive yoffset means scroll up/forward; negative means scroll down/backward. Parameters mirror the GLFW scroll callback.