SDL  2.0
The xdg_surface interface

An interface that may be implemented by a wl_surface, for implementations that provide a desktop-style user interface. More...

Data Structures

struct  xdg_surface_listener
 

Macros

#define XDG_SURFACE_CONFIGURE_SINCE_VERSION   1
 
#define XDG_SURFACE_DESTROY_SINCE_VERSION   1
 
#define XDG_SURFACE_GET_TOPLEVEL_SINCE_VERSION   1
 
#define XDG_SURFACE_GET_POPUP_SINCE_VERSION   1
 
#define XDG_SURFACE_SET_WINDOW_GEOMETRY_SINCE_VERSION   1
 
#define XDG_SURFACE_ACK_CONFIGURE_SINCE_VERSION   1
 

Functions

static int xdg_surface_add_listener (struct xdg_surface *xdg_surface, const struct xdg_surface_listener *listener, void *data)
 
static void xdg_surface_set_user_data (struct xdg_surface *xdg_surface, void *user_data)
 
static voidxdg_surface_get_user_data (struct xdg_surface *xdg_surface)
 
static void xdg_surface_destroy (struct xdg_surface *xdg_surface)
 
static struct xdg_toplevel * xdg_surface_get_toplevel (struct xdg_surface *xdg_surface)
 
static struct xdg_popup * xdg_surface_get_popup (struct xdg_surface *xdg_surface, struct xdg_surface *parent, struct xdg_positioner *positioner)
 
static void xdg_surface_set_window_geometry (struct xdg_surface *xdg_surface, int32_t x, int32_t y, int32_t width, int32_t height)
 
static void xdg_surface_ack_configure (struct xdg_surface *xdg_surface, uint32_t serial)
 

Detailed Description

An interface that may be implemented by a wl_surface, for implementations that provide a desktop-style user interface.

It provides a base set of functionality required to construct user interface elements requiring management by the compositor, such as toplevel windows, menus, etc. The types of functionality are split into xdg_surface roles.

Creating an xdg_surface does not set the role for a wl_surface. In order to map an xdg_surface, the client must create a role-specific object using, e.g., get_toplevel, get_popup. The wl_surface for any given xdg_surface can have at most one role, and may not be assigned any role not based on xdg_surface.

A role must be assigned before any other requests are made to the xdg_surface object.

The client must call wl_surface.commit on the corresponding wl_surface for the xdg_surface state to take effect.

Creating an xdg_surface from a wl_surface which has a buffer attached or committed is a client error, and any attempts by a client to attach or manipulate a buffer prior to the first xdg_surface.configure call must also be treated as errors.

Mapping an xdg_surface-based role surface is defined as making it possible for the surface to be shown by the compositor. Note that a mapped surface is not guaranteed to be visible once it is mapped.

For an xdg_surface to be mapped by the compositor, the following conditions must be met: (1) the client has assigned an xdg_surface-based role to the surface (2) the client has set and committed the xdg_surface state and the role-dependent state to the surface (3) the client has committed a buffer to the surface

A newly-unmapped surface is considered to have met condition (1) out of the 3 required conditions for mapping a surface if its role surface has not been destroyed.

Macro Definition Documentation

◆ XDG_SURFACE_ACK_CONFIGURE_SINCE_VERSION

#define XDG_SURFACE_ACK_CONFIGURE_SINCE_VERSION   1

Definition at line 863 of file xdg-shell-client-protocol.h.

◆ XDG_SURFACE_CONFIGURE_SINCE_VERSION

#define XDG_SURFACE_CONFIGURE_SINCE_VERSION   1

Definition at line 842 of file xdg-shell-client-protocol.h.

◆ XDG_SURFACE_DESTROY_SINCE_VERSION

#define XDG_SURFACE_DESTROY_SINCE_VERSION   1

Definition at line 847 of file xdg-shell-client-protocol.h.

◆ XDG_SURFACE_GET_POPUP_SINCE_VERSION

#define XDG_SURFACE_GET_POPUP_SINCE_VERSION   1

