← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/vnc4/gutsy

« back to all changes in this revision

Viewing changes to unix/xc/doc/man/GL/gl/interleavedarrays.3gl

  • Committer: Bazaar Package Importer
  • Author(s): Ola Lundqvist
  • Date: 2006-05-15 20:35:17 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20060515203517-l4lre1ku942mn26k
Tags: 4.1.1+X4.3.0-10
* Correction of critical security issue. Thanks to Martin Kogler
  <e9925248@student.tuwien.ac.at> that informed me about the issue,
  and provided the patch.
  This flaw was originally found by Steve Wiseman of intelliadmin.com.
* Applied patch from Javier Kohen <jkohen@users.sourceforge.net> that
  inform the user that only 8 first characters of the password will
  actually be used when typing more than 8 characters, closes:
  #355619.

Show diffs side-by-side

added added

removed removed

Lines of Context:
unix/xc/doc/man/GL/gl/interleavedarrays.3gl
 
1
'\" te
 
2
'\"! tbl|eqn | mmdoc
 
3
'\"macro stdmacro
 
4
.ds Vn Version 1.2
 
5
.ds Dt 24 September 1999
 
6
.ds Re Release 1.2.1
 
7
.ds Dp Jan 14 18:30
 
8
.ds Dm 01 interleav
 
9
.ds Xs 31502 6 interleavedarrays.gl
 
10
.TH GLINTERLEAVEDARRAYS 3G
 
11
.SH NAME
 
12
.B "glInterleavedArrays
 
13
\- simultaneously specify and enable several interleaved arrays
 
14
 
 
15
.SH C SPECIFICATION
 
16
void \f3glInterleavedArrays\fP(
 
17
GLenum \fIformat\fP,
 
18
.nf
 
19
.ta \w'\f3void \fPglInterleavedArrays( 'u
 
20
        GLsizei \fIstride\fP,
 
21
        const GLvoid \fI*pointer\fP )
 
22
.fi
 
23
 
 
24
.SH PARAMETERS
 
25
.TP \w'\fIpointer\fP\ \ 'u 
 
26
\f2format\fP
 
27
Specifies the type of array to enable. Symbolic constants
 
28
\%\f3GL_V2F\fP,
 
29
\%\f3GL_V3F\fP,
 
30
\%\f3GL_C4UB_V2F\fP,
 
31
\%\f3GL_C4UB_V3F\fP,
 
32
\%\f3GL_C3F_V3F\fP,
 
33
\%\f3GL_N3F_V3F\fP,
 
34
\%\f3GL_C4F_N3F_V3F\fP,
 
35
\%\f3GL_T2F_V3F\fP,
 
36
\%\f3GL_T4F_V4F\fP,
 
37
\%\f3GL_T2F_C4UB_V3F\fP,
 
38
\%\f3GL_T2F_C3F_V3F\fP,
 
39
\%\f3GL_T2F_N3F_V3F\fP,
 
40
\%\f3GL_T2F_C4F_N3F_V3F\fP,
 
41
and
 
42
\%\f3GL_T4F_C4F_N3F_V4F\fP
 
43
are accepted. 
 
44
.TP
 
45
\f2stride\fP 
 
46
Specifies the offset in bytes between each aggregate array element.
 
47
.SH DESCRIPTION
 
48
\%\f3glInterleavedArrays\fP lets you specify and enable individual color, 
 
49
normal, 
 
50
texture and vertex
 
51
arrays whose elements are part of a larger aggregate array element.
 
52
For some implementations, this is more efficient than specifying the arrays
 
53
separately. 
 
54
.P
 
55
If \f2stride\fP is 0, the aggregate elements are stored consecutively.
 
56
Otherwise, \f2stride\fP bytes occur between the beginning of one
 
57
aggregate array element and the beginning of the next aggregate array
 
58
element.
 
59
.P
 
60
\f2format\fP serves as a ``key''
 
61
describing the extraction of individual arrays from the aggregate array.
 
62
If \f2format\fP contains a T, then texture coordinates are 
 
63
extracted from the interleaved array.  If C is present, color values
 
64
are extracted. If N is present, normal coordinates are extracted.
 
65
Vertex coordinates are always extracted.
 
66
.P
 
67
The digits 2, 3, and 4 denote how many values are extracted.
 
68
F indicates that values are extracted as floating-point values.
 
69
Colors may also be extracted as 4 unsigned bytes if 4UB follows the
 
70
C.  If a color is extracted as 4 unsigned bytes, the vertex 
 
71
array element which follows is located at the first possible 
 
72
floating-point aligned address.
 
73
.SH NOTES
 
74
\%\f3glInterleavedArrays\fP is available only if the GL version is 1.1 or greater.
 
75
.P
 
76
If \%\f3glInterleavedArrays\fP is called while compiling a display list, it is not
 
77
compiled into the list, and it is executed immediately.
 
78
.P
 
79
Execution of \%\f3glInterleavedArrays\fP is not allowed between the execution of
 
80
\%\f3glBegin\fP and the corresponding execution of \%\f3glEnd\fP,
 
81
but an error may or may not be generated. If no error is generated,
 
82
the operation is undefined.
 
83
.P
 
84
\%\f3glInterleavedArrays\fP is typically implemented on the client side.
 
85
.P
 
86
Vertex array parameters are client-side state and are therefore not
 
87
saved or restored by \%\f3glPushAttrib\fP and \%\f3glPopAttrib\fP.
 
88
Use \%\f3glPushClientAttrib\fP and \%\f3glPopClientAttrib\fP instead.
 
89
.P
 
90
When the \%\f3GL_ARB_multitexture\fP extension is supported, \%\f3glInterleavedArrays\fP
 
91
only updates the texture coordinate array for the active active texture
 
92
unit. The texture coordinate state for other client texture units is not 
 
93
update, regardless if they are enabled or not.
 
94
.SH ERRORS
 
95
\%\f3GL_INVALID_ENUM\fP is generated if \f2format\fP is not an accepted value.
 
96
.P
 
97
\%\f3GL_INVALID_VALUE\fP is generated if \f2stride\fP is negative.
 
98
.SH SEE ALSO 
 
99
\%\f3glArrayElement(3G)\fP,
 
100
\%\f3glClientActiveTextureARB(3G)\fP,
 
101
\%\f3glColorPointer(3G)\fP,
 
102
\%\f3glDrawArrays(3G)\fP,
 
103
\%\f3glDrawElements(3G)\fP,
 
104
\%\f3glEdgeFlagPointer(3G)\fP,
 
105
\%\f3glEnableClientState(3G)\fP,
 
106
\%\f3glGetPointer(3G)\fP,
 
107
\%\f3glIndexPointer(3G)\fP,
 
108
\%\f3glNormalPointer(3G)\fP,
 
109
\%\f3glTexCoordPointer(3G)\fP,
 
110
\%\f3glVertexPointer(3G)\fP