ewol/ewol__resource__Manager.html

262 lines
13 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>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::Manager</h1>
<br/>
<h2>Constructor and Destructor:</h2>
<pre>
+ <a class="code-function" href="#Manager">Manager</a> (<span class="code-type">void</span>);<br>+ ~<a class="code-function" href="#Manager">Manager</a> (<span class="code-type">void</span>);<br></pre>
<h2>Synopsis:</h2>
<pre>
+ <span class="code-type">void</span> <a class="code-function" href="#unInit">unInit</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#display">display</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#reLoadResources">reLoadResources</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#update">update</a> (<a href="ewol__Resource.html" class="code-type">ewol::Resource</a> * <span class="code-argument">_object</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="#contextHasBeenDestroyed">contextHasBeenDestroyed</a> (<span class="code-type">void</span>);<br>+ <a href="ewol__Resource.html" class="code-type">ewol::Resource</a> * <a class="code-function" href="#localKeep">localKeep</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_filename</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#localAdd">localAdd</a> (<a href="ewol__Resource.html" class="code-type">ewol::Resource</a> * <span class="code-argument">_object</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#release">release</a> (<a href="ewol__Resource.html" class="code-type">ewol::Resource</a> * & <span class="code-argument">_object</span>);<br></pre>
<h2>Detail:<h2>
<h3>ewol::resource::<a id="Manager">Manager</a> ()</h3>
<pre>
<span class="code-function">Manager</span>(<span class="code-type">void</span>);</pre>
<br/>
initialize the internal variable
<br/><br/>
<hr/>
<h3>ewol::resource::~<a id="Manager">Manager</a> ()</h3>
<pre>
~<span class="code-function">Manager</span>(<span class="code-type">void</span>);</pre>
<br/>
Uninitiamize the resource manager, free all resources previously requested
<br/><b>Notes:</b> when not free == > generate warning, because the segfault can appear after...
<br/> <br/>
<hr/>
<h3><a id="unInit">unInit</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">unInit</span>(<span class="code-type">void</span>);</pre>
<br/>
remove all resources (un-init) out of the destructor (due to the system implementation)
<br/><br/>
<hr/>
<h3><a id="display">display</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">display</span>(<span class="code-type">void</span>);</pre>
<br/>
display in the log all the resources loaded ...
<br/><br/>
<hr/>
<h3><a id="reLoadResources">reLoadResources</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">reLoadResources</span>(<span class="code-type">void</span>);</pre>
<br/>
Reload all resources from files, and send there in openGL card if needed.
<br/><b>Notes:</b> If file is reference at THEME:XXX:filename if the Theme change the file will reload the newOne
<br/> <br/>
<hr/>
<h3><a id="update">update</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">update</span>(<a href="ewol__Resource.html" class="code-type">ewol::Resource</a> * <span class="code-argument">_object</span>);</pre>
<br/>
Call by the system to send all the needed data on the graphic card chen they change ...
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">_object</span> The resources that might be updated
<br/></ul>
<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/>
Call by the system chen the openGL Context has been unexpectially removed == > This reload all the texture, VBO and other ....
<br/><br/>
<hr/>
<h3><a id="contextHasBeenDestroyed">contextHasBeenDestroyed</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">contextHasBeenDestroyed</span>(<span class="code-type">void</span>);</pre>
<br/>
This is to inform the resources manager that we have no more openGl context ...
<br/><br/>
<hr/>
<h3><a id="localKeep">localKeep</a> ()</h3>
<pre>
<a href="ewol__Resource.html" class="code-type">ewol::Resource</a> * <span class="code-function">localKeep</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_filename</span>);</pre>
<br/>
<br/>
<hr/>
<h3><a id="localAdd">localAdd</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">localAdd</span>(<a href="ewol__Resource.html" class="code-type">ewol::Resource</a> * <span class="code-argument">_object</span>);</pre>
<br/>
<br/>
<hr/>
<h3><a id="release">release</a> ()</h3>
<pre>
<span class="code-type">bool</span> <span class="code-function">release</span>(<a href="ewol__Resource.html" class="code-type">ewol::Resource</a> * & <span class="code-argument">_object</span>);</pre>
<br/>
release a resources and free it if the Last release is call.
<br/><ul>
<b>Parameter [input] [output]:</b> <span class="code-argument">_object</span> element to realease == > is return at NULL value.
<br/><b>Return:</b> true, if element is removed, and false for just decreasing counter
<br/></ul>
<br/>
<hr/>
</div>
</body>
</html>