File: ggiSetDisplayFrame.3ggi

package info (click to toggle)
libggi 1%3A2.0.1-2
  • links: PTS
  • area: main
  • in suites: woody
  • size: 6,072 kB
  • ctags: 5,274
  • sloc: ansic: 42,720; sh: 6,508; makefile: 666
file content (45 lines) | stat: -rw-r--r-- 1,569 bytes parent folder | download
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
.\\" auto-generated by docbook2man-spec $Revision: 1.5 $
.TH "ggiSetDisplayFrame" "3ggi" "22 August 2001" "GGI" "LibGGI API"
.SH NAME
ggiSetDisplayFrame, ggiSetWriteFrame, ggiSetReadFrame, ggiGetDisplayFrame, ggiGetWriteFrame, ggiGetReadFrame \- Set or get the current frame for display, writing and reading
.SH SYNOPSIS
\fB#include <ggi/ggi.h>
.sp
int ggiSetDisplayFrame(ggi_visual_t \fIvis\fB, int \fIframeno\fB);
.sp
int ggiSetWriteFrame(ggi_visual_t \fIvis\fB, int \fIframeno\fB);
.sp
int ggiSetReadFrame(ggi_visual_t \fIvis\fB, int \fIframeno\fB);
.sp
int ggiGetDisplayFrame(ggi_visual_t \fIvis\fB);
.sp
int ggiGetWriteFrame(ggi_visual_t \fIvis\fB);
.sp
int ggiGetReadFrame(ggi_visual_t \fIvis\fB);
\fR.SH "DESCRIPTION"
.PP
These functions are used for selecting or getting the current
buffers, when using the multiple buffering
function of LibGGI.
.PP
\fBggiSetDisplayFrame\fR sets the frame that gets displayed. 
.PP
\fBggiSetWriteFrame\fR sets the frame for write operations such as
\fBggiPuts\fR and \fBggiHLine\fR.
.PP
\fBggiSetReadFrame\fR sets the frame for read operations, like
\fBggiGetPixel\fR and the \fBggiCrossBlit\fR source.
.PP
\fBggiGetDisplayFrame\fR reports the frame currently displayed. 
.PP
\fBggiGetWriteFrame\fR reports the frame currently written to. 
.PP
\fBggiSetReadFrame\fR reports the frame currently read from.
.PP
Frames are numbered from 0 to the number of frames requested - 1.
.SH "RETURN VALUE"
.PP
The \fBggiSet*Frame\fR functions return 0 if they
succeed, and <0 if they fail.
.PP
The \fBggiGet*Frame\fR functions never fail.