nordic-dev.net/wlroots
2
0
Fork 0
mirror of https://gitlab.freedesktop.org/wlroots/wlroots.git synced 2024-11-25 08:32:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

damage_ring: Add notes about damage being in buffer local coordinates

Browse Source
This commit is contained in:
Alexander Orezechowski 2024-10-09 18:15:08 -04:00 committed by Kirill Primak
parent 79e063035c
commit 831e7fc7ee
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
include/wlr/types/wlr_damage_ring.h
View File

@ -40,13 +40,15 @@ void wlr_damage_ring_init(struct wlr_damage_ring *ring);
void wlr_damage_ring_finish(struct wlr_damage_ring *ring); void wlr_damage_ring_finish(struct wlr_damage_ring *ring);
/** /**
* Add a region to the current damage. * Add a region to the current damage. The region must be in the buffer-local
* coordinate space.
*/ */
void wlr_damage_ring_add(struct wlr_damage_ring *ring, void wlr_damage_ring_add(struct wlr_damage_ring *ring,
const pixman_region32_t *damage); const pixman_region32_t *damage);
/** /**
* Add a box to the current damage. * Add a box to the current damage. The box must be in the buffer-local
* coordinate space.
*/ */
void wlr_damage_ring_add_box(struct wlr_damage_ring *ring, void wlr_damage_ring_add_box(struct wlr_damage_ring *ring,
const struct wlr_box *box); const struct wlr_box *box);
@ -65,6 +67,8 @@ void wlr_damage_ring_add_whole(struct wlr_damage_ring *ring);
* *
* Users should damage the ring if an error occurs while rendering or * Users should damage the ring if an error occurs while rendering or
* submitting the new buffer to the backend. * submitting the new buffer to the backend.
*
* The returned damage will be in the buffer-local coordinate space.
*/ */
void wlr_damage_ring_rotate_buffer(struct wlr_damage_ring *ring, void wlr_damage_ring_rotate_buffer(struct wlr_damage_ring *ring,
struct wlr_buffer *buffer, pixman_region32_t *damage); struct wlr_buffer *buffer, pixman_region32_t *damage);