mirror of
https://github.com/brl/mutter.git
synced 2024-11-09 23:46:33 -05:00
wayland: Add documentation to the WaylandBuffer object
https://gitlab.gnome.org/GNOME/mutter/merge_requests/871
This commit is contained in:
parent
542bad60ba
commit
404e713227
@ -22,6 +22,30 @@
|
||||
* Jasper St. Pierre <jstpierre@mecheye.net>
|
||||
*/
|
||||
|
||||
/**
|
||||
* SECTION:meta-wayland-buffer
|
||||
* @title: MetaWaylandBuffer
|
||||
* @short_description: A wrapper for wayland buffers
|
||||
*
|
||||
* #MetaWaylandBuffer is a general wrapper around wl_buffer, the basic way of
|
||||
* passing rendered data from Wayland clients to the compositor. Note that a
|
||||
* buffer can be backed by several types of memory, as specified by
|
||||
* #MetaWaylandBufferType.
|
||||
*/
|
||||
|
||||
/**
|
||||
* MetaWaylandBufferType:
|
||||
* @META_WAYLAND_BUFFER_TYPE_UNKNOWN: Unknown type.
|
||||
* @META_WAYLAND_BUFFER_TYPE_SHM: wl_buffer backed by shared memory
|
||||
* @META_WAYLAND_BUFFER_TYPE_EGL_IMAGE: wl_buffer backed by an EGLImage
|
||||
* @META_WAYLAND_BUFFER_TYPE_EGL_STREAM: wl_buffer backed by an EGLStream (NVIDIA-specific)
|
||||
* @META_WAYLAND_BUFFER_TYPE_DMA_BUF: wl_buffer backed by a Linux DMA-BUF
|
||||
*
|
||||
* Specifies the backing memory for a #MetaWaylandBuffer. Depending on the type
|
||||
* of buffer, this will lead to different handling for the compositor. For
|
||||
* example, a shared-memory buffer will still need to be uploaded to the GPU.
|
||||
*/
|
||||
|
||||
#include "config.h"
|
||||
|
||||
#include "wayland/meta-wayland-buffer.h"
|
||||
@ -449,6 +473,15 @@ meta_wayland_buffer_attach (MetaWaylandBuffer *buffer,
|
||||
return FALSE;
|
||||
}
|
||||
|
||||
/**
|
||||
* meta_wayland_buffer_create_snippet:
|
||||
* @buffer: A #MetaWaylandBuffer object
|
||||
*
|
||||
* If needed, this method creates a #CoglSnippet to make sure the buffer can be
|
||||
* dealt with appropriately in a #CoglPipeline that renders it.
|
||||
*
|
||||
* Returns: (transfer full) (nullable): A new #CoglSnippet, or %NULL.
|
||||
*/
|
||||
CoglSnippet *
|
||||
meta_wayland_buffer_create_snippet (MetaWaylandBuffer *buffer)
|
||||
{
|
||||
@ -582,6 +615,11 @@ meta_wayland_buffer_class_init (MetaWaylandBufferClass *klass)
|
||||
|
||||
object_class->finalize = meta_wayland_buffer_finalize;
|
||||
|
||||
/**
|
||||
* MetaWaylandBuffer::resource-destroyed:
|
||||
*
|
||||
* Called when the underlying wl_resource was destroyed.
|
||||
*/
|
||||
signals[RESOURCE_DESTROYED] = g_signal_new ("resource-destroyed",
|
||||
G_TYPE_FROM_CLASS (object_class),
|
||||
G_SIGNAL_RUN_LAST,
|
||||
|
Loading…
Reference in New Issue
Block a user