124 lines
4.6 KiB
Markdown
124 lines
4.6 KiB
Markdown
|
Ewol library {#mainpage}
|
||
|
============
|
||
|
|
||
|
What is EWOL, and how can I use it?
|
||
|
-----------------------------------
|
||
|
|
||
|
EWOL, or Edn Widget OpenGl Layer, is a multi-platform library for creating graphical user interfaces in OpenGL. Offering a complete set of widgets.
|
||
|
|
||
|
Where can I use it?
|
||
|
-------------------
|
||
|
|
||
|
Everywhere! EWOL is cross-platform devolopped to support bases OS:
|
||
|
- Linux (X11) (mouse)
|
||
|
- Windows (mouse) (build on linux...)
|
||
|
- MacOs (mouse)
|
||
|
- Android (mouse + touch)
|
||
|
- IOs (touch)
|
||
|
|
||
|
What languages are supported?
|
||
|
-----------------------------
|
||
|
|
||
|
EWOL is written in C++ and is not (for now) supported for other languages.
|
||
|
|
||
|
Are there any licensing restrictions?
|
||
|
-------------------------------------
|
||
|
|
||
|
EWOL is [b]FREE software[/b] and [i]all sub-library are FREE and staticly linkable !!![/i]
|
||
|
|
||
|
That allow you to use it for every program you want, including those developing proprietary software, without any license fees or royalties.
|
||
|
|
||
|
The static support is important for some platform like IOs, and this limit the external library use at some license like:
|
||
|
- BSD*
|
||
|
- MIT
|
||
|
- APPACHE-2
|
||
|
- PNG
|
||
|
- ZLIB
|
||
|
|
||
|
This exclude the classical extern library with licence:
|
||
|
- L-GPL
|
||
|
- GPL
|
||
|
|
||
|
License (APACHE 2)
|
||
|
------------------
|
||
|
|
||
|
Copyright ewol Edouard DUPIN
|
||
|
|
||
|
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
|
||
|
|
||
|
<http://www.apache.org/licenses/LICENSE-2.0>
|
||
|
|
||
|
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.
|
||
|
|
||
|
|
||
|
Sub library:
|
||
|
------------
|
||
|
|
||
|
License:
|
||
|
|
||
|
- [**etk**](http://atria-soft.github.io/etk) : APACHE-2
|
||
|
- [**elog**](http://atria-soft.github.io/elog) : APACHE-2
|
||
|
+ **linearmath** : z-lib (subset of bullet lib)
|
||
|
+ [**earchive**](http://atria-soft.github.io/earchive) : APACHE-2
|
||
|
* **zlib** : z-lib
|
||
|
- [**egami**](http://atria-soft.github.io/egami) : APACHE-2
|
||
|
+ [**esvg**](http://atria-soft.github.io/esvg) : APACHE-2
|
||
|
+ **libpng** : PNG
|
||
|
- **libogg** : BSD-like
|
||
|
- **libfreetype** : BSD-like
|
||
|
- [**e-json**](http://atria-soft.github.io/ejson) : APACHE-2
|
||
|
- [**e-xml**](http://atria-soft.github.io/exml) : APACHE-2
|
||
|
- [**audio**](http://musicdsp.github.io/audio) : APACHE-2
|
||
|
- [**audio-orchestra**](http://musicdsp.github.io/audio-orchestra) : APACHE-2
|
||
|
- [**audio-river**](http://musicdsp.github.io/audio-river) : APACHE-2
|
||
|
|
||
|
...
|
||
|
|
||
|
Description:
|
||
|
------------
|
||
|
|
||
|
Internal:
|
||
|
|
||
|
- [**elog**](http://atria-soft.github.io/elog) : Generic Log interface (for Android and MacOs) ...
|
||
|
- [**etk**](http://atria-soft.github.io/etk) : Generic toolkit to acces on file, standardize acces on string (for Android and MacOs) ...
|
||
|
- [**earchive**](http://atria-soft.github.io/earchive) : Generic access to a zip file (used to access on file on Android)
|
||
|
- [**egami**](http://atria-soft.github.io/egami) : generic image accessor for PNG, svg and bmp image (might add some other type ...)
|
||
|
- [**esvg**](http://atria-soft.github.io/esvg) : Generic SVG image parser and displayer
|
||
|
- [**e-json**](http://atria-soft.github.io/ejson) : JSON file access (read and write)
|
||
|
- [**e-xml**](http://atria-soft.github.io/exml) : XML file access (read and write)
|
||
|
- [**audio**](http://musicdsp.github.io/audio) : Basic audio format
|
||
|
- [**audio-orchestra**](http://musicdsp.github.io/audio-orchestra) : Low level wrapper of audio interface (Linux/Windows/MacOs/IOs/Android)
|
||
|
- [**audio-river**](http://musicdsp.github.io/audio-river) : High level audio abstraction
|
||
|
- [**ege**](http://musicdsp.github.io/ege) : 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)
|
||
|
|
||
|
External:
|
||
|
---------
|
||
|
|
||
|
- **linearmath** : bullet mathamatical sub lib (for using same vec3).
|
||
|
- **Z lib** : Clkassical zlib lib.
|
||
|
- **libPNG** : the classical png display lib.
|
||
|
- **ogg** : The classical Ogg coder reader lib.
|
||
|
- **freetype** : The classicle true-type reader lib.
|
||
|
- **bulletlib** : the classical bullet library physical engine. (dependence by ege)
|
||
|
|
||
|
Program Using EWOL
|
||
|
------------------
|
||
|
|
||
|
- [**edn**](http://musicdsp.github.io/edn): (Application in GPLv3) Edn is the main application using this lib and designed for (in the first time). This is a "Code editor".
|
||
|
- [**worddown**](http://play.google.com/store/apps/details?id=com.edouarddupin.worddown): (Proprietary) Worddown is a simple word game.
|
||
|
|
||
|
|
||
|
Main documentation:
|
||
|
-------------------
|
||
|
|
||
|
[doc[001_bases | Global Documantation]]
|
||
|
|
||
|
[tutorial[000_Build | Tutorials]]
|
||
|
|