Definition at line 855 of file xdg-shell-client-protocol.h.

◆ XDG_SURFACE_GET_TOPLEVEL_SINCE_VERSION

#define XDG_SURFACE_GET_TOPLEVEL_SINCE_VERSION   1

Definition at line 851 of file xdg-shell-client-protocol.h.

◆ XDG_SURFACE_SET_WINDOW_GEOMETRY_SINCE_VERSION

#define XDG_SURFACE_SET_WINDOW_GEOMETRY_SINCE_VERSION   1

Definition at line 859 of file xdg-shell-client-protocol.h.

Function Documentation

◆ xdg_surface_ack_configure()

static void xdg_surface_ack_configure ( struct xdg_surface *  xdg_surface,
uint32_t  serial 
)
inlinestatic

When a configure event is received, if a client commits the surface in response to the configure event, then the client must make an ack_configure request sometime before the commit request, passing along the serial of the configure event.

For instance, for toplevel surfaces the compositor might use this information to move a surface to the top left only when the client has drawn itself for the maximized or fullscreen state.

If the client receives multiple configure events before it can respond to one, it only has to ack the last configure event.

A client is not required to commit immediately after sending an ack_configure request - it may even ack_configure several times before its next surface commit.

A client may send multiple ack_configure requests before committing, but only the last request sent before a commit indicates which configure event the client really is responding to.

Definition at line 1006 of file xdg-shell-client-protocol.h.

1007 {
1008  wl_proxy_marshal((struct wl_proxy *) xdg_surface,
1009  XDG_SURFACE_ACK_CONFIGURE, serial);
1010 }

References XDG_SURFACE_ACK_CONFIGURE.

◆ xdg_surface_add_listener()

static int xdg_surface_add_listener ( struct xdg_surface *  xdg_surface,
const struct xdg_surface_listener listener,
void data 
)
inlinestatic

Definition at line 825 of file xdg-shell-client-protocol.h.

827 {
828  return wl_proxy_add_listener((struct wl_proxy *) xdg_surface,
829  (void (**)(void)) listener, data);
830 }

◆ xdg_surface_destroy()

static void xdg_surface_destroy ( struct xdg_surface *  xdg_surface)
inlinestatic

Destroy the xdg_surface object. An xdg_surface must only be destroyed after its role object has been destroyed.

Definition at line 891 of file xdg-shell-client-protocol.h.

