From eb25f878a44f99544872818f91d528e3836a2e67 Mon Sep 17 00:00:00 2001 From: Simon Lees Date: Mon, 11 Mar 2024 19:38:55 +1030 Subject: [PATCH] Document cairo_place_image --- doc/lua.yaml | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/doc/lua.yaml b/doc/lua.yaml index ce5852a0..e9538cea 100644 --- a/doc/lua.yaml +++ b/doc/lua.yaml @@ -194,4 +194,18 @@ values: | | 0.5 for half size etc. | | | Default value: No Scaling (1.0,1.0) | - require('cairo_imlib2_helper') in your lua file. \ No newline at end of file + require('cairo_imlib2_helper') in your lua file. + - name: cairo_place_image(file, cr, x, y, width, height, alpha) + desc: |- + Renders an image onto a cairo_t, using imlib2. In some cases using a cairo_t and exact coordinates is more + useful. + + | Argument | Description | + |---------------------|--------------------------------------------------------------------------------------| + | file | Path to the image to render. | + | cr | The `cairo_t` to render to. | + | x,y | Position to render the image. | + | width, height | The width and height to draw the image | + | alpha | The transparency of the image 1.0 is solid 0.0 is fully translucent. | + + require('cairo_imlib2_helper') in your lua file. \ No newline at end of file