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