Miroirs/libliftoff
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/emersion/libliftoff.git synced 2025-01-13 20:01:35 +01:00
Code Issues Projects Releases Packages Wiki Activity

Add basic docs

Browse source
This commit is contained in:
Simon Ser 2019-08-23 19:37:53 +03:00
parent 7bea0c7bf7
commit c3f546328e
No known key found for this signature in database
GPG key ID: 0FDE7BE0E88F5E48
1 changed files with 24 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
include/libhwc.h
View file

@ -6,18 +6,42 @@
#include <stddef.h> #include <stddef.h>
#include <xf86drmMode.h> #include <xf86drmMode.h>
/**
* Initialize libhwc for a DRM node. The node is expected to have
* DRM_CLIENT_CAP_UNIVERSAL_PLANES and DRM_CLIENT_CAP_ATOMIC enabled.
*/
struct hwc_display *hwc_display_create(int drm_fd); struct hwc_display *hwc_display_create(int drm_fd);
void hwc_display_destroy(struct hwc_display *display); void hwc_display_destroy(struct hwc_display *display);
/**
* Build a layer to plane mapping and append the plane configuration to `req`.
* Callers are expected to commit `req` afterwards and can read the layer to
* plane mapping with `hwc_layer_get_plane_id`.
*/
bool hwc_display_apply(struct hwc_display *display, drmModeAtomicReq *req); bool hwc_display_apply(struct hwc_display *display, drmModeAtomicReq *req);
/**
* Make the display manage a CRTC's planes. The returned output allows callers
* to attach layers.
*/
struct hwc_output *hwc_output_create(struct hwc_display *display, struct hwc_output *hwc_output_create(struct hwc_display *display,
uint32_t crtc_id); uint32_t crtc_id);
void hwc_output_destroy(struct hwc_output *output); void hwc_output_destroy(struct hwc_output *output);
/**
* Create a new layer on an output.
*/
struct hwc_layer *hwc_layer_create(struct hwc_output *output); struct hwc_layer *hwc_layer_create(struct hwc_output *output);
void hwc_layer_destroy(struct hwc_layer *layer); void hwc_layer_destroy(struct hwc_layer *layer);
/**
* Set a property on the layer. Any plane property can be set. If none of the
* planes support the property, the layer won't be mapped to any plane.
*/
void hwc_layer_set_property(struct hwc_layer *layer, const char *name, void hwc_layer_set_property(struct hwc_layer *layer, const char *name,
uint64_t value); uint64_t value);
/**
* Retrieve the plane mapped to this layer. Zero is returned if no plane is
* mapped.
*/
uint32_t hwc_layer_get_plane_id(struct hwc_layer *layer); uint32_t hwc_layer_get_plane_id(struct hwc_layer *layer);
#endif #endif