public class WlShmPoolProxy extends Proxy<WlShmPoolEvents>
The wl_shm_pool object encapsulates a piece of memory shared between the compositor and client. Through the wl_shm_pool object, the client can allocate shared memory wl_buffer objects. All objects created through the same pool share the same underlying mapped memory. Reusing the mapped memory avoids the setup/teardown overhead and is useful when interactively resizing a surface or for many small buffers.
| Modifier and Type | Field and Description |
|---|---|
static String |
INTERFACE_NAME |
| Constructor and Description |
|---|
WlShmPoolProxy(long pointer) |
WlShmPoolProxy(long pointer,
WlShmPoolEvents implementation,
int version) |
| Modifier and Type | Method and Description |
|---|---|
WlBufferProxy |
createBuffer(WlBufferEvents implementation,
int offset,
int width,
int height,
int stride,
int format)
create a buffer from the pool
|
void |
destroy()
destroy the pool
|
void |
resize(int size)
change the size of the pool mapping
|
equals, getId, getImplementation, getPointer, getVersion, hashCode, marshal, marshal, marshalConstructor, setQueuepublic static final String INTERFACE_NAME
public WlShmPoolProxy(long pointer,
WlShmPoolEvents implementation,
int version)
public WlShmPoolProxy(long pointer)
public WlBufferProxy createBuffer(WlBufferEvents implementation, int offset, int width, int height, int stride, int format)
Create a wl_buffer object from the pool.
The buffer is created offset bytes into the pool and has width and height as specified. The stride argument specifies the number of bytes from the beginning of one row to the beginning of the next. The format is the pixel format of the buffer and must be one of those advertised through the wl_shm.format event.
A buffer will keep a reference to the pool it was created from so it is valid to destroy the pool immediately after creating a buffer from it.
implementation - A protocol event listener for the newly created proxy.offset - buffer byte offset within the poolwidth - buffer width, in pixelsheight - buffer height, in pixelsstride - number of bytes from the beginning of one row to the beginning of the next rowformat - buffer pixel formatpublic void destroy()
Destroy the shared memory pool.
The mmapped memory will be released when all buffers that have been created from this pool are gone.
destroy in class Proxy<WlShmPoolEvents>public void resize(int size)
This request will cause the server to remap the backing memory for the pool from the file descriptor passed when the pool was created, but using the new size. This request can only be used to make the pool bigger.
size - new size of the pool, in bytesCopyright © 2016. All rights reserved.