ewol/index.html

277 lines
17 KiB
HTML
Raw Normal View History

2016-10-23 21:18:24 +02:00
<!-- HTML header for doxygen 1.8.8-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<!-- For Mobile Devices -->
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
<title>Ewol: Ewol Widget in OpenGl: Ewol library</title>
<!--<link href="tabs.css" rel="stylesheet" type="text/css"/>-->
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/js/bootstrap.min.js"></script>
<script type="text/javascript" src="doxy-boot.js"></script>
</head>
<body>
<nav class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand">Ewol: Ewol Widget in OpenGl 0.10.0</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li><a href="index.html">Main&nbsp;Page</a></li>
<li><a href="pages.html">Related&nbsp;Pages</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="annotated.html">Classes</a></li>
<li><a href="files.html">Files</a></li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">
Link-libs<span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="http://HeeroYui.github.io/lutin">lutin</a></li>
<li><a href="http://atria-soft.github.io/ewol">ewol</a></li>
2016-10-23 23:20:07 +02:00
<li><a href="http://atria-soft.github.io/echrono">echrono</a></li>
2016-10-23 21:18:24 +02:00
<li><a href="http://atria-soft.github.io/etk">etk</a></li>
<li><a href="http://atria-soft.github.io/ejson">ejson</a></li>
<li><a href="http://atria-soft.github.io/exml">exml</a></li>
<li><a href="http://atria-soft.github.io/esvg">esvg</a></li>
<li><a href="http://atria-soft.github.io/egami">egami</a></li>
<li><a href="http://atria-soft.github.io/gale">gale</a></li>
<li><a href="http://atria-soft.github.io/ege">ege</a></li>
<li><a href="http://atria-soft.github.io/elog">elog</a></li>
<li><a href="http://atria-soft.github.io/ememory">ememory</a></li>
<li><a href="http://atria-soft.github.io/enet">enet</a></li>
<li><a href="http://atria-soft.github.io/eproperty">eproperty</a></li>
<li><a href="http://atria-soft.github.io/esignal">esignal</a></li>
2016-10-23 23:20:07 +02:00
<li><a href="http://atria-soft.github.io/etranslate">etranslate</a></li>
2016-10-23 21:18:24 +02:00
<li><a href="http://atria-soft.github.io/zeus">zeus</a></li>
2016-10-23 23:20:07 +02:00
<li><a href="http://musicdsp.github.io/audio-ess">audio-ess</a></li>
2016-10-23 21:18:24 +02:00
<li><a href="http://musicdsp.github.io/audio">audio</a></li>
<li><a href="http://musicdsp.github.io/audio-drain">audio-drain</a></li>
<li><a href="http://musicdsp.github.io/audio-orchestra">audio-orchestra</a></li>
<li><a href="http://musicdsp.github.io/audio-river">audio-river</a></li>
</ul>
</li>
</ul>
<div id="search-box" class="input-group">
<div class="input-group-btn">
<button aria-expanded="false" type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown">
<span class="glyphicon glyphicon-search"></span>
<span class="caret"></span>
</button>
<ul class="dropdown-menu">
<li><a href="#">All</a></li>
<li><a href="#">Classes</a></li>
<li><a href="#">Namespaces</a></li>
<li><a href="#">Files</a></li>
<li><a href="#">Functions</a></li>
<li><a href="#">Variables</a></li>
<li><a href="#">Typedefs</a></li>
<li><a href="#">Enumerations</a></li>
<li><a href="#">Enumerator</a></li>
<li><a href="#">Friends</a></li>
<li><a href="#">Macros</a></li>
<li><a href="#">Pages</a></li>
</ul>
</div>
<button id="search-close" type="button" class="close" aria-label="Close">
<span aria-hidden="true"></span>
</button>
<input id="search-field" class="form-control" accesskey="S" onkeydown="searchBox.OnSearchFieldChange(event);" placeholder="Search ..." type="text">
</div>
</div><!--/.nav-collapse -->
</div>
</nav>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div class="content" id="content">
<div class="container">
<div class="row">
<div class="col-sm-12 panel panel-default" style="padding-bottom: 15px;">
2016-10-23 23:20:07 +02:00
<div style="margin-bottom: 15px;margin-top: 60px;">
2016-10-23 21:18:24 +02:00
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">Ewol library </div> </div>
</div><!--header-->
<div class="contents">
<div class="toc"><h3>Table of Contents</h3>
<ul><li class="level1"><a href="#ewol_mainpage_what">What is EWOL? </a></li>
<li class="level1"><a href="#ewol_mainpage_where">Where can I use it? </a></li>
<li class="level1"><a href="#ewol_mainpage_language">What languages are supported? </a></li>
<li class="level1"><a href="#ewol_mainpage_restriction">Are there any licensing restrictions? </a></li>
<li class="level1"><a href="#ewol_mainpage_license">License (APACHE 2) </a></li>
<li class="level1"><a href="#ewol_mainpage_sub">Sub library: </a><ul><li class="level2"><a href="#ewol_mainpage_desc">Description: </a></li>
<li class="level2"><a href="#ewol_mainpage_ext">External: </a></li>
<li class="level2"><a href="#ewol_mainpage_using">Program Using EWOL </a></li>
2013-12-28 17:04:11 +01:00
</ul>
2016-10-23 21:18:24 +02:00
</li>
<li class="level1"><a href="#ewol_mainpage_sub_doc">Main documentation: </a></li>
2013-12-28 17:04:11 +01:00
</ul>
2016-10-23 21:18:24 +02:00
</div>
<div class="textblock"><h1><a class="anchor" id="ewol_mainpage_what"></a>
What is EWOL? </h1>
<p>EWOL, or Edn Widget OpenGl Layer, is a multi-platform library for creating graphical user interfaces in OpenGL. Offering a complete set of widgets.</p>
<h1><a class="anchor" id="ewol_mainpage_where"></a>
Where can I use it? </h1>
<p>Everywhere! EWOL is cross-platform devolopped to support bases OS:</p><ul>
<li>Linux (X11) (mouse)</li>
<li>Windows (mouse) (build on linux...)</li>
<li>MacOs (mouse)</li>
<li>Android (mouse + touch)</li>
<li>IOs (touch)</li>
2013-12-28 17:04:11 +01:00
</ul>
2016-10-23 21:18:24 +02:00
<h1><a class="anchor" id="ewol_mainpage_language"></a>
What languages are supported? </h1>
<p>EWOL is written in C++ and is not (for now) supported for other languages.</p>
<h1><a class="anchor" id="ewol_mainpage_restriction"></a>
Are there any licensing restrictions? </h1>
<p>EWOL is <b>FREE software</b> and <em>all sub-library are FREE and staticly linkable !!!</em></p>
<p>That allow you to use it for every program you want, including those developing proprietary software, without any license fees or royalties.</p>
<p>The static support is important for some platform like IOs, and this limit the external library use at some license like:</p><ul>
<li>BSD*</li>
<li>MIT</li>
<li>APPACHE-2</li>
<li>PNG</li>
<li>ZLIB</li>
</ul>
<p>This exclude the classical extern library with licence:</p><ul>
<li>L-GPL</li>
<li>GPL</li>
</ul>
<h1><a class="anchor" id="ewol_mainpage_license"></a>
License (APACHE 2) </h1>
<p>Copyright ewol Edouard DUPIN</p>
<p>Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at</p>
<p><a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></p>
<p>Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.</p>
<h1><a class="anchor" id="ewol_mainpage_sub"></a>
Sub library: </h1>
<p>License:</p>
<ul>
<li><a href="http://atria-soft.github.io/etk"><b>etk</b></a> : APACHE-2</li>
<li><a href="http://atria-soft.github.io/elog"><b>elog</b></a> : APACHE-2<ul>
<li><b>linearmath</b> : z-lib (subset of bullet lib)</li>
<li><a href="http://atria-soft.github.io/earchive"><b>earchive</b></a> : APACHE-2<ul>
<li><b>zlib</b> : z-lib</li>
</ul>
</li>
</ul>
</li>
<li><a href="http://atria-soft.github.io/egami"><b>egami</b></a> : APACHE-2<ul>
<li><a href="http://atria-soft.github.io/esvg"><b>esvg</b></a> : APACHE-2</li>
<li><b>libpng</b> : PNG</li>
</ul>
</li>
<li><b>libogg</b> : BSD-like</li>
<li><b>libfreetype</b> : BSD-like</li>
<li><a href="http://atria-soft.github.io/ejson"><b>e-json</b></a> : APACHE-2</li>
<li><a href="http://atria-soft.github.io/exml"><b>e-xml</b></a> : APACHE-2</li>
<li><a href="http://musicdsp.github.io/audio"><b>audio</b></a> : APACHE-2</li>
<li><a href="http://musicdsp.github.io/audio-orchestra"><b>audio-orchestra</b></a> : MIT</li>
<li><a href="http://musicdsp.github.io/audio-drain"><b>audio-drain</b></a> : APACHE-2</li>
<li><a href="http://musicdsp.github.io/audio-river"><b>audio-river</b></a> : APACHE-2</li>
<li><a href="http://musicdsp.github.io/audio-ess"><b>audio-ess</b></a> : APACHE-2</li>
<li><a href="http://atria-soft.github.io/ege"><b>ege</b></a> : APACHE-2</li>
<li><a href="http://atria-soft.github.io/dollar"><b>dollar</b></a> : APACHE-2 ...</li>
</ul>
<h2><a class="anchor" id="ewol_mainpage_desc"></a>
Description: </h2>
<p>Internal:</p>
<ul>
<li><a href="http://atria-soft.github.io/elog"><b>elog</b></a> : Generic Log interface (for Android and MacOs) ...</li>
<li><a href="http://atria-soft.github.io/etk"><b>etk</b></a> : Generic toolkit to acces on file, standardize acces on string (for Android and MacOs) ...</li>
<li><a href="http://atria-soft.github.io/earchive"><b>earchive</b></a> : Generic access to a zip file (used to access on file on Android)</li>
<li><a href="http://atria-soft.github.io/egami"><b>egami</b></a> : generic image accessor for PNG, svg and bmp image (might add some other type ...)</li>
<li><a href="http://atria-soft.github.io/esvg"><b>e-svg</b></a> : Generic SVG image parser and displayer</li>
<li><a href="http://atria-soft.github.io/ejson"><b>e-json</b></a> : JSON file access (read and write)</li>
<li><a href="http://atria-soft.github.io/exml"><b>e-xml</b></a> : XML file access (read and write)</li>
<li><a href="http://musicdsp.github.io/audio"><b>audio</b></a> : Basic audio format</li>
<li><a href="http://musicdsp.github.io/audio-orchestra"><b>audio-orchestra</b></a> : Low level wrapper of audio interface (Linux/Windows/MacOs/IOs/Android)</li>
<li><a href="http://musicdsp.github.io/audio-drain"><b>audio-drain</b></a> : single stream audio processing</li>
<li><a href="http://musicdsp.github.io/audio-river"><b>audio-river</b></a> : High level audio abstraction</li>
<li><a href="http://musicdsp.github.io/audio-ess"><b>audio-ess</b></a> : basic sound set manager</li>
<li><a href="http://musicdsp.github.io/ege"><b>ege</b></a> : Ewol Game engine is a wrapper on the the bullet physical engine and ewol renderer engin. This is in developpement for now (the simple objective is to produce game to make profitable all my work)</li>
<li><a href="http://atria-soft.github.io/zeus"><b>zeus</b></a> : RPC over websocket</li>
<li><a href="http://atria-soft.github.io/dollar"><b>dollar</b></a> : $1 $n $p and $p+</li>
</ul>
<h2><a class="anchor" id="ewol_mainpage_ext"></a>
External: </h2>
<ul>
<li><b>linearmath</b> : bullet mathamatical sub lib (for using same vec3).</li>
<li><b>Z lib</b> : Clkassical zlib lib.</li>
<li><b>libPNG</b> : the classical png display lib.</li>
<li><b>ogg</b> : The classical Ogg coder reader lib.</li>
<li><b>freetype</b> : The classicle true-type reader lib.</li>
<li><b>bulletlib</b> : the classical bullet library physical engine. (dependence by ege)</li>
<li><b>openSSL</b> : generic SSL library. (dependence by zeus)</li>
</ul>
<h2><a class="anchor" id="ewol_mainpage_using"></a>
Program Using EWOL </h2>
<ul>
<li><a href="http://github.com/HeeroYui/edn"><b>edn</b></a>: (Application in GPLv3) Edn is the main application using this lib and designed for (in the first time). This is a "Code editor".</li>
<li><a href="http://play.google.com/store/apps/details?id=com.edouarddupin.worddown"><b>worddown</b></a>: (Proprietary) Worddown is a simple word game.</li>
</ul>
<h1><a class="anchor" id="ewol_mainpage_sub_doc"></a>
Main documentation: </h1>
<ul>
<li><a class="el" href="ewol_build.html">Build lib &amp; build sample</a></li>
<li><a class="el" href="ewol_page_bases.html">EWOL: Bases</a></li>
<li><a class="el" href="ewol_tutorials.html">Tutorials</a></li>
<li><a class="el" href="ewol_coding_style.html">Ewol coding style</a> </li>
</ul>
</div></div><!-- contents -->
<!-- HTML footer for doxygen 1.8.8-->
<!-- start footer part -->
</div>
</div>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>
2016-10-23 23:20:07 +02:00
Generated on Mon Oct 24 2016 15:35:53 for Ewol: Ewol Widget in OpenGl by &#160;<a href="http://www.doxygen.org/index.html">
2016-10-23 21:18:24 +02:00
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>