surface.h File Reference

#include <libbase/libbase.h>
#include <stdbool.h>
#include <wayland-server-core.h>
#include "element.h"

Include dependency graph for surface.h:

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

Go to the source code of this file.

Classes
struct	_wlmtk_surface_t
struct	_wlmtk_fake_surface_t

Typedefs
typedef struct _wlmtk_surface_t	wlmtk_surface_t
typedef struct _wlmtk_surface_vmt_t	wlmtk_surface_vmt_t
typedef struct _wlmtk_fake_surface_t	wlmtk_fake_surface_t
typedef wlmtk_surface_t *(*	wlmtk_surface_create_t) (struct wlr_surface *wlr_surface_ptr, struct wlr_seat *wlr_seat_ptr)

Functions
wlmtk_surface_t *	wlmtk_surface_create (struct wlr_surface *wlr_surface_ptr, struct wlr_seat *wlr_seat_ptr)
void	wlmtk_surface_destroy (wlmtk_surface_t *surface_ptr)
wlmtk_element_t *	wlmtk_surface_element (wlmtk_surface_t *surface_ptr)
void	wlmtk_surface_get_size (wlmtk_surface_t *surface_ptr, int *width_ptr, int *height_ptr)
void	wlmtk_surface_set_activated (wlmtk_surface_t *surface_ptr, bool activated)
void	wlmtk_surface_connect_map_listener_signal (wlmtk_surface_t *surface_ptr, struct wl_listener *listener_ptr, wl_notify_func_t handler)
void	wlmtk_surface_connect_unmap_listener_signal (wlmtk_surface_t *surface_ptr, struct wl_listener *listener_ptr, wl_notify_func_t handler)
wlmtk_fake_surface_t *	wlmtk_fake_surface_create (void)
wlmtk_surface_t *	wlmtk_fake_surface_create_inject (struct wlr_surface *wlr_surface_ptr, struct wlr_seat *wlr_seat_ptr)
void	wlmtk_fake_surface_commit_size (wlmtk_fake_surface_t *fake_surface_ptr, int width, int height)
void	wlmtk_fake_surface_destroy (wlmtk_fake_surface_t *fake_surface_ptr)

Variables
const bs_test_case_t	wlmtk_surface_test_cases []

Detailed Description

Copyright

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

wlmtk_fake_surface_t

typedef struct _wlmtk_fake_surface_t wlmtk_fake_surface_t

Forward declaration: State of fake surface, for tests.

wlmtk_surface_create_t

typedef wlmtk_surface_t *(* wlmtk_surface_create_t) (struct wlr_surface *wlr_surface_ptr, struct wlr_seat *wlr_seat_ptr)

Type of the surface ctor, for injection.

See also

wlmtk_surface_create.

wlmtk_surface_t

typedef struct _wlmtk_surface_t wlmtk_surface_t

Forward declaration: State of a toolkit's WLR surface.

wlmtk_surface_vmt_t

typedef struct _wlmtk_surface_vmt_t wlmtk_surface_vmt_t

Forward declaration: Virtual method table of the toolkit's WLR surface.

Function Documentation

wlmtk_fake_surface_commit_size()

void wlmtk_fake_surface_commit_size	(	wlmtk_fake_surface_t *	fake_surface_ptr,
		int	width,
		int	height
	)

Fakes a wlr_surface commit event.

wlmtk_fake_surface_create()

wlmtk_fake_surface_t * wlmtk_fake_surface_create

(

void

)

Ctor for the fake surface.

wlmtk_fake_surface_create_inject()

wlmtk_surface_t * wlmtk_fake_surface_create_inject	(	struct wlr_surface *	wlr_surface_ptr,
		struct wlr_seat *	wlr_seat_ptr
	)

Injectable ctor for the fake surface.

wlmtk_fake_surface_destroy()

void wlmtk_fake_surface_destroy

(

wlmtk_fake_surface_t *

fake_surface_ptr

)

Dtor for the fake surface.

wlmtk_surface_connect_map_listener_signal()

void wlmtk_surface_connect_map_listener_signal	(	wlmtk_surface_t *	surface_ptr,
		struct wl_listener *	listener_ptr,
		wl_notify_func_t	handler
	)

Connects a listener and handler to the map signal of wlr_surface.

wlmtk_surface_connect_unmap_listener_signal()

void wlmtk_surface_connect_unmap_listener_signal	(	wlmtk_surface_t *	surface_ptr,
		struct wl_listener *	listener_ptr,
		wl_notify_func_t	handler
	)

Connects a listener and handler to the unmap signal of wlr_surface.

wlmtk_surface_create()

wlmtk_surface_t * wlmtk_surface_create	(	struct wlr_surface *	wlr_surface_ptr,
		struct wlr_seat *	wlr_seat_ptr
	)

Creates a toolkit surface from the wlr_surface_ptr.

Parameters

wlr_surface_ptr
wlr_seat_ptr

Returns

A pointer to the wlmtk_surface_t. Must be destroyed by calling wlmtk_surface_destroy.

wlmtk_surface_destroy()

void wlmtk_surface_destroy

(

wlmtk_surface_t *

surface_ptr

)

Destroys the toolkit surface.

Parameters

surface_ptr

wlmtk_surface_element()

wlmtk_element_t * wlmtk_surface_element

(

wlmtk_surface_t *

surface_ptr

)

Returns a pointer to the surface's element superclass instance.

Parameters

surface_ptr

Returns

Pointer to the corresponding wlmtk_element_t.

wlmtk_surface_get_size()

void wlmtk_surface_get_size	(	wlmtk_surface_t *	surface_ptr,
		int *	width_ptr,
		int *	height_ptr
	)

Returns committed size of the surface.

Parameters

surface_ptr
width_ptr
height_ptr

wlmtk_surface_set_activated()

void wlmtk_surface_set_activated	(	wlmtk_surface_t *	surface_ptr,
		bool	activated
	)

Activates the surface.

Parameters

surface_ptr
activated

Variable Documentation

wlmtk_surface_test_cases

const bs_test_case_t wlmtk_surface_test_cases[]

extern

Unit test cases.