isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-11-30 03:50:47 -05:00
Code Issues Packages Projects Releases Wiki Activity
ec03357e88
mutter/doc/reference/cogl-2.0-experimental/cogl-2.0-experimental-docs.xml.in

213 lines
6.9 KiB
XML
Raw Normal View History

Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 18:23:44 -04:00
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version "@VERSION@">
]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
<title>Cogl 2.0 Reference Manual</title>
<releaseinfo>for Cogl 2.0;</releaseinfo>
<copyright>
<year>2008</year>
<holder>OpenedHand LTD</holder>
</copyright>
<copyright>
<year>2009</year>
<year>2010</year>
<year>2011</year>
Rework sdl integration api This re-works the SDL integration api to simplify the integration for application developers and also allow Cogl to know when the application is about to go idle waiting for events so it can perform idle book-keeping work. Reviewed-by: Neil Roberts <neil@linux.intel.com>
2012-04-06 06:16:19 -04:00
<year>2012</year>
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 18:23:44 -04:00
<holder>Intel Corporation</holder>
</copyright>
<legalnotice>
<para>
Permission is granted to copy, distribute and/or modify this
document under the terms of the <citetitle>GNU Free
Documentation License</citetitle>, Version 1.1 or any later
version published by the Free Software Foundation with no
Invariant Sections, no Front-Cover Texts, and no Back-Cover
Texts. You may obtain a copy of the <citetitle>GNU Free
Documentation License</citetitle> from the Free Software
Foundation by visiting <ulink type="http"
url="http://www.fsf.org">their Web site</ulink> or by writing
to:
<address>
The Free Software Foundation, Inc.,
<street>59 Temple Place</street> - Suite 330,
<city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>,
<country>USA</country>
</address>
</para>
</legalnotice>
</bookinfo>
<chapter>
<title>Cogl - a modern 3D graphics API</title>
<section id="cogl-intro">
<title>About Cogl</title>
<para>Cogl is a modern 3D graphics API with associated utility
APIs designed to expose the features of 3D graphics hardware
using a more object oriented design than OpenGL. The library has
primarily been driven by the practical needs of Clutter but it
is not tied to any one toolkit or even constrained to developing
UI toolkits.</para>
</section>
<xi:include href="xml/cogl-object.xml"/>
Adds CoglError api Although we use GLib internally in Cogl we would rather not leak GLib api through Cogl's own api, except through explicitly namespaced cogl_glib_ / cogl_gtype_ feature apis. One of the benefits we see to not leaking GLib through Cogl's public API is that documentation for Cogl won't need to first introduce the Glib API to newcomers, thus hopefully lowering the barrier to learning Cogl. This patch provides a Cogl specific typedef for reporting runtime errors which by no coincidence matches the typedef for GError exactly. If Cogl is built with --enable-glib (default) then developers can even safely assume that a CoglError is a GError under the hood. This patch also enforces a consistent policy for when NULL is passed as an error argument and an error is thrown. In this case we log the error and abort the application, instead of silently ignoring it. In common cases where nothing has been implemented to handle a particular error and/or where applications are just printing the error and aborting themselves then this saves some typing. This also seems more consistent with language based exceptions which usually cause a program to abort if they are not explicitly caught (which passing a non-NULL error signifies in this case) Since this policy for NULL error pointers is stricter than the standard GError convention, there is a clear note in the documentation to warn developers that are used to using the GError api. Reviewed-by: Neil Roberts <neil@linux.intel.com> (cherry picked from commit b068d5ea09ab32c37e8c965fc8582c85d1b2db46) Note: Since we can't change the Cogl 1.x api the patch was changed to not rename _error_quark() functions to be _error_domain() functions and although it's a bit ugly, instead of providing our own CoglError type that's compatible with GError we simply #define CoglError to GError unless Cogl is built with glib disabled. Note: this patch does technically introduce an API break since it drops the cogl_error_get_type() symbol generated by glib-mkenum (Since the CoglError enum was replaced by a CoglSystemError enum) but for now we are assuming that this will not affect anyone currently using the Cogl API. If this does turn out to be a problem in practice then we would be able to fix this my manually copying an implementation of cogl_error_get_type() generated by glib-mkenum into a compatibility source file and we could also define the original COGL_ERROR_ enums for compatibility too. Note: another minor concern with cherry-picking this patch to the 1.14 branch is that an api scanner would be lead to believe that some APIs have changed, and for example the gobject-introspection parser which understands the semantics of GError will not understand the semantics of CoglError. We expect most people that have tried to use gobject-introspection with Cogl already understand though that it is not well suited to generating bindings of the Cogl api anyway and we aren't aware or anyone depending on such bindings for apis involving GErrors. (GnomeShell only makes very-very minimal use of Cogl via the gjs bindings for the cogl_rectangle and cogl_color apis.) The main reason we have cherry-picked this patch to the 1.14 branch even given the above concerns is that without it it would become very awkward for us to cherry-pick other beneficial patches from master.
2012-08-31 14:28:27 -04:00
<xi:include href="xml/cogl-error.xml"/>
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 18:23:44 -04:00
<xi:include href="xml/cogl-context.xml"/>
Add support for main loop integration This adds two new functions: void cogl_poll_get_info (CoglContext *context, CoglPollFD **poll_fds, int *n_poll_fds, gint64 *timeout); void cogl_poll_dispatch (CoglContext *context, const CoglPollFD *poll_fds, int n_poll_fds); The application is expected to call the first function whenever it is about to block to go idle, and the second function whenever it comes out of idle. This gives Cogl winsys's the ability poll file descriptors for events. For example when handing swap complete notifications, it can report that it needs to block on a file descriptor. The two functions are backed by winsys virtual functions. There are currently no implementations. The default handler for get_info just reports no file descriptors and an infinite timeout. Reviewed-by: Robert Bragg <robert@linux.intel.com>
2011-12-16 12:49:28 -05:00
<xi:include href="xml/cogl-poll.xml"/>
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 18:23:44 -04:00
docs: Fix typo to avoid duplicate section name Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-20 09:07:07 -04:00
<section id="cogl-pipeline-apis">
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 18:23:44 -04:00
<title>Setting Up A GPU Pipeline</title>
<xi:include href="blend-strings.xml"/>
<xi:include href="xml/cogl-pipeline.xml"/>
snippet: Add some more documentation This adds a documentation section for CoglSnippet which gives an overview of how to use them. It also fixes some syntax errors in the existing documentation and adds the missing pipeline functions for adding snippets to the documentation sections file. Reviewed-by: Robert Bragg <robert@linux.intel.com>
2011-12-06 14:17:03 -05:00
<xi:include href="xml/cogl-snippet.xml"/>
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 18:23:44 -04:00
</section>
<section id="cogl-buffer-apis">
<title>Allocating GPU Memory</title>
<xi:include href="xml/cogl-buffer.xml"/>
docs: fix stale include links Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-20 12:34:21 -04:00
<xi:include href="xml/cogl-attribute-buffer.xml"/>
<xi:include href="xml/cogl-index-buffer.xml"/>
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 18:23:44 -04:00
</section>
<section id="cogl-buffer-layout-apis">
<title>Describing the layout of GPU Memory</title>
<xi:include href="xml/cogl-attribute.xml"/>
<xi:include href="xml/cogl-indices.xml"/>
</section>
<section id="cogl-primitive-apis">
<title>Geometry</title>
<xi:include href="xml/cogl-primitive.xml"/>
<xi:include href="xml/cogl-paths.xml"/>
<xi:include href="xml/cogl-rectangle.xml"/>
</section>
<section id="cogl-textures">
<title>Textures</title>
<xi:include href="xml/cogl-texture.xml"/>
docs: Adds various missing 2.0 sections and symbols This adds a number of missing sections and symbols to the experimental 2.0 reference manual.
2011-10-28 13:31:05 -04:00
</section>
<section id="cogl-meta-textures">
<title>Meta Textures</title>
<xi:include href="xml/cogl-meta-texture.xml"/>
<xi:include href="xml/cogl-sub-texture.xml"/>
<xi:include href="xml/cogl-texture-2d-sliced.xml"/>
<xi:include href="xml/cogl-texture-pixmap-x11.xml"/>
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 18:23:44 -04:00
</section>
Add a CoglPrimitiveTexture interface This interface represents any textures that are backed by a single texture in GL and that can be used directly with the cogl_framebuffer_draw_attributes family of functions. This currently equates to CoglTexture2D, CoglTexture3D and CoglTextureRectangle. The interface currently has only one method called cogl_primitive_set_auto_mipmap. This replaces the COGL_TEXTURE_NO_AUTO_MIPMAP flag from the CoglTextureFlags parameter in the constructors. None of the other flags in CoglTextureFlags make sense for primitive textures so it doesn't seem like a good idea to need them for primitive constructors. There is a boolean in the vtable to mark whether a texture type is primitive which the new cogl_is_primitive function uses. There is also a new texture virtual called set_auto_mipmap which is only required to be implemented for primitive textures. Reviewed-by: Robert Bragg <robert@linux.intel.com>
2012-04-04 10:09:43 -04:00
<section id="cogl-primitive-textures">
<title>Primitive Textures</title>
<xi:include href="xml/cogl-primitive-texture.xml"/>
<xi:include href="xml/cogl-texture-2d.xml"/>
<xi:include href="xml/cogl-texture-3d.xml"/>
<xi:include href="xml/cogl-texture-rectangle.xml"/>
</section>
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 18:23:44 -04:00
<section id="cogl-framebuffer-apis">
<title>Framebuffers</title>
<xi:include href="xml/cogl-framebuffer.xml"/>
<xi:include href="xml/cogl-offscreen.xml"/>
</section>
<section id="cogl-utilities">
<title>Utilities</title>
<xi:include href="xml/cogl-color.xml"/>
<xi:include href="xml/cogl-matrix.xml"/>
<xi:include href="xml/cogl-vector.xml"/>
doc: Include the documentation for CoglEuler Several little changes were needed to make the CoglEuler documentation appear: • Fix the embeded docbook snippet in the CoglEuler section header • Add the xinclude directive to the main document • Add the missing <SECTION> in -sections.txt Reviewed-by: Robert Bragg <robert@linux.intel.com> (cherry picked from commit c7f6e07f7b8ba0d7dc9604e888c8a46165ec3ed4)
2012-05-11 06:57:03 -04:00
<xi:include href="xml/cogl-euler.xml"/>
math: Adds an experimental quaternion API This adds an experimental quaternion utility API. It's not yet fully documented but it's complete enough that people can start to experiment with using it. It adds the following functions: cogl_quaternion_init_identity cogl_quaternion_init cogl_quaternion_init_from_angle_vector cogl_quaternion_init_from_array cogl_quaternion_init_from_x_rotation cogl_quaternion_init_from_y_rotation cogl_quaternion_init_from_z_rotation cogl_quaternion_equal cogl_quaternion_copy cogl_quaternion_free cogl_quaternion_get_rotation_angle cogl_quaternion_get_rotation_axis cogl_quaternion_normalize cogl_quaternion_dot_product cogl_quaternion_invert cogl_quaternion_multiply cogl_quaternion_pow cogl_quaternion_slerp cogl_quaternion_nlerp cogl_quaternion_squad cogl_get_static_identity_quaternion cogl_get_static_zero_quaternion Since it's experimental API you'll need to define COGL_ENABLE_EXPERIMENTAL_API before including cogl.h.
2010-02-24 20:40:29 -05:00
<xi:include href="xml/cogl-quaternion.xml"/>
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 18:23:44 -04:00
<xi:include href="xml/cogl-types.xml"/>
Add a cogl-version header This adds a version header which contains macros to define which version of Cogl the application is being compiled against. This helps applications that want to support multiple incompatible versions of Cogl at compile time. The macros are called COGL_VERSION_{MAJOR,MINOR,MICRO}. This does not match Clutter which names them CLUTTER_{MAJOR,MINOR,MICRO}_VERSION but I think the former is nicer and it at least matches Cairo and Pango. The values of the macro are defined to COGL_VERSION_*_INTERNAL which is generated by the configure script into cogl-defines.h. There is also a macro for the entire version as a string called COGL_VERSION_STRING. The internal utility macros for encoding a 3 part version number into a single integer have been moved into the new header so they can be used publicly as a convenient way to check if the version is within a particular range. There is also a COGL_VERSION_CHECK macro for the very common case that a feature will be used since a particular version of Cogl. There is a macro called COGL_VERSION which contains the pre-encoded version of Cogl being compiled against for convenience. Unlike in Clutter this patch does not add any runtime version identification mechanism. A test case is also added which just contains static asserts to sanity check the macros. Reviewed-by: Robert Bragg <robert@linux.intel.com> (cherry picked from commit 3480cf140dc355fa87ab3fbcf0aeeb0124798a8f)
2012-04-23 09:09:19 -04:00
<xi:include href="xml/cogl-version.xml"/>
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 18:23:44 -04:00
</section>
<section id="cogl-integration">
<title>Binding and Integrating</title>
Rework sdl integration api This re-works the SDL integration api to simplify the integration for application developers and also allow Cogl to know when the application is about to go idle waiting for events so it can perform idle book-keeping work. Reviewed-by: Neil Roberts <neil@linux.intel.com>
2012-04-06 06:16:19 -04:00
<xi:include href="xml/cogl-sdl.xml"/>
Adds experimental cogl 2.0 reference This pulls in the experimental cogl 2.0 reference manual from the clutter repository since it wasn't included in the filter-branch when we split cogl out.
2011-05-08 18:23:44 -04:00
<xi:include href="xml/cogl-gtype.xml"/>
</section>
</chapter>
<chapter id="coglglossary">
<title>Glossaries</title>
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
</chapter>
<index>
<title>Index of all symbols</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
</index>
<index role="deprecated">
<title>Index of deprecated symbols</title>
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
</index>
<index role="0.8">
<title>Index of new symbols in 0.8</title>
<xi:include href="xml/api-index-0.8.xml"><xi:fallback /></xi:include>
</index>
<index role="1.0">
<title>Index of new symbols in 1.0</title>
<xi:include href="xml/api-index-1.0.xml"><xi:fallback /></xi:include>
</index>
<index role="1.2">
<title>Index of new symbols in 1.2</title>
<xi:include href="xml/api-index-1.2.xml"><xi:fallback /></xi:include>
</index>
<index role="1.4">
<title>Index of new symbols in 1.4</title>
<xi:include href="xml/api-index-1.4.xml"><xi:fallback /></xi:include>
</index>
<appendix id="license">
<title>License</title>
<para>
This library is free software; you can redistribute it and/or
modify it under the terms of the <citetitle>GNU Library General
Public License</citetitle> as published by the Free Software
Foundation; either version 2 of the License, or (at your option)
any later version.
</para>
<para>
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
<citetitle>GNU Library General Public License</citetitle> for
more details.
</para>
<para>
You may obtain a copy of the <citetitle>GNU Library General
Public License</citetitle> from the Free Software Foundation by
visiting <ulink type="http" url="http://www.fsf.org">their Web
site</ulink> or by writing to:
<address>
Free Software Foundation, Inc.
<street>59 Temple Place</street> - Suite 330
<city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>
<country>USA</country>
</address>
</para>
</appendix>
</book>
Reference in New Issue Copy Permalink