Package org.freedesktop.wayland.client

Class WlShmProxy

java.lang.Object

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

org.freedesktop.wayland.client.WlShmProxy

All Implemented Interfaces:

WaylandObject

public class WlShmProxy
extends Proxy<WlShmEvents>

shared memory support

A singleton global object that provides support for shared memory.

Clients can create wl_shm_pool objects using the create_pool request.

On binding the wl_shm object one or more format events are emitted to inform clients about the valid pixel formats that can be used for buffers.

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
WlShmProxy(MemorySegment pointer)
WlShmProxy(MemorySegment pointer, WlShmEvents implementation, int version)

Method Summary

Modifier and Type	Method	Description
WlShmPoolProxy	createPool(WlShmPoolEvents implementation, int fd, int size)	create a shm pool
void	release()	release the shm object

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

destroy, 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

WlShmProxy

public WlShmProxy(MemorySegment pointer,
 WlShmEvents implementation,
 int version)

WlShmProxy

public WlShmProxy(MemorySegment pointer)

Method Details

createPool

public WlShmPoolProxy createPool(WlShmPoolEvents implementation,
 int fd,
 int size)

create a shm pool

Create a new wl_shm_pool object.

The pool can be used to create shared memory based buffer objects. The server will mmap size bytes of the passed file descriptor, to use as backing memory for the pool.

Parameters:

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

fd - file descriptor for the pool

size - pool size, in bytes

release

public void release()

release the shm object

Using this request a client can tell the server that it is not going to use the shm object anymore.

Objects created via this interface remain unaffected.