wlr-layer-shell-unstable-v1-client-protocol

wlr-layer-shell-unstable-v1-client-protocol

Functions

Types and Values

Description

Functions

zwlr_layer_shell_v1_set_user_data ()

void
zwlr_layer_shell_v1_set_user_data (struct zwlr_layer_shell_v1 *zwlr_layer_shell_v1,
                                   void *user_data);

zwlr_layer_shell_v1_get_user_data ()

void *
zwlr_layer_shell_v1_get_user_data (struct zwlr_layer_shell_v1 *zwlr_layer_shell_v1);

zwlr_layer_shell_v1_get_version ()

uint32_t
zwlr_layer_shell_v1_get_version (struct zwlr_layer_shell_v1 *zwlr_layer_shell_v1);

zwlr_layer_shell_v1_destroy ()

void
zwlr_layer_shell_v1_destroy (struct zwlr_layer_shell_v1 *zwlr_layer_shell_v1);

zwlr_layer_shell_v1_get_layer_surface ()

struct zwlr_layer_surface_v1 *
zwlr_layer_shell_v1_get_layer_surface (struct zwlr_layer_shell_v1 *zwlr_layer_shell_v1,
                                       struct wl_surface *surface,
                                       struct wl_output *output,
                                       uint32_t layer,
                                       const char *namespace);

zwlr_layer_surface_v1_add_listener ()

int
zwlr_layer_surface_v1_add_listener (struct zwlr_layer_surface_v1 *zwlr_layer_surface_v1,
                                    const struct zwlr_layer_surface_v1_listener *listener,
                                    void *data);

zwlr_layer_surface_v1_set_user_data ()

void
zwlr_layer_surface_v1_set_user_data (struct zwlr_layer_surface_v1 *zwlr_layer_surface_v1,
                                     void *user_data);

zwlr_layer_surface_v1_get_user_data ()

void *
zwlr_layer_surface_v1_get_user_data (struct zwlr_layer_surface_v1 *zwlr_layer_surface_v1);

zwlr_layer_surface_v1_get_version ()

uint32_t
zwlr_layer_surface_v1_get_version (struct zwlr_layer_surface_v1 *zwlr_layer_surface_v1);

zwlr_layer_surface_v1_set_size ()

void
zwlr_layer_surface_v1_set_size (struct zwlr_layer_surface_v1 *zwlr_layer_surface_v1,
                                uint32_t width,
                                uint32_t height);

zwlr_layer_surface_v1_set_anchor ()

void
zwlr_layer_surface_v1_set_anchor (struct zwlr_layer_surface_v1 *zwlr_layer_surface_v1,
                                  uint32_t anchor);

zwlr_layer_surface_v1_set_exclusive_zone ()

void
zwlr_layer_surface_v1_set_exclusive_zone
                               (struct zwlr_layer_surface_v1 *zwlr_layer_surface_v1,
                                int32_t zone);

zwlr_layer_surface_v1_set_margin ()

void
zwlr_layer_surface_v1_set_margin (struct zwlr_layer_surface_v1 *zwlr_layer_surface_v1,
                                  int32_t top,
                                  int32_t right,
                                  int32_t bottom,
                                  int32_t left);

zwlr_layer_surface_v1_set_keyboard_interactivity ()

void
zwlr_layer_surface_v1_set_keyboard_interactivity
                               (struct zwlr_layer_surface_v1 *zwlr_layer_surface_v1,
                                uint32_t keyboard_interactivity);

zwlr_layer_surface_v1_get_popup ()

void
zwlr_layer_surface_v1_get_popup (struct zwlr_layer_surface_v1 *zwlr_layer_surface_v1,
                                 struct xdg_popup *popup);

zwlr_layer_surface_v1_ack_configure ()

void
zwlr_layer_surface_v1_ack_configure (struct zwlr_layer_surface_v1 *zwlr_layer_surface_v1,
                                     uint32_t serial);

zwlr_layer_surface_v1_destroy ()

