mlx_mouse.c File Reference

#include "MLX42/MLX42_Int.h"

Include dependency graph for mlx_mouse.c:

Go to the source code of this file.

Functions
static void	mlx_scroll_cb (GLFWwindow *window, double xoffset, double yoffset)
static void	mlx_mouse_cb (GLFWwindow *window, int32_t button, int32_t action, int32_t mods)
static void	mlx_cursor_cb (GLFWwindow *window, double xpos, double ypos)
void	mlx_scroll_hook (mlx_t *mlx, mlx_scrollfunc func, void *param)
void	mlx_mouse_hook (mlx_t *mlx, mlx_mousefunc func, void *param)
void	mlx_cursor_hook (mlx_t *mlx, mlx_cursorfunc func, void *param)
bool	mlx_is_mouse_down (mlx_t *mlx, mouse_key_t key)
void	mlx_set_mouse_pos (mlx_t *mlx, int32_t x, int32_t y)
void	mlx_get_mouse_pos (mlx_t *mlx, int32_t *x, int32_t *y)

Function Documentation

mlx_cursor_cb()

static void mlx_cursor_cb ( GLFWwindow *  window, double  xpos, double  ypos  )

static

Definition at line 33 of file mlx_mouse.c.

{
    const mlx_t* mlx = glfwGetWindowUserPointer(window);
    const mlx_cursor_t cursor_hook = ((mlx_ctx_t*)mlx->context)->cursor_hook;
 
    cursor_hook.func(xpos, ypos, cursor_hook.param);
}

Here is the caller graph for this function:

mlx_cursor_hook()

void mlx_cursor_hook	(	mlx_t *	mlx,
		mlx_cursorfunc	func,
		void *	param
	)

This function sets the cursor callback, which is called when the mouse position changes. Position is relative to the window.

Parameters

[in]	mlx	The MLX instance handle.
[in]	func	The cursor callback function.
[in]	param	An additional optional parameter.

Definition at line 65 of file mlx_mouse.c.

{
    MLX_NONNULL(mlx);
    MLX_NONNULL(func);
 
    mlx_ctx_t* const mlxctx = mlx->context;
    mlxctx->cursor_hook.func = func;
    mlxctx->cursor_hook.param = param;
    glfwSetCursorPosCallback(mlx->window, mlx_cursor_cb);
}

Here is the call graph for this function:

mlx_get_mouse_pos()

void mlx_get_mouse_pos	(	mlx_t *	mlx,
		int32_t *	x,
		int32_t *	y
	)

Returns the current, relative, mouse cursor position on the window, starting from the top left corner.

Negative values or values greater than window width or height indicate that it is outside the window.

Parameters

[in]	mlx	The MLX instance handle.
[out]	x	The position.
[out]	y	The position.

Definition at line 90 of file mlx_mouse.c.

{
    MLX_NONNULL(mlx);
    MLX_NONNULL(x);
    MLX_NONNULL(y);
 
    double xd, yd;
    glfwGetCursorPos(mlx->window, &xd, &yd);
    *x = (int32_t)xd;
    *y = (int32_t)yd;
}

mlx_is_mouse_down()

bool mlx_is_mouse_down	(	mlx_t *	mlx,
		mouse_key_t	key
	)

Checks whether a mouse button is pressed or not.

Parameters

[in]	mlx	The MLX instance handle.
[in]	key	A specific mouse key. e.g MLX_MOUSE_BUTTON_0

Returns

True or false if the mouse key is down or not.

Definition at line 76 of file mlx_mouse.c.

{
    MLX_NONNULL(mlx);
 
    return (glfwGetMouseButton(mlx->window, key) == GLFW_PRESS);
}

mlx_mouse_cb()

static void mlx_mouse_cb ( GLFWwindow *  window, int32_t  button, int32_t  action, int32_t  mods  )

static

Definition at line 25 of file mlx_mouse.c.

{
    const mlx_t* mlx = glfwGetWindowUserPointer(window);
    const mlx_mouse_t mouse_hook = ((mlx_ctx_t*)mlx->context)->mouse_hook;
 
    mouse_hook.func(button, action, mods, mouse_hook.param);
}

Here is the caller graph for this function:

mlx_mouse_hook()

void mlx_mouse_hook	(	mlx_t *	mlx,
		mlx_mousefunc	func,
		void *	param
	)

This function sets the mouse callback, which is called when a mouse does any sort of action such as pressing a key.

Parameters

[in]	mlx	The MLX instance handle.
[in]	func	The mouse callback function.
[in]	param	An additional optional parameter.

Definition at line 54 of file mlx_mouse.c.

{
    MLX_NONNULL(mlx);
    MLX_NONNULL(func);
 
    mlx_ctx_t* const mlxctx = mlx->context;
    mlxctx->mouse_hook.func = func;
    mlxctx->mouse_hook.param = param;
    glfwSetMouseButtonCallback(mlx->window, mlx_mouse_cb);
}

Here is the call graph for this function:

mlx_scroll_cb()

static void mlx_scroll_cb ( GLFWwindow *  window, double  xoffset, double  yoffset  )

static

Definition at line 17 of file mlx_mouse.c.

{
    const mlx_t* mlx = glfwGetWindowUserPointer(window);
    const mlx_scroll_t scroll_hook = ((mlx_ctx_t*)mlx->context)->scroll_hook;
 
    scroll_hook.func(xoffset, yoffset, scroll_hook.param);
}

Here is the caller graph for this function:

mlx_scroll_hook()

void mlx_scroll_hook	(	mlx_t *	mlx,
		mlx_scrollfunc	func,
		void *	param
	)

This function sets the scroll callback, which is called when a scrolling device is used, such as a mouse wheel.

Parameters

[in]	mlx	The MLX instance handle.
[in]	func	The scroll wheel callback function.
[in]	param	An additional optional parameter.

Definition at line 43 of file mlx_mouse.c.

{
    MLX_NONNULL(mlx);
    MLX_NONNULL(func);
 
    mlx_ctx_t* const mlxctx = mlx->context;
    mlxctx->scroll_hook.func = func;
    mlxctx->scroll_hook.param = param;
    glfwSetScrollCallback(mlx->window, mlx_scroll_cb);
}

Here is the call graph for this function:

mlx_set_mouse_pos()

void mlx_set_mouse_pos	(	mlx_t *	mlx,
		int32_t	x,
		int32_t	y
	)

Sets the mouse position.

Parameters

[in]	mlx	The MLX instance handle.
[in]	pos	The position.

Definition at line 83 of file mlx_mouse.c.

{
    MLX_NONNULL(mlx);
 
    glfwSetCursorPos(mlx->window, (double)x, (double)y);
}