mirror of
https://github.com/brl/mutter.git
synced 2024-11-25 09:30:45 -05:00
Read-only mirror of https://gitlab.gnome.org/GNOME/mutter
185630085c
This option to GCC makes it give a warning whenever a global function is defined without a declaration. This should catch cases were we've defined a function but forgot to put it in a header. In that case it is either only used within one file so we should make it static or we should declare it in a header. The following changes where made to fix problems: • Some functions were made static • cogl-path.h (the one containing the 1.0 API) was split into two files, one defining the functions and one defining the enums so that cogl-path.c can include the enum and function declarations from the 2.0 API as well as the function declarations from the 1.0 API. • cogl2-clip-state has been removed. This only had one experimental function called cogl_clip_push_from_path but as this is unstable we might as well remove it favour of the equivalent cogl_framebuffer_* API. • The GLX, SDL and WGL winsys's now have a private header to define their get_vtable function instead of directly declaring in the C file where it is called. • All places that were calling COGL_OBJECT_DEFINE need to have the cogl_is_whatever function declared so these have been added either as a public function or in a private header. • Some files that were not including the header containing their function declarations have been fixed to do so. • Any unused error quark functions have been removed. If we later want them we should add them back one by one and add a declaration for them in a header. • _cogl_is_framebuffer has been renamed to cogl_is_framebuffer and made a public function with a declaration in cogl-framebuffer.h • Similarly for CoglOnscreen. • cogl_vdraw_indexed_attributes is called cogl_framebuffer_vdraw_indexed_attributes in the header. The definition has been changed to match the header. • cogl_index_buffer_allocate has been removed. This had no declaration and I'm not sure what it's supposed to do. • CoglJournal has been changed to use the internal CoglObject macro so that it won't define an exported cogl_is_journal symbol. • The _cogl_blah_pointer_from_handle functions have been removed. CoglHandle isn't used much anymore anyway and in the few places where it is used I think it's safe to just use the implicit cast from void* to the right type. • The test-utils.h header for the conformance tests explicitly disables the -Wmissing-declaration option using a pragma because all of the tests declare their main function without a header. Any mistakes relating to missing declarations aren't really important for the tests. • cogl_quaternion_init_from_quaternion and init_from_matrix have been given declarations in cogl-quaternion.h Reviewed-by: Robert Bragg <robert@linux.intel.com> |
||
|---|---|---|
| build | ||
| cogl | ||
| cogl-pango | ||
| doc | ||
| examples | ||
| po | ||
| tests | ||
| .gitignore | ||
| .vimrc | ||
| autogen.sh | ||
| ChangeLog | ||
| cogl.doap | ||
| config-custom.h | ||
| config.h.win32.in | ||
| configure.ac | ||
| COPYING | ||
| Makefile.am | ||
| NEWS | ||
| README.in | ||
README for Cogl @COGL_1_VERSION@
===============================================================================
Note: This file is delimited with -- markers so it is possible to split
sections out for other purposes, such as for release notes.
--
DESCRIPTION
-------------------------------------------------------------------------------
Cogl is a small open source library for using 3D graphics hardware for
rendering. The API departs from the flat state machine style of OpenGL and is
designed to make it easy to write orthogonal components that can render without
stepping on each others toes.
As well as aiming for a nice API, we think having a single library as opposed
to an API specification like OpenGL has a few advantages too; like being
able to paper over the inconsistencies/bugs of different OpenGL
implementations in a centralized place, not to mention the myriad of OpenGL
extensions. It also means we are in a better position to provide utility
APIs that help software developers since they only need to be implemented
once and there is no risk of inconsistency between implementations.
Having other backends, besides OpenGL, such as drm, Gallium or D3D are
options we are interested in for the future.
--
REQUIREMENTS
-------------------------------------------------------------------------------
Cogl currently only requires:
• GLib ≥ @GLIB_REQ_VERSION@
• OpenGL ≥ 1.3 (or 1.2 + multitexturing), or OpenGL ES 2.0 (or 1.1)
• GLX, AGL, WGL or an EGL implementation
Cogl also has optional dependencies:
• GDK-Pixbuf ≥ @GDK_PIXBUF_REQ_VERSION@
- for image loading
• Cairo ≥ @CAIRO_REQ_VERSION@
- for debugging texture atlasing (debug builds only)
The optional Cogl Pango library requires:
• Cairo ≥ @CAIRO_REQ_VERSION@
• PangoCairo ≥ @PANGOCAIRO_REQ_VERSION@
On X11, Cogl depends on the following extensions
• XComposite ≥ @XCOMPOSITE_REQ_VERSION@
• XDamage
• XExt
• XFixes ≥ @XFIXES_REQ_VERSION@
When running with OpenGL, Cogl requires at least version 1.3
or 1.2 with the multitexturing extension. However to build Cogl
you will need the latest GL headers which can be obtained from:
http://www.khronos.org
If you are building the API reference you will also need:
• GTK-Doc ≥ @GTK_DOC_REQ_VERSION@
If you are building the additional documentation you will also need:
• xsltproc
• jw (optional, for generating PDFs)
If you are building the Introspection data you will also need:
• GObject-Introspection ≥ @GI_REQ_VERSION@
GObject-Introspection is available from:
git://git.gnome.org/gobject-introspection
If you want support for profiling Cogl you will also need:
• UProf ≥ @UPROF_REQ_VERSION@
UProf is available from:
git://github.com/rib/UProf.git
--
DOCUMENTATION
-------------------------------------------------------------------------------
The API references for the latest stable release are available at:
http://docs.clutter-project.org/docs/cogl/stable/
The experimental 2.0 API can be found here:
http://docs.clutter-project.org/docs/cogl-2.0-experimental/stable/
Note: The confusing "stable" at the end refers to the overall Cogl release
status, not the documentation specifically.
--
LICENSE
-------------------------------------------------------------------------------
Most of Cogl is licensed under the terms of the GNU Lesser General Public
License, version 2.1 or (at your option) later. Some files are licensed under
more permissive licenses MIT or BSD style licenses though so please see
individual files for details.
--
BUILDING AND INSTALLATION
-------------------------------------------------------------------------------
Please refer to the INSTALL document.
--
BUGS
-------------------------------------------------------------------------------
Please report bugs here:
http://bugzilla.gnome.org/enter_bug.cgi?product=cogl
You will need a Bugzilla account.
Please include the following in bug reports:
• what system you're running Cogl on;
• which version of Cogl you are using;
• which version of GLib and OpenGL (or OpenGL ES) you are using;
• which video card and which drivers you are using, including output of
glxinfo and xdpyinfo (if applicable);
• how to reproduce the bug.
If you cannot reproduce the bug with one of the tests that come with
Cogl's source code, it can help a lot to include a small test case
displaying the bad behaviour.
If the bug exposes a crash, the exact text printed out and a stack trace
obtained using gdb are greatly appreciated.
--
CONTRIBUTING
-------------------------------------------------------------------------------
The CODING_STYLE file describes the coding style we use throughout Cogl,
please try your best to conform to this style because the consistency
really helps keep the code maintainable.
We can accept contributions in several ways:
• Either as patches attached to bugs on bugzilla
- For this you may be interested in using git-bz.
See http://git.fishsoup.net/man/git-bz.html for details
• You can email us patches
- For this we recommend using git-send-email
• You can create a remote branch and ask us to pull from that for more
substantial changes.
- For this we recommend using github.
Ideally standalone patches should be created using git format-patch since
that makes it easiest to import the patch with a commit message into a
git repository.