Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Document EGL exported images #187

Merged
merged 1 commit into from
Mar 13, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading