ewol/doc/ewol__Compositing.html

248 lines
12 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">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="container">
<h1>ewol Library</h1>
<li><a href="eSystemMessage.html">eSystemMessage</a></li>
<li>ewol</li>
<ul>
<li><a href="ewol__Area.html">Area</a></li>
<li><a href="ewol__Colored3DObject.html">Colored3DObject</a></li>
<li><a href="ewol__CommandLine.html">CommandLine</a></li>
<li><a href="ewol__Compositing.html">Compositing</a></li>
<li><a href="ewol__ConfigFile.html">ConfigFile</a></li>
<li><a href="ewol__ConfigFont.html">ConfigFont</a></li>
<li><a href="ewol__Dimension.html">Dimension</a></li>
<li><a href="ewol__DrawProperty.html">DrawProperty</a></li>
<li><a href="ewol__Drawing.html">Drawing</a></li>
<li><a href="ewol__EConfig.html">EConfig</a></li>
<li><a href="ewol__EConfigElement.html">EConfigElement</a></li>
<li><a href="ewol__EMessage.html">EMessage</a></li>
<li><a href="ewol__EMultiCast.html">EMultiCast</a></li>
<li><a href="ewol__EMultiCast__MessageList.html">EMultiCast::MessageList</a></li>
<li><a href="ewol__EObject.html">EObject</a></li>
<li><a href="ewol__EObjectManager.html">EObjectManager</a></li>
<li><a href="ewol__EventEntry.html">EventEntry</a></li>
<li><a href="ewol__EventEntrySystem.html">EventEntrySystem</a></li>
<li><a href="ewol__EventExtGen.html">EventExtGen</a></li>
<li><a href="ewol__EventInput.html">EventInput</a></li>
<li><a href="ewol__EventInputSystem.html">EventInputSystem</a></li>
<li><a href="ewol__EventShortCut.html">EventShortCut</a></li>
<li><a href="ewol__EventTime.html">EventTime</a></li>
<li><a href="ewol__Face.html">Face</a></li>
<li><a href="ewol__FaceIndexing.html">FaceIndexing</a></li>
<li><a href="ewol__FontBase.html">FontBase</a></li>
<li><a href="ewol__FontFreeType.html">FontFreeType</a></li>
<li><a href="ewol__Fps.html">Fps</a></li>
<li><a href="ewol__GlyphProperty.html">GlyphProperty</a></li>
<li><a href="ewol__Image.html">Image</a></li>
<li><a href="ewol__Kerning.html">Kerning</a></li>
<li><a href="ewol__Light.html">Light</a></li>
<li><a href="ewol__Material.html">Material</a></li>
<li><a href="ewol__MaterialGlId.html">MaterialGlId</a></li>
<li><a href="ewol__Mesh.html">Mesh</a></li>
<li><a href="ewol__PhysicsBox.html">PhysicsBox</a></li>
<li><a href="ewol__PhysicsCapsule.html">PhysicsCapsule</a></li>
<li><a href="ewol__PhysicsCone.html">PhysicsCone</a></li>
<li><a href="ewol__PhysicsConvexHull.html">PhysicsConvexHull</a></li>
<li><a href="ewol__PhysicsCylinder.html">PhysicsCylinder</a></li>
<li><a href="ewol__PhysicsShape.html">PhysicsShape</a></li>
<li><a href="ewol__PhysicsSphere.html">PhysicsSphere</a></li>
<li><a href="ewol__Program.html">Program</a></li>
<li><a href="ewol__Resource.html">Resource</a></li>
<li><a href="ewol__ResourceManager.html">ResourceManager</a></li>
<li><a href="ewol__Shader.html">Shader</a></li>
<li><a href="ewol__Shaper.html">Shaper</a></li>
<li><a href="ewol__SimpleConfigElement.html">SimpleConfigElement</a></li>
<li><a href="ewol__SpecialKey.html">SpecialKey</a></li>
<li><a href="ewol__SpecialKey__SpecialKey__union__.html">SpecialKey::SpecialKey::union ::</a></li>
<li><a href="ewol__SpecialKey__union.html">SpecialKey::union </a></li>
<li><a href="ewol__Sprite.html">Sprite</a></li>
<li><a href="ewol__Text.html">Text</a></li>
<li><a href="ewol__TextDecoration.html">TextDecoration</a></li>
<li><a href="ewol__Texture.html">Texture</a></li>
<li><a href="ewol__TextureFile.html">TextureFile</a></li>
<li><a href="ewol__TexturedFont.html">TexturedFont</a></li>
<li><a href="ewol__VirtualBufferObject.html">VirtualBufferObject</a></li>
<li><a href="ewol__Widget.html">Widget</a></li>
<li><a href="ewol__WidgetManager.html">WidgetManager</a></li>
<li><a href="ewol__Windows.html">Windows</a></li>
<li><a href="ewol__eContext.html">eContext</a></li>
<li><a href="ewol__eInput.html">eInput</a></li>
<li><a href="ewol__progAttributeElement.html">progAttributeElement</a></li>
</ul>
<li>widget</li>
<ul>
<li><a href="widget__Button.html">Button</a></li>
<li><a href="widget__ButtonColor.html">ButtonColor</a></li>
<li><a href="widget__CheckBox.html">CheckBox</a></li>
<li><a href="widget__ColorBar.html">ColorBar</a></li>
<li><a href="widget__ColorChooser.html">ColorChooser</a></li>
<li><a href="widget__Composer.html">Composer</a></li>
<li><a href="widget__Container.html">Container</a></li>
<li><a href="widget__ContainerN.html">ContainerN</a></li>
<li><a href="widget__ContextMenu.html">ContextMenu</a></li>
<li><a href="widget__Entry.html">Entry</a></li>
<li><a href="widget__FileChooser.html">FileChooser</a></li>
<li><a href="widget__Gird.html">Gird</a></li>
<li><a href="widget__Gird__GirdProperties.html">Gird::GirdProperties</a></li>
<li><a href="widget__Image.html">Image</a></li>
<li><a href="widget__Joystick.html">Joystick</a></li>
<li><a href="widget__Label.html">Label</a></li>
<li><a href="widget__Layer.html">Layer</a></li>
<li><a href="widget__List.html">List</a></li>
<li><a href="widget__ListFileSystem.html">ListFileSystem</a></li>
<li><a href="widget__Menu.html">Menu</a></li>
<li><a href="widget__MenuElement.html">MenuElement</a></li>
<li><a href="widget__Mesh.html">Mesh</a></li>
<li><a href="widget__Parameter.html">Parameter</a></li>
<li><a href="widget__ParameterList.html">ParameterList</a></li>
<li><a href="widget__PopUp.html">PopUp</a></li>
<li><a href="widget__ProgressBar.html">ProgressBar</a></li>
<li><a href="widget__Scroll.html">Scroll</a></li>
<li><a href="widget__Sizer.html">Sizer</a></li>
<li><a href="widget__Slider.html">Slider</a></li>
<li><a href="widget__Spacer.html">Spacer</a></li>
<li><a href="widget__StdPopUp.html">StdPopUp</a></li>
<li><a href="widget__WSlider.html">WSlider</a></li>
<li><a href="widget__WidgetScrooled.html">WidgetScrooled</a></li>
<li><a href="widget__elementPL.html">elementPL</a></li>
</ul>
</ul>
<li>ewol</li>
<ul>
<li><a href="ewol__clipBoard__clipboardListe.html">clipBoard::clipboardListe</a></li>
<li><a href="ewol__cursorDisplay.html">cursorDisplay</a></li>
<li><a href="ewol__font__mode.html">font::mode</a></li>
<li><a href="ewol__gravity.html">gravity</a></li>
<li><a href="ewol__keyEvent__keyboard.html">keyEvent::keyboard</a></li>
<li><a href="ewol__keyEvent__status.html">keyEvent::status</a></li>
<li><a href="ewol__keyEvent__type.html">keyEvent::type</a></li>
<li><a href="ewol__openGL__openGlFlags.html">openGL::openGlFlags</a></li>
<li><a href="ewol__orientation.html">orientation</a></li>
</ul>
</div>
</div>
<div class="container" id="content">
<h1>Class: ewol::Compositing</h1>
<br/>
<h2>Synopsis:</h2>
<pre>
+ <a class="code-function" href="#Compositing">Compositing</a> (<span class="code-type">void</span>);<br>+ ~<a class="code-function" href="#Compositing">Compositing</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#draw">draw</a> (<span class="code-type">bool</span> <span class="code-argument">_disableDepthTest</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#clear">clear</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#resetMatrix">resetMatrix</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#translate">translate</a> (<span class="code-storage-keyword">const</span> vec3 & <span class="code-argument">_vect</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#rotate">rotate</a> (<span class="code-storage-keyword">const</span> vec3 & <span class="code-argument">_vect</span>,<br/> <span class="code-type">float</span> <span class="code-argument">_angle</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#scale">scale</a> (<span class="code-storage-keyword">const</span> vec3 & <span class="code-argument">_vect</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setMatrix">setMatrix</a> (<span class="code-storage-keyword">const</span> mat4 & <span class="code-argument">_mat</span>);<br></pre>
<h2>Object Hierarchy:</h2>
<pre>
<b>ewol::Compositing</b>
+--> <a href="ewol__Shaper.html">ewol::Shaper</a>
+--> <a href="ewol__Drawing.html">ewol::Drawing</a>
+--> <a href="ewol__Text.html">ewol::Text</a>
+--> <a href="ewol__Image.html">ewol::Image</a>
+--> <a href="ewol__Area.html">ewol::Area</a>
</pre>
<br/>
<h2>Detail:<h2>
<h3>ewol::<a id="Compositing">Compositing</a> ()</h3>
<pre>
<span class="code-function">Compositing</span>(<span class="code-type">void</span>);</pre>
<br/>
generic constructor
<br/><br/>
<hr/>
<h3>ewol::~<a id="Compositing">Compositing</a> ()</h3>
<pre>
~<span class="code-function">Compositing</span>(<span class="code-type">void</span>);</pre>
<br/>
Generic destructor
<br/><br/>
<hr/>
<h3><a id="draw">draw</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">draw</span>(<span class="code-type">bool</span> <span class="code-argument">_disableDepthTest</span>);</pre>
<br/>
Virtal pure function that request the draw of all openGl elements
<br/><br/>
<hr/>
<h3><a id="clear">clear</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">clear</span>(<span class="code-type">void</span>);</pre>
<br/>
clear alll tre registered element in the current element
<br/><br/>
<hr/>
<h3><a id="resetMatrix">resetMatrix</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">resetMatrix</span>(<span class="code-type">void</span>);</pre>
<br/>
reset to the eye matrix the openGL mouving system
<br/><br/>
<hr/>
<h3><a id="translate">translate</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">translate</span>(<span class="code-storage-keyword">const</span> vec3 & <span class="code-argument">_vect</span>);</pre>
<br/>
translate the current display of this element
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">_vect</span> The translation vector to apply at the transformation matrix
<br/></ul>
<br/>
<hr/>
<h3><a id="rotate">rotate</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">rotate</span>(<span class="code-storage-keyword">const</span> vec3 & <span class="code-argument">_vect</span>,
<span class="code-type">float</span> <span class="code-argument">_angle</span>);</pre>
<br/>
rotate the curent display of this element
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">_vect</span> The rotation vector to apply at the transformation matrix
<br/></ul>
<br/>
<hr/>
<h3><a id="scale">scale</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">scale</span>(<span class="code-storage-keyword">const</span> vec3 & <span class="code-argument">_vect</span>);</pre>
<br/>
scale the current diaplsy of this element
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">_vect</span> The scaling vector to apply at the transformation matrix
<br/></ul>
<br/>
<hr/>
<h3><a id="setMatrix">setMatrix</a> ()</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">_mat</span>);</pre>
<br/>
set the transformation matrix
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">_mat</span> The new matrix.
<br/></ul>
<br/>
<hr/>
</div>
</body>
</html>