892 {
893  wl_proxy_marshal((struct wl_proxy *) xdg_surface,
895 
896  wl_proxy_destroy((struct wl_proxy *) xdg_surface);
897 }

References XDG_SURFACE_DESTROY.

◆ xdg_surface_get_popup()

static struct xdg_popup* xdg_surface_get_popup ( struct xdg_surface *  xdg_surface,
struct xdg_surface *  parent,
struct xdg_positioner *  positioner 
)
inlinestatic

This creates an xdg_popup object for the given xdg_surface and gives the associated wl_surface the xdg_popup role.

If null is passed as a parent, a parent surface must be specified using some other protocol, before committing the initial state.

See the documentation of xdg_popup for more details about what an xdg_popup is and how it is used.

Definition at line 932 of file xdg-shell-client-protocol.h.

933 {
934  struct wl_proxy *id;
935 
936  id = wl_proxy_marshal_constructor((struct wl_proxy *) xdg_surface,
937  XDG_SURFACE_GET_POPUP, &xdg_popup_interface, NULL, parent, positioner);
938 
939  return (struct xdg_popup *) id;
940 }

References NULL, xdg_popup_interface, and XDG_SURFACE_GET_POPUP.

◆ xdg_surface_get_toplevel()

static struct xdg_toplevel* xdg_surface_get_toplevel ( struct xdg_surface *  xdg_surface)
inlinestatic

This creates an xdg_toplevel object for the given xdg_surface and gives the associated wl_surface the xdg_toplevel role.

See the documentation of xdg_toplevel for more details about what an xdg_toplevel is and how it is used.

Definition at line 909 of file xdg-shell-client-protocol.h.

910 {
911  struct wl_proxy *id;
912 
913  id = wl_proxy_marshal_constructor((struct wl_proxy *) xdg_surface,
915 
916  return (struct xdg_toplevel *) id;
917 }

References NULL, XDG_SURFACE_GET_TOPLEVEL, and xdg_toplevel_interface.

◆ xdg_surface_get_user_data()

static void* xdg_surface_get_user_data ( struct xdg_surface *  xdg_surface)
inlinestatic

Definition at line 873 of file xdg-shell-client-protocol.h.

874 {
875  return wl_proxy_get_user_data((struct wl_proxy *) xdg_surface);
876 }

◆ xdg_surface_set_user_data()

static void xdg_surface_set_user_data ( struct xdg_surface *  xdg_surface,
void user_data 
)
inlinestatic

Definition at line 866 of file xdg-shell-client-protocol.h.

867 {
868  wl_proxy_set_user_data((struct wl_proxy *) xdg_surface, user_data);
869 }

◆ xdg_surface_set_window_geometry()

static void xdg_surface_set_window_geometry ( struct xdg_surface *  xdg_surface,
int32_t  x,
int32_t  y,
int32_t  width,
int32_t  height 
)
inlinestatic

The window geometry of a surface is its "visible bounds" from the user's perspective. Client-side decorations often have invisible portions like drop-shadows which should be ignored for the purposes of aligning, placing and constraining windows.

The window geometry is double buffered, and will be applied at the time wl_surface.commit of the corresponding wl_surface is called.

When maintaining a position, the compositor should treat the (x, y) coordinate of the window geometry as the top left corner of the window. A client changing the (x, y) window geometry coordinate should in general not alter the position of the window.

Once the window geometry of the surface is set, it is not possible to unset it, and it will remain the same until set_window_geometry is called again, even if a new subsurface or buffer is attached.

If never set, the value is the full bounds of the surface, including any subsurfaces. This updates dynamically on every commit. This unset is meant for extremely simple clients.

The arguments are given in the surface-local coordinate space of the wl_surface associated with this xdg_surface.

The width and height must be greater than zero. Setting an invalid size will raise an error. When applied, the effective window geometry will be the set window geometry clamped to the bounding rectangle of the combined geometry of the surface of the xdg_surface and the associated subsurfaces.

Definition at line 976 of file xdg-shell-client-protocol.h.

977 {
978  wl_proxy_marshal((struct wl_proxy *) xdg_surface,
980 }

References XDG_SURFACE_SET_WINDOW_GEOMETRY.

XDG_SURFACE_DESTROY
#define XDG_SURFACE_DESTROY
Definition: xdg-shell-client-protocol.h:832
NULL
#define NULL
Definition: begin_code.h:167
width
GLint GLint GLsizei width
Definition: SDL_opengl.h:1572
XDG_SURFACE_SET_WINDOW_GEOMETRY
#define XDG_SURFACE_SET_WINDOW_GEOMETRY
Definition: xdg-shell-client-protocol.h:835
data
GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const GLvoid * data
Definition: SDL_opengl.h:1974
XDG_SURFACE_GET_POPUP
#define XDG_SURFACE_GET_POPUP
Definition: xdg-shell-client-protocol.h:834
XDG_SURFACE_ACK_CONFIGURE
#define XDG_SURFACE_ACK_CONFIGURE
Definition: xdg-shell-client-protocol.h:836
x
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1574
height
GLint GLint GLsizei GLsizei height
Definition: SDL_opengl.h:1572
xdg_toplevel_interface
const struct wl_interface xdg_toplevel_interface
Definition: xdg-shell-protocol.c:143
xdg_popup_interface
const struct wl_interface xdg_popup_interface
Definition: xdg-shell-protocol.c:159
XDG_SURFACE_GET_TOPLEVEL
#define XDG_SURFACE_GET_TOPLEVEL
Definition: xdg-shell-client-protocol.h:833
y
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1574
id
GLuint id
Definition: SDL_opengl_glext.h:531