From 6bea61a199dd841b23053cf1b8ccd3dd753c0846 Mon Sep 17 00:00:00 2001
From: Mattias Andrée <maandree@kth.se>
Date: Tue, 7 Feb 2023 22:38:36 +0100
Subject: Add man pages
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Mattias Andrée <maandree@kth.se>
---
 rtgrpblib_create_raster.3 | 67 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 67 insertions(+)
 create mode 100644 rtgrpblib_create_raster.3

(limited to 'rtgrpblib_create_raster.3')

diff --git a/rtgrpblib_create_raster.3 b/rtgrpblib_create_raster.3
new file mode 100644
index 0000000..63250e9
--- /dev/null
+++ b/rtgrpblib_create_raster.3
@@ -0,0 +1,67 @@
+.TH RTGRPBLIB_CREATE_RASTER 3 LIBRIFUNKTIONSTECKENSNITTSGLYFRASTERISERINGSPROGRAMBIBLIOTEKET
+.SH NAME
+rtgrpblib_create_raster - Create a drawing buffer
+
+.SH DESCRIPTION
+.LP
+.nf
+#include <librifunktionsteckensnittsglyfrasteriseringsprogrambiblioteket.h>
+
+typedef struct rtgrpblib_raster RTGRPBLIB_RASTER;
+
+RTGRPBLIB_RASTER *rtgrpblib_create_raster(size_t \fIwidth\fP, size_t \fIheight\fP);
+.fi
+.PP
+Link with
+.IR "-lrifunktionsteckensnittsglyfrasteriseringsprogrambiblioteket" .
+
+.SH DESCRIPTION
+The
+.BR rtgrpblib_create_raster ()
+function creates a buffer, with configurations, that the
+library's drawing functions can draw curves in, which the
+.BR rtgrpblib_fill_shapes (3)
+function can ultimately process to generate a image.
+.PP
+The created buffer will be
+.I width
+cells wide, and
+.I height
+cells tall.
+.PP
+The returned object can be deallocated using the
+.BR free (3)
+function, it can also be reinitialised and reshaped
+using the
+.BR rtgrpblib_reset_raster (3)
+function.
+
+.SH RETURN VALUES
+The
+.BR rtgrpblib_create_raster ()
+function returns a pointer to a newly allocated object
+upon successful completion, and
+.I NULL
+on failure.
+
+.SH ERRORS
+The
+.BR rtgrpblib_create_raster ()
+function will fail if:
+.TP
+.B EINVAL
+.I width
+or
+.I height
+is zero.
+.LP
+and may fail if:
+.TP
+.B ENOMEM
+Cannot allocate enough memory.
+
+.SH SEE ALSO
+.BR librifunktionsteckensnittsglyfrasteriseringsprogrambiblioteket (7),
+.BR rtgrpblib_reset_raster (3),
+.BR rtgrpblib_set_draftness (3),
+.BR rtgrpblib_fill_shapes (3)
-- 
cgit v1.2.3-70-g09d2