Package org.freedesktop.wayland.server

Interface WlShmRequestsV2

All Superinterfaces:

WlShmRequests

public interface WlShmRequestsV2
extends WlShmRequests

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 int	VERSION

Method Summary

Modifier and Type	Method	Description
void	createPool(WlShmResource requester, int id, int fd, int size)	create a shm pool
void	release(WlShmResource requester)	release the shm object

Field Details

VERSION

static final int VERSION

See Also:

• Constant Field Values

Method Details

createPool

void createPool(WlShmResource requester,
 int id,
 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.

Specified by:

createPool in interface WlShmRequests

Parameters:

requester - The protocol object that made the request.

id - pool to create

fd - file descriptor for the pool

size - pool size, in bytes

release

void release(WlShmResource requester)

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.

Parameters:

requester - The protocol object that made the request.