isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-12-27 05:12:15 +00:00
Code Issues Packages Projects Releases Wiki Activity
a72a2c99fe
mutter/doc/reference/cogl-2.0-experimental/cogl-2.0-experimental-docs.xml.in

208 lines
6.7 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 22:23:44 +00: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>
<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"/>
<xi:include href="xml/cogl-context.xml"/>
docs: Fix typo to avoid duplicate section name Signed-off-by: Neil Roberts <neil@linux.intel.com>
2011-06-20 13:07:07 +00: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 22:23:44 +00: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 19:17:03 +00: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 22:23:44 +00: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 16:34:21 +00: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 22:23:44 +00: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"/>
</section>
<section id="cogl-drawing-apis">
<title>Drawing</title>
<xi:include href="xml/cogl-drawing.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 17:31:05 +00:00
<xi:include href="xml/cogl-texture-2d.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 22:23:44 +00:00
<xi:include href="xml/cogl-texture-3d.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 17:31:05 +00:00
<xi:include href="xml/cogl-texture-rectangle.xml"/>
</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 22:23:44 +00:00
</section>
<xi:include href="xml/cogl-clipping.xml"/>
<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"/>
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-25 01:40:29 +00: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 22:23:44 +00:00
<xi:include href="xml/cogl-types.xml"/>
</section>
<section id="cogl-integration">
<title>Binding and Integrating</title>
<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