265 lines
17 KiB
HTML
265 lines
17 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
|
|
<title>ewol Library</title>
|
|
<link rel="stylesheet" href="base.css">
|
|
<link rel="stylesheet" href="menu.css">
|
|
</head>
|
|
<body>
|
|
<div class="navbar navbar-fixed-top">
|
|
<div class="container">
|
|
<h1><a href="index.html">ewol library</a></h1>
|
|
<h4><a href="http://github.com/heeroyui/ewol/"> [ sources ]</a></h4>
|
|
<h3>API:</h3> <div id="menu">
|
|
<ul class="niveau1">
|
|
<li class="sousmenu"><a href="namespace_ewol.html">ewol</a>
|
|
<ul class="niveau2">
|
|
<li><a href="namespace_ewol__key.html">key</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__widget.html">widget</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__openGL.html">openGL</a>
|
|
</li>
|
|
<li class="sousmenu"><a href="namespace_ewol__context.html">context</a>
|
|
<ul class="niveau3">
|
|
<li><a href="namespace_ewol__context__clipBoard.html">clipBoard</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="sousmenu"><a href="namespace_ewol__audio.html">audio</a>
|
|
<ul class="niveau3">
|
|
<li><a href="namespace_ewol__audio__wav.html">wav</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__audio__music.html">music</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__audio__effects.html">effects</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="namespace_ewol__portAudio.html">portAudio</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__compositing.html">compositing</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__object.html">object</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__resource.html">resource</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__font.html">font</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__event.html">event</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="namespace_MacOs.html">MacOs</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<h3>Documentation:</h3><div id="menu">
|
|
<ul class="niveau1"><li><a href="001_bases.html">bases</a></li>
|
|
</ul></div>
|
|
<h3>Tutorials:</h3><div id="menu">
|
|
<ul class="niveau1"><li><a href="tutorial_000_Build.html">Build</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_001_HelloWord.html">HelloWord</a></li>
|
|
</ul></div>
|
|
<br/><h3>Associate libraries:</h3><div id="menu">
|
|
<ul class="niveau1"><li><a href="../ejson/index.html">ejson</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../egami/index.html">egami</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../ege/index.html">ege</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../esvg/index.html">esvg</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../etk/index.html">etk</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../exml/index.html">exml</a></li>
|
|
</ul></div>
|
|
<br/>
|
|
<br/>
|
|
<br/>
|
|
<br/>
|
|
<br/>
|
|
<br/>
|
|
</div>
|
|
</div>
|
|
<div class="container" id="content">
|
|
<h1>namespace: ewol::openGL</h1><hr/><h2>Description:</h2>
|
|
|
|
<br/><br/>
|
|
<h2>enum:</h2>
|
|
<ul>
|
|
<li><a href="enum_ewol__openGL__openGlFlags.html">openGlFlags</a></li></ul>
|
|
<h2>Synopsis:</h2>
|
|
<pre>
|
|
<span class="code-type" >void</span> <a class="code-function" href="#3825">lock</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/> <span class="code-type" >void</span> <a class="code-function" href="#3827">unLock</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/> <span class="code-type" >void</span> <a class="code-function" href="#3829">setBasicMatrix</a> (<span class="code-storage-keyword">const</span> mat4 & <span class="code-argument">_newOne</span>);<br/> <span class="code-type" >void</span> <a class="code-function" href="#3831">setMatrix</a> (<span class="code-storage-keyword">const</span> mat4 & <span class="code-argument">_newOne</span>);<br/> <span class="code-type" >void</span> <a class="code-function" href="#3833">push</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/> <span class="code-type" >void</span> <a class="code-function" href="#3835">pop</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/> <span class="code-storage-keyword">const</span> mat4 & <a class="code-function" href="#3837">getMatrix</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/> <span class="code-storage-keyword">const</span> mat4 & <a class="code-function" href="#3839">getCameraMatrix</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/> <span class="code-type" >void</span> <a class="code-function" href="#3841">setCameraMatrix</a> (<span class="code-storage-keyword">const</span> mat4 & <span class="code-argument">_newOne</span>);<br/> <span class="code-type" >void</span> <a class="code-function" href="#3843">finish</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/> <span class="code-type" >void</span> <a class="code-function" href="#3845">flush</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/> <span class="code-type" >void</span> <a class="code-function" href="#3847">swap</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/> <span class="code-type" >void</span> <a class="code-function" href="#3850">enable</a> (<span class="code-storage-keyword">enum</span> openGlFlags <span class="code-argument">_flagID</span>);<br/> <span class="code-type" >void</span> <a class="code-function" href="#3852">disable</a> (<span class="code-storage-keyword">enum</span> openGlFlags <span class="code-argument">_flagID</span>);<br/> <span class="code-type" >void</span> <a class="code-function" href="#3854">updateAllFlags</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/> <span class="code-type" >void</span> <a class="code-function" href="#3856">activeTexture</a> (<span class="code-type" >uint32_t</span> <span class="code-argument">_flagID</span>);<br/> <span class="code-type" >void</span> <a class="code-function" href="#3858">desActiveTexture</a> (<span class="code-type" >uint32_t</span> <span class="code-argument">_flagID</span>);<br/> <span class="code-type" >void</span> <a class="code-function" href="#3860">drawArrays</a> (<span class="code-type" >uint32_t</span> <span class="code-argument">_mode</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_first</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_count</span>);<br/> <span class="code-type" >void</span> <a class="code-function" href="#3864">drawElements</a> (<span class="code-type" >uint32_t</span> <span class="code-argument">_mode</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/vector/vector/">std::vector</a><uint32_t> & <span class="code-argument">_indices</span>);<br/> <span class="code-type" >void</span> <a class="code-function" href="#3867">drawElements16</a> (<span class="code-type" >uint32_t</span> <span class="code-argument">_mode</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/vector/vector/">std::vector</a><uint16_t> & <span class="code-argument">_indices</span>);<br/> <span class="code-type" >void</span> <a class="code-function" href="#3870">drawElements8</a> (<span class="code-type" >uint32_t</span> <span class="code-argument">_mode</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/vector/vector/">std::vector</a><uint8_t> & <span class="code-argument">_indices</span>);<br/> <span class="code-type" >void</span> <a class="code-function" href="#3873">useProgram</a> (<span class="code-type" >int32_t</span> <span class="code-argument">_id</span>);<br/></pre>
|
|
<br/>
|
|
<h2>Detail:</h2>
|
|
<a id="3825"/><a id="3827"/><h3>lock</h3><pre>
|
|
<span class="code-type" >void</span> <span class="code-function">lock</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
Lock the openGL context for one user only == > better to keep flags and other things ...<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="3829"/><h3>unLock</h3><pre>
|
|
<span class="code-type" >void</span> <span class="code-function">unLock</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
Un-lock the openGL context for an other user...<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="3831"/><h3>setBasicMatrix</h3><pre>
|
|
<span class="code-type" >void</span> <span class="code-function">setBasicMatrix</span> (<span class="code-storage-keyword">const</span> mat4 & <span class="code-argument">_newOne</span>);<br/></pre>
|
|
When you will done an opengl rendering, you might call this reset matrix first. It remove all the stach of the matrix pushed.<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_newOne</span> </td><td> the default matrix that might be set for the graphic card for renderer. if too more pop will be done, this is the last that mmight survived</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="3833"/><h3>setMatrix</h3><pre>
|
|
<span class="code-type" >void</span> <span class="code-function">setMatrix</span> (<span class="code-storage-keyword">const</span> mat4 & <span class="code-argument">_newOne</span>);<br/></pre>
|
|
this funtion configure the current use matrix for the renderer (call @ref Push before, and @ref Pop when no more needed).<br/><b>Note:</b> We did not use opengl standard system, due to the fact that is not supported in opengl ES-2<br/> <ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_newOne</span> </td><td> The new current matrix use for the render.</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="3835"/><h3>push</h3><pre>
|
|
<span class="code-type" >void</span> <span class="code-function">push</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
store current matrix in the matrix stack.<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="3837"/><h3>pop</h3><pre>
|
|
<span class="code-type" >void</span> <span class="code-function">pop</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
remove the current matrix and get the last one from the matrix stack.<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="3839"/><h3>getMatrix</h3><pre>
|
|
<span class="code-storage-keyword">const</span> mat4 & <span class="code-function">getMatrix</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
get a reference on the current matrix destinate to opengl renderer.<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>The requested matrix.</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="3841"/><h3>getCameraMatrix</h3><pre>
|
|
<span class="code-storage-keyword">const</span> mat4 & <span class="code-function">getCameraMatrix</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
get a reference on the current matrix camera destinate to opengl renderer.<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>The requested matrix.</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="3843"/><h3>setCameraMatrix</h3><pre>
|
|
<span class="code-type" >void</span> <span class="code-function">setCameraMatrix</span> (<span class="code-storage-keyword">const</span> mat4 & <span class="code-argument">_newOne</span>);<br/></pre>
|
|
set a reference on the current camera to opengl renderer.<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_newOne</span> </td><td> The requested matrix.</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="3845"/><h3>finish</h3><pre>
|
|
<span class="code-type" >void</span> <span class="code-function">finish</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="3847"/><h3>flush</h3><pre>
|
|
<span class="code-type" >void</span> <span class="code-function">flush</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="3850"/><h3>swap</h3><pre>
|
|
<span class="code-type" >void</span> <span class="code-function">swap</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="3852"/><h3>enable</h3><pre>
|
|
<span class="code-type" >void</span> <span class="code-function">enable</span> (<span class="code-storage-keyword">enum</span> openGlFlags <span class="code-argument">_flagID</span>);<br/></pre>
|
|
enable a flag on the system<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">flagID</span> </td><td> The flag requested</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="3854"/><h3>disable</h3><pre>
|
|
<span class="code-type" >void</span> <span class="code-function">disable</span> (<span class="code-storage-keyword">enum</span> openGlFlags <span class="code-argument">_flagID</span>);<br/></pre>
|
|
disable a flag on the system<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">flagID</span> </td><td> The flag requested</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="3856"/><h3>updateAllFlags</h3><pre>
|
|
<span class="code-type" >void</span> <span class="code-function">updateAllFlags</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="3858"/><h3>activeTexture</h3><pre>
|
|
<span class="code-type" >void</span> <span class="code-function">activeTexture</span> (<span class="code-type" >uint32_t</span> <span class="code-argument">_flagID</span>);<br/></pre>
|
|
enable Texture on the system<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">flagID</span> </td><td> The flag requested</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="3860"/><h3>desActiveTexture</h3><pre>
|
|
<span class="code-type" >void</span> <span class="code-function">desActiveTexture</span> (<span class="code-type" >uint32_t</span> <span class="code-argument">_flagID</span>);<br/></pre>
|
|
disable Texture on the system<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">flagID</span> </td><td> The flag requested</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="3864"/><h3>drawArrays</h3><pre>
|
|
<span class="code-type" >void</span> <span class="code-function">drawArrays</span> (<span class="code-type" >uint32_t</span> <span class="code-argument">_mode</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_first</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_count</span>);<br/></pre>
|
|
draw a specific array == > this enable mode difference ...<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="3867"/><h3>drawElements</h3><pre>
|
|
<span class="code-type" >void</span> <span class="code-function">drawElements</span> (<span class="code-type" >uint32_t</span> <span class="code-argument">_mode</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/vector/vector/">std::vector</a><uint32_t> & <span class="code-argument">_indices</span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="3870"/><h3>drawElements16</h3><pre>
|
|
<span class="code-type" >void</span> <span class="code-function">drawElements16</span> (<span class="code-type" >uint32_t</span> <span class="code-argument">_mode</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/vector/vector/">std::vector</a><uint16_t> & <span class="code-argument">_indices</span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="3873"/><h3>drawElements8</h3><pre>
|
|
<span class="code-type" >void</span> <span class="code-function">drawElements8</span> (<span class="code-type" >uint32_t</span> <span class="code-argument">_mode</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/vector/vector/">std::vector</a><uint8_t> & <span class="code-argument">_indices</span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<h3>useProgram</h3><pre>
|
|
<span class="code-type" >void</span> <span class="code-function">useProgram</span> (<span class="code-type" >int32_t</span> <span class="code-argument">_id</span>);<br/></pre>
|
|
Use openGL program<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">id</span> </td><td> Id of the program that might be used</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
</div>
|
|
<script>
|
|
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
|
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
|
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
|
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
|
ga('create', 'UA-46753803-1', 'heeroyui.github.io');
|
|
ga('send', 'pageview');
|
|
</script>
|
|
</body>
|
|
</html>
|