aboutsummaryrefslogtreecommitdiffstats
path: root/rtgrpblib_reset_raster.3
blob: 66817579bee4902a14c4ea9e17b51ccb043845b9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
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)