subcompositor.h File Reference

#include <stdbool.h>
#include <toolkit/toolkit.h>
#include "wlclient/layer_surface.h"
#include "wlclient/wlclient.h"

Include dependency graph for subcompositor.h:

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

Go to the source code of this file.

Typedefs
typedef struct _wlmdock_subcompositor_t	wlmdock_subcompositor_t

Functions
wlmdock_subcompositor_t *	wlmdock_subcompositor_create (struct wl_display *wl_display_ptr, struct wlr_backend *wlr_backend_ptr, wlmcl_client_t *client_ptr, wlmcl_layer_surface_t *layer_surface_ptr, struct wlmim_cursor_style *cursor_style_ptr, wlmtk_container_t *container_ptr)
bool	wlmdock_subcompositor_start (wlmdock_subcompositor_t *subcompositor_ptr, struct wlr_backend *wlr_backend_ptr, struct wlr_allocator *wlr_allocator_ptr, struct wlr_renderer *wlr_renderer_ptr)
void	wlmdock_subcompositor_destroy (wlmdock_subcompositor_t *subcompositor_ptr)
wlmtk_element_t *	wlmdock_subcompositor_element (wlmdock_subcompositor_t *subcompositor_ptr)

Detailed Description

Interface for a subcompositor based off a wl_surface. TODO(kaese.nosp@m.r@gu.nosp@m.bbe.c.nosp@m.h): Give this module a better name. An output? Scene?

Copyright

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

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

wlmdock_subcompositor_t

typedef struct _wlmdock_subcompositor_t wlmdock_subcompositor_t

Handle to the subcompositor's state.

Function Documentation

wlmdock_subcompositor_create()

wlmdock_subcompositor_t * wlmdock_subcompositor_create	(	struct wl_display *	wl_display_ptr,
		struct wlr_backend *	wlr_backend_ptr,
		wlmcl_client_t *	client_ptr,
		wlmcl_layer_surface_t *	layer_surface_ptr,
		struct wlmim_cursor_style *	cursor_style_ptr,
		wlmtk_container_t *	container_ptr
	)

Creates a subcompositor.

Parameters

wl_display_ptr
wlr_backend_ptr	Must be a wayland backend, not started (yet).
client_ptr
layer_surface_ptr
cursor_style_ptr
container_ptr

Returns

Handle of the compositor, or NULL on error.

wlmdock_subcompositor_destroy()

void wlmdock_subcompositor_destroy

(

wlmdock_subcompositor_t *

subcompositor_ptr

)

Destroys the subcompositor.

Parameters

subcompositor_ptr

wlmdock_subcompositor_element()

wlmtk_element_t * wlmdock_subcompositor_element

(

wlmdock_subcompositor_t *

subcompositor_ptr

)

Returns the topmost element of the subcompositor's element tree.

Parameters

subcompositor_ptr

Returns

Pointer to wlmdock_subcompositor_t::container super element.

wlmdock_subcompositor_start()

bool wlmdock_subcompositor_start	(	wlmdock_subcompositor_t *	subcompositor_ptr,
		struct wlr_backend *	wlr_backend_ptr,
		struct wlr_allocator *	wlr_allocator_ptr,
		struct wlr_renderer *	wlr_renderer_ptr
	)

Starts the subcompositor.

Parameters

subcompositor_ptr
wlr_backend_ptr	Must be a wayland backend, must be started.
wlr_allocator_ptr
wlr_renderer_ptr

Returns

true on success.