backend.h File Reference

#include <stddef.h>
#include <libbase/libbase.h>
#include <libbase/plist.h>

Include dependency graph for backend.h:

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

Go to the source code of this file.

Typedefs
typedef struct _wlmbe_backend_t	wlmbe_backend_t

Functions
wlmbe_backend_t *	wlmbe_backend_create (struct wl_display *wl_display_ptr, struct wlr_scene *wlr_scene_ptr, struct wlr_output_layout *wlr_output_layout_ptr, int width, int height, bspl_dict_t *config_dict_ptr)
void	wlmbe_backend_destroy (wlmbe_backend_t *backend_ptr)
void	wlmbe_backend_switch_to_vt (wlmbe_backend_t *backend_ptr, unsigned vt_num)
struct wlr_backend *	wlmbe_backend_wlr (wlmbe_backend_t *backend_ptr)
struct wlr_compositor *	wlmbe_backend_compositor (wlmbe_backend_t *backend_ptr)
struct wlr_output *	wlmbe_primary_output (struct wlr_output_layout *wlr_output_layout_ptr)
size_t	wlmbe_num_outputs (struct wlr_output_layout *wlr_output_layout_ptr)

Variables
const bs_test_case_t	wlmbe_backend_test_cases []

Detailed Description

Copyright

Copyright 2025 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

wlmbe_backend_t

typedef struct _wlmbe_backend_t wlmbe_backend_t

Forward declaration.

Function Documentation

wlmbe_backend_compositor()

struct wlr_compositor * wlmbe_backend_compositor

(

wlmbe_backend_t *

backend_ptr

)

Accessor. TODO(kaese.nosp@m.r@gu.nosp@m.bbe.c.nosp@m.h): Eliminate.

wlmbe_backend_create()

wlmbe_backend_t * wlmbe_backend_create	(	struct wl_display *	wl_display_ptr,
		struct wlr_scene *	wlr_scene_ptr,
		struct wlr_output_layout *	wlr_output_layout_ptr,
		int	width,
		int	height,
		bspl_dict_t *	config_dict_ptr
	)

Creates the backend drivers.

Parameters

wl_display_ptr
wlr_scene_ptr
wlr_output_layout_ptr
width
height
config_dict_ptr

Returns

the server backend state, or NULL on error.

wlmbe_backend_destroy()

void wlmbe_backend_destroy

(

wlmbe_backend_t *

backend_ptr

)

Destroys the server backend.

Parameters

backend_ptr

wlmbe_backend_switch_to_vt()

void wlmbe_backend_switch_to_vt	(	wlmbe_backend_t *	backend_ptr,
		unsigned	vt_num
	)

Switches to the given virtual terminal, if a wlroots session is available.

Logs if wlr_session_change_vt() fails, but ignores the errors.

Parameters

backend_ptr
vt_num

wlmbe_backend_wlr()

struct wlr_backend * wlmbe_backend_wlr

(

wlmbe_backend_t *

backend_ptr

)

Accessor. TODO(kaese.nosp@m.r@gu.nosp@m.bbe.c.nosp@m.h): Eliminate.

wlmbe_num_outputs()

size_t wlmbe_num_outputs

(

struct wlr_output_layout *

wlr_output_layout_ptr

)

Returns the number of outputs active in the output layout.

Parameters

wlr_output_layout_ptr

Returns

Number of outputs.

wlmbe_primary_output()

struct wlr_output * wlmbe_primary_output

(

struct wlr_output_layout *

wlr_output_layout_ptr

)

Returns the primary output. Currently that is the first output found in the output layout.

Parameters

wlr_output_layout_ptr

Returns

A pointer to the struct wlr_output for the primary output.

Variable Documentation

wlmbe_backend_test_cases

const bs_test_case_t wlmbe_backend_test_cases[]

extern

Unit test cases.