SDL  2.0
The wl_subcompositor interface

Macros

#define WL_SUBCOMPOSITOR_DESTROY_SINCE_VERSION   1
 
#define WL_SUBCOMPOSITOR_GET_SUBSURFACE_SINCE_VERSION   1
 

Functions

static void wl_subcompositor_set_user_data (struct wl_subcompositor *wl_subcompositor, void *user_data)
 
static voidwl_subcompositor_get_user_data (struct wl_subcompositor *wl_subcompositor)
 
static void wl_subcompositor_destroy (struct wl_subcompositor *wl_subcompositor)
 
static struct wl_subsurface * wl_subcompositor_get_subsurface (struct wl_subcompositor *wl_subcompositor, struct wl_surface *surface, struct wl_surface *parent)
 

Detailed Description

The global interface exposing sub-surface compositing capabilities. A wl_surface, that has sub-surfaces associated, is called the parent surface. Sub-surfaces can be arbitrarily nested and create a tree of sub-surfaces.

The root surface in a tree of sub-surfaces is the main surface. The main surface cannot be a sub-surface, because sub-surfaces must always have a parent.

A main surface with its sub-surfaces forms a (compound) window. For window management purposes, this set of wl_surface objects is to be considered as a single window, and it should also behave as such.

The aim of sub-surfaces is to offload some of the compositing work within a window from clients to the compositor. A prime example is a video player with decorations and video in separate wl_surface objects. This should allow the compositor to pass YUV video buffer processing to dedicated overlay hardware when possible.

Macro Definition Documentation

◆ WL_SUBCOMPOSITOR_DESTROY_SINCE_VERSION

#define WL_SUBCOMPOSITOR_DESTROY_SINCE_VERSION   1

Definition at line 5330 of file wayland-client-protocol.h.

◆ WL_SUBCOMPOSITOR_GET_SUBSURFACE_SINCE_VERSION

#define WL_SUBCOMPOSITOR_GET_SUBSURFACE_SINCE_VERSION   1

Definition at line 5334 of file wayland-client-protocol.h.

Function Documentation

◆ wl_subcompositor_destroy()

static void wl_subcompositor_destroy ( struct wl_subcompositor *  wl_subcompositor)
inlinestatic

Informs the server that the client will not be using this protocol object anymore. This does not affect any other objects, wl_subsurface objects included.

Definition at line 5364 of file wayland-client-protocol.h.

References WL_SUBCOMPOSITOR_DESTROY.

5365 {
5366  wl_proxy_marshal((struct wl_proxy *) wl_subcompositor,
5368 
5369  wl_proxy_destroy((struct wl_proxy *) wl_subcompositor);
5370 }
#define WL_SUBCOMPOSITOR_DESTROY

◆ wl_subcompositor_get_subsurface()

static struct wl_subsurface* wl_subcompositor_get_subsurface ( struct wl_subcompositor *  wl_subcompositor,
struct wl_surface *  surface,
struct wl_surface *  parent 
)
static

Create a sub-surface interface for the given surface, and associate it with the given parent surface. This turns a plain wl_surface into a sub-surface.

The to-be sub-surface must not already have another role, and it must not have an existing wl_subsurface object. Otherwise a protocol error is raised.

Adding sub-surfaces to a parent is a double-buffered operation on the parent (see wl_surface.commit). The effect of adding a sub-surface becomes visible on the next time the state of the parent surface is applied.

This request modifies the behaviour of wl_surface.commit request on the sub-surface, see the documentation on wl_subsurface interface.

Definition at line 5392 of file wayland-client-protocol.h.

References NULL, WL_SUBCOMPOSITOR_GET_SUBSURFACE, and wl_subsurface_interface.

5393 {
5394  struct wl_proxy *id;
5395 
5396  id = wl_proxy_marshal_constructor((struct wl_proxy *) wl_subcompositor,
5398 
5399  return (struct wl_subsurface *) id;
5400 }
const struct wl_interface wl_subsurface_interface
GLuint id
EGLSurface surface
Definition: eglext.h:248
#define WL_SUBCOMPOSITOR_GET_SUBSURFACE
#define NULL
Definition: begin_code.h:164

◆ wl_subcompositor_get_user_data()

static void* wl_subcompositor_get_user_data ( struct wl_subcompositor *  wl_subcompositor)
inlinestatic

Definition at line 5345 of file wayland-client-protocol.h.

5346 {
5347  return wl_proxy_get_user_data((struct wl_proxy *) wl_subcompositor);
5348 }

◆ wl_subcompositor_set_user_data()

static void wl_subcompositor_set_user_data ( struct wl_subcompositor *  wl_subcompositor,
void user_data 
)
inlinestatic

Definition at line 5338 of file wayland-client-protocol.h.

5339 {
5340  wl_proxy_set_user_data((struct wl_proxy *) wl_subcompositor, user_data);
5341 }