void
zwlr_layer_surface_v1_destroy (struct zwlr_layer_surface_v1 *zwlr_layer_surface_v1);

Types and Values

ZWLR_LAYER_SHELL_V1_ERROR_ENUM

#define             ZWLR_LAYER_SHELL_V1_ERROR_ENUM

enum zwlr_layer_shell_v1_error

Members

ZWLR_LAYER_SHELL_V1_ERROR_ROLE

   

ZWLR_LAYER_SHELL_V1_ERROR_INVALID_LAYER

   

ZWLR_LAYER_SHELL_V1_ERROR_ALREADY_CONSTRUCTED

   

ZWLR_LAYER_SHELL_V1_LAYER_ENUM

#define             ZWLR_LAYER_SHELL_V1_LAYER_ENUM

enum zwlr_layer_shell_v1_layer

Members

ZWLR_LAYER_SHELL_V1_LAYER_BACKGROUND

   

ZWLR_LAYER_SHELL_V1_LAYER_BOTTOM

   

ZWLR_LAYER_SHELL_V1_LAYER_TOP

   

ZWLR_LAYER_SHELL_V1_LAYER_OVERLAY

   

ZWLR_LAYER_SHELL_V1_GET_LAYER_SURFACE

#define             ZWLR_LAYER_SHELL_V1_GET_LAYER_SURFACE

ZWLR_LAYER_SHELL_V1_GET_LAYER_SURFACE_SINCE_VERSION

#define             ZWLR_LAYER_SHELL_V1_GET_LAYER_SURFACE_SINCE_VERSION

ZWLR_LAYER_SURFACE_V1_ERROR_ENUM

#define             ZWLR_LAYER_SURFACE_V1_ERROR_ENUM

enum zwlr_layer_surface_v1_error

Members

ZWLR_LAYER_SURFACE_V1_ERROR_INVALID_SURFACE_STATE

   

ZWLR_LAYER_SURFACE_V1_ERROR_INVALID_SIZE

   

ZWLR_LAYER_SURFACE_V1_ERROR_INVALID_ANCHOR

   

ZWLR_LAYER_SURFACE_V1_ANCHOR_ENUM

#define             ZWLR_LAYER_SURFACE_V1_ANCHOR_ENUM

enum zwlr_layer_surface_v1_anchor

Members

ZWLR_LAYER_SURFACE_V1_ANCHOR_TOP

   

ZWLR_LAYER_SURFACE_V1_ANCHOR_BOTTOM

   

ZWLR_LAYER_SURFACE_V1_ANCHOR_LEFT

   

ZWLR_LAYER_SURFACE_V1_ANCHOR_RIGHT

   

struct zwlr_layer_surface_v1_listener

struct zwlr_layer_surface_v1_listener {
	/**
	 * suggest a surface change
	 *
	 * The configure event asks the client to resize its surface.
	 *
	 * Clients should arrange their surface for the new states, and
	 * then send an ack_configure request with the serial sent in this
	 * configure event at some point before committing the new surface.
	 *
	 * The client is free to dismiss all but the last configure event
	 * it received.
	 *
	 * The width and height arguments specify the size of the window in
	 * surface-local coordinates.
	 *
	 * The size is a hint, in the sense that the client is free to
	 * ignore it if it doesn't resize, pick a smaller size (to satisfy
	 * aspect ratio or resize in steps of NxM pixels). If the client
	 * picks a smaller size and is anchored to two opposite anchors
	 * (e.g. 'top' and 'bottom'), the surface will be centered on this
	 * axis.
	 *
	 * If the width or height arguments are zero, it means the client
	 * should decide its own window dimension.
	 */
	void (*configure)(void *data,
			  struct zwlr_layer_surface_v1 *zwlr_layer_surface_v1,
			  uint32_t serial,
			  uint32_t width,
			  uint32_t height);
	/**
	 * surface should be closed
	 *
	 * The closed event is sent by the compositor when the surface
	 * will no longer be shown. The output may have been destroyed or
	 * the user may have asked for it to be removed. Further changes to
	 * the surface will be ignored. The client should destroy the
	 * resource after receiving this event, and create a new surface if
	 * they so choose.
	 */
	void (*closed)(void *data,
		       struct zwlr_layer_surface_v1 *zwlr_layer_surface_v1);
};

