Add man pages

Signed-off-by: Mattias Andrée <maandree@kth.se>

1 files changed, 61 insertions, 0 deletions

diff --git a/rtgrpblib_reset_raster.3 b/rtgrpblib_reset_raster.3
new file mode 100644
index 0000000..6681757
--- /dev/null
+++ b/rtgrpblib_reset_raster.3
@@ -0,0 +1,61 @@
+.TH RTGRPBLIB_RESET_RASTER 3 LIBRIFUNKTIONSTECKENSNITTSGLYFRASTERISERINGSPROGRAMBIBLIOTEKET
+.SH NAME
+rtgrpblib_reset_raster - Reuse a drawing buffer
+
+.SH DESCRIPTION
+.LP
+.nf
+#include <librifunktionsteckensnittsglyfrasteriseringsprogrambiblioteket.h>
+
+int rtgrpblib_reset_raster(RTGRPBLIB_RASTER *\fIraster\fP, size_t \fIwidth\fP, size_t \fIheight\fP);
+.fi
+.PP
+Link with
+.IR "-lrifunktionsteckensnittsglyfrasteriseringsprogrambiblioteket" .
+
+.SH DESCRIPTION
+The
+.BR rtgrpblib_reset_raster ()
+function changes a buffer's
+.RI ( raster 's)
+width and height, to
+.I width
+and
+.IR height ,
+respectively, and clears the buffer as if recently
+created. However, the function cannot reallocate
+the buffer, which means that the new area cannot
+be greater than the original area, however it can
+be greater than the current area.
+.PP
+Other configurations in
+.I raster
+are kept as is.
+
+.SH RETURN VALUES
+The
+.BR rtgrpblib_reset_raster ()
+function returns 0 upon successful completion,
+and -1 on failure.
+
+.SH ERRORS
+The
+.BR rtgrpblib_reset_raster ()
+function will fail if:
+.TP
+.B EINVAL
+.I width
+or
+.I height
+is zero.
+.TP
+.B EINVAL
+The product
+.I width
+and
+.I height
+exceeds the original size of the buffer.
+
+.SH SEE ALSO
+.BR librifunktionsteckensnittsglyfrasteriseringsprogrambiblioteket (7),
+.BR rtgrpblib_create_raster (3)