2
===============================================================================
4
Note: This file is delimited with -- markers so it is possible to split
5
sections out for other purposes, such as for release notes.
9
-------------------------------------------------------------------------------
11
Cogl is a small open source library for using 3D graphics hardware for
12
rendering. The API departs from the flat state machine style of OpenGL and is
13
designed to make it easy to write orthogonal components that can render without
14
stepping on each others toes.
16
As well as aiming for a nice API, we think having a single library as opposed
17
to an API specification like OpenGL has a few advantages too; like being
18
able to paper over the inconsistencies/bugs of different OpenGL
19
implementations in a centralized place, not to mention the myriad of OpenGL
20
extensions. It also means we are in a better position to provide utility
21
APIs that help software developers since they only need to be implemented
22
once and there is no risk of inconsistency between implementations.
24
Having other backends, besides OpenGL, such as drm, Gallium or D3D are
25
options we are interested in for the future.
29
-------------------------------------------------------------------------------
31
Cogl currently only requires:
34
• OpenGL ≥ 1.3 (or 1.2 + multitexturing), or OpenGL ES 2.0 (or 1.1)
35
• GLX, AGL, WGL or an EGL implementation
37
Cogl also has optional dependencies:
42
- for debugging texture atlasing (debug builds only)
44
The optional Cogl Pango library requires:
48
On X11, Cogl depends on the following extensions
55
When running with OpenGL, Cogl requires at least version 1.3
56
or 1.2 with the multitexturing extension. However to build Cogl
57
you will need the latest GL headers which can be obtained from:
59
http://www.khronos.org
61
If you are building the API reference you will also need:
65
If you are building the additional documentation you will also need:
68
• jw (optional, for generating PDFs)
70
If you are building the Introspection data you will also need:
72
• GObject-Introspection ≥ 0.9.5
74
GObject-Introspection is available from:
76
git://git.gnome.org/gobject-introspection
78
If you want support for profiling Cogl you will also need:
82
UProf is available from:
84
git://github.com/rib/UProf.git
88
-------------------------------------------------------------------------------
90
The API references for the latest stable release are available at:
92
http://docs.clutter-project.org/docs/cogl/stable/
94
The experimental 2.0 API can be found here:
96
http://docs.clutter-project.org/docs/cogl-2.0-experimental/stable/
98
Note: The confusing "stable" at the end refers to the overall Cogl release
99
status, not the documentation specifically.
103
-------------------------------------------------------------------------------
105
Most of Cogl is licensed under the terms of the GNU Lesser General Public
106
License, version 2.1 or (at your option) later. Some files are licensed under
107
more permissive licenses MIT or BSD style licenses though so please see
108
individual files for details.
111
BUILDING AND INSTALLATION
112
-------------------------------------------------------------------------------
114
Please refer to the INSTALL document.
118
-------------------------------------------------------------------------------
120
Please report bugs here:
122
http://bugzilla.gnome.org/enter_bug.cgi?product=cogl
124
You will need a Bugzilla account.
126
Please include the following in bug reports:
128
• what system you're running Cogl on;
129
• which version of Cogl you are using;
130
• which version of GLib and OpenGL (or OpenGL ES) you are using;
131
• which video card and which drivers you are using, including output of
132
glxinfo and xdpyinfo (if applicable);
133
• how to reproduce the bug.
135
If you cannot reproduce the bug with one of the tests that come with
136
Cogl's source code, it can help a lot to include a small test case
137
displaying the bad behaviour.
139
If the bug exposes a crash, the exact text printed out and a stack trace
140
obtained using gdb are greatly appreciated.
144
-------------------------------------------------------------------------------
146
The CODING_STYLE file describes the coding style we use throughout Cogl,
147
please try your best to conform to this style because the consistency
148
really helps keep the code maintainable.
150
We can accept contributions in several ways:
151
• Either as patches attached to bugs on bugzilla
152
- For this you may be interested in using git-bz.
154
See http://git.fishsoup.net/man/git-bz.html for details
155
• You can email us patches
156
- For this we recommend using git-send-email
158
• You can create a remote branch and ask us to pull from that for more
160
- For this we recommend using github.
162
Ideally standalone patches should be created using git format-patch since
163
that makes it easiest to import the patch with a commit message into a
added
removed
README
