Package org.freedesktop.wayland.client

Class WlBufferProxy

java.lang.Object

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

org.freedesktop.wayland.client.WlBufferProxy

All Implemented Interfaces:

WaylandObject

public class WlBufferProxy
extends Proxy<WlBufferEvents>

content for a wl_surface

A buffer provides the content for a wl_surface. Buffers are created through factory interfaces such as wl_shm, wp_linux_buffer_params (from the linux-dmabuf protocol extension) or similar. It has a width and a height and can be attached to a wl_surface, but the mechanism by which a client provides and updates the contents is defined by the buffer factory interface.

Color channels are assumed to be electrical rather than optical (in other words, encoded with a transfer function) unless otherwise specified. If the buffer uses a format that has an alpha channel, the alpha channel is assumed to be premultiplied into the electrical color channel values (after transfer function encoding) unless otherwise specified.

Note, because wl_buffer objects are created from multiple independent factory interfaces, the wl_buffer interface is frozen at version 1.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INTERFACE_NAME

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

pointer

Constructor Summary

Constructors

Constructor	Description
WlBufferProxy(MemorySegment pointer)
WlBufferProxy(MemorySegment pointer, WlBufferEvents implementation, int version)

Method Summary

Modifier and Type	Method	Description
void	destroy()	destroy a buffer

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 Details

INTERFACE_NAME

public static final String INTERFACE_NAME

See Also:

• Constant Field Values

Constructor Details

WlBufferProxy

public WlBufferProxy(MemorySegment pointer,
 WlBufferEvents implementation,
 int version)

WlBufferProxy

public WlBufferProxy(MemorySegment pointer)

Method Details

destroy

public void destroy()

destroy a buffer

Destroy a buffer. If and how you need to release the backing storage is defined by the buffer factory interface.

For possible side-effects to a surface, see wl_surface.attach.

Overrides:

destroy in class Proxy<WlBufferEvents>