ZWLR_LAYER_SURFACE_V1_SET_SIZE

#define             ZWLR_LAYER_SURFACE_V1_SET_SIZE

ZWLR_LAYER_SURFACE_V1_SET_ANCHOR

#define             ZWLR_LAYER_SURFACE_V1_SET_ANCHOR

ZWLR_LAYER_SURFACE_V1_SET_EXCLUSIVE_ZONE

#define             ZWLR_LAYER_SURFACE_V1_SET_EXCLUSIVE_ZONE

ZWLR_LAYER_SURFACE_V1_SET_MARGIN

#define             ZWLR_LAYER_SURFACE_V1_SET_MARGIN

ZWLR_LAYER_SURFACE_V1_SET_KEYBOARD_INTERACTIVITY

#define             ZWLR_LAYER_SURFACE_V1_SET_KEYBOARD_INTERACTIVITY

ZWLR_LAYER_SURFACE_V1_GET_POPUP

#define             ZWLR_LAYER_SURFACE_V1_GET_POPUP

ZWLR_LAYER_SURFACE_V1_ACK_CONFIGURE

#define             ZWLR_LAYER_SURFACE_V1_ACK_CONFIGURE

ZWLR_LAYER_SURFACE_V1_DESTROY

#define             ZWLR_LAYER_SURFACE_V1_DESTROY

ZWLR_LAYER_SURFACE_V1_CONFIGURE_SINCE_VERSION

#define             ZWLR_LAYER_SURFACE_V1_CONFIGURE_SINCE_VERSION

ZWLR_LAYER_SURFACE_V1_CLOSED_SINCE_VERSION

#define             ZWLR_LAYER_SURFACE_V1_CLOSED_SINCE_VERSION

ZWLR_LAYER_SURFACE_V1_SET_SIZE_SINCE_VERSION

#define             ZWLR_LAYER_SURFACE_V1_SET_SIZE_SINCE_VERSION

ZWLR_LAYER_SURFACE_V1_SET_ANCHOR_SINCE_VERSION

#define             ZWLR_LAYER_SURFACE_V1_SET_ANCHOR_SINCE_VERSION

ZWLR_LAYER_SURFACE_V1_SET_EXCLUSIVE_ZONE_SINCE_VERSION

#define             ZWLR_LAYER_SURFACE_V1_SET_EXCLUSIVE_ZONE_SINCE_VERSION

ZWLR_LAYER_SURFACE_V1_SET_MARGIN_SINCE_VERSION

#define             ZWLR_LAYER_SURFACE_V1_SET_MARGIN_SINCE_VERSION

ZWLR_LAYER_SURFACE_V1_SET_KEYBOARD_INTERACTIVITY_SINCE_VERSION

#define             ZWLR_LAYER_SURFACE_V1_SET_KEYBOARD_INTERACTIVITY_SINCE_VERSION

ZWLR_LAYER_SURFACE_V1_GET_POPUP_SINCE_VERSION

#define             ZWLR_LAYER_SURFACE_V1_GET_POPUP_SINCE_VERSION

ZWLR_LAYER_SURFACE_V1_ACK_CONFIGURE_SINCE_VERSION

#define             ZWLR_LAYER_SURFACE_V1_ACK_CONFIGURE_SINCE_VERSION

ZWLR_LAYER_SURFACE_V1_DESTROY_SINCE_VERSION

#define             ZWLR_LAYER_SURFACE_V1_DESTROY_SINCE_VERSION

struct wl_output

struct wl_output;

struct wl_surface

struct wl_surface;

struct xdg_popup

struct xdg_popup;

struct zwlr_layer_shell_v1

struct zwlr_layer_shell_v1;

struct zwlr_layer_surface_v1

struct zwlr_layer_surface_v1;