mlx_keys.c File Reference

#include "MLX42/MLX42_Int.h"

Include dependency graph for mlx_keys.c:

Go to the source code of this file.

Functions
static void	mlx_key_callback (GLFWwindow *window, int32_t key, int32_t scancode, int32_t action, int32_t mods)
void	mlx_key_hook (mlx_t *mlx, mlx_keyfunc func, void *param)
bool	mlx_is_key_down (mlx_t *mlx, keys_t key)

Function Documentation

mlx_is_key_down()

bool mlx_is_key_down	(	mlx_t *	mlx,
		keys_t	key
	)

Returns true or false if the key is down or not.

Parameters

[in]	mlx	The MLX instance handle.
[in]	key	The keycode to check, use MLX_KEY_... to specify!

Returns

True or false if the key is down or not.

Definition at line 44 of file mlx_keys.c.

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

mlx_key_callback()

static void mlx_key_callback ( GLFWwindow *  window, int32_t  key, int32_t  scancode, int32_t  action, int32_t  mods  )

static

Definition at line 17 of file mlx_keys.c.

{
    const mlx_t* mlx = glfwGetWindowUserPointer(window);
    const mlx_key_t key_hook = ((mlx_ctx_t*)mlx->context)->key_hook;
    const mlx_key_data_t callback_data = {
        key,
        action,
        scancode,
        mods,
    };
 
    key_hook.func(callback_data, key_hook.param);
}

Here is the caller graph for this function:

mlx_key_hook()

void mlx_key_hook	(	mlx_t *	mlx,
		mlx_keyfunc	func,
		void *	param
	)

This function sets the key callback, which is called when a key is pressed on the keyboard. Useful for single keypress detection.

Parameters

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

Definition at line 33 of file mlx_keys.c.

{
    MLX_NONNULL(mlx);
    MLX_NONNULL(func);
 
    mlx_ctx_t* mlxctx = mlx->context;
    mlxctx->key_hook.func = func;
    mlxctx->key_hook.param = param;
    glfwSetKeyCallback(mlx->window, mlx_key_callback);
}

Here is the call graph for this function: