https://libcinder.org/docs/

1<!DOCTYPE html>
2
3<html>
4<head>
5<!-- 
6    Copyright (c) 2015, The Cinder Project, All rights reserved.
7    Cinder v0.9.3dev
8    Made with DoxyWizard v1.8.10
9    Created on 2026-10-01
10     -->
11<meta charset="utf-8">
12<meta content="IE=edge" http-equiv="X-UA-Compatible">
13<meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" name="viewport">
14<title></title> <!-- dynamic partial defined in python -->
15<link href="_assets/css/foundation.css" rel="stylesheet">
16<link href="_assets/css/prism.css" rel="stylesheet" type="text/css"/>
17<link href="_assets/css/treeview.css" rel="stylesheet" type="text/css"/>
18<link href="_assets/css/style.css" rel="stylesheet" type="text/css"/>

19<script type="text/javascript">
20        var fontLinks = ["<link href='http://fonts.googleapis.com/css?family=Open+Sans:400,300,600,700' rel='stylesheet' type='text/css'>",
21                        "<link href='http://fonts.googleapis.com/css?family=Libre+Baskerville:400,400italic' rel='stylesheet' type='text/css'>",
22                        "<link href='http://fonts.googleapis.com/css?family=Inconsolata' rel='stylesheet' type='text/css'>"]
23        // get fonts for local file docs
24        var headHTML = document.getElementsByTagName('head')[0].innerHTML;
25        var prefix = ""
26        if( window.location.origin == "file://") {
27            prefix = "http:"
28        }else{
29            prefix = ""
30        }
31
32        for(var i=0; i < fontLinks.length; i++){
33            var link = fontLinks[i].replace("http:", prefix);
34            headHTML += link;
35        }
36        document.getElementsByTagName('head')[0].innerHTML = headHTML;
37    </script>

37
38<!-- Google Analytics -->

39<script>

