]> gitweb.factorcode.org Git - factor.git/blob - basis/opengl/gl/gl-docs.factor
83331decee86edf544e4ba1a9f0dd3f50c7a8ea7
[factor.git] / basis / opengl / gl / gl-docs.factor
1
2 USING: help.syntax help.markup ;
3
4 IN: opengl.gl
5
6 ARTICLE: "opengl-low-level" "OpenGL binding"
7   { $subsection "opengl-specifying-vertices" }
8   { $subsection "opengl-geometric-primitives" }
9   { $subsection "opengl-modeling-transformations" } ;
10
11 ARTICLE: "opengl-specifying-vertices" "Specifying vertices"
12
13   { $subsection glVertex2d }
14   { $subsection glVertex2f }
15   { $subsection glVertex2i }
16   { $subsection glVertex2s }
17   { $subsection glVertex3d }
18   { $subsection glVertex3f }
19   { $subsection glVertex3i }
20   { $subsection glVertex3s }
21   { $subsection glVertex4d }
22   { $subsection glVertex4f }
23   { $subsection glVertex4i }
24   { $subsection glVertex4s }
25   { $subsection glVertex2dv }
26   { $subsection glVertex2fv }
27   { $subsection glVertex2iv }
28   { $subsection glVertex2sv }
29   { $subsection glVertex3dv }
30   { $subsection glVertex3fv }
31   { $subsection glVertex3iv }
32   { $subsection glVertex3sv }
33   { $subsection glVertex4dv }
34   { $subsection glVertex4fv }
35   { $subsection glVertex4iv }
36   { $subsection glVertex4sv } ;
37
38 ARTICLE: "opengl-geometric-primitives" "OpenGL geometric primitives"
39
40   { $table
41       { { $link GL_POINTS         } "individual points" }
42       { { $link GL_LINES          } { "pairs of vertices interpreted as "
43                                       "individual line segments" } }
44       { { $link GL_LINE_STRIP     } "series of connected line segments" }
45       { { $link GL_LINE_LOOP      } { "same as above, with a segment added "
46                                       "between last and first vertices" } }
47       { { $link GL_TRIANGLES      }
48         "triples of vertices interpreted as triangles" }
49       { { $link GL_TRIANGLE_STRIP } "linked strip of triangles" }
50       { { $link GL_TRIANGLE_FAN   } "linked fan of triangles" }
51       { { $link GL_QUADS          }
52         "quadruples of vertices interpreted as four-sided polygons" }
53       { { $link GL_QUAD_STRIP     } "linked strip of quadrilaterals" }
54       { { $link GL_POLYGON        } "boundary of a simple, convex polygon" } }
55
56 ;
57
58 HELP: glBegin
59   { $values { "mode"
60               { "One of the " { $link "opengl-geometric-primitives" } } } } ;
61
62 HELP: glPolygonMode
63   { $values { "face" { "One of the following:"
64                        { $list { $link GL_FRONT }
65                                { $link GL_BACK }
66                                { $link GL_FRONT_AND_BACK } } } }
67             { "mode" { "One of the following:"
68                        { $list
69                          { $link GL_POINT }
70                          { $link GL_LINE }
71                          { $link GL_FILL } } } } } ;
72
73 ARTICLE: "opengl-modeling-transformations" "Modeling transformations"
74   { $subsection glTranslatef }
75   { $subsection glTranslated }
76   { $subsection glRotatef }
77   { $subsection glRotated }
78   { $subsection glScalef }
79   { $subsection glScaled } ;
80
81
82 { glTranslatef glTranslated glRotatef glRotated glScalef glScaled }
83 related-words
84
85