mlx_cursor.c File Reference

#include "MLX42/MLX42_Int.h"

Include dependency graph for mlx_cursor.c:

Go to the source code of this file.

Functions
mlx_win_cursor_t *	mlx_create_std_cursor (cursor_t type)
mlx_win_cursor_t *	mlx_create_cursor (mlx_texture_t *texture)
void	mlx_destroy_cursor (mlx_win_cursor_t *cursor)
void	mlx_set_cursor (mlx_t *mlx, mlx_win_cursor_t *cursor)
void	mlx_set_cursor_mode (mlx_t *mlx, mouse_mode_t mode)

Function Documentation

mlx_create_cursor()

mlx_win_cursor_t * mlx_create_cursor

(

mlx_texture_t *

texture

)

Allows for the creation of custom cursors with a given texture.

Use mlx_set_cursor to select the specific cursor. Cursors are destroyed at mlx_terminate().

Parameters

[in]

texture

The texture to use as cursor.

Returns

The cursor object or null on failure.

Definition at line 27 of file mlx_cursor.c.

{
    MLX_NONNULL(texture);
 
    GLFWcursor* cursor;
    GLFWimage image = (GLFWimage) {
        .width = texture->width,
        .height = texture->height,
        .pixels = texture->pixels
    };
 
    if ((cursor = glfwCreateCursor(&image, 0, 0)))
        return (cursor);
    return ((void *)mlx_error(MLX_MEMFAIL));
}

Here is the call graph for this function:

mlx_create_std_cursor()

mlx_win_cursor_t * mlx_create_std_cursor

(

cursor_t

type

)

Retrieves the system standard cursor.

Parameters

[in]

type

The standard cursor type to create.

Returns

The cursor object or null on failure.

Definition at line 17 of file mlx_cursor.c.

{
    MLX_ASSERT(type >= MLX_CURSOR_ARROW && type < MLX_CURSOR_VRESIZE, "Invalid standard cursor type");
 
    GLFWcursor* cursor;
    if ((cursor = glfwCreateStandardCursor(type)))
        return (cursor);
    return ((void *)mlx_error(MLX_MEMFAIL));
}

Here is the call graph for this function:

mlx_destroy_cursor()

void mlx_destroy_cursor

(

mlx_win_cursor_t *

cursor

)

Destroys the given cursor object.

Parameters

[in]

cursor

The cursor object to destroy.

Definition at line 43 of file mlx_cursor.c.

{
    MLX_NONNULL(cursor);
 
    glfwDestroyCursor(cursor);
}

mlx_set_cursor()

void mlx_set_cursor	(	mlx_t *	mlx,
		mlx_win_cursor_t *	cursor
	)

Sets the current cursor to the given custom cursor.

Parameters

[in]	mlx	The MLX instance handle.
[in]	cursor	The cursor object to display, if null default cursor is selected.

Definition at line 50 of file mlx_cursor.c.

{
    MLX_NONNULL(mlx);
    MLX_NONNULL(cursor);
 
    glfwSetCursor(mlx->window, cursor);
}

mlx_set_cursor_mode()

void mlx_set_cursor_mode	(	mlx_t *	mlx,
		mouse_mode_t	mode
	)

Defines the state for the cursor.

Parameters

[in]	mlx	The MLX instance handle.
[in]	mode	A specified mouse mode.

Definition at line 58 of file mlx_cursor.c.

{
    MLX_NONNULL(mlx);
 
    glfwSetInputMode(mlx->window, GLFW_CURSOR, mode);
}