cursor.h File Reference

#include <libbase/libbase.h>
#include <libbase/plist.h>
#include <stdbool.h>
#include <stdint.h>
#include "manager.h"
#include "toolkit/toolkit.h"

Include dependency graph for cursor.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	wlmim_cursor_style
struct	wlmim_cursor_options

Typedefs
typedef struct _wlmim_cursor_t	wlmim_cursor_t

Functions
wlmim_cursor_t *	wlmim_cursor_create (wlmim_t *input_manager_ptr, const struct wlmim_cursor_style *style_ptr, const struct wlmim_cursor_options *options_ptr, struct wlr_output_layout *wlr_output_layout_ptr, struct wlr_seat *wlr_seat_ptr, wlmtk_root_t *root_ptr)
void	wlmim_cursor_destroy (wlmim_cursor_t *cursor_ptr)
bool	wlmim_cursor_set_style (wlmim_cursor_t *cursor_ptr, const struct wlmim_cursor_style *style_ptr)
struct wlr_cursor *	wlmim_cursor_wlr_cursor (wlmim_cursor_t *cursor_ptr)
void	wlmim_cursor_attach_input_device (wlmim_cursor_t *cursor_ptr, struct wlr_input_device *wlr_input_device_ptr)
void	wlmim_cursor_detach_input_device (wlmim_cursor_t *cursor_ptr, struct wlr_input_device *wlr_input_device_ptr)

Variables
const bspl_desc_t	wlmim_cursor_style_desc []
const bspl_desc_t	wlmim_cursor_options_desc []
const bs_test_set_t	wlmim_cursor_test_set

Detailed Description

Copyright

Copyright (c) 2026 Philipp Kaeser (kaese.nosp@m.r@gu.nosp@m.bbe.c.nosp@m.h) Copyright 2023 Google LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Typedef Documentation

wlmim_cursor_t

typedef struct _wlmim_cursor_t wlmim_cursor_t

Forward declaration of wlmaker cursor state.

Function Documentation

wlmim_cursor_attach_input_device()

void wlmim_cursor_attach_input_device	(	wlmim_cursor_t *	cursor_ptr,
		struct wlr_input_device *	wlr_input_device_ptr
	)

Attaches the input device. May be a pointer, touch or tablet_tool device.

Parameters

cursor_ptr
wlr_input_device_ptr

wlmim_cursor_create()

wlmim_cursor_t * wlmim_cursor_create	(	wlmim_t *	input_manager_ptr,
		const struct wlmim_cursor_style *	style_ptr,
		const struct wlmim_cursor_options *	options_ptr,
		struct wlr_output_layout *	wlr_output_layout_ptr,
		struct wlr_seat *	wlr_seat_ptr,
		wlmtk_root_t *	root_ptr
	)

Creates the cursor handlers.

Parameters

input_manager_ptr
style_ptr
options_ptr
wlr_output_layout_ptr
wlr_seat_ptr
root_ptr

Returns

The cursor handler or NULL on error.

wlmim_cursor_destroy()

void wlmim_cursor_destroy

(

wlmim_cursor_t *

cursor_ptr

)

Destroys the cursor handlers.

Parameters

cursor_ptr

wlmim_cursor_detach_input_device()

void wlmim_cursor_detach_input_device	(	wlmim_cursor_t *	cursor_ptr,
		struct wlr_input_device *	wlr_input_device_ptr
	)

Detaches the input device.

See also

wlmim_cursor_attach_input_device.

Parameters

cursor_ptr
wlr_input_device_ptr

wlmim_cursor_set_style()

bool wlmim_cursor_set_style	(	wlmim_cursor_t *	cursor_ptr,
		const struct wlmim_cursor_style *	style_ptr
	)

Updates the cursor's style.

Parameters

cursor_ptr
style_ptr

Returns

true on success.

wlmim_cursor_wlr_cursor()

struct wlr_cursor * wlmim_cursor_wlr_cursor

(

wlmim_cursor_t *

cursor_ptr

)

Returns

wlmim_cursor_t::wlr_cursor_ptr.

Variable Documentation

wlmim_cursor_options_desc

const bspl_desc_t wlmim_cursor_options_desc[]

extern

Descriptor for decoding Cursor-relevant config dictionary.

wlmim_cursor_style_desc

const bspl_desc_t wlmim_cursor_style_desc[]

extern

Descriptor for decoding the "Cursor" style dictionary.

wlmim_cursor_test_set

const bs_test_set_t wlmim_cursor_test_set

extern

Unit tests for cursor.