39
40        (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
41        (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
42        m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
43        })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
44
45        ga('create', '

45UA-68329198-1

45', 'auto');
46        ga('send', 'pageview');
47    

47</script>

47
48</link></meta></meta></meta></head>
49<body class="section_home language-cpp">
50<!-- start offcanvas content for responsive sliding nav -->
51<div class="off-canvas-wrap wrapper" data-offcanvas="">
52<main class="inner-wrap">
53<section class="main-section">
54<!-- top section -->
55<div id="top-primary">
56<!-- main nav -->
57<nav class="show-for-medium-up row" data-topbar="" id="main-nav" role="navigation">
58<div class="branding columns medium-4 large-3 collapse">
59<div class="navbar-header">
60<a class="navbar-brand" href="index.html"></a><div class="cinder-version">0.9.3dev</div>
61</div>
62</div>
63<div class="columns medium-8 large-9">
64<div class="nav-section">
65<!-- Right Nav Section -->
66<div class="right" id="nav_search">
67<div id="search">
68<input autocomplete="off" id="search-input" placeholder="Search documentation..." type="text">
69<button id="search-button">Search</button>
70<div id="search-results">
71<div id="search-results-namespace">
72<h5>Namespaces</h5>
73<ul></ul>
74</div>
75<div id="search-results-class">
76<h5>Classes</h5>
77<ul></ul>
78</div>
79<div id="search-results-module">
80<h5>Modules</h5>
81<ul></ul>
82</div>
83<div id="search-results-guide">
84<h5>Guides</h5>
85<ul></ul>
86</div>
87<div id="search-results-reference">
88<h5>Reference</h5>
89<ul></ul>
90</div>
91<div id="search-results-view-all"><a href="#">View All Results &raquo;</a></div>
92</div>
93</input></div>
94</div>
95<!-- Left Nav Section -->
96<ul class="tablist nav">
97<li class="active" id="nav_home">
98<a href="index.html">Main Page</a></li>
99<li class=" " id="nav_reference">
100<a href="reference/index.html">Reference</a></li>
101<li class="" id="nav_guides">
102<a href="guides/index.html">Guides</a></li>
103<!--<li id="nav_guides"    class="">
104                                        <a href="#">Samples</a></li>-->
105</ul>
106</div>
107</div>
108</nav>
109<!-- for any additional content you'd want to put up here -->
110</div>
111<!-- mobile nav -->
112<nav class="tab-bar show-for-small">
113<section class="left-small">
114<a class="left-off-canvas-toggle menu-icon" href="#"><span></span></a>
115</section>
116<section class="middle tab-bar-section">
117<h2 class="title">Cinder</h2>
118</section>
119</nav>
120<aside class="left-off-canvas-menu">
121<ul class="off-canvas-list">
122<li><label>Cinder Documentation</label></li>
123<li id="nav_home"><a href="index.html">Main Page</a></li>
124<li id="nav_reference"><a href="reference/index.html">Reference</a></li>
125<li id="nav_guides"><a href="guides/index.html">Guides</a></li>
126<!--<li id="nav_samples"><a href="#">Samples</a></li>-->
127</ul>
128</aside>
129<div id="main-content">
130<div id="top-content">
131<div class="row" id="intro">
132<!-- cinder docs version links -->
133<div class="columns medium-4 large-3 hide-for-small" id="downloads">
134<ul>
135<li data-ci-version="0.9.3"><a href="https://libcinder.org/docs/release/v0.9.3/">Latest Release (v0.9.3)</a></li>
136<li data-ci-version="0.9.4dev"><a href="https://libcinder.org/docs/branch/master/">Master (v0.9.4dev)</a></li>
137</ul>
138</div>
139<!-- intro -->
140<div class="content content-column columns medium-7 large-8 end">
141<h1>Cinder Documentation</h1>
142<p>If you are just getting started, we recommend you begin with the <a href="guides/opengl/index.html">OpenGL in Cinder</a> guide. If you'd like to just get a sense of what's in Cinder, take a look at the <a href="reference/index.html">Categories list</a>. And don't forget, the samples are still the best way to learn Cinder for now as we work to fill out the documentation.</p>
143</div>
144</div>
145</div>
146<!--   guides and features section -->
147<div id="mid-content">
148<div class="row">
149<!-- guide links -->
150<div class="columns large-3">
151<label>Cinder Guides</label>
152<ul class="fancy">
153<li><a href="guides/mac-setup/index.html">Setup Cinder on OS X</a></li>
154<li><a href="guides/windows-setup/index.html">Setup Cinder on Windows</a></li>
155<li><a href="guides/git/index.html">Cinder + Git</a></li>
156<li><a href="guides/tinderbox/index.html">TinderBox</a></li>
157<li><a href="guides/cinder-blocks/index.html">CinderBlocks</a></li>
158<li><a href="guides/opengl/index.html">OpenGL in Cinder</a></li>
159</ul>
160<a class="cta-arrow" href="guides/index.html">All Guides</a>
161</div>
162<!-- library features -->
163<div class="columns content-column large-7 end">
164<label>Categories</label>
165<ul class="library-features clearing-thumbs small-block-grid-2 medium-block-grid-3 large-block-grid-5">
166<li>
167<a href="reference/geometry.html">
168<div class="img-holder">
169<img src="_assets/images/icons/geom_red.svg">
170</img></div>
171<div class="title">Geometry</div></a></li>
172<li>
173<a href="reference/math.html">
174<div class="img-holder">
175<img src="_assets/images/icons/math_red.svg">
176</img></div>
177<div class="title">Math</div></a></li>
178<li>
179<a href="reference/system.html">
180<div class="img-holder">
181<img src="_assets/images/icons/system_red.svg">
182</img></div>
183<div class="title">System</div></a></li>
184<li>
185<a href="reference/platform.html">
186<div class="img-holder">
187<img src="_assets/images/icons/platform_red.svg">
188</img></div>
189<div class="title">Platform</div></a></li>
190<li>
191<a href="reference/opengl.html">
192<div class="img-holder">
193<img src="_assets/images/icons/opengl_red.svg">
194</img></div>
195<div class="title">OpenGL</div></a></li>
196<li>
197<a href="reference/2dgraphics.html">
198<div class="img-holder">
199<img src="_assets/images/icons/2d_red.svg">
200</img></div>
201<div class="title">2D Graphics</div></a></li>
202<li>
203<a href="reference/audio.html">
204<div class="img-holder">
205<img src="_assets/images/icons/audio_red.svg">
206</img></div>
207<div class="title">Audio</div></a></li>
208<li>
209<a href="reference/video.html">
210<div class="img-holder">
211<img src="_assets/images/icons/video_red.svg">
212</img></div>
213<div class="title">video</div></a></li>
214<li>
215<a href="reference/images.html">
216<div class="img-holder">
217<img src="_assets/images/icons/images_red.svg">
218</img></div>
219<div class="title">Images</div></a></li>
220<li>
221<a href="reference/application.html">
222<div class="img-holder">
223<img src="_assets/images/icons/app_red.svg">
224</img></div>
225<div class="title">App</div></a></li>
226</ul>
227</div> <!-- content-column -->
228</div> <!-- row -->
229</div>
230<div id="bottom-content">
231<div class="row">
232<!-- sample links -->
233<div class="columns large-12 content">
234<label>Samples</label>
235<p>Cinder ships with numerous <a href="https://github.com/cinder/Cinder/tree/master/samples">samples</a> which are designed to demonstrate specific features of the library. Studying these samples is one one of the most direct routes for learning Cinder. A few examples:</p>
236</div>
237</div>

238<ul class="row samples fancy">
239<li class="columns large-4">
240<a href="https://github.com/cinder/Cinder/tree/master/samples/_opengl/NormalMapping">
241<div class="img-wrap"><img src="_assets/images/normal_mapping_sample.jpg"/></div>
242					Normal Mapping</a>
243</li>
244<li class="columns large-4">
245<a href="https://github.com/cinder/Cinder/tree/master/samples/_opengl/SuperformulaGPU">
246<div class="img-wrap"><img src="_assets/images/superformula_sample.jpg"/></div>
247					Superformula GPU</a>
248</li>
249<li class="columns large-4">
250<a href="https://github.com/cinder/Cinder/tree/master/samples/Geometry">
251<div class="img-wrap"><img src="_assets/images/geometry_sample.jpg"/></div>
252					Geometry</a>
253</li>
254</ul>
255</div>
256<!-- dynamic partial defined in python -->
257</div>
258</section>
259<a class="exit-off-canvas"></a>
260</main>
261<footer>
262<div class="row">&copy;Copyright 2020 <a href="http://www.libcinder.org">Cinder</a></div>
263</footer>
264</div>

265<script src="_assets/js/jquery.js" type="text/javascript"></script>

265

266<script src="_assets/js/underscore.min.js" type="text/javascript"></script>

266

267<script src="_assets/js/foundation.min.js" type="text/javascript"></script>

267

268<script src="_assets/js/foundation.magellan.js" type="text/javascript"></script>

268

269<script src="_assets/js/prism.js" type="text/javascript"></script>

269

270<script src="_assets/js/lunr.min.js" type="text/javascript"></script>

270

271<script src="search_index.js" type="text/javascript"></script>

271

272<script src="_assets/js/cinder.js" type="text/javascript"></script>

272

273<script type="text/javascript">
274        // Calling foundation runs through any calls
275        // related to foundation 5.
276        // One such thing is making sure the column sizes stay in sync
277        window.cinderVersion = "0.9.3dev";
278        window.sectionType = "section_home";
279        window.docsRoot = "docs";
280        $(document).foundation( 'offcanvas', 'reflow' );
281    </script>

281

282<script type="text/javascript">
283			// select the current version of the cinder docs
284			var versionNav = $('#top-content').find('[data-ci-version="' + window.cinderVersion + '"]');
285			if(versionNav)
286				versionNav.addClass('active');
287		</script>

287</body>
288</html>