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

230 lines
7.5 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>
doc: Add 2013 in the Copyright statement (cherry picked from commit 1be3b40624b1619ea367804c9c44549770aea2a8)
2013-01-01 09:19:18 -05:00
<year>2013</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>
doc: Re-organise the first few sections 2 Things seems to mixed at the top level here. General APIs that work throughout the library and the context object. Let's split the sections in two then. (cherry picked from commit 5f72fb9ffec33213ff1089ce786a9b2e4c4c513f)
2012-12-29 15:31:02 -05:00
<section id="cogl-general-apis">
<title>General API concepts</title>
<xi:include href="xml/cogl-object.xml"/>
<xi:include href="xml/cogl-error.xml"/>
doc: Populate cogl-types a bit more and move it to the general section I just added the general types creating warnings in the current state of the documentation (ie the ones references by already documented functions) and moved the section from the 'Utility' section to the 'General' section which I believe is a better fit as they are used by more than one type and not really utilities. (cherry picked from commit c51b147789763863ef32482d7ffa936160ed7c93)
2012-12-31 11:08:12 -05:00
<xi:include href="xml/cogl-types.xml"/>
doc: Re-organise the first few sections 2 Things seems to mixed at the top level here. General APIs that work throughout the library and the context object. Let's split the sections in two then. (cherry picked from commit 5f72fb9ffec33213ff1089ce786a9b2e4c4c513f)
2012-12-29 15:31:02 -05:00
</section>
<section id="cogl-context-apis">
<title>Setting Up A Drawing Context</title>
doc: Add all the objects with a role leading to context creation Time to add those objects to the documentation! (cherry picked from commit 7d44969dccdcd8ca3d691c46f0535ab4981859a2)
2012-12-29 15:32:10 -05:00
<xi:include href="xml/cogl-renderer.xml"/>
<xi:include href="xml/cogl-onscreen-template.xml"/>
<xi:include href="xml/cogl-display.xml"/>
doc: Re-organise the first few sections 2 Things seems to mixed at the top level here. General APIs that work throughout the library and the context object. Let's split the sections in two then. (cherry picked from commit 5f72fb9ffec33213ff1089ce786a9b2e4c4c513f)
2012-12-29 15:31:02 -05:00
<xi:include href="xml/cogl-context.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
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"/>
doc: Expose CoglDepthState It wasn't included to the documention up to now. (cherry picked from commit 826c0d5c8333ad31595d690d7c8753f84d12b2ad)
2012-12-30 15:21:34 -05:00
<xi:include href="xml/cogl-depth-state.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>
doc: Expose CoglBitmap (cherry picked from commit ee97e4ae2b7ca272882a1acaa7eb6df3aed60096)
2012-12-30 11:21:38 -05:00
<xi:include href="xml/cogl-bitmap.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-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"/>
doc: Add Onscreen to the party It was sad and crying in a corner. (cherry picked from commit e3d3d7f8d1faf68ebb1ce5d4e19c05a9dd7edf9d)
2012-12-31 11:15:08 -05:00
<xi:include href="xml/cogl-onscreen.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-offscreen.xml"/>
</section>
<section id="cogl-utilities">
<title>Utilities</title>
<xi:include href="xml/cogl-color.xml"/>
<xi:include href="xml/cogl-matrix.xml"/>
matrix-stack: make CoglMatrixStack public We have found several times now when writing code using Cogl that it would really help if Cogl's matrix stack api was public as a utility api. In Rig for example we want to avoid redundant arithmetic when deriving the matrices of entities used to render and we aren't able to simply use the framebuffer's matrix stack to achieve this. Also when implementing cairo-cogl we found that it would be really useful if we could have a matrix stack utility api. (cherry picked from commit d17a01fd935d88fab96fe6cc0b906c84026c0067)
2012-11-20 12:08:43 -05:00
<xi:include href="xml/cogl-matrix-stack.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-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"/>
Add fence API cogl_framebuffer_add_fence creates a synchronisation fence, which will invoke a user-specified callback when the GPU has finished executing all commands provided to it up to that point in time. Support is currently provided for GL 3.x's GL_ARB_sync extension, and EGL's EGL_KHR_fence_sync (when used with OpenGL ES). Signed-off-by: Daniel Stone <daniel@fooishbar.org> Reviewed-by: Neil Roberts <neil@linux.intel.com> Reviewed-by: Robert Bragg <robert@linux.intel.com> https://bugzilla.gnome.org/show_bug.cgi?id=691752 (cherry picked from commit e6d37470da9294adc1554c0a8c91aa2af560ed9f)
2013-01-10 20:13:34 -05:00
<xi:include href="xml/cogl-fence.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"/>
doc: Move the main loop integration in the integration section Looks more logical than a top level section on its own and at the top of the documentation. (cherry picked from commit a3b1cd7f7dad3ec29fa5d9d53b155040916a5454)
2012-12-29 14:44:58 -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
<xi:include href="xml/cogl-gtype.xml"/>
doc: Expose the Cogl GLES 2.0 facilities in the documentation (cherry picked from commit 0c2344b9aafe4afdf7782fd9badc451de79b7a63)
2012-12-30 10:14:34 -05:00
<xi:include href="xml/cogl-gles2.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>
</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