1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
/*
* 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
|
