brl/mutter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
7abe63953e
mutter/doc/reference/cogl/cogl-docs.xml.in

170 lines
5.6 KiB
XML
Raw Normal View History

Merged clutter-ivan branch into trunk. svn merge \ https://svn.o-hand.com/repos/clutter/trunk/clutter@2509 \ https://svn.o-hand.com/repos/clutter/branches/clutter-ivan@HEAD
2008-04-25 09:37:36 -04:00
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
2008-06-24 Matthew Allum <mallum@openedhand.com> * cogl/Makefile.am: * cogl/cogl-docs.sgml: * cogl/version.xml.in * clutter/version.xml.in Add full version (including minor) to docs. Add version to COGL docs
2008-06-24 06:38:18 -04:00
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
[docs] Rework the API reference version generation Clutter copies the gtk-doc from the usual gtk+ template, and has a version.xml.in containing only: @VERSION@ Without a newline at the end. Unfortunately, it appears that autoconf has started adding a newline to the generated version.xml which then is used as the payload for the "version" XML entity. Instead of using a secondary file we can make configure generate the whole clutter-docs.xml and cogl-docs.xml files from a template; this way we also get the ability to substitute more autoconf variables into the documentation -- if needs be.
2009-06-01 12:35:41 -04:00
<!ENTITY version "@VERSION@">
2008-06-24 Matthew Allum <mallum@openedhand.com> * cogl/Makefile.am: * cogl/cogl-docs.sgml: * cogl/version.xml.in * clutter/version.xml.in Add full version (including minor) to docs. Add version to COGL docs
2008-06-24 06:38:18 -04:00
]>
Merged clutter-ivan branch into trunk. svn merge \ https://svn.o-hand.com/repos/clutter/trunk/clutter@2509 \ https://svn.o-hand.com/repos/clutter/branches/clutter-ivan@HEAD
2008-04-25 09:37:36 -04:00
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
2008-06-24 Matthew Allum <mallum@openedhand.com> * cogl/Makefile.am: * cogl/cogl-docs.sgml: * cogl/version.xml.in * clutter/version.xml.in Add full version (including minor) to docs. Add version to COGL docs
2008-06-24 06:38:18 -04:00
Merged clutter-ivan branch into trunk. svn merge \ https://svn.o-hand.com/repos/clutter/trunk/clutter@2509 \ https://svn.o-hand.com/repos/clutter/branches/clutter-ivan@HEAD
2008-04-25 09:37:36 -04:00
<bookinfo>
[docs] Remove the version number from the title The version number in the title made sense when we were breaking API with every minor release. Now that we're API stable we can drop that and make the output in Devhelp and on the website slightly more good looking.
2009-08-13 11:15:04 -04:00
<title>COGL Reference Manual</title>
<releaseinfo>for COGL &version;</releaseinfo>
Merged clutter-ivan branch into trunk. svn merge \ https://svn.o-hand.com/repos/clutter/trunk/clutter@2509 \ https://svn.o-hand.com/repos/clutter/branches/clutter-ivan@HEAD
2008-04-25 09:37:36 -04:00
<copyright>
<year>2008</year>
<holder>OpenedHand LTD</holder>
</copyright>
[docs] Remove the version number from the title The version number in the title made sense when we were breaking API with every minor release. Now that we're API stable we can drop that and make the output in Devhelp and on the website slightly more good looking.
2009-08-13 11:15:04 -04:00
<copyright>
<year>2009</year>
docs: Add 2010 in COGL's Copyright notice While at it, fix the usage of <year> in <copyright> to let the stylesheet do the collation when having several years.
2010-02-08 14:18:36 -05:00
<year>2010</year>
[docs] Remove the version number from the title The version number in the title made sense when we were breaking API with every minor release. Now that we're API stable we can drop that and make the output in Devhelp and on the website slightly more good looking.
2009-08-13 11:15:04 -04:00
<holder>Intel Corporation</holder>
</copyright>
Merged clutter-ivan branch into trunk. svn merge \ https://svn.o-hand.com/repos/clutter/trunk/clutter@2509 \ https://svn.o-hand.com/repos/clutter/branches/clutter-ivan@HEAD
2008-04-25 09:37:36 -04:00
<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,
docs: fix new line in the cogl xml top level document A comma in the FSF address is wrong. Supreme Offence.
2010-01-27 11:03:28 -05:00
<city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>,
Merged clutter-ivan branch into trunk. svn merge \ https://svn.o-hand.com/repos/clutter/trunk/clutter@2509 \ https://svn.o-hand.com/repos/clutter/branches/clutter-ivan@HEAD
2008-04-25 09:37:36 -04:00
<country>USA</country>
</address>
</para>
</legalnotice>
</bookinfo>
<chapter>
<title>COGL - GL Abstraction API</title>
<section id="cogl-intro">
<title>About COGL</title>
2008-06-16 Matthew Allum <mallum@openedhand.com> * cogl/cogl-docs.sgml: Add an intro.
2008-06-16 12:31:08 -04:00
2008-07-01 Emmanuele Bassi <ebassi@openedhand.com> * cogl/cogl-docs.sgml: Add an index to the COGL API reference and the licensing information.
2008-07-01 06:15:07 -04:00
<para>COGL is a low level OpenGL abstraction library developed for (and
part of) Clutter. It is used primarily by Clutter to provide a common
rendering API that works transparently across OpenGL >=1.4,
OpenGL ES 1.1 and OpenGL ES 2.0.</para>
2008-06-16 Matthew Allum <mallum@openedhand.com> * cogl/cogl-docs.sgml: Add an intro.
2008-06-16 12:31:08 -04:00
Merged clutter-ivan branch into trunk. svn merge \ https://svn.o-hand.com/repos/clutter/trunk/clutter@2509 \ https://svn.o-hand.com/repos/clutter/branches/clutter-ivan@HEAD
2008-04-25 09:37:36 -04:00
</section>
<xi:include href="xml/cogl.xml"/>
[docs] Various gtk-doc updates for Cogl This hides a number of internal structs and enums from the docs, and moves some functions to more appropriate sections as well as misc description updates (mostly for the vertex buffer api)
2009-02-06 06:16:42 -05:00
<xi:include href="xml/cogl-color.xml"/>
Merged clutter-ivan branch into trunk. svn merge \ https://svn.o-hand.com/repos/clutter/trunk/clutter@2509 \ https://svn.o-hand.com/repos/clutter/branches/clutter-ivan@HEAD
2008-04-25 09:37:36 -04:00
<xi:include href="xml/cogl-texture.xml"/>
Add a Cogl texture 3D backend This adds a publicly exposed experimental API for a 3D texture backend. There is a feature flag which can be checked for whether 3D textures are supported. Although we require OpenGL 1.2 which has 3D textures in core, GLES only provides them through an extension so the feature can be used to detect that. The textures can be created with one of two new API functions :- cogl_texture_3d_new_with_size and cogl_texture_3d_new_from_data There is also internally a new_from_bitmap function. new_from_data is implemented in terms of this function. The two constructors are effectively the only way to upload data to a 3D texture. It does not work to call glTexImage2D with the GL_TEXTURE_3D target so the virtual for cogl_texture_set_region does nothing. It would be possible to make cogl_texture_get_data do something sensible like returning all of the images as a single long image but this is not currently implemented and instead the virtual just always fails. We may want to add API specific to the 3D texture backend to get and set a sub region of the texture. All of those three functions can throw a GError. This will happen if the GPU does not support 3D textures or it does not support NPOTs and an NPOT size is requested. It will also fail if the FBO extension is not supported and the COGL_TEXTURE_NO_AUTO_MIPMAP flag is not given. This could be avoided by copying the code for the GL_GENERATE_MIPMAP TexParameter fallback, but in the interests of keeping the code simple this is not yet done. This adds a couple of functions to cogl-texture-driver for uploading 3D data and querying the 3D proxy texture. prep_gl_for_pixels_upload_full now also takes sets the GL_UNPACK_IMAGE_HEIGHT parameter so that 3D textures can have padding between the images. Whenever 3D texture is uploading, both the height of the images and the height of all of the data is specified (either explicitly or implicilty from the CoglBitmap) so that the image height can be deduced by dividing by the depth.
2010-07-01 17:04:59 -04:00
<xi:include href="xml/cogl-texture-3d.xml"/>
[cogl-material] Support string based blending and layer combine descriptions Setting up layer combine functions and blend modes is very awkward to do programatically. This adds a parser for string based descriptions which are more consise and readable. E.g. a material layer combine function could now be given as: "RGBA = ADD (TEXTURE[A], PREVIOUS[RGB])" or "RGB = REPLACE (PREVIOUS)" "A = MODULATE (PREVIOUS, TEXTURE)" The simple syntax and grammar are only designed to expose standard fixed function hardware, more advanced combining must be done with shaders. This includes standalone documentation of blend strings covering the aspects that are common to blending and texture combining, and adds documentation with examples specific to the new cogl_material_set_blend() and cogl_material_layer_set_combine() functions. Note: The hope is to remove the now redundant bits of the material API before 1.0
2009-05-10 19:40:41 -04:00
<xi:include href="blend-strings.xml"/>
[doc] Hooks up cogl-material reference documentation Adds some more gtk-doc comments to cogl-material.h, and adds a new section to cogl-sections.txt
2008-12-22 11:19:49 -05:00
<xi:include href="xml/cogl-material.xml"/>
[docs] Various gtk-doc updates for Cogl This hides a number of internal structs and enums from the docs, and moves some functions to more appropriate sections as well as misc description updates (mostly for the vertex buffer api)
2009-02-06 06:16:42 -05:00
<xi:include href="xml/cogl-primitives.xml"/>
docs: Add a cogl-paths section The path primitives have a specific section, now, and gtk-doc is loudly complaining about it being defined but not referenced.
2010-07-02 12:48:19 -04:00
<xi:include href="xml/cogl-paths.xml"/>
docs: Add the "clipping" section to the COGL API reference All the clip-related API in COGL is missing from the API reference because the cogl-clipping section is not included inside the main index file.
2009-10-07 12:35:11 -04:00
<xi:include href="xml/cogl-clipping.xml"/>
[docs] Various gtk-doc updates for Cogl This hides a number of internal structs and enums from the docs, and moves some functions to more appropriate sections as well as misc description updates (mostly for the vertex buffer api)
2009-02-06 06:16:42 -05:00
<xi:include href="xml/cogl-vertex-buffer.xml"/>
<xi:include href="xml/cogl-matrix.xml"/>
Merged clutter-ivan branch into trunk. svn merge \ https://svn.o-hand.com/repos/clutter/trunk/clutter@2509 \ https://svn.o-hand.com/repos/clutter/branches/clutter-ivan@HEAD
2008-04-25 09:37:36 -04:00
<xi:include href="xml/cogl-shaders.xml"/>
<xi:include href="xml/cogl-offscreen.xml"/>
2008-10-30 Emmanuele Bassi <ebassi@linux.intel.com> Bug 1209 - Move fixed point API in COGL * clutter/cogl/cogl-fixed.h: * clutter/cogl/cogl.h.in: * clutter/cogl/common/Makefile.am: * clutter/cogl/common/cogl-fixed.c: Add fixed point API, modelled after the ClutterFixed. The CoglFixed API supercedes the ClutterFixed one and avoids the dependency of COGL on Clutter's own API. * clutter/cogl/common/cogl-clip-stack.c: * clutter/cogl/common/cogl-primitives.c: * clutter/cogl/common/cogl-primitives.h: Update internal usage of ClutterFixed to CoglFixed. * clutter/cogl/gl/Makefile.am: * clutter/cogl/gl/cogl-primitives.c: * clutter/cogl/gl/cogl-texture.c: * clutter/cogl/gl/cogl.c: Ditto, in the GL implementation of the COGL API. * clutter/cogl/gles/Makefile.am: * clutter/cogl/gles/cogl-fbo.c: * clutter/cogl/gles/cogl-gles2-wrapper.c: * clutter/cogl/gles/cogl-primitives.c: * clutter/cogl/gles/cogl-texture.c: * clutter/cogl/gles/cogl.c: Ditto, in the GLES implementation of the COGL API. * clutter/pango/pangoclutter-glyph-cache.c: * clutter/pango/pangoclutter-glyph-cache.h: Ditto, in the Pango renderer glyphs cache. * clutter/clutter-fixed.c: * clutter/clutter-fixed.h: ClutterFixed and related API becomes a simple transition API for bindings and public Clutter API. * clutter/clutter-actor.c: * clutter/clutter-alpha.c: * clutter/clutter-backend.c: * clutter/clutter-behaviour-depth.c: * clutter/clutter-behaviour-ellipse.c: * clutter/clutter-behaviour-path.c: * clutter/clutter-behaviour-rotate.c: * clutter/clutter-behaviour-scale.c: * clutter/clutter-clone-texture.c: * clutter/clutter-color.c: * clutter/clutter-entry.c: * clutter/clutter-stage.c: * clutter/clutter-texture.c: * clutter/clutter-timeline.c: * clutter/clutter-units.h: Move from the internal usage of ClutterFixed to CoglFixed. * doc/reference/clutter/clutter-sections.txt: * doc/reference/cogl/cogl-docs.sgml: * doc/reference/cogl/cogl-sections.txt: Update the documentation. * tests/test-cogl-tex-tile.c: * tests/test-project.c: Fix tests after the API change * README: Add release notes.
2008-10-30 12:37:55 -04:00
<xi:include href="xml/cogl-fixed.xml"/>
2008-07-01 Emmanuele Bassi <ebassi@openedhand.com> * cogl/cogl-docs.sgml: Add an index to the COGL API reference and the licensing information.
2008-07-01 06:15:07 -04:00
Merged clutter-ivan branch into trunk. svn merge \ https://svn.o-hand.com/repos/clutter/trunk/clutter@2509 \ https://svn.o-hand.com/repos/clutter/branches/clutter-ivan@HEAD
2008-04-25 09:37:36 -04:00
</chapter>
2008-07-01 Emmanuele Bassi <ebassi@openedhand.com> * cogl/cogl-docs.sgml: Add an index to the COGL API reference and the licensing information.
2008-07-01 06:15:07 -04:00
cogl-buffer: add an abstract class around openGL's buffer objects Buffer objects are cool! This abstracts the buffer API first introduced by GL_ARB_vertex_buffer_object and then extended to other objects. The coglBuffer abstract class is intended to be the base class of all the buffer objects, letting the user map() buffers. If the underlying implementation does not support buffer objects (or only support VBO but not FBO for instance), fallback paths should be provided.
2010-01-10 12:28:24 -05:00
<chapter>
<title>COGL experimental API</title>
<section id="cogl-experimental">
<title>About the experimental API</title>
<para>COGL has some experimental API developers are welcomed to play
with. The main drawback when using those is that there is no API
stability guarantee, functions flagged as experimental could be changed
or removed in future versions of the library. To use this experimental
API you will need to define
<literal>COGL_ENABLE_EXPERIMENTAL_API</literal> before including
<filename class="headerfile">&lt;clutter/clutter.h&gt;</filename> or
<filename class="headerfile">&lt;cogl/cogl.h&gt;</filename>.</para>
</section>
<xi:include href="xml/cogl-buffer.xml"/>
math: Adds an experimental cogl_vector3_* API This adds a math utility API for handling 3 component, single precision float vectors with the following; mostly self explanatory functions: cogl_vector3_init cogl_vector3_init_zero cogl_vector3_equal cogl_vector3_equal_with_epsilon cogl_vector3_copy cogl_vector3_free cogl_vector3_invert cogl_vector3_add cogl_vector3_subtract cogl_vector3_multiply_scalar cogl_vector3_divide_scalar cogl_vector3_normalize cogl_vector3_magnitude cogl_vector3_cross_product cogl_vector3_dot_product cogl_vector3_distance Since the API is experimental you will need to define COGL_ENABLE_EXPERIMENTAL_API before including cogl.h if you want to use the API.
2010-05-20 09:54:44 -04:00
<xi:include href="xml/cogl-vector.xml"/>
cogl-buffer: add an abstract class around openGL's buffer objects Buffer objects are cool! This abstracts the buffer API first introduced by GL_ARB_vertex_buffer_object and then extended to other objects. The coglBuffer abstract class is intended to be the base class of all the buffer objects, letting the user map() buffers. If the underlying implementation does not support buffer objects (or only support VBO but not FBO for instance), fallback paths should be provided.
2010-01-10 12:28:24 -05:00
</chapter>
docs: Add annotation glossary to the Cogl API reference It's the only way to let gtk-doc know that we're using annotations in the comments.
2010-09-03 11:52:06 -04:00
<chapter id="clutterglossary">
<title>Glossaries</title>
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
</chapter>
2008-07-01 Emmanuele Bassi <ebassi@openedhand.com> * cogl/cogl-docs.sgml: Add an index to the COGL API reference and the licensing information.
2008-07-01 06:15:07 -04:00
<index>
docs: Add indices to the Cogl API reference The Clutter API reference has an index of the symbols for each minor version, and a list of deprecated symbols. The Cogl API reference should have the same layout.
2009-11-19 09:30:01 -05:00
<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>
2008-07-01 Emmanuele Bassi <ebassi@openedhand.com> * cogl/cogl-docs.sgml: Add an index to the COGL API reference and the licensing information.
2008-07-01 06:15:07 -04:00
</index>
docs: Add 1.4 index to the API references Now that master has branched for the 1.3 development cycle.
2010-03-25 05:45:59 -04:00
<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>
2008-07-01 Emmanuele Bassi <ebassi@openedhand.com> * cogl/cogl-docs.sgml: Add an index to the COGL API reference and the licensing information.
2008-07-01 06:15:07 -04:00
<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>
Merged clutter-ivan branch into trunk. svn merge \ https://svn.o-hand.com/repos/clutter/trunk/clutter@2509 \ https://svn.o-hand.com/repos/clutter/branches/clutter-ivan@HEAD
2008-04-25 09:37:36 -04:00
</book>
Reference in New Issue Copy Permalink