Skip to content

Commit

Permalink
doc: Document EGL exported images
Browse files Browse the repository at this point in the history
  • Loading branch information
aperezdc committed Mar 13, 2024
1 parent 4bd27e8 commit 0b35394
Showing 1 changed file with 39 additions and 3 deletions.
42 changes: 39 additions & 3 deletions include/wpe/exported-image-egl.h
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,18 @@
#ifndef __exported_image_egl_h__
#define __exported_image_egl_h__

/**
* SECTION:egl_exported_image
* @short_description: EGL exported images.
* @include wpe/fdo-egl.h
*
* Represents an EGL exported image with some associated attributes.
*
* An `wpe_fdo_egl_exported_image` represents an `EGLImageKHR` object,
* which may be retrieved using wpe_fdo_egl_exported_image_get_egl_image(),
* and provides additional information about it.
*/

#include <stdint.h>

#ifdef __cplusplus
Expand All @@ -40,14 +52,38 @@ typedef void* EGLImageKHR;

struct wpe_fdo_egl_exported_image;

/**
* wpe_fdo_egl_exported_image_get_width:
* @image: (transfer none): An exported EGL image.
*
* Gets the width of an exported @image.
*
* Returns: Image width.
*/
uint32_t
wpe_fdo_egl_exported_image_get_width(struct wpe_fdo_egl_exported_image*);
wpe_fdo_egl_exported_image_get_width(struct wpe_fdo_egl_exported_image *image);

/**
* wpe_fdo_egl_exported_image_get_height:
* @image: (transfer none): An exported EGL image.
*
* Gets the height of an exported @image.
*
* Returns: Image height.
*/
uint32_t
wpe_fdo_egl_exported_image_get_height(struct wpe_fdo_egl_exported_image*);
wpe_fdo_egl_exported_image_get_height(struct wpe_fdo_egl_exported_image *image);

/**
* wpe_fdo_egl_exported_image_get_egl_image:
* @image: (transfer none): An exported EGL image.
*
* Gets the `EGLImage` for en exported @image.
*
* Returns: (transfer none): An `EGLImage` handle.
*/
EGLImageKHR
wpe_fdo_egl_exported_image_get_egl_image(struct wpe_fdo_egl_exported_image*);
wpe_fdo_egl_exported_image_get_egl_image(struct wpe_fdo_egl_exported_image *image);

#ifdef __cplusplus
}
Expand Down

0 comments on commit 0b35394

Please sign in to comment.