You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
142 lines
3.7 KiB
142 lines
3.7 KiB
/*
|
|
* This an unstable interface of wlroots. No guarantees are made regarding the
|
|
* future consistency of this API.
|
|
*/
|
|
#ifndef WLR_USE_UNSTABLE
|
|
#error "Add -DWLR_USE_UNSTABLE to enable unstable wlroots features"
|
|
#endif
|
|
|
|
#ifndef WLR_RENDER_WLR_RENDERER_H
|
|
#define WLR_RENDER_WLR_RENDERER_H
|
|
|
|
#include <stdint.h>
|
|
#include <wayland-server-core.h>
|
|
#include <wlr/render/pass.h>
|
|
#include <wlr/render/wlr_texture.h>
|
|
#include <wlr/util/box.h>
|
|
|
|
struct wlr_backend;
|
|
struct wlr_renderer_impl;
|
|
struct wlr_drm_format_set;
|
|
struct wlr_buffer;
|
|
struct wlr_box;
|
|
struct wlr_fbox;
|
|
|
|
/**
|
|
* A renderer for basic 2D operations.
|
|
*/
|
|
struct wlr_renderer {
|
|
struct {
|
|
struct wl_signal destroy;
|
|
/**
|
|
* Emitted when the GPU is lost, e.g. on GPU reset.
|
|
*
|
|
* Compositors should destroy the renderer and re-create it.
|
|
*/
|
|
struct wl_signal lost;
|
|
} events;
|
|
|
|
// private state
|
|
|
|
const struct wlr_renderer_impl *impl;
|
|
|
|
bool rendering;
|
|
bool rendering_with_buffer;
|
|
};
|
|
|
|
/**
|
|
* Automatically create a new renderer.
|
|
*
|
|
* Selects an appropriate renderer type to use depending on the backend,
|
|
* platform, environment, etc.
|
|
*/
|
|
struct wlr_renderer *wlr_renderer_autocreate(struct wlr_backend *backend);
|
|
|
|
/**
|
|
* Start a render pass with the provided viewport.
|
|
*
|
|
* This should be called after wlr_output_attach_render(). Compositors must call
|
|
* wlr_renderer_end() when they are done.
|
|
*
|
|
* Returns false on failure, in which case compositors shouldn't try rendering.
|
|
*/
|
|
bool wlr_renderer_begin(struct wlr_renderer *r, uint32_t width, uint32_t height);
|
|
/**
|
|
* Start a render pass on the provided struct wlr_buffer.
|
|
*
|
|
* Compositors must call wlr_renderer_end() when they are done.
|
|
*/
|
|
bool wlr_renderer_begin_with_buffer(struct wlr_renderer *r,
|
|
struct wlr_buffer *buffer);
|
|
/**
|
|
* End a render pass.
|
|
*/
|
|
void wlr_renderer_end(struct wlr_renderer *r);
|
|
|
|
/**
|
|
* Get the shared-memory formats supporting import usage. Buffers allocated
|
|
* with a format from this list may be imported via wlr_texture_from_pixels().
|
|
*/
|
|
const uint32_t *wlr_renderer_get_shm_texture_formats(
|
|
struct wlr_renderer *r, size_t *len);
|
|
/**
|
|
* Get the DMA-BUF formats supporting sampling usage. Buffers allocated with
|
|
* a format from this list may be imported via wlr_texture_from_dmabuf().
|
|
*/
|
|
const struct wlr_drm_format_set *wlr_renderer_get_dmabuf_texture_formats(
|
|
struct wlr_renderer *renderer);
|
|
/**
|
|
* Reads out of pixels of the currently bound surface into data. `stride` is in
|
|
* bytes.
|
|
*/
|
|
bool wlr_renderer_read_pixels(struct wlr_renderer *r, uint32_t fmt,
|
|
uint32_t stride, uint32_t width, uint32_t height,
|
|
uint32_t src_x, uint32_t src_y, uint32_t dst_x, uint32_t dst_y, void *data);
|
|
|
|
/**
|
|
* Initializes wl_shm, linux-dmabuf and other buffer factory protocols.
|
|
*
|
|
* Returns false on failure.
|
|
*/
|
|
bool wlr_renderer_init_wl_display(struct wlr_renderer *r,
|
|
struct wl_display *wl_display);
|
|
|
|
/**
|
|
* Initializes wl_shm on the provided struct wl_display.
|
|
*/
|
|
bool wlr_renderer_init_wl_shm(struct wlr_renderer *r,
|
|
struct wl_display *wl_display);
|
|
|
|
/**
|
|
* Obtains the FD of the DRM device used for rendering, or -1 if unavailable.
|
|
*
|
|
* The caller doesn't have ownership of the FD, it must not close it.
|
|
*/
|
|
int wlr_renderer_get_drm_fd(struct wlr_renderer *r);
|
|
|
|
/**
|
|
* Destroys the renderer.
|
|
*
|
|
* Textures must be destroyed separately.
|
|
*/
|
|
void wlr_renderer_destroy(struct wlr_renderer *renderer);
|
|
|
|
/**
|
|
* Allocate and initialise a new render timer.
|
|
*/
|
|
struct wlr_render_timer *wlr_render_timer_create(struct wlr_renderer *renderer);
|
|
|
|
/**
|
|
* Get the render duration in nanoseconds from the timer.
|
|
*
|
|
* Returns -1 if the duration is unavailable.
|
|
*/
|
|
int wlr_render_timer_get_duration_ns(struct wlr_render_timer *timer);
|
|
|
|
/**
|
|
* Destroy the render timer.
|
|
*/
|
|
void wlr_render_timer_destroy(struct wlr_render_timer *timer);
|
|
|
|
#endif
|