From e74285dcbec27d71f7126aa937616a871e5bb988 Mon Sep 17 00:00:00 2001 From: Jesper Lloyd Date: Sun, 23 Feb 2020 12:13:33 +0100 Subject: [PATCH] minimal.c: add comment explaining the example --- examples/minimal.c | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/examples/minimal.c b/examples/minimal.c index f5870ea4..796eb130 100644 --- a/examples/minimal.c +++ b/examples/minimal.c @@ -1,6 +1,18 @@ #include "libmypaint.c" #include "mypaint-fixed-tiled-surface.h" +/* + +This example draws a rectangle on a fixed surface, using the default brush. +It only uses pre-v1.5.0 interfaces/structures. + +Compiling and running it will produce a file called "output.ppm". +Open it in a compatible image viewer to see the result. + +The ppm format is _very_ space-inefficient, so only use low resolutions. + +*/ + void stroke_to(MyPaintBrush *brush, MyPaintSurface *surf, float x, float y) {