org.freedesktop.wayland.client

Class WlSubcompositorProxy

java.lang.Object

org.freedesktop.wayland.client.Proxy<WlSubcompositorEvents>

org.freedesktop.wayland.client.WlSubcompositorProxy

All Implemented Interfaces:

org.freedesktop.wayland.util.WaylandObject

public class WlSubcompositorProxy
extends Proxy<WlSubcompositorEvents>

sub-surface compositing

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	INTERFACE_NAME

Fields inherited from class org.freedesktop.wayland.client.Proxy

pointer

Constructor Summary

Constructors

Constructor and Description
WlSubcompositorProxy(long pointer)
WlSubcompositorProxy(long pointer, WlSubcompositorEvents implementation, int version)

Method Summary

Modifier and Type	Method and Description
void	destroy() unbind from the subcompositor interface
WlSubsurfaceProxy	getSubsurface(WlSubsurfaceEvents implementation, WlSurfaceProxy surface, WlSurfaceProxy parent) give a surface the role sub-surface

Methods inherited from class org.freedesktop.wayland.client.Proxy

equals, getId, getImplementation, getPointer, getVersion, hashCode, marshal, marshal, marshalConstructor, setQueue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

INTERFACE_NAME

public static final String INTERFACE_NAME

See Also:

Constant Field Values

Constructor Detail

WlSubcompositorProxy

public WlSubcompositorProxy(long pointer,
                            WlSubcompositorEvents implementation,
                            int version)

WlSubcompositorProxy

public WlSubcompositorProxy(long pointer)

Method Detail

destroy

public void destroy()

unbind from the subcompositor interface

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.

Overrides:

destroy in class Proxy<WlSubcompositorEvents>

getSubsurface

public WlSubsurfaceProxy getSubsurface(WlSubsurfaceEvents implementation,
                                       @Nonnull
                                       WlSurfaceProxy surface,
                                       @Nonnull
                                       WlSurfaceProxy parent)

give a surface the role sub-surface

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.

Parameters:

implementation - A protocol event listener for the newly created proxy.

surface - the surface to be turned into a sub-surface

parent - the parent surface