mirror of
https://github.com/brl/mutter.git
synced 2024-12-23 19:42:05 +00:00
docs: Adds an initial cogl-2.0 reference manual
So we can keep track of the experimental progress of Cogl 2.0 features this adds a standalone Cogl 2.0 Reference Manual which doesn't cover the deprecated 1.x symbols and removes the need for a "Cogl experimental API" chapter since those sections now make up the main table of contents.
This commit is contained in:
Robert Bragg
parent
fb9d3a8350
commit
21c7403011
@ -1121,6 +1121,8 @@ AC_CONFIG_FILES([
|
||||
doc/reference/clutter/clutter-docs.xml
|
||||
doc/reference/cogl/Makefile
|
||||
doc/reference/cogl/cogl-docs.xml
|
||||
doc/reference/cogl-2.0/Makefile
|
||||
doc/reference/cogl-2.0/cogl-docs.xml
|
||||
doc/reference/cally/Makefile
|
||||
doc/reference/cally/cally-docs.xml
|
||||
doc/common/Makefile
|
||||
|
||||
@ -1 +1 @@
|
||||
SUBDIRS = cogl clutter cally
|
||||
SUBDIRS = cogl cogl-2.0 clutter cally
|
||||
|
||||
142
doc/reference/cogl-2.0/Makefile.am
Normal file
142
doc/reference/cogl-2.0/Makefile.am
Normal file
@ -0,0 +1,142 @@
|
||||
## Process this file with automake to produce Makefile.in
|
||||
|
||||
# We require automake 1.6 at least.
|
||||
AUTOMAKE_OPTIONS = 1.6
|
||||
|
||||
# This is a blank Makefile.am for using gtk-doc.
|
||||
# Copy this to your project's API docs directory and modify the variables to
|
||||
# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
|
||||
# of using the various options.
|
||||
|
||||
# The name of the module, e.g. 'glib'.
|
||||
DOC_MODULE=cogl
|
||||
|
||||
# The top-level SGML file. You can change this if you want to.
|
||||
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
|
||||
|
||||
# The directory containing the source code. Relative to $(srcdir).
|
||||
# gtk-doc will search all .c & .h files beneath here for inline comments
|
||||
# documenting the functions and macros.
|
||||
# e.g. DOC_SOURCE_DIR=../../../gtk
|
||||
DOC_SOURCE_DIR=../../../clutter/cogl/cogl
|
||||
|
||||
# Extra options to pass to gtkdoc-scangobj. Not normally needed.
|
||||
SCANGOBJ_OPTIONS=--type-init-func="g_type_init()"
|
||||
|
||||
# Extra options to supply to gtkdoc-scan.
|
||||
# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
|
||||
SCAN_OPTIONS=--deprecated-guards="COGL_DISABLE_DEPRECATED"
|
||||
|
||||
# Extra options to supply to gtkdoc-mkdb.
|
||||
# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
|
||||
MKDB_OPTIONS=--sgml-mode --output-format=xml --name-space=cogl
|
||||
|
||||
# Extra options to supply to gtkdoc-mktmpl
|
||||
# e.g. MKTMPL_OPTIONS=--only-section-tmpl
|
||||
MKTMPL_OPTIONS=
|
||||
|
||||
# Extra options to supply to gtkdoc-fixref. Not normally needed.
|
||||
# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
|
||||
FIXXREF_OPTIONS=\
|
||||
--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/glib \
|
||||
--extra-dir=$(GDPIXBUF_PREFIX)/share/gtk-doc/html/gdk-pixbuf
|
||||
|
||||
# Used for dependencies. The docs will be rebuilt if any of these change.
|
||||
# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
|
||||
# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
|
||||
HFILE_GLOB=\
|
||||
$(top_srcdir)/clutter/cogl/cogl/*.h \
|
||||
$(top_builddir)/clutter/cogl/cogl/*.h
|
||||
CFILE_GLOB=$(top_srcdir)/clutter/cogl/cogl/*.c
|
||||
|
||||
# Header files to ignore when scanning.
|
||||
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
|
||||
IGNORE_HFILES=\
|
||||
cogl-atlas.h \
|
||||
cogl-atlas-texture-private.h \
|
||||
cogl-bitmap-private.h \
|
||||
cogl-buffer-private.h \
|
||||
cogl-color-private.h \
|
||||
cogl-feature-private.h \
|
||||
cogl-framebuffer-private.h \
|
||||
cogl-journal-private.h \
|
||||
cogl-material-compat.h \
|
||||
cogl-material-arbfp-private.h \
|
||||
cogl-material-fixed-private.h \
|
||||
cogl-material-glsl-private.h \
|
||||
cogl-material-opengl-private.h \
|
||||
cogl-material-private.h \
|
||||
cogl-matrix-private.h \
|
||||
cogl-object-private.h \
|
||||
cogl-path.h \
|
||||
cogl-path-private.h \
|
||||
cogl-pixel-array-private.h \
|
||||
cogl-shader-private.h \
|
||||
cogl-sub-texture-private.h \
|
||||
cogl-texture-2d-private.h \
|
||||
cogl-texture-2d-sliced-private.h \
|
||||
cogl-texture-3d-private.h \
|
||||
cogl-texture-private.h \
|
||||
cogl-texture-rectangle-private.h \
|
||||
cogl-vertex-buffer.h \
|
||||
cogl-vertex-buffer-private.h \
|
||||
cogl-blend-string.h \
|
||||
cogl-clip-stack.h \
|
||||
cogl-context.h \
|
||||
cogl-debug.h \
|
||||
cogl-defines.h \
|
||||
cogl-deprecated.h \
|
||||
cogl-handle.h \
|
||||
cogl-internal.h \
|
||||
cogl-matrix-mesa.h \
|
||||
cogl-matrix-stack.h \
|
||||
cogl-spans.h \
|
||||
cogl-profile.h \
|
||||
cogl-util.h \
|
||||
driver \
|
||||
tesselator \
|
||||
winsys
|
||||
|
||||
EXTRA_HFILES=
|
||||
|
||||
# Images to copy into HTML directory.
|
||||
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
|
||||
HTML_IMAGES = \
|
||||
fill-rule-non-zero.png \
|
||||
fill-rule-even-odd.png \
|
||||
quad-indices-order.png \
|
||||
quad-indices-triangles.png \
|
||||
cogl_ortho.png
|
||||
|
||||
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
|
||||
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
|
||||
content_files = \
|
||||
blend-strings.xml
|
||||
|
||||
# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
|
||||
# These files must be listed here *and* in content_files
|
||||
# e.g. expand_content_files=running.sgml
|
||||
expand_content_files = \
|
||||
blend-strings.xml
|
||||
|
||||
# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
|
||||
# Only needed if you are using gtkdoc-scangobj to dynamically query widget
|
||||
# signals and properties.
|
||||
# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
|
||||
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
|
||||
|
||||
INCLUDES=-I$(top_srcdir) -I$(top_srcdir)/clutter -I$(top_srcdir)/clutter/cogl -I$(top_builddir)/clutter/cogl -DCOGL_ENABLE_EXPERIMENTAL_API $(CLUTTER_CFLAGS)
|
||||
GTKDOC_LIBS=$(top_builddir)/clutter/libclutter-@CLUTTER_WINSYS@-@CLUTTER_API_VERSION@.la $(CLUTTER_LIBS)
|
||||
|
||||
# This includes the standard gtk-doc make rules, copied by gtkdocize.
|
||||
include $(top_srcdir)/gtk-doc.make
|
||||
|
||||
# Other files to distribute
|
||||
# e.g. EXTRA_DIST += version.xml.in
|
||||
|
||||
EXTRA_DIST += \
|
||||
fill-rule-non-zero.png \
|
||||
fill-rule-even-odd.png \
|
||||
quad-indices-triangles.png \
|
||||
quad-indices-order.png \
|
||||
cogl_ortho.png
|
||||
129
doc/reference/cogl-2.0/blend-strings.xml
Normal file
129
doc/reference/cogl-2.0/blend-strings.xml
Normal file
@ -0,0 +1,129 @@
|
||||
<?xml version="1.0"?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
||||
<!ENTITY version SYSTEM "version.xml">
|
||||
]>
|
||||
|
||||
<refentry id="cogl-Blend-Strings">
|
||||
<refmeta>
|
||||
<refentrytitle role="top_of_page" id="cogl-Blend-Strings.top_of_page">Blend Strings</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>COGL Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>Blend Strings</refname>
|
||||
<refpurpose>A simple syntax and grammar for describing blending and texture
|
||||
combining functions.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 id="cogl-Blend-Strings.description" role="desc">
|
||||
<title>Cogl Blend Strings</title>
|
||||
<para>
|
||||
Describing GPU blending and texture combining states is rather awkward to do
|
||||
in a consise but also readable fashion. Cogl helps by supporting
|
||||
string based descriptions using a simple syntax.
|
||||
</para>
|
||||
|
||||
<section>
|
||||
<title>Some examples</title>
|
||||
|
||||
<para>Here is an example used for blending:</para>
|
||||
<programlisting>
|
||||
"RGBA = ADD (SRC_COLOR * (SRC_COLOR[A]), DST_COLOR * (1-SRC_COLOR[A]))"
|
||||
</programlisting>
|
||||
<para>In OpenGL terms this replaces glBlendFunc[Separate] and
|
||||
glBlendEquation[Separate]</para>
|
||||
<para>
|
||||
Actually in this case it's more verbose than the GL equivalent:
|
||||
</para>
|
||||
<programlisting>
|
||||
glBlendFunc (GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
|
||||
</programlisting>
|
||||
<para>
|
||||
But unless you are familiar with OpenGL or refer to its API documentation
|
||||
you wouldn't know that the default function used by OpenGL is GL_FUNC_ADD
|
||||
nor would you know that the above arguments determine what the source color
|
||||
and destination color will be multiplied by before being adding.
|
||||
</para>
|
||||
|
||||
<para>Here is an example used for texture combining:</para>
|
||||
<programlisting>
|
||||
"RGB = REPLACE (PREVIOUS)"
|
||||
"A = MODULATE (PREVIOUS, TEXTURE)"
|
||||
</programlisting>
|
||||
<para>
|
||||
In OpenGL terms this replaces glTexEnv, and the above example is equivalent
|
||||
to this OpenGL code:
|
||||
</para>
|
||||
<programlisting>
|
||||
glTexEnvi (GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_COMBINE);
|
||||
glTexEnvi (GL_TEXTURE_ENV, GL_COMBINE_RGB, GL_REPLACE);
|
||||
glTexEnvi (GL_TEXTURE_ENV, GL_SRC0_RGB, GL_PREVIOUS);
|
||||
glTexEnvi (GL_TEXTURE_ENV, GL_OPERAND0_RGB, GL_SRC_COLOR);
|
||||
glTexEnvi (GL_TEXTURE_ENV, GL_COMBINE_ALPHA, GL_MODULATE);
|
||||
glTexEnvi (GL_TEXTURE_ENV, GL_SRC0_ALPHA, GL_PREVIOUS);
|
||||
glTexEnvi (GL_TEXTURE_ENV, GL_OPERAND0_ALPHA, GL_SRC_COLOR);
|
||||
glTexEnvi (GL_TEXTURE_ENV, GL_SRC1_ALPHA, GL_TEXTURE);
|
||||
glTexEnvi (GL_TEXTURE_ENV, GL_OPERAND1_ALPHA, GL_SRC_COLOR);
|
||||
</programlisting>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="cogl-Blend-String-syntax">
|
||||
<title>Here's the syntax</title>
|
||||
|
||||
<programlisting>
|
||||
<statement>:
|
||||
<channel-mask>=<function-name>(<arg-list>)
|
||||
|
||||
You can either use a single statement with an RGBA channel-mask or you can use
|
||||
two statements; one with an A channel-mask and the other with an RGB
|
||||
channel-mask.
|
||||
|
||||
<channel-mask>:
|
||||
A or RGB or RGBA
|
||||
|
||||
<function-name>:
|
||||
[A-Za-z_]*
|
||||
|
||||
<arg-list>:
|
||||
<arg>,<arg>
|
||||
or <arg>
|
||||
or ""
|
||||
|
||||
I.e. functions may take 0 or more arguments
|
||||
|
||||
<arg>:
|
||||
<color-source>
|
||||
1 - <color-source> : Only intended for texture combining
|
||||
<color-source> * ( <factor> ) : Only intended for blending
|
||||
0 : Only intended for blending
|
||||
|
||||
See the blending or texture combining sections for further notes and examples.
|
||||
|
||||
<color-source>:
|
||||
<source-name>[<channel-mask>]
|
||||
<source-name>
|
||||
|
||||
See the blending or texture combining sections for the list of source-names
|
||||
valid in each context.
|
||||
|
||||
If a channel mask is not given then the channel mask of the statement
|
||||
is assumed instead.
|
||||
|
||||
<factor>:
|
||||
0
|
||||
1
|
||||
<color-source>
|
||||
1-<color-source>
|
||||
SRC_ALPHA_SATURATE
|
||||
</programlisting>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
</refentry>
|
||||
188
doc/reference/cogl-2.0/cogl-docs.xml.in
Normal file
188
doc/reference/cogl-2.0/cogl-docs.xml.in
Normal file
@ -0,0 +1,188 @@
|
||||
<?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>
|
||||
<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"/>
|
||||
|
||||
<section id="cogl-buffer-apis">
|
||||
<title>Setting Up A GPU Pipeline</title>
|
||||
<xi:include href="blend-strings.xml"/>
|
||||
<xi:include href="xml/cogl-pipeline.xml"/>
|
||||
</section>
|
||||
|
||||
<section id="cogl-buffer-apis">
|
||||
<title>Allocating GPU Memory</title>
|
||||
<xi:include href="xml/cogl-buffer.xml"/>
|
||||
<xi:include href="xml/cogl-vertex-array.xml"/>
|
||||
<xi:include href="xml/cogl-index-array.xml"/>
|
||||
</section>
|
||||
|
||||
<section id="cogl-buffer-layout-apis">
|
||||
<title>Describing the layout of GPU Memory</title>
|
||||
<xi:include href="xml/cogl-vertex-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"/>
|
||||
<xi:include href="xml/cogl-texture-3d.xml"/>
|
||||
</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"/>
|
||||
<xi:include href="xml/cogl-types.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>
|
||||
480
doc/reference/cogl-2.0/cogl-sections.txt
Normal file
480
doc/reference/cogl-2.0/cogl-sections.txt
Normal file
@ -0,0 +1,480 @@
|
||||
|
||||
<SECTION>
|
||||
<FILE>cogl-object</FILE>
|
||||
<TITLE>The Base Object</TITLE>
|
||||
CoglObject
|
||||
cogl_object_ref
|
||||
cogl_object_unref
|
||||
CoglUserDataKey
|
||||
cogl_object_get_user_data
|
||||
cogl_object_set_user_data
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>cogl-context</FILE>
|
||||
<TITLE>The Top-Level Context</TITLE>
|
||||
|
||||
<SUBSECTION>
|
||||
CoglFeatureFlags
|
||||
cogl_get_features
|
||||
cogl_features_available
|
||||
cogl_get_proc_address
|
||||
cogl_get_option_group
|
||||
|
||||
<SUBSECTION>
|
||||
cogl_push_matrix
|
||||
cogl_pop_matrix
|
||||
cogl_scale
|
||||
cogl_translate
|
||||
cogl_rotate
|
||||
cogl_transform
|
||||
cogl_frustum
|
||||
cogl_perspective
|
||||
cogl_ortho
|
||||
|
||||
<SUBSECTION>
|
||||
cogl_get_modelview_matrix
|
||||
cogl_set_modelview_matrix
|
||||
cogl_get_projection_matrix
|
||||
cogl_set_projection_matrix
|
||||
cogl_set_viewport
|
||||
cogl_get_viewport
|
||||
|
||||
<SUBSECTION>
|
||||
cogl_clear
|
||||
cogl_set_backface_culling_enabled
|
||||
cogl_get_backface_culling_enabled
|
||||
|
||||
<SUBSECTION>
|
||||
cogl_set_source
|
||||
cogl_set_source_color
|
||||
cogl_set_source_color4ub
|
||||
cogl_set_source_color4f
|
||||
cogl_set_source_texture
|
||||
cogl_get_source
|
||||
cogl_push_source
|
||||
cogl_pop_source
|
||||
|
||||
<SUBSECTION>
|
||||
CoglReadPixelsFlags
|
||||
cogl_read_pixels
|
||||
|
||||
<SUBSECTION>
|
||||
cogl_flush
|
||||
cogl_begin_gl
|
||||
cogl_end_gl
|
||||
|
||||
<SUBSECTION Standard>
|
||||
COGL_TYPE_ATTRIBUTE_TYPE
|
||||
COGL_TYPE_BLEND_STRING_ERROR
|
||||
COGL_TYPE_BUFFER_ACCESS
|
||||
COGL_TYPE_BUFFER_BIT
|
||||
COGL_TYPE_BUFFER_TARGET
|
||||
COGL_TYPE_BUFFER_UPDATE_HINT
|
||||
COGL_TYPE_BUFFER_USAGE_HINT
|
||||
COGL_TYPE_DEBUG_FLAGS
|
||||
COGL_TYPE_DRIVER_ERROR
|
||||
COGL_TYPE_FEATURE_FLAGS
|
||||
COGL_TYPE_INDICES_TYPE
|
||||
COGL_TYPE_PIXEL_FORMAT
|
||||
COGL_TYPE_READ_PIXELS_FLAGS
|
||||
COGL_TYPE_TEXTURE_FLAGS
|
||||
COGL_TYPE_VERTICES_MODE
|
||||
|
||||
<SUBSECTION Private>
|
||||
COGL_DRIVER_ERROR
|
||||
CoglDriverError
|
||||
cogl_attribute_type_get_type
|
||||
cogl_buffer_bit_get_type
|
||||
cogl_buffer_target_get_type
|
||||
cogl_debug_flags_get_type
|
||||
cogl_driver_error_get_type
|
||||
cogl_feature_flags_get_type
|
||||
cogl_fixed_get_type
|
||||
cogl_fog_mode_get_type
|
||||
cogl_indices_type_get_type
|
||||
cogl_pixel_format_get_type
|
||||
cogl_read_pixels_flags_get_type
|
||||
cogl_shader_type_get_type
|
||||
cogl_texture_flags_get_type
|
||||
cogl_vertices_mode_get_type
|
||||
COGL_AFIRST_BIT
|
||||
COGL_A_BIT
|
||||
COGL_BGR_BIT
|
||||
COGL_PIXEL_FORMAT_24
|
||||
COGL_PIXEL_FORMAT_32
|
||||
COGL_PREMULT_BIT
|
||||
COGL_UNORDERED_MASK
|
||||
COGL_UNPREMULT_MASK
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>cogl-clipping</FILE>
|
||||
<TITLE>Clipping</TITLE>
|
||||
cogl_clip_push_rectangle
|
||||
cogl_clip_push_window_rectangle
|
||||
cogl_clip_push_from_path
|
||||
cogl_clip_push_from_path_preserve
|
||||
cogl_clip_pop
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>cogl-vertex-array</FILE>
|
||||
<TITLE>Vertex Arrays</TITLE>
|
||||
cogl_vertex_array_new
|
||||
cogl_is_vertex_array
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>cogl-index-array</FILE>
|
||||
<TITLE>Index Arrays</TITLE>
|
||||
cogl_index_array_new
|
||||
cogl_is_index_array
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>cogl-vertex-attribute</FILE>
|
||||
<TITLE>Vertex Attributes</TITLE>
|
||||
cogl_vertex_attribute_new
|
||||
cogl_is_vertex_attribute
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>cogl-indices</FILE>
|
||||
<TITLE>Indices</TITLE>
|
||||
cogl_indices_new
|
||||
cogl_is_indices
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>cogl-primitive</FILE>
|
||||
<TITLE>Primitives</TITLE>
|
||||
cogl_primitive_new
|
||||
cogl_primitive_new_with_attributes_array
|
||||
cogl_primitive_new_with_p3_attributes
|
||||
cogl_primitive_new_with_p2c4_attributes
|
||||
cogl_primitive_new_with_p3c4_attributes
|
||||
cogl_primitive_new_with_p2t2_attributes
|
||||
cogl_primitive_new_with_p3t2_attributes
|
||||
cogl_primitive_new_with_p2t2c4_attributes
|
||||
cogl_primitive_new_with_p3t2c4_attributes
|
||||
cogl_is_primitive
|
||||
cogl_primitive_get_first_vertex
|
||||
cogl_primitive_set_first_vertex
|
||||
cogl_primitive_get_n_vertices
|
||||
cogl_primitive_set_n_vertices
|
||||
cogl_primitive_get_mode
|
||||
cogl_primitive_set_mode
|
||||
cogl_primitive_set_attributes
|
||||
cogl_primitive_set_indices
|
||||
cogl_primitive_draw
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>cogl-rectangle</FILE>
|
||||
<TITLE>Rectangles</TITLE>
|
||||
cogl_rectangle
|
||||
cogl_rectangles
|
||||
cogl_rectangle_with_texture_coords
|
||||
cogl_rectangles_with_texture_coords
|
||||
cogl_rectangle_with_multitexture_coords
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>cogl-primitives-deprecated</FILE>
|
||||
<TITLE>Primitives (Deprecated)</TITLE>
|
||||
cogl_polygon
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>cogl-paths</FILE>
|
||||
<TITLE>Path Primitives</TITLE>
|
||||
cogl_is_path
|
||||
cogl_path_new
|
||||
cogl_path_copy
|
||||
cogl_path_move_to
|
||||
cogl_path_close
|
||||
cogl_path_line_to
|
||||
cogl_path_curve_to
|
||||
cogl_path_arc
|
||||
cogl_path_rel_move_to
|
||||
cogl_path_rel_line_to
|
||||
cogl_path_rel_curve_to
|
||||
cogl_path_line
|
||||
cogl_path_polyline
|
||||
cogl_path_polygon
|
||||
cogl_path_rectangle
|
||||
cogl_path_round_rectangle
|
||||
cogl_path_ellipse
|
||||
|
||||
<SUBSECTION>
|
||||
CoglPathFillRule
|
||||
cogl_path_set_fill_rule
|
||||
cogl_path_get_fill_rule
|
||||
cogl_path_fill
|
||||
cogl_path_stroke
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>cogl-drawing</FILE>
|
||||
<TITLE>Draw Vertex Attributes</TITLE>
|
||||
cogl_draw_vertex_attributes
|
||||
cogl_draw_vertex_attributes_array
|
||||
cogl_draw_indexed_vertex_attributes
|
||||
cogl_draw_indexed_vertex_attributes_array
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>cogl-bitmap</FILE>
|
||||
<TITLE>Bitmaps</TITLE>
|
||||
cogl_bitmap_new_from_file
|
||||
cogl_bitmap_get_size_from_file
|
||||
cogl_is_bitmap
|
||||
CoglBitmapError
|
||||
COGL_BITMAP_ERROR
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>cogl-texture</FILE>
|
||||
<TITLE>The Base Texture</TITLE>
|
||||
CoglTextureVertex
|
||||
CoglTextureFlags
|
||||
cogl_texture_new_with_size
|
||||
cogl_texture_new_from_file
|
||||
cogl_texture_new_from_data
|
||||
cogl_texture_new_from_foreign
|
||||
cogl_texture_new_from_bitmap
|
||||
cogl_texture_new_from_sub_texture
|
||||
cogl_is_texture
|
||||
|
||||
<SUBSECTION>
|
||||
cogl_texture_get_width
|
||||
cogl_texture_get_height
|
||||
cogl_texture_get_format
|
||||
cogl_texture_get_rowstride
|
||||
cogl_texture_get_max_waste
|
||||
cogl_texture_is_sliced
|
||||
cogl_texture_get_gl_texture
|
||||
cogl_texture_get_data
|
||||
cogl_texture_set_region
|
||||
|
||||
<SUBSECTION Private>
|
||||
COGL_TEXTURE_MAX_WASTE
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>cogl-texture-3d</FILE>
|
||||
<TITLE>3D textures</TITLE>
|
||||
cogl_texture_3d_new_with_size
|
||||
cogl_texture_3d_new_from_data
|
||||
cogl_is_texture_3d
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>cogl-framebuffer</FILE>
|
||||
<TITLE>CoglFramebuffer: The Base Framebuffer Type</TITLE>
|
||||
cogl_set_framebuffer
|
||||
cogl_push_framebuffer
|
||||
cogl_pop_framebuffer
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>cogl-offscreen</FILE>
|
||||
<TITLE>Offscreen Framebuffers</TITLE>
|
||||
cogl_offscreen_new_to_texture
|
||||
cogl_is_offscreen
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>cogl-color</FILE>
|
||||
<TITLE>Color Type</TITLE>
|
||||
CoglColor
|
||||
cogl_color_new
|
||||
cogl_color_copy
|
||||
cogl_color_free
|
||||
cogl_color_set_from_4ub
|
||||
cogl_color_set_from_4f
|
||||
|
||||
<SUBSECTION>
|
||||
cogl_color_get_red
|
||||
cogl_color_get_green
|
||||
cogl_color_get_blue
|
||||
cogl_color_get_alpha
|
||||
|
||||
<SUBSECTION>
|
||||
cogl_color_get_red_byte
|
||||
cogl_color_get_green_byte
|
||||
cogl_color_get_blue_byte
|
||||
cogl_color_get_alpha_byte
|
||||
|
||||
<SUBSECTION>
|
||||
cogl_color_get_red_float
|
||||
cogl_color_get_green_float
|
||||
cogl_color_get_blue_float
|
||||
cogl_color_get_alpha_float
|
||||
|
||||
<SUBSECTION>
|
||||
cogl_color_set_red
|
||||
cogl_color_set_green
|
||||
cogl_color_set_blue
|
||||
cogl_color_set_alpha
|
||||
|
||||
<SUBSECTION>
|
||||
cogl_color_set_red_byte
|
||||
cogl_color_set_green_byte
|
||||
cogl_color_set_blue_byte
|
||||
cogl_color_set_alpha_byte
|
||||
|
||||
<SUBSECTION>
|
||||
cogl_color_set_red_float
|
||||
cogl_color_set_green_float
|
||||
cogl_color_set_blue_float
|
||||
cogl_color_set_alpha_float
|
||||
|
||||
<SUBSECTION>
|
||||
cogl_color_premultiply
|
||||
cogl_color_unpremultiply
|
||||
cogl_color_equal
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>cogl-matrix</FILE>
|
||||
<TITLE>Matrices</TITLE>
|
||||
CoglMatrix
|
||||
cogl_matrix_init_identity
|
||||
cogl_matrix_frustum
|
||||
cogl_matrix_ortho
|
||||
cogl_matrix_perspective
|
||||
cogl_matrix_transform_point
|
||||
cogl_matrix_multiply
|
||||
cogl_matrix_rotate
|
||||
cogl_matrix_translate
|
||||
cogl_matrix_scale
|
||||
cogl_matrix_init_from_array
|
||||
cogl_matrix_get_array
|
||||
cogl_matrix_get_inverse
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>cogl-pipeline</FILE>
|
||||
<TITLE>Pipeline</TITLE>
|
||||
cogl_pipeline_new
|
||||
cogl_pipeline_copy
|
||||
cogl_is_pipeline
|
||||
|
||||
cogl_pipeline_set_color
|
||||
cogl_pipeline_set_color4ub
|
||||
cogl_pipeline_set_color4f
|
||||
cogl_pipeline_get_color
|
||||
|
||||
cogl_pipeline_set_ambient
|
||||
cogl_pipeline_get_ambient
|
||||
cogl_pipeline_set_diffuse
|
||||
cogl_pipeline_get_diffuse
|
||||
cogl_pipeline_set_ambient_and_diffuse
|
||||
cogl_pipeline_set_emission
|
||||
cogl_pipeline_get_emission
|
||||
cogl_pipeline_set_specular
|
||||
cogl_pipeline_get_specular
|
||||
cogl_pipeline_set_shininess
|
||||
cogl_pipeline_get_shininess
|
||||
|
||||
CoglMaterialAlphaFunc
|
||||
cogl_pipeline_set_alpha_test_function
|
||||
|
||||
COGL_BLEND_STRING_ERROR
|
||||
CoglBlendStringError
|
||||
cogl_pipeline_set_blend
|
||||
cogl_pipeline_set_blend_constant
|
||||
cogl_pipeline_set_point_size
|
||||
cogl_pipeline_get_point_size
|
||||
|
||||
cogl_pipeline_set_layer_texture
|
||||
cogl_pipeline_get_layer_texture
|
||||
CoglMaterialFilter
|
||||
cogl_pipeline_set_layer_filters
|
||||
cogl_pipeline_get_layer_min_filter
|
||||
cogl_pipeline_get_layer_mag_filter
|
||||
CoglMaterialWrapMode
|
||||
cogl_pipeline_set_layer_wrap_mode
|
||||
cogl_pipeline_set_layer_wrap_mode_s
|
||||
cogl_pipeline_set_layer_wrap_mode_t
|
||||
cogl_pipeline_set_layer_wrap_mode_p
|
||||
cogl_pipeline_set_layer_combine
|
||||
cogl_pipeline_set_layer_combine_constant
|
||||
cogl_pipeline_set_layer_matrix
|
||||
cogl_pipeline_set_layer_point_sprite_coords_enabled
|
||||
cogl_pipeline_get_layer_point_sprite_coords_enabled
|
||||
|
||||
cogl_pipeline_remove_layer
|
||||
|
||||
cogl_pipeline_get_n_layers
|
||||
cogl_pipeline_foreach_layer
|
||||
|
||||
<SUBSECTION Private>
|
||||
cogl_blend_string_error_get_type
|
||||
cogl_blend_string_error_quark
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>cogl-buffer</FILE>
|
||||
<TITLE>CoglBuffer: The Base Buffer Type</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
|
||||
|
||||
<SUBSECTION>
|
||||
cogl_pixel_buffer_new
|
||||
cogl_pixel_buffer_new_for_size
|
||||
cogl_is_pixel_buffer
|
||||
|
||||
<SUBSECTION>
|
||||
cogl_texture_new_from_buffer
|
||||
|
||||
<SUBSECTION Private>
|
||||
cogl_buffer_access_get_type
|
||||
cogl_buffer_update_hint_get_type
|
||||
cogl_buffer_usage_hint_get_type
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>cogl-vector</FILE>
|
||||
<TITLE>3 Component Vectors</TITLE>
|
||||
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
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>cogl-types</FILE>
|
||||
<TITLE>Common Types</TITLE>
|
||||
CoglFuncPtr
|
||||
CoglPixelFormat
|
||||
CoglBufferTarget
|
||||
CoglBufferBit
|
||||
CoglAttributeType
|
||||
</SECTION>
|
||||
|
||||
|
||||
BIN
doc/reference/cogl-2.0/cogl_ortho.png
Normal file
BIN
doc/reference/cogl-2.0/cogl_ortho.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
BIN
doc/reference/cogl-2.0/fill-rule-even-odd.png
Normal file
BIN
doc/reference/cogl-2.0/fill-rule-even-odd.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.0 KiB |
BIN
doc/reference/cogl-2.0/fill-rule-non-zero.png
Normal file
BIN
doc/reference/cogl-2.0/fill-rule-non-zero.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.1 KiB |
BIN
doc/reference/cogl-2.0/quad-indices-order.png
Normal file
BIN
doc/reference/cogl-2.0/quad-indices-order.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.6 KiB |
BIN
doc/reference/cogl-2.0/quad-indices-triangles.png
Normal file
BIN
doc/reference/cogl-2.0/quad-indices-triangles.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 7.8 KiB |
Loading…
Reference in New Issue
Block a user