doc/reference/cogl/cogl-docs.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
   4 <!ENTITY version "1.10.2">
   5 ]>
   6 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
   7
   8   <bookinfo>
   9     <title>Cogl Reference Manual</title>
  10     <releaseinfo>for Cogl &version;</releaseinfo>
  11
  12     <copyright>
  13       <year>2008</year>
  14       <holder>OpenedHand LTD</holder>
  15     </copyright>
  16
  17     <copyright>
  18       <year>2009</year>
  19       <year>2010</year>
  20       <holder>Intel Corporation</holder>
  21     </copyright>
  22
  23     <legalnotice>
  24       <para>
  25         Permission is granted to copy, distribute and/or modify this
  26         document under the terms of the <citetitle>GNU Free
  27         Documentation License</citetitle>, Version 1.1 or any later
  28         version published by the Free Software Foundation with no
  29         Invariant Sections, no Front-Cover Texts, and no Back-Cover
  30         Texts. You may obtain a copy of the <citetitle>GNU Free
  31         Documentation License</citetitle> from the Free Software
  32         Foundation by visiting <ulink type="http"
  33         url="http://www.fsf.org">their Web site</ulink> or by writing
  34         to:
  35
  36         <address>
  37           The Free Software Foundation, Inc.,
  38           <street>59 Temple Place</street> - Suite 330,
  39           <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>,
  40           <country>USA</country>
  41         </address>
  42       </para>
  43     </legalnotice>
  44
  45   </bookinfo>
  46
  47   <chapter>
  48     <title>Cogl - a modern 3D graphics API</title>
  49
  50     <section id="cogl-intro">
  51       <title>About Cogl</title>
  52
  53       <para>Cogl is a modern 3D graphics API with associated utility
  54       APIs designed to expose the features of 3D graphics hardware
  55       using a more object oriented design than OpenGL. The library has
  56       primarily been driven by the practical needs of Clutter but it
  57       is not tied to any one toolkit or even constrained to developing
  58       UI toolkits.</para>
  59
  60     </section>
  61
  62     <xi:include href="xml/cogl.xml"/>
  63     <xi:include href="xml/cogl-color.xml"/>
  64     <xi:include href="xml/cogl-texture.xml"/>
  65     <xi:include href="blend-strings.xml"/>
  66     <xi:include href="xml/cogl-material.xml"/>
  67     <xi:include href="xml/cogl-primitives.xml"/>
  68     <xi:include href="xml/cogl-paths.xml"/>
  69     <xi:include href="xml/cogl-clipping.xml"/>
  70     <xi:include href="xml/cogl-vertex-buffer.xml"/>
  71     <xi:include href="xml/cogl-matrix.xml"/>
  72     <xi:include href="xml/cogl-shaders.xml"/>
  73     <xi:include href="xml/cogl-offscreen.xml"/>
  74     <xi:include href="xml/cogl-bitmap.xml"/>
  75     <xi:include href="xml/cogl-fixed.xml"/>
  76     <xi:include href="xml/cogl-gtype.xml"/>
  77
  78   </chapter>
  79
  80   <chapter>
  81     <title>Cogl experimental API</title>
  82
  83     <section id="cogl-experimental">
  84       <title>About the experimental API</title>
  85
  86       <para>Cogl has some experimental API developers are welcomed to play
  87       with. The main drawback when using those is that there is no API
  88       stability guarantee, functions flagged as experimental could be changed
  89       or removed in future versions of the library. To use this experimental
  90       API you will need to define
  91       <literal>COGL_ENABLE_EXPERIMENTAL_API</literal> before including
  92       <filename class="headerfile">&lt;clutter/clutter.h&gt;</filename> or
  93       <filename class="headerfile">&lt;cogl/cogl.h&gt;</filename>.</para>
  94
  95     </section>
  96
  97     <xi:include href="xml/cogl-buffer.xml"/>
  98     <xi:include href="xml/cogl-vector.xml"/>
  99     <xi:include href="xml/cogl-texture-3d.xml"/>
 100     <xi:include href="xml/cogl-quaternion.xml"/>
 101
 102   </chapter>
 103
 104   <chapter>
 105     <title>Cogl deprecated API</title>
 106
 107     <section id="cogl-deprecated">
 108
 109       <title>About the deprecated API</title>
 110
 111       <para>Cogl has evolved from once being a thin abstraction over
 112       OpenGL and GLES where a lot of OpenGL's state machine style APIs
 113       were simply rebranded as Cogl API into the more distinguished API
 114       style we have today. The result of this evolution though is that
 115       some of the APIs are considered deprecated and because we plan to
 116       remove them at the next opportunity we have to break the API
 117       developers should aim to avoid these functions to keep their code
 118       working with future major versions of Cogl.</para>
 119
 120     </section>
 121
 122     <xi:include href="xml/cogl-deprecated.xml"/>
 123     <xi:include href="xml/cogl-texture-deprecated.xml"/>
 124     <xi:include href="xml/cogl-material-deprecated.xml"/>
 125     <xi:include href="xml/cogl-clipping-deprecated.xml"/>
 126     <xi:include href="xml/cogl-vertex-buffer-deprecated.xml"/>
 127     <xi:include href="xml/cogl-shaders-deprecated.xml"/>
 128     <xi:include href="xml/cogl-offscreen-deprecated.xml"/>
 129
 130   </chapter>
 131
 132   <chapter id="coglglossary">
 133     <title>Glossaries</title>
 134
 135     <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
 136   </chapter>
 137
 138   <index>
 139     <title>Index of all symbols</title>
 140     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
 141   </index>
 142
 143   <index role="deprecated">
 144     <title>Index of deprecated symbols</title>
 145     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
 146   </index>
 147
 148   <index role="0.8">
 149     <title>Index of new symbols in 0.8</title>
 150     <xi:include href="xml/api-index-0.8.xml"><xi:fallback /></xi:include>
 151   </index>
 152
 153   <index role="1.0">
 154     <title>Index of new symbols in 1.0</title>
 155     <xi:include href="xml/api-index-1.0.xml"><xi:fallback /></xi:include>
 156   </index>
 157
 158   <index role="1.2">
 159     <title>Index of new symbols in 1.2</title>
 160     <xi:include href="xml/api-index-1.2.xml"><xi:fallback /></xi:include>
 161   </index>
 162
 163   <index role="1.4">
 164     <title>Index of new symbols in 1.4</title>
 165     <xi:include href="xml/api-index-1.4.xml"><xi:fallback /></xi:include>
 166   </index>
 167
 168   <index role="1.6">
 169     <title>Index of new symbols in 1.6</title>
 170     <xi:include href="xml/api-index-1.6.xml"><xi:fallback /></xi:include>
 171   </index>
 172
 173   <index role="1.8">
 174     <title>Index of new symbols in 1.8</title>
 175     <xi:include href="xml/api-index-1.8.xml"><xi:fallback /></xi:include>
 176   </index>
 177
 178   <appendix id="license">
 179     <title>License</title>
 180
 181     <para>
 182       This library is free software; you can redistribute it and/or
 183       modify it under the terms of the <citetitle>GNU Library General
 184       Public License</citetitle> as published by the Free Software
 185       Foundation; either version 2 of the License, or (at your option)
 186       any later version.
 187     </para>
 188
 189     <para>
 190       This library is distributed in the hope that it will be useful,
 191       but WITHOUT ANY WARRANTY; without even the implied warranty of
 192       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 193       <citetitle>GNU Library General Public License</citetitle> for
 194       more details.
 195     </para>
 196
 197     <para>
 198       You may obtain a copy of the <citetitle>GNU Library General
 199       Public License</citetitle> from the Free Software Foundation by
 200       visiting <ulink type="http" url="http://www.fsf.org">their Web
 201       site</ulink> or by writing to:
 202
 203       <address>
 204         Free Software Foundation, Inc.
 205         <street>59 Temple Place</street> - Suite 330
 206         <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>
 207         <country>USA</country>
 208       </address>
 209     </para>
 210   </appendix>
 211
 212 </book>