From d0961a02af36aee2b051ac6775c928a1f64ebc70 Mon Sep 17 00:00:00 2001 From: emersion Date: Tue, 30 Jan 2018 10:00:58 +0100 Subject: [PATCH] render: add wlr_renderer_scissor docs --- include/wlr/render.h | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/include/wlr/render.h b/include/wlr/render.h index 46ee0fa3..c277ab17 100644 --- a/include/wlr/render.h +++ b/include/wlr/render.h @@ -15,6 +15,11 @@ void wlr_renderer_begin(struct wlr_renderer *r, struct wlr_output *output); void wlr_renderer_end(struct wlr_renderer *r); void wlr_renderer_clear(struct wlr_renderer *r, float red, float green, float blue, float alpha); +/** + * Defines a scissor box. Only pixels that lie within the scissor box can be + * modified by drawing functions. Providing a NULL `box` disables the scissor + * box. + */ void wlr_renderer_scissor(struct wlr_renderer *r, struct wlr_box *box); /** * Requests a texture handle from this renderer.