atria-soft/ewol
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
ewol/ewol__resource__VirtualBufferObject.html

355 lines
18 KiB
HTML
Raw Blame History

<!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>ewol Library</h1>
<div id="menu">
<h2>ewol</h2>
<ul class="niveau1">
<li class="sousmenu"><a>compositing</a>
<ul class="niveau2">
<li><a href="ewol__Compositing.html">Compositing</a></li>
<li><a href="ewol__compositing__Area.html">Area</a></li>
<li><a href="ewol__compositing__Drawing.html">Drawing</a></li>
<li><a href="ewol__compositing__Image.html">Image</a></li>
<li><a href="ewol__compositing__Shaper.html">Shaper</a></li>
<li><a href="ewol__compositing__Sprite.html">Sprite</a></li>
<li><a href="ewol__compositing__Text.html">Text</a></li>
</ul>
</li>
<li class="sousmenu"><a>context</a>
<ul class="niveau2">
<li><a href="ewol__Context.html">Context</a></li>
<li><a href="ewol__context__CommandLine.html">CommandLine</a></li>
<li><a href="ewol__context__ConfigFont.html">ConfigFont</a></li>
<li><a href="ewol__context__InputManager.html">InputManager</a></li>
<li class="sousmenu"><a href="ewol__context__clipBoard.html">clipBoard</a>
<ul class="niveau3">
<li><a href="ewol__context__clipBoard.html::clipboardListe">clipboardListe</a></li>
</ul>
</li>
<li><a href="ewol__context__cursorDisplay.html">cursorDisplay</a></li>
</ul>
</li>
<li class="sousmenu"><a>event</a>
<ul class="niveau2">
<li><a href="ewol__event__Entry.html">Entry</a></li>
<li><a href="ewol__event__EntrySystem.html">EntrySystem</a></li>
<li><a href="ewol__event__Input.html">Input</a></li>
<li><a href="ewol__event__InputSystem.html">InputSystem</a></li>
<li><a href="ewol__event__Time.html">Time</a></li>
</ul>
</li>
<li class="sousmenu"><a>key</a>
<ul class="niveau2">
<li><a href="ewol__key__Special.html">Special</a></li>
<li><a href="ewol__key__keyboard.html">keyboard</a></li>
<li><a href="ewol__key__status.html">status</a></li>
<li><a href="ewol__key__type.html">type</a></li>
</ul>
</li>
<li class="sousmenu"><a>object</a>
<ul class="niveau2">
<li><a href="ewol__Object.html">Object</a></li>
<li><a href="ewol__object__Config.html">Config</a></li>
<li><a href="ewol__object__ConfigElement.html">ConfigElement</a></li>
<li><a href="ewol__object__Manager.html">Manager</a></li>
<li><a href="ewol__object__Message.html">Message</a></li>
<li class="sousmenu"><a href="ewol__object__MultiCast.html">MultiCast</a>
<ul class="niveau3">
<li><a href="ewol__object__MultiCast.html::MessageList">MessageList</a></li>
</ul>
</li>
</ul>
</li>
<li class="sousmenu"><a>openGL</a>
<ul class="niveau2">
<li><a href="ewol__openGL__openGlFlags.html">openGlFlags</a></li>
</ul>
</li>
<li class="sousmenu"><a>resource</a>
<ul class="niveau2">
<li><a href="ewol__Resource.html">Resource</a></li>
<li><a href="ewol__resource__Colored3DObject.html">Colored3DObject</a></li>
<li><a href="ewol__resource__ConfigFile.html">ConfigFile</a></li>
<li><a href="ewol__resource__FontBase.html">FontBase</a></li>
<li><a href="ewol__resource__FontFreeType.html">FontFreeType</a></li>
<li><a href="ewol__resource__Manager.html">Manager</a></li>
<li><a href="ewol__resource__Program.html">Program</a></li>
<li><a href="ewol__resource__Shader.html">Shader</a></li>
<li><a href="ewol__resource__Texture.html">Texture</a></li>
<li><a href="ewol__resource__TextureFile.html">TextureFile</a></li>
<li><a href="ewol__resource__TexturedFont.html">TexturedFont</a></li>
<li><a href="ewol__resource__VirtualBufferObject.html">VirtualBufferObject</a></li>
</ul>
</li>
<li class="sousmenu"><a>widget</a>
<ul class="niveau2">
<li><a href="ewol__Widget.html">Widget</a></li>
<li><a href="ewol__widget__Button.html">Button</a></li>
<li><a href="ewol__widget__ButtonColor.html">ButtonColor</a></li>
<li><a href="ewol__widget__CheckBox.html">CheckBox</a></li>
<li><a href="ewol__widget__ColorBar.html">ColorBar</a></li>
<li><a href="ewol__widget__ColorChooser.html">ColorChooser</a></li>
<li><a href="ewol__widget__Composer.html">Composer</a></li>
<li><a href="ewol__widget__Container.html">Container</a></li>
<li><a href="ewol__widget__ContainerN.html">ContainerN</a></li>
<li><a href="ewol__widget__ContextMenu.html">ContextMenu</a></li>
<li><a href="ewol__widget__Entry.html">Entry</a></li>
<li><a href="ewol__widget__FileChooser.html">FileChooser</a></li>
<li class="sousmenu"><a href="ewol__widget__Gird.html">Gird</a>
<ul class="niveau3">
<li><a href="ewol__widget__Gird.html::GirdProperties">GirdProperties</a></li>
</ul>
</li>
<li><a href="ewol__widget__Image.html">Image</a></li>
<li><a href="ewol__widget__Joystick.html">Joystick</a></li>
<li><a href="ewol__widget__Label.html">Label</a></li>
<li><a href="ewol__widget__Layer.html">Layer</a></li>
<li><a href="ewol__widget__List.html">List</a></li>
<li><a href="ewol__widget__ListFileSystem.html">ListFileSystem</a></li>
<li><a href="ewol__widget__Manager.html">Manager</a></li>
<li><a href="ewol__widget__Menu.html">Menu</a></li>
<li><a href="ewol__widget__MenuElement.html">MenuElement</a></li>
<li><a href="ewol__widget__Parameter.html">Parameter</a></li>
<li><a href="ewol__widget__ParameterList.html">ParameterList</a></li>
<li><a href="ewol__widget__PopUp.html">PopUp</a></li>
<li><a href="ewol__widget__ProgressBar.html">ProgressBar</a></li>
<li><a href="ewol__widget__Scroll.html">Scroll</a></li>
<li><a href="ewol__widget__Sizer.html">Sizer</a></li>
<li><a href="ewol__widget__Slider.html">Slider</a></li>
<li><a href="ewol__widget__Spacer.html">Spacer</a></li>
<li><a href="ewol__widget__StdPopUp.html">StdPopUp</a></li>
<li><a href="ewol__widget__WSlider.html">WSlider</a></li>
<li><a href="ewol__widget__WidgetScrooled.html">WidgetScrooled</a></li>
<li><a href="ewol__widget__Windows.html">Windows</a></li>
<li><a href="ewol__widget__elementPL.html">elementPL</a></li>
</ul>
</li>
<ul>
<h3> </h3>
</div>
</div>
</div>
<div class="container" id="content">
<h1>Class: ewol::resource::VirtualBufferObject</h1>
<br/>
<h2>Constructor and Destructor:</h2>
<pre>
# <a class="code-function" href="#VirtualBufferObject">VirtualBufferObject</a> (<span class="code-type">int32_t</span> <span class="code-argument">_number</span>);<br># ~<a class="code-function" href="#VirtualBufferObject">VirtualBufferObject</a> (<span class="code-type">void</span>);<br></pre>
<h2>Synopsis:</h2>
<pre>
+ GL<span class="code-type">uint</span> <a class="code-function" href="#getGL_ID">getGL_ID</a> (<span class="code-type">int32_t</span> <span class="code-argument">id</span>);<br>+ std::vector<<span class="code-type">float</span>> & <a class="code-function" href="#getRefBuffer">getRefBuffer</a> (<span class="code-type">int32_t</span> <span class="code-argument">id</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#pushOnBuffer">pushOnBuffer</a> (<span class="code-type">int32_t</span> <span class="code-argument">id</span>,<br/> <span class="code-storage-keyword">const</span> vec3 & <span class="code-argument">data</span>);<br>+ vec3 <a class="code-function" href="#getOnBufferVec3">getOnBufferVec3</a> (<span class="code-type">int32_t</span> <span class="code-argument">id</span>,<br/> <span class="code-type">int32_t</span> <span class="code-argument">elementID</span>);<br>+ <span class="code-type">int32_t</span> <a class="code-function" href="#sizeOnBufferVec3">sizeOnBufferVec3</a> (<span class="code-type">int32_t</span> <span class="code-argument">id</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#pushOnBuffer">pushOnBuffer</a> (<span class="code-type">int32_t</span> <span class="code-argument">id</span>,<br/> <span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">data</span>);<br>+ vec2 <a class="code-function" href="#getOnBufferVec2">getOnBufferVec2</a> (<span class="code-type">int32_t</span> <span class="code-argument">id</span>,<br/> <span class="code-type">int32_t</span> <span class="code-argument">elementID</span>);<br>+ <span class="code-type">int32_t</span> <a class="code-function" href="#sizeOnBufferVec2">sizeOnBufferVec2</a> (<span class="code-type">int32_t</span> <span class="code-argument">id</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#retreiveData">retreiveData</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#flush">flush</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#updateContext">updateContext</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#removeContext">removeContext</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#removeContextToLate">removeContextToLate</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#reload">reload</a> (<span class="code-type">void</span>);<br>+ <span class="code-storage-keyword">static</span> <a href="ewol__resource__VirtualBufferObject.html" class="code-type">ewol::resource::VirtualBufferObject</a> * <a class="code-function" href="#keep">keep</a> (<span class="code-type">int32_t</span> <span class="code-argument">_number</span>);<br>+ <span class="code-storage-keyword">static</span> <span class="code-type">void</span> <a class="code-function" href="#release">release</a> (<a href="ewol__resource__VirtualBufferObject.html" class="code-type">ewol::resource::VirtualBufferObject</a> * & <span class="code-argument">_object</span>);<br></pre>
<h2>Object Hierarchy:</h2>
<pre>
<a href="ewol__Object.html">ewol::Object</a>
+--> <a href="ewol__Resource.html">ewol::Resource</a>
+--> <b>ewol::resource::VirtualBufferObject</b>
</pre>
<br/>
<h2>Description:</h2>
/**
* @brief VirtualBufferObject is a specific resources for opengl, this load the data directly in the graphic card ad keep these inside
*/<h2>Detail:<h2>
<h3><a id="getGL_ID">getGL_ID</a> ()</h3>
<pre>
GL<span class="code-type">uint</span> <span class="code-function">getGL_ID</span>(<span class="code-type">int32_t</span> <span class="code-argument">id</span>);</pre>
<br/>
get the real openGL ID.
<br/><ul>
<b>Return:</b> the Ogl id reference of this VBO.
<br/></ul>
<br/>
<hr/>
<h3><a id="getRefBuffer">getRefBuffer</a> ()</h3>
<pre>
std::vector<<span class="code-type">float</span>> & <span class="code-function">getRefBuffer</span>(<span class="code-type">int32_t</span> <span class="code-argument">id</span>);</pre>
<br/>
get a reference on hte buffer data for this VBO.
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">id</span> Id of the buffer requested
<br/><b>Return:</b> A reference on the data.
<br/></ul>
<br/>
<hr/>
<h3><a id="pushOnBuffer">pushOnBuffer</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">pushOnBuffer</span>(<span class="code-type">int32_t</span> <span class="code-argument">id</span>,
<span class="code-storage-keyword">const</span> vec3 & <span class="code-argument">data</span>);</pre>
<br/>
push data on a buffer with a custum type :
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">id</span> Id of the buffer requested.
<br/><b>Parameter [input]:</b> <span class="code-argument">data</span> Direct data that might be set.
<br/></ul>
<br/>
<hr/>
<h3><a id="getOnBufferVec3">getOnBufferVec3</a> ()</h3>
<pre>
vec3 <span class="code-function">getOnBufferVec3</span>(<span class="code-type">int32_t</span> <span class="code-argument">id</span>,
<span class="code-type">int32_t</span> <span class="code-argument">elementID</span>);</pre>
<br/>
<br/>
<hr/>
<h3><a id="sizeOnBufferVec3">sizeOnBufferVec3</a> ()</h3>
<pre>
<span class="code-type">int32_t</span> <span class="code-function">sizeOnBufferVec3</span>(<span class="code-type">int32_t</span> <span class="code-argument">id</span>);</pre>
<br/>
<br/>
<hr/>
<h3><a id="pushOnBuffer">pushOnBuffer</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">pushOnBuffer</span>(<span class="code-type">int32_t</span> <span class="code-argument">id</span>,
<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">data</span>);</pre>
<br/>
push data on a buffer with a custum type :
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">id</span> Id of the buffer requested.
<br/><b>Parameter [input]:</b> <span class="code-argument">data</span> Direct data that might be set.
<br/></ul>
<br/>
<hr/>
<h3><a id="getOnBufferVec2">getOnBufferVec2</a> ()</h3>
<pre>
vec2 <span class="code-function">getOnBufferVec2</span>(<span class="code-type">int32_t</span> <span class="code-argument">id</span>,
<span class="code-type">int32_t</span> <span class="code-argument">elementID</span>);</pre>
<br/>
<br/>
<hr/>
<h3><a id="sizeOnBufferVec2">sizeOnBufferVec2</a> ()</h3>
<pre>
<span class="code-type">int32_t</span> <span class="code-function">sizeOnBufferVec2</span>(<span class="code-type">int32_t</span> <span class="code-argument">id</span>);</pre>
<br/>
<br/>
<hr/>
<h3><a id="retreiveData">retreiveData</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">retreiveData</span>(<span class="code-type">void</span>);</pre>
<br/>
get the data from the graphic card.
<br/><br/>
<hr/>
<h3><a id="flush">flush</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">flush</span>(<span class="code-type">void</span>);</pre>
<br/>
Send the data to the graphic card.
<br/><br/>
<hr/>
<h3><a id="updateContext">updateContext</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">updateContext</span>(<span class="code-type">void</span>);</pre>
<br/>
This load/reload the data in the opengl context, needed when removed previously.
<br/><br/>
<hr/>
<h3><a id="removeContext">removeContext</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">removeContext</span>(<span class="code-type">void</span>);</pre>
<br/>
remove the data from the opengl context.
<br/><br/>
<hr/>
<h3><a id="removeContextToLate">removeContextToLate</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">removeContextToLate</span>(<span class="code-type">void</span>);</pre>
<br/>
Special android spec! It inform us that all context is removed and after notify us...
<br/><br/>
<hr/>
<h3><a id="reload">reload</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">reload</span>(<span class="code-type">void</span>);</pre>
<br/>
Relode the shader from the file. used when a request of resouces reload is done.
<br/><b>Notes:</b> this is really usefull when we tested the new themes or shader developpements.
<br/> <br/>
<hr/>
<h3>ewol::resource::<a id="keep">keep</a> ()</h3>
<pre>
<span class="code-storage-keyword">static</span> <a href="ewol__resource__VirtualBufferObject.html" class="code-type">ewol::resource::VirtualBufferObject</a> * <span class="code-function">keep</span>(<span class="code-type">int32_t</span> <span class="code-argument">_number</span>);</pre>
<br/>
keep the resource pointer.
<br/><b>Notes:</b> Never free this pointer by your own...
<br/> <ul>
<b>Parameter [input]:</b> <span class="code-argument">_number</span> Number of VBO needed
<br/><b>Return:</b> pointer on the resource or NULL if an error occured.
<br/></ul>
<br/>
<hr/>
<h3>ewol::resource::<a id="release">release</a> ()</h3>
<pre>
<span class="code-storage-keyword">static</span> <span class="code-type">void</span> <span class="code-function">release</span>(<a href="ewol__resource__VirtualBufferObject.html" class="code-type">ewol::resource::VirtualBufferObject</a> * & <span class="code-argument">_object</span>);</pre>
<br/>
release the keeped resources
<br/><ul>
<b>Parameter [input] [output]:</b> <span class="code-argument">reference</span> on the object pointer
<br/></ul>
<br/>
<hr/>
<h3>ewol::resource::<a id="VirtualBufferObject">VirtualBufferObject</a> ()</h3>
<pre>
<span class="code-function">VirtualBufferObject</span>(<span class="code-type">int32_t</span> <span class="code-argument">_number</span>);</pre>
<br/>
Constructor of this VBO.
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">accesMode</span> Acces mode : ???
<br/></ul>
<br/>
<hr/>
<h3>ewol::resource::~<a id="VirtualBufferObject">VirtualBufferObject</a> ()</h3>
<pre>
~<span class="code-function">VirtualBufferObject</span>(<span class="code-type">void</span>);</pre>
<br/>
Destructor of this VBO.
<br/><br/>
<hr/>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink