-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi.html
239 lines (210 loc) · 8.78 KB
/
api.html
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Application Program Interface (API)</title>
<link rel="stylesheet" href="_static/basic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/bootswatch-3.3.4/cosmo/bootstrap.min.css" type="text/css" />
<link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="_static/css/font-mfizz.css" type="text/css" />
<link rel="stylesheet" href="_static/css/font-awesome.css" type="text/css" />
<link rel="stylesheet" href="_static/style.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/jquery-1.11.0.min.js"></script>
<script type="text/javascript" src="_static/js/jquery-fix.js"></script>
<script type="text/javascript" src="_static/bootstrap-3.3.4/js/bootstrap.min.js"></script>
<script type="text/javascript" src="_static/bootstrap-sphinx.js"></script>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="top" title="" href="index.html" />
<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">
</head>
<body role="document">
<div id="navbar" class="navbar navbar-default navbar-fixed-top">
<div class="container">
<div class="navbar-header">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html"><img src="_static/glumpy-text-white.png">
</a>
<span class="navbar-text navbar-version pull-left"><b></b></span>
</div>
<div class="collapse navbar-collapse nav-collapse">
<ul class="nav navbar-nav">
<li class="divider-vertical"></li>
<li><a href="http://glumpy.readthedocs.org/en/latest/">Documentation</a></li>
<li><a href="gallery.html">Gallery</a></li>
<li><a href="resources.html">Resources</a></li>
<li><a href="community.html">Community</a></li>
<li><a href="news.html">News</a></li>
<li class="dropdown globaltoc-container">
<a role="button"
id="dLabelGlobalToc"
data-toggle="dropdown"
data-target="#"
href="index.html">Site <b class="caret"></b></a>
<ul class="dropdown-menu globaltoc"
role="menu"
aria-labelledby="dLabelGlobalToc"></ul>
</li>
</ul>
<!--
<form class="navbar-form navbar-right" action="search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
-->
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="col-md-3">
<div id="sidebar" class="bs-sidenav" role="complementary"><ul>
<li><a class="reference internal" href="#">Application Program Interface (API)</a></li>
</ul>
<form action="search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="col-md-9 content">
<div class="section" id="application-program-interface-api">
<h1>Application Program Interface (API)<a class="headerlink" href="#application-program-interface-api" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
</div>
<div class="lead">
<p>Glumpy is organized around three blocks:</p>
<div class="small">
<ul class="simple">
<li>The <a class="reference external" href="api-app.html">app</a> package is responsible for opening a window and handling
user events.</li>
<li>The <a class="reference external" href="api-gloo.html">gloo</a> package is responsible for handling shader programs and
syncing CPU/GPU data.</li>
<li>The <a class="reference external" href="api-graphicshtml">graphics</a> package provides higher-level common objects such as
text, collections and widgets.</li>
</ul>
</div>
</div>
<hr class="docutils" />
<div class="row">
<div class="col-md-6">
<p><span class="h2">App</span></p>
<ul class="simple">
<li><strong>clock</strong> : Clock</li>
<li><strong>console</strong> : Debug console</li>
<li><strong>options</strong> : Command line options</li>
<li><strong>configuration</strong> : Default configuration</li>
<li><strong>window</strong><ul>
<li><strong>backends</strong> : Backend specific code</li>
<li><strong>event</strong> : Event dispatcher</li>
<li><strong>mouse</strong> : Mouse events</li>
<li><strong>keyboard</strong> : Keyboard events</li>
<li><strong>window</strong> : Abstract window</li>
</ul>
</li>
</ul>
</div>
<div class="col-md-6">
<p><span class="h2">Gloo</span></p>
<ul class="simple">
<li><strong>globject</strong> : Abstract object that lives on CPU & GPU</li>
<li><strong>gpudata</strong> : GPU aware numpy array</li>
<li><strong>program</strong> : GPU Program</li>
<li><strong>parser</strong> : GLSL parser</li>
<li><strong>shader</strong> : Programmable shader</li>
<li><strong>snippet</strong> : Reusable GLSL snippet</li>
<li><strong>variable</strong> : Shader variable (attribute or uniform)</li>
<li><strong>buffer</strong> : GPU buffer (VertexBuffer/IndexBuffer)</li>
<li><strong>texture</strong> : GPU texture (1D/2D/3D)</li>
<li><strong>atlas</strong> : 2D Texture atlas</li>
</ul>
</div>
</div>
<div class="row">
<div class="col-md-6">
<p><span class="h2">Graphics</span></p>
<ul class="simple">
<li><strong>color</strong> : Color handling</li>
<li><strong>svg</strong> : SVG parsing</li>
<li><strong>collections</strong><ul>
<li><strong>point</strong> : Points collection</li>
<li><strong>segment</strong> : Line segment collection</li>
<li><strong>path</strong> : Path collection</li>
<li><strong>triangle</strong> : Triangles collection</li>
<li><strong>polygon</strong> : Polygon collection</li>
<li><strong>glyph</strong> : Glyph collection</li>
</ul>
</li>
</ul>
</div>
<div class="col-md-6">
<p><span class="h2">Others</span></p>
<ul class="simple">
<li><strong>geometry</strong> : Geometry related functions</li>
<li><strong>transforms</strong> : Interactive transformations</li>
<li><strong>library</strong> : Actual shader code</li>
<li><strong>gl</strong> : OpenGL access</li>
<li><strong>glm</strong> : Simple 3D matrix transforms</li>
<li><strong>ext</strong> : External packages</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
<footer class="footer">
<div class="container">
<ul class="list-inline">
<li><a href="https://github.com/glumpy/glumpy">GitHub</a></li>
<li>·</li>
<li><a href=""><a href="https://github.com/glumpy/glumpy/blob/master/examples/README.rst">Examples</a></li>
<li>·</li>
<li><a href="https://github.com/glumpy/glumpy/issues">Issues</a></li>
<li>·</li>
<li><a href="">Changelog</a></li>
<li>·</li>
<li><a href="https://github.com/glumpy/glumpy/releases">Releases</a></li>
<li class="pull-right"><a href="#">Back to top</a></li>
</ul>
<ul class="list-unstyled small">
<li>Copyright (c) 2011-2016 Nicolas P. Rougier</li>
<li>Code licensed under
<a href="http://opensource.org/licenses/BSD-2-Clause">BSD license</a>,
documentation under <a href="http://creativecommons.org/licenses/by/3.0/">CC BY 3.0 </a>
</li>
<li>
Made with <a href="http://sphinx-doc.org">sphinx</a> using the excellent
<a href="https://github.com/ryan-roemer/sphinx-bootstrap-theme">bootstrap theme</a>
</li>
</ul>
</div>
</footer>
</body>
</html>