1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
|
.TH TICKIT_RENDERBUFFER_NEW 3
.SH NAME
tickit_renderbuffer_new \- create a new render buffer instance
.SH SYNOPSIS
.EX
.B #include <tickit.h>
.sp
.BI "TickitRenderBuffer *tickit_renderbuffer_new(int " lines ", int " cols );
.EE
.sp
Link with \fI\-ltickit\fP.
.SH DESCRIPTION
\fBtickit_renderbuffer_new\fP() creates a new \fBTickitRenderBuffer\fP instance of the given size. Once constructed, the size is fixed. Initially it has a clipping region covering the entire area, a zero translation offset, no applied masks, no stored pen and no virtual cursor position. It can be reset back to this state at any time by calling \fBtickit_renderbuffer_reset\fP(3).
.PP
The reference count of a newly-constructed render buffer instance will be one. This can be incremented or decremented using \fBtickit_renderbuffer_ref\fP(3) and \fBtickit_renderbuffer_unref\fP(3). When its reference count reaches zero it is destroyed.
.SH "RETURN VALUE"
If successful, \fBtickit_renderbuffer_new\fP() returns a pointer to the new instance.
.SH "SEE ALSO"
.BR tickit_renderbuffer_text (3),
.BR tickit_renderbuffer_blit (3),
.BR tickit_renderbuffer_flush_to_term (3),
.BR tickit_renderbuffer (7),
.BR tickit (7)
|
