Class

WPEPlatformBuffer

Description [src]

abstract class WPEPlatform.Buffer : GObject.Object
{
  WPEBufferPrivate* priv
}

A buffer to be rendered on a WPEView.

WPEBuffer is an abstract class that represents a buffer produced by the web engine and handed to a WPEView for display through wpe_view_render_buffer(). The WPE platform library provides three concrete implementations: WPEBufferDMABuf, WPEBufferSHM and WPEBufferAndroid.

WPEBuffer offers helpers to import a buffer’s contents as an EGL image with wpe_buffer_import_to_egl_image() or as pixels in memory with wpe_buffer_import_to_pixels(), as well as rendering and release fences for use when the display supports explicit sync.

Hierarchy

Ancestors

GObject

Descendants

Instance methods

wpe_buffer_get_display

Get the WPEDisplay of buffer.

wpe_buffer_get_height

Get the buffer height.

wpe_buffer_get_release_fence

Get the release fence file descriptor of buffer.

wpe_buffer_get_rendering_fence

Get the rendering fence file descriptor of buffer.

wpe_buffer_get_user_data

Get user data previously set with wpe_buffer_set_user_data().

wpe_buffer_get_width

Get the buffer width.

wpe_buffer_import_to_egl_image

Import buffer into an EGL image.

wpe_buffer_import_to_pixels

Import buffer into a pixels buffer. The returned data is owned by the buffer and it’s not a copy, so if you are not going to use it immediately or need to modify the data, you should make a copy.

wpe_buffer_set_release_fence

Set the release fence file descriptor to use for the buffer. The fence will be used to wait before releasing the buffer to be destroyed or reused. The buffer takes the ownership of the file descriptor.

wpe_buffer_set_rendering_fence

Set the rendering fence file descriptor to use for the buffer. The fence will be used to wait before rendering the buffer when the display supports explicit sync, see wpe_display_use_explicit_sync(). The buffer takes the ownership of the file descriptor.

wpe_buffer_set_user_data

Set user_data to buffer. When buffer is destroyed destroy_func is called with user_data.

wpe_buffer_take_release_fence

Get the release fence file descriptor of buffer and set it to -1.

wpe_buffer_take_rendering_fence

Get the rendering fence file descriptor of buffer and set it to -1.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

WPEPlatform.Buffer:display

The WPEDisplay of the buffer.

WPEPlatform.Buffer:height

The buffer height.

WPEPlatform.Buffer:width

The buffer width.

Signals

Signals inherited from GObject (1)

GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct WPEPlatformBufferClass {
  GObjectClass parent_class;
  gpointer (* import_to_egl_image) (
    WPEBuffer* buffer,
    GError** error
  );
  GBytes* (* import_to_pixels) (
    WPEBuffer* buffer,
    GError** error
  );
  gpointer padding;
  
}

No description available.

Class members

parent_class: GObjectClass: No description available.
import_to_egl_image: gpointer (* import_to_egl_image) ( WPEBuffer* buffer, GError** error ): No description available.
import_to_pixels: GBytes* (* import_to_pixels) ( WPEBuffer* buffer, GError** error ): No description available.
padding: gpointer: No description available.

Virtual methods

WPEPlatform.BufferClass.import_to_egl_image

Import buffer into an EGL image.

WPEPlatform.BufferClass.import_to_pixels

Import buffer into a pixels buffer. The returned data is owned by the buffer and it’s not a copy, so if you are not going to use it immediately or need to modify the data, you should make a copy.