diff options
| author | Damien Lespiau <damien.lespiau@intel.com> | 2010-01-10 17:28:24 +0000 |
|---|---|---|
| committer | Damien Lespiau <damien.lespiau@intel.com> | 2010-02-08 17:14:49 +0000 |
| commit | 40b73a8c0c295400a0e4fd8402ec1a170db9a66a (patch) | |
| tree | dc1ed3c853986367e727c68b5d47a4d924ecba07 /doc | |
| parent | dbef77cd8bfad02a5f2cf4b9c7343e42e584de6a (diff) | |
| download | cogl-40b73a8c0c295400a0e4fd8402ec1a170db9a66a.tar.gz | |
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.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/reference/cogl/cogl-docs.xml.in | 21 | ||||
| -rw-r--r-- | doc/reference/cogl/cogl-sections.txt | 17 |
2 files changed, 38 insertions, 0 deletions
diff --git a/doc/reference/cogl/cogl-docs.xml.in b/doc/reference/cogl/cogl-docs.xml.in index 35b6dd8e..fd47d4a6 100644 --- a/doc/reference/cogl/cogl-docs.xml.in +++ b/doc/reference/cogl/cogl-docs.xml.in @@ -71,6 +71,27 @@ </chapter> + <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"><clutter/clutter.h></filename> or + <filename class="headerfile"><cogl/cogl.h></filename>.</para> + + </section> + + <xi:include href="xml/cogl-buffer.xml"/> + + </chapter> + <index> <title>Index of all symbols</title> <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include> diff --git a/doc/reference/cogl/cogl-sections.txt b/doc/reference/cogl/cogl-sections.txt index eda10b46..4334bd2c 100644 --- a/doc/reference/cogl/cogl-sections.txt +++ b/doc/reference/cogl/cogl-sections.txt @@ -472,3 +472,20 @@ CoglMaterialLayerType cogl_material_layer_get_type cogl_material_layer_get_texture </SECTION> + +<SECTION> +<FILE>cogl-buffer</FILE> +<TITLE>Buffers</TITLE> +cogl_is_buffer +cogl_buffer_get_size +CoglBufferUsageHint +cogl_buffer_set_usage_hint +cogl_buffer_get_usage_hint +CoglBufferUpdateHint +cogl_buffer_set_update_hint +cogl_buffer_get_update_hint +CoglBufferAccess +cogl_buffer_map +cogl_buffer_unmap +cogl_buffer_set_data +</SECTION> |