configure: get rid of docs
@ -18,7 +18,7 @@ if BUILD_COGL_GST
|
|||||||
SUBDIRS += cogl-gst
|
SUBDIRS += cogl-gst
|
||||||
endif
|
endif
|
||||||
|
|
||||||
SUBDIRS += tests examples doc po
|
SUBDIRS += tests examples po
|
||||||
|
|
||||||
ACLOCAL_AMFLAGS = -I build/autotools ${ACLOCAL_FLAGS}
|
ACLOCAL_AMFLAGS = -I build/autotools ${ACLOCAL_FLAGS}
|
||||||
|
|
||||||
@ -31,7 +31,6 @@ CLEANFILES=
|
|||||||
DISTCLEANFILES=
|
DISTCLEANFILES=
|
||||||
|
|
||||||
DISTCHECK_CONFIGURE_FLAGS = \
|
DISTCHECK_CONFIGURE_FLAGS = \
|
||||||
--enable-gtk-doc \
|
|
||||||
--enable-maintainer-flags \
|
--enable-maintainer-flags \
|
||||||
--enable-profile \
|
--enable-profile \
|
||||||
--enable-gles2 \
|
--enable-gles2 \
|
||||||
|
10
autogen.sh
@ -34,12 +34,6 @@ if test -z "$AUTOMAKE"; then
|
|||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
(gtkdocize --version) < /dev/null > /dev/null 2>&1 || {
|
|
||||||
echo "You don't have gtk-doc installed to compile $PROJECT, and thus"
|
|
||||||
echo "won't be able to generate the $PROJECT documentation."
|
|
||||||
NOGTKDOC=1
|
|
||||||
}
|
|
||||||
|
|
||||||
# NOCONFIGURE is used by gnome-common
|
# NOCONFIGURE is used by gnome-common
|
||||||
if test -z "$NOCONFIGURE"; then
|
if test -z "$NOCONFIGURE"; then
|
||||||
if test -z "$*"; then
|
if test -z "$*"; then
|
||||||
@ -66,10 +60,6 @@ fi
|
|||||||
|
|
||||||
rm -rf autom4te.cache
|
rm -rf autom4te.cache
|
||||||
|
|
||||||
if test -z "$NOGTKDOC"; then
|
|
||||||
gtkdocize || exit $?
|
|
||||||
fi
|
|
||||||
|
|
||||||
autoreconf -vfi || exit $?
|
autoreconf -vfi || exit $?
|
||||||
cd $ORIGDIR || exit $?
|
cd $ORIGDIR || exit $?
|
||||||
|
|
||||||
|
18
configure.ac
@ -90,7 +90,6 @@ m4_define([pangocairo_req_version], [1.20])
|
|||||||
m4_define([gi_req_version], [0.9.5])
|
m4_define([gi_req_version], [0.9.5])
|
||||||
m4_define([gdk_pixbuf_req_version], [2.0])
|
m4_define([gdk_pixbuf_req_version], [2.0])
|
||||||
m4_define([uprof_req_version], [0.3])
|
m4_define([uprof_req_version], [0.3])
|
||||||
m4_define([gtk_doc_req_version], [1.13])
|
|
||||||
m4_define([xfixes_req_version], [3])
|
m4_define([xfixes_req_version], [3])
|
||||||
m4_define([xcomposite_req_version], [0.4])
|
m4_define([xcomposite_req_version], [0.4])
|
||||||
m4_define([xrandr_req_version], [1.2])
|
m4_define([xrandr_req_version], [1.2])
|
||||||
@ -105,7 +104,6 @@ AC_SUBST([CAIRO_REQ_VERSION], [cairo_req_version])
|
|||||||
AC_SUBST([PANGOCAIRO_REQ_VERSION], [pangocairo_req_version])
|
AC_SUBST([PANGOCAIRO_REQ_VERSION], [pangocairo_req_version])
|
||||||
AC_SUBST([XCOMPOSITE_REQ_VERSION], [xcomposite_req_version])
|
AC_SUBST([XCOMPOSITE_REQ_VERSION], [xcomposite_req_version])
|
||||||
AC_SUBST([XFIXES_REQ_VERSION], [xfixes_req_version])
|
AC_SUBST([XFIXES_REQ_VERSION], [xfixes_req_version])
|
||||||
AC_SUBST([GTK_DOC_REQ_VERSION], [gtk_doc_req_version])
|
|
||||||
AC_SUBST([GI_REQ_VERSION], [gi_req_version])
|
AC_SUBST([GI_REQ_VERSION], [gi_req_version])
|
||||||
AC_SUBST([UPROF_REQ_VERSION], [uprof_req_version])
|
AC_SUBST([UPROF_REQ_VERSION], [uprof_req_version])
|
||||||
AC_SUBST([WAYLAND_SERVER_REQ_VERSION], [wayland_server_req_version])
|
AC_SUBST([WAYLAND_SERVER_REQ_VERSION], [wayland_server_req_version])
|
||||||
@ -974,13 +972,6 @@ AM_CONDITIONAL(SUPPORT_XLIB, [test "x$SUPPORT_XLIB" = "xyes"])
|
|||||||
dnl ================================================================
|
dnl ================================================================
|
||||||
dnl Documentation stuff.
|
dnl Documentation stuff.
|
||||||
dnl ================================================================
|
dnl ================================================================
|
||||||
# gtkdocize greps for ^GTK_DOC_CHECK and parses it, so you need to have
|
|
||||||
# it on it's own line.
|
|
||||||
m4_ifdef([GTK_DOC_CHECK], [
|
|
||||||
GTK_DOC_CHECK([gtk_doc_req_version], [--flavour no-tmpl])
|
|
||||||
])
|
|
||||||
AM_CONDITIONAL([BUILD_GTK_DOC], [test "x$enable_gtk_doc" = "xyes"])
|
|
||||||
|
|
||||||
GLIB_PREFIX="`$PKG_CONFIG --variable=prefix glib-2.0`"
|
GLIB_PREFIX="`$PKG_CONFIG --variable=prefix glib-2.0`"
|
||||||
GDKPIXBUF_PREFIX="`$PKG_CONFIG --variable=prefix gdk-pixbuf-2.0`"
|
GDKPIXBUF_PREFIX="`$PKG_CONFIG --variable=prefix gdk-pixbuf-2.0`"
|
||||||
AC_SUBST(GLIB_PREFIX)
|
AC_SUBST(GLIB_PREFIX)
|
||||||
@ -1197,14 +1188,6 @@ cogl-gst/cogl-gst-2.0-experimental.pc
|
|||||||
cogl-gles2/Makefile
|
cogl-gles2/Makefile
|
||||||
cogl-gles2/cogl-gles2-1.0.pc
|
cogl-gles2/cogl-gles2-1.0.pc
|
||||||
cogl-gles2/cogl-gles2-2.0-experimental.pc
|
cogl-gles2/cogl-gles2-2.0-experimental.pc
|
||||||
doc/Makefile
|
|
||||||
doc/reference/Makefile
|
|
||||||
doc/reference/cogl/Makefile
|
|
||||||
doc/reference/cogl/cogl-docs.xml
|
|
||||||
doc/reference/cogl-2.0-experimental/Makefile
|
|
||||||
doc/reference/cogl-2.0-experimental/cogl-2.0-experimental-docs.xml
|
|
||||||
doc/reference/cogl-gst/Makefile
|
|
||||||
doc/reference/cogl-gst/cogl-gst-docs.xml
|
|
||||||
examples/Makefile
|
examples/Makefile
|
||||||
tests/Makefile
|
tests/Makefile
|
||||||
tests/config.env
|
tests/config.env
|
||||||
@ -1262,7 +1245,6 @@ echo " Linker flags: ${LDFLAGS} ${COGL_EXTRA_LDFLAGS}"
|
|||||||
# Miscellaneous
|
# Miscellaneous
|
||||||
echo ""
|
echo ""
|
||||||
echo " • Extra:"
|
echo " • Extra:"
|
||||||
echo " Build API reference: ${enable_gtk_doc}"
|
|
||||||
echo " Build introspection data: ${enable_introspection}"
|
echo " Build introspection data: ${enable_introspection}"
|
||||||
echo " Build unit tests: ${enable_unit_tests}"
|
echo " Build unit tests: ${enable_unit_tests}"
|
||||||
echo " Enable internationalization: ${USE_NLS}"
|
echo " Enable internationalization: ${USE_NLS}"
|
||||||
|
@ -1,50 +0,0 @@
|
|||||||
Cogl Coding Style
|
|
||||||
--------------------
|
|
||||||
|
|
||||||
This document is intended to be a short description of the preferred
|
|
||||||
coding style to be used for the Cogl source code.
|
|
||||||
|
|
||||||
Coding style is a matter of consistency, readability and maintainance;
|
|
||||||
coding style is also completely arbitrary and a matter of taste. This
|
|
||||||
document will use examples at the very least to provide authoritative
|
|
||||||
and consistent answers to common questions regarding the coding style,
|
|
||||||
and will also try to identify the allowed exceptions.
|
|
||||||
|
|
||||||
The Cogl coding style is currently defined relative to the Clutter
|
|
||||||
coding style, so please first read clutter/docs/CODING_STYLE.
|
|
||||||
|
|
||||||
Differences to the Clutter coding style:
|
|
||||||
|
|
||||||
+ Headers
|
|
||||||
|
|
||||||
Cogl headers are not exempt from the 80 characters limit as they are in
|
|
||||||
Clutter. Function prototypes should not be arranged into vertical
|
|
||||||
columns but should instead look somthing like this:
|
|
||||||
|
|
||||||
void
|
|
||||||
my_function (CoglType type,
|
|
||||||
CoglType *a_pointer,
|
|
||||||
CoglType another_type);
|
|
||||||
|
|
||||||
+ Types
|
|
||||||
|
|
||||||
Avoid the use of redundant glib typedefs and wherever possible simply
|
|
||||||
use ANSI C/c99 types.
|
|
||||||
|
|
||||||
The following types should not be used:
|
|
||||||
gint, guint, gfloat, gdouble, glong, gulong, gchar, guchar,
|
|
||||||
guint{8,16,32} or gint{8,16,32}
|
|
||||||
Instead use:
|
|
||||||
int, unsigned int, float, double, long, unsigned long, char,
|
|
||||||
unsigned char, uint{8,16,32}_t and int{8,16,32}_t
|
|
||||||
|
|
||||||
Use CoglBool for boolean types.
|
|
||||||
|
|
||||||
When ever you need a byte size type for dealing with pixel data then
|
|
||||||
uint8_t should be used.
|
|
||||||
|
|
||||||
The general intention is that Cogl should look palatable to the widest
|
|
||||||
range of C programmers including those outside the Gnome community so
|
|
||||||
- especially for the public API - we want to minimize the number of
|
|
||||||
foreign looking typedefs.
|
|
||||||
|
|
@ -1,9 +0,0 @@
|
|||||||
SUBDIRS =
|
|
||||||
|
|
||||||
if BUILD_GTK_DOC
|
|
||||||
SUBDIRS += reference
|
|
||||||
endif
|
|
||||||
|
|
||||||
DIST_SUBDIRS = reference
|
|
||||||
|
|
||||||
EXTRA_DIST = CODING_STYLE
|
|
129
doc/RELEASING
@ -1,129 +0,0 @@
|
|||||||
RELEASING
|
|
||||||
=========
|
|
||||||
|
|
||||||
When making a new release;
|
|
||||||
|
|
||||||
|
|
||||||
== Add version defines + macros if applicable ==
|
|
||||||
|
|
||||||
- If it's a new stable release that increments the Cogl minor version
|
|
||||||
remember to add a new COGL_VERSION_1_X define to cogl/cogl-version.h
|
|
||||||
and update cogl/cogl-macros.h accordingly
|
|
||||||
|
|
||||||
|
|
||||||
== Update the documentation ==
|
|
||||||
|
|
||||||
- Update the NEWS with:
|
|
||||||
|
|
||||||
- new feature details, bugs fixed, acknowledgements
|
|
||||||
- Use git shortlog -n -s to get the list of authors
|
|
||||||
- The following bash snippet may help with extracting the list of
|
|
||||||
bugs closed:
|
|
||||||
- Grep the source code for "XXX: ONGOING BUG" and add a
|
|
||||||
section about workarounds for un-resolved upstream bugs.
|
|
||||||
|
|
||||||
URLS=$(git log $1|grep bugzilla|sort|uniq)
|
|
||||||
for i in $URLS
|
|
||||||
do
|
|
||||||
ID=$(echo $i|cut -d'=' -f2)
|
|
||||||
TITLE=$(wget --quiet -O - $i|grep -e '<title>.*</title>'|sed -e 's/<title>Bug [0-9]\+ – \(.*\)<\/title>/\1/')
|
|
||||||
echo " #$ID - $TITLE"
|
|
||||||
done
|
|
||||||
|
|
||||||
- README: dependencies, any behavioural changes relevant to
|
|
||||||
developers;
|
|
||||||
|
|
||||||
then commit the changes.
|
|
||||||
|
|
||||||
|
|
||||||
== Update the package version ==
|
|
||||||
|
|
||||||
- Read the release comments in configure.ac
|
|
||||||
- Bump cogl_1_micro_version to the next even number
|
|
||||||
- Don't change the 2.0 version number
|
|
||||||
- Update the libtool versioning
|
|
||||||
- Update the cogl_release_status status to "release" or "snapshot"
|
|
||||||
as appropriate.
|
|
||||||
- commit the changes.
|
|
||||||
|
|
||||||
|
|
||||||
== Test the release ==
|
|
||||||
|
|
||||||
- Verify that you don't have uncommitted changes; both:
|
|
||||||
|
|
||||||
$ git diff HEAD
|
|
||||||
|
|
||||||
and:
|
|
||||||
|
|
||||||
$ git diff --stat master origin/master
|
|
||||||
|
|
||||||
should be empty.
|
|
||||||
|
|
||||||
- Clean your work directory:
|
|
||||||
|
|
||||||
$ git clean -xdf
|
|
||||||
|
|
||||||
This ensures that you don't have stale files lying around.
|
|
||||||
|
|
||||||
- Run:
|
|
||||||
|
|
||||||
$ ./autogen.sh --enable-gtk-doc --enable-profile --enable-gles1 \
|
|
||||||
--enable-gles2 --enable-gl --enable-xlib-egl-platform \
|
|
||||||
--enable-wayland-egl-platform --enable-glx \
|
|
||||||
--enable-wayland-egl-server --enable-cogl-gst
|
|
||||||
$ make all
|
|
||||||
$ make install
|
|
||||||
|
|
||||||
And verify that the code builds and installs from a clean Git snapshot.
|
|
||||||
|
|
||||||
- Run checks including running the conformance tests:
|
|
||||||
|
|
||||||
$ make check
|
|
||||||
|
|
||||||
- Test with Clutter:
|
|
||||||
|
|
||||||
Since we haven't migrated all the Cogl unit tests from Clutter yet, you
|
|
||||||
should now build Clutter against Cogl and run the conformance tests:
|
|
||||||
|
|
||||||
$ ./autogen.sh
|
|
||||||
$ make all
|
|
||||||
$ make test
|
|
||||||
|
|
||||||
- Test cross-compiling for Windows:
|
|
||||||
|
|
||||||
Please use the build/mingw/mingw-fetch-dependencies.sh with a fresh
|
|
||||||
build directory to make sure that all of the download links still
|
|
||||||
work.
|
|
||||||
|
|
||||||
|
|
||||||
== Make the release ==
|
|
||||||
|
|
||||||
- Run:
|
|
||||||
|
|
||||||
$ make release-publish
|
|
||||||
|
|
||||||
Note: if you want to break this into multiple steps see
|
|
||||||
build/autotools/Makefile.am.release for details. You may prefer to first
|
|
||||||
`make release-check` and then manually use `make release-tag`, `make
|
|
||||||
release-upload` and `make release-message`.
|
|
||||||
|
|
||||||
`make release-publish` will:
|
|
||||||
|
|
||||||
- do sanity checks on the build
|
|
||||||
- distcheck the release
|
|
||||||
- tag the repository with the version number
|
|
||||||
- upload the tarball to the remote server (needs SSH account)
|
|
||||||
|
|
||||||
|
|
||||||
== Prepare for the next development branch ==
|
|
||||||
|
|
||||||
- Bump cogl_1_micro_version to the next odd number
|
|
||||||
- Revert cogl_release_status to "git"
|
|
||||||
|
|
||||||
- Push the branch and then the tag, e.g.:
|
|
||||||
|
|
||||||
$ git push origin master
|
|
||||||
$ git push origin 1.7.0
|
|
||||||
|
|
||||||
- Announce release to the waiting world on the blog and mailing lists. Use
|
|
||||||
the template printed by `make release-publish`.
|
|
@ -1,5 +0,0 @@
|
|||||||
SUBDIRS = cogl cogl-2.0-experimental
|
|
||||||
|
|
||||||
if BUILD_COGL_GST
|
|
||||||
SUBDIRS += cogl-gst
|
|
||||||
endif
|
|
@ -1,132 +0,0 @@
|
|||||||
## 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-2.0-experimental
|
|
||||||
|
|
||||||
# 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=../../../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=$(GDKPIXBUF_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)/cogl/*.h \
|
|
||||||
$(top_builddir)/cogl/*.h \
|
|
||||||
$(top_srcdir)/cogl/winsys/*.h
|
|
||||||
CFILE_GLOB=$(top_srcdir)/cogl/*.c
|
|
||||||
|
|
||||||
# Header files to ignore when scanning.
|
|
||||||
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
|
|
||||||
cogl_private_headers := \
|
|
||||||
$(shell cd $(top_srcdir)/cogl && echo *-private.h && cd - && \
|
|
||||||
cd $(top_srcdir)/cogl/winsys && echo *-private.h && cd -)
|
|
||||||
|
|
||||||
IGNORE_HFILES=\
|
|
||||||
driver \
|
|
||||||
tesselator \
|
|
||||||
cogl.h \
|
|
||||||
$(cogl_private_headers) \
|
|
||||||
cogl-atlas.h \
|
|
||||||
cogl-path.h \
|
|
||||||
cogl-program.h \
|
|
||||||
cogl-shader.h \
|
|
||||||
cogl-bitmap-packing.h \
|
|
||||||
cogl-bitmask.h \
|
|
||||||
cogl-blend-string.h \
|
|
||||||
cogl-blit.h \
|
|
||||||
cogl-boxed-value.h \
|
|
||||||
cogl-clip-stack.h \
|
|
||||||
cogl-debug.h \
|
|
||||||
cogl-debug-options.h \
|
|
||||||
cogl-defines.h \
|
|
||||||
cogl-driver.h \
|
|
||||||
cogl-enum-types.h \
|
|
||||||
cogl-flags.h \
|
|
||||||
cogl-gles2-types.h \
|
|
||||||
cogl-gl-header.h \
|
|
||||||
cogl-glsl-shader-boilerplate.h \
|
|
||||||
cogl-deprecated.h \
|
|
||||||
cogl-profile.h \
|
|
||||||
cogl-rectangle-map.h \
|
|
||||||
cogl-spans.h \
|
|
||||||
cogl-texture-driver.h \
|
|
||||||
cogl-util.h \
|
|
||||||
$(NULL)
|
|
||||||
|
|
||||||
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. AM_CPPFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
|
|
||||||
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
|
|
||||||
|
|
||||||
AM_CPPFLAGS=-I$(top_srcdir) -I$(top_builddir)/cogl -DCOGL_ENABLE_EXPERIMENTAL_API $(COGL_DEP_CFLAGS)
|
|
||||||
GTKDOC_LIBS=$(top_builddir)/cogl/libcogl.la $(COGL_DEP_LIBS)
|
|
||||||
|
|
||||||
# This includes the standard gtk-doc make rules, copied by gtkdocize.
|
|
||||||
if BUILD_GTK_DOC
|
|
||||||
include $(top_srcdir)/gtk-doc.make
|
|
||||||
else
|
|
||||||
EXTRA_DIST =
|
|
||||||
endif
|
|
||||||
|
|
||||||
# Other files to distribute
|
|
||||||
# e.g. EXTRA_DIST += version.xml.in
|
|
||||||
|
|
||||||
EXTRA_DIST += $(HTML_IMAGES) $(content_files)
|
|
@ -1,129 +0,0 @@
|
|||||||
<?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>
|
|
@ -1,229 +0,0 @@
|
|||||||
<?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>
|
|
||||||
<year>2012</year>
|
|
||||||
<year>2013</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>
|
|
||||||
|
|
||||||
<section id="cogl-general-apis">
|
|
||||||
<title>General API concepts</title>
|
|
||||||
<xi:include href="xml/cogl-object.xml"/>
|
|
||||||
<xi:include href="xml/cogl-error.xml"/>
|
|
||||||
<xi:include href="xml/cogl-types.xml"/>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section id="cogl-context-apis">
|
|
||||||
<title>Setting Up A Drawing Context</title>
|
|
||||||
<xi:include href="xml/cogl-renderer.xml"/>
|
|
||||||
<xi:include href="xml/cogl-onscreen-template.xml"/>
|
|
||||||
<xi:include href="xml/cogl-display.xml"/>
|
|
||||||
<xi:include href="xml/cogl-context.xml"/>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section id="cogl-pipeline-apis">
|
|
||||||
<title>Setting Up A GPU Pipeline</title>
|
|
||||||
<xi:include href="blend-strings.xml"/>
|
|
||||||
<xi:include href="xml/cogl-pipeline.xml"/>
|
|
||||||
<xi:include href="xml/cogl-depth-state.xml"/>
|
|
||||||
<xi:include href="xml/cogl-snippet.xml"/>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section id="cogl-buffer-apis">
|
|
||||||
<title>Allocating GPU Memory</title>
|
|
||||||
<xi:include href="xml/cogl-buffer.xml"/>
|
|
||||||
<xi:include href="xml/cogl-attribute-buffer.xml"/>
|
|
||||||
<xi:include href="xml/cogl-index-buffer.xml"/>
|
|
||||||
</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"/>
|
|
||||||
<xi:include href="xml/cogl-rectangle.xml"/>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section id="cogl-textures">
|
|
||||||
<title>Textures</title>
|
|
||||||
<xi:include href="xml/cogl-bitmap.xml"/>
|
|
||||||
<xi:include href="xml/cogl-texture.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"/>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section id="cogl-primitive-textures">
|
|
||||||
<title>Primitive Textures</title>
|
|
||||||
<xi:include href="xml/cogl-primitive-texture.xml"/>
|
|
||||||
<xi:include href="xml/cogl-texture-2d.xml"/>
|
|
||||||
<xi:include href="xml/cogl-texture-3d.xml"/>
|
|
||||||
<xi:include href="xml/cogl-texture-rectangle.xml"/>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section id="cogl-framebuffer-apis">
|
|
||||||
<title>Framebuffers</title>
|
|
||||||
<xi:include href="xml/cogl-framebuffer.xml"/>
|
|
||||||
<xi:include href="xml/cogl-onscreen.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-matrix-stack.xml"/>
|
|
||||||
<xi:include href="xml/cogl-vector.xml"/>
|
|
||||||
<xi:include href="xml/cogl-euler.xml"/>
|
|
||||||
<xi:include href="xml/cogl-quaternion.xml"/>
|
|
||||||
<xi:include href="xml/cogl-fence.xml"/>
|
|
||||||
<xi:include href="xml/cogl-version.xml"/>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section id="cogl-integration">
|
|
||||||
<title>Binding and Integrating</title>
|
|
||||||
<xi:include href="xml/cogl-sdl.xml"/>
|
|
||||||
<xi:include href="xml/cogl-poll.xml"/>
|
|
||||||
<xi:include href="xml/cogl-gtype.xml"/>
|
|
||||||
<xi:include href="xml/cogl-gles2.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>
|
|
Before Width: | Height: | Size: 12 KiB |
Before Width: | Height: | Size: 3.0 KiB |
Before Width: | Height: | Size: 3.1 KiB |
Before Width: | Height: | Size: 2.6 KiB |
Before Width: | Height: | Size: 7.8 KiB |
@ -1,106 +0,0 @@
|
|||||||
## 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-gst
|
|
||||||
|
|
||||||
# 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=../../../cogl-gst
|
|
||||||
|
|
||||||
# Extra options to pass to gtkdoc-scangobj. Not normally needed.
|
|
||||||
SCANGOBJ_OPTIONS=--type-init-func="gst_init(NULL, NULL)"
|
|
||||||
|
|
||||||
# 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_gst
|
|
||||||
|
|
||||||
# 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=$(GDKPIXBUF_PREFIX)/share/gtk-doc/html/gdk-pixbuf \
|
|
||||||
--extra-dir=$(GSTREAMER_PREFIX)/share/gtk-doc/html/gstreamer-1.0 \
|
|
||||||
--extra-dir=$(GSTREAMER_PREFIX)/share/gtk-doc/html/gstreamer-libs-1.0
|
|
||||||
|
|
||||||
# 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)/cogl/*.h \
|
|
||||||
$(top_builddir)/cogl/*.h \
|
|
||||||
$(top_srcdir)/cogl/winsys/*.h \
|
|
||||||
$(top_srcdir)/cogl-gst/*.h
|
|
||||||
CFILE_GLOB=$(top_srcdir)/cogl-gst/*.c
|
|
||||||
|
|
||||||
IGNORE_HFILES=\
|
|
||||||
$(NULL)
|
|
||||||
|
|
||||||
EXTRA_HFILES=
|
|
||||||
|
|
||||||
# Images to copy into HTML directory.
|
|
||||||
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
|
|
||||||
HTML_IMAGES=\
|
|
||||||
$(NULL)
|
|
||||||
|
|
||||||
# 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=\
|
|
||||||
$(NULL)
|
|
||||||
|
|
||||||
# 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=\
|
|
||||||
$(NULL)
|
|
||||||
|
|
||||||
# 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. AM_CPPFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
|
|
||||||
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
|
|
||||||
|
|
||||||
AM_CPPFLAGS=\
|
|
||||||
-I$(top_srcdir) \
|
|
||||||
-I$(top_builddir) \
|
|
||||||
-DCOGL_ENABLE_EXPERIMENTAL_API \
|
|
||||||
$(COGL_DEP_CFLAGS) \
|
|
||||||
$(COGL_GST_DEP_CFLAGS)
|
|
||||||
|
|
||||||
GTKDOC_LIBS=\
|
|
||||||
$(top_builddir)/cogl/libcogl.la \
|
|
||||||
$(top_builddir)/cogl-gst/libcogl-gst.la \
|
|
||||||
$(COGL_DEP_LIBS) \
|
|
||||||
$(COGL_GST_DEP_LIBS)
|
|
||||||
|
|
||||||
# This includes the standard gtk-doc make rules, copied by gtkdocize.
|
|
||||||
if BUILD_GTK_DOC
|
|
||||||
include $(top_srcdir)/gtk-doc.make
|
|
||||||
else
|
|
||||||
EXTRA_DIST =
|
|
||||||
endif
|
|
||||||
|
|
||||||
# Other files to distribute
|
|
||||||
# e.g. EXTRA_DIST += version.xml.in
|
|
||||||
|
|
||||||
EXTRA_DIST += $(HTML_IMAGES) $(content_files)
|
|
@ -1,105 +0,0 @@
|
|||||||
<?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 GST 2.0 Reference Manual</title>
|
|
||||||
<releaseinfo>for Cogl &version;</releaseinfo>
|
|
||||||
|
|
||||||
<copyright>
|
|
||||||
<year>2013</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 GST - a library for integrating GStreamer with Cogl</title>
|
|
||||||
|
|
||||||
<section id="cogl-gst-intro">
|
|
||||||
<title>About Cogl GST</title>
|
|
||||||
|
|
||||||
<para>Cogl GST is a small library which provides a GStreamer
|
|
||||||
sink which can manage a CoglPipeline to render a video within a
|
|
||||||
Cogl scene.</para>
|
|
||||||
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section id="cogl-gst-general-apis">
|
|
||||||
<title>General APIs</title>
|
|
||||||
<xi:include href="xml/cogl-gst-video-sink.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>
|
|
||||||
|
|
||||||
<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>
|
|
@ -1,33 +0,0 @@
|
|||||||
<SECTION>
|
|
||||||
<FILE>cogl-gst-video-sink</FILE>
|
|
||||||
<TITLE>CoglGstVideoSink</TITLE>
|
|
||||||
|
|
||||||
<SUBSECTION>
|
|
||||||
CoglGstVideoSink
|
|
||||||
CoglGstVideoSinkClass
|
|
||||||
cogl_gst_video_sink_new
|
|
||||||
cogl_gst_video_sink_set_context
|
|
||||||
cogl_gst_video_sink_get_pipeline
|
|
||||||
cogl_gst_video_sink_attach_frame
|
|
||||||
cogl_gst_video_sink_setup_pipeline
|
|
||||||
cogl_gst_video_sink_get_free_layer
|
|
||||||
cogl_gst_video_sink_set_first_layer
|
|
||||||
cogl_gst_video_sink_set_default_sample
|
|
||||||
cogl_gst_video_sink_is_ready
|
|
||||||
cogl_gst_video_sink_get_aspect
|
|
||||||
cogl_gst_video_sink_get_width_for_height
|
|
||||||
cogl_gst_video_sink_get_height_for_width
|
|
||||||
cogl_gst_video_sink_fit_size
|
|
||||||
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
COGL_GST_IS_VIDEO_SINK
|
|
||||||
COGL_GST_IS_VIDEO_SINK_CLASS
|
|
||||||
COGL_GST_VIDEO_SINK
|
|
||||||
COGL_GST_VIDEO_SINK_CLASS
|
|
||||||
COGL_GST_TYPE_VIDEO_SINK
|
|
||||||
COGL_GST_VIDEO_SINK_GET_CLASS
|
|
||||||
<SUBSECTION Private>
|
|
||||||
CoglGstVideoSinkPrivate
|
|
||||||
cogl_gst_video_sink_get_type
|
|
||||||
|
|
||||||
</SECTION>
|
|
@ -1,2 +0,0 @@
|
|||||||
#include <cogl-gst/cogl-gst.h>
|
|
||||||
cogl_gst_video_sink_get_type
|
|
@ -1,153 +0,0 @@
|
|||||||
## 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=../../../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)/cogl/*.h \
|
|
||||||
$(top_builddir)/cogl/*.h
|
|
||||||
CFILE_GLOB=$(top_srcdir)/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-onscreen-private.h \
|
|
||||||
cogl-gtype-private.h \
|
|
||||||
cogl-index-buffer-private.h \
|
|
||||||
cogl-indices-private.h \
|
|
||||||
cogl-journal-private.h \
|
|
||||||
cogl-matrix-private.h \
|
|
||||||
cogl-object-private.h \
|
|
||||||
cogl-path-private.h \
|
|
||||||
cogl-depth-state-private.h \
|
|
||||||
cogl-pipeline-fragend-arbfp-private.h \
|
|
||||||
cogl-pipeline-fragend-fixed-private.h \
|
|
||||||
cogl-pipeline-fragend-glsl-private.h \
|
|
||||||
cogl-pipeline-opengl-private.h \
|
|
||||||
cogl-pipeline-private.h \
|
|
||||||
cogl-pipeline-state-private.h \
|
|
||||||
cogl-pipeline-layer-state-private.h \
|
|
||||||
cogl-pipeline-progend-glsl-private.h \
|
|
||||||
cogl-pipeline-vertend-fixed-private.h \
|
|
||||||
cogl-pipeline-vertend-glsl-private.h \
|
|
||||||
cogl-pixel-buffer-private.h \
|
|
||||||
cogl-primitive-private.h \
|
|
||||||
cogl-primitives-private.h \
|
|
||||||
cogl-private.h \
|
|
||||||
cogl-program-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-array-private.h \
|
|
||||||
cogl-vertex-attribute-private.h \
|
|
||||||
cogl-vertex-buffer-private.h \
|
|
||||||
cogl-blend-string.h \
|
|
||||||
cogl-clip-stack.h \
|
|
||||||
cogl-debug.h \
|
|
||||||
cogl-defines.h \
|
|
||||||
cogl-deprecated.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)
|
|
||||||
|
|
||||||
AM_CPPFLAGS=-I$(top_srcdir) -I$(top_builddir)/cogl -DCOGL_ENABLE_EXPERIMENTAL_API
|
|
||||||
AM_CFLAGS=$(COGL_DEP_CFLAGS)
|
|
||||||
GTKDOC_LIBS=$(top_builddir)/cogl/libcogl.la $(COGL_DEP_LIBS)
|
|
||||||
|
|
||||||
# This includes the standard gtk-doc make rules, copied by gtkdocize.
|
|
||||||
if BUILD_GTK_DOC
|
|
||||||
include $(top_srcdir)/gtk-doc.make
|
|
||||||
else
|
|
||||||
EXTRA_DIST =
|
|
||||||
endif
|
|
||||||
|
|
||||||
# Other files to distribute
|
|
||||||
# e.g. EXTRA_DIST += version.xml.in
|
|
||||||
|
|
||||||
EXTRA_DIST += $(HTML_IMAGES) $(content_files)
|
|
@ -1,129 +0,0 @@
|
|||||||
<?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">Material Blend Strings</refentrytitle>
|
|
||||||
<manvolnum>3</manvolnum>
|
|
||||||
<refmiscinfo>COGL Library</refmiscinfo>
|
|
||||||
</refmeta>
|
|
||||||
|
|
||||||
<refnamediv>
|
|
||||||
<refname>Material 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>
|
|
@ -1,212 +0,0 @@
|
|||||||
<?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 "@COGL_1_VERSION@">
|
|
||||||
]>
|
|
||||||
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
|
|
||||||
|
|
||||||
<bookinfo>
|
|
||||||
<title>Cogl Reference Manual</title>
|
|
||||||
<releaseinfo>for Cogl &version;</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.xml"/>
|
|
||||||
<xi:include href="xml/cogl-color.xml"/>
|
|
||||||
<xi:include href="xml/cogl-texture.xml"/>
|
|
||||||
<xi:include href="blend-strings.xml"/>
|
|
||||||
<xi:include href="xml/cogl-material.xml"/>
|
|
||||||
<xi:include href="xml/cogl-primitives.xml"/>
|
|
||||||
<xi:include href="xml/cogl-paths.xml"/>
|
|
||||||
<xi:include href="xml/cogl-clipping.xml"/>
|
|
||||||
<xi:include href="xml/cogl-vertex-buffer.xml"/>
|
|
||||||
<xi:include href="xml/cogl-matrix.xml"/>
|
|
||||||
<xi:include href="xml/cogl-shaders.xml"/>
|
|
||||||
<xi:include href="xml/cogl-offscreen.xml"/>
|
|
||||||
<xi:include href="xml/cogl-bitmap.xml"/>
|
|
||||||
<xi:include href="xml/cogl-fixed.xml"/>
|
|
||||||
<xi:include href="xml/cogl-gtype.xml"/>
|
|
||||||
|
|
||||||
</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"/>
|
|
||||||
<xi:include href="xml/cogl-vector.xml"/>
|
|
||||||
<xi:include href="xml/cogl-texture-3d.xml"/>
|
|
||||||
<xi:include href="xml/cogl-quaternion.xml"/>
|
|
||||||
|
|
||||||
</chapter>
|
|
||||||
|
|
||||||
<chapter>
|
|
||||||
<title>Cogl deprecated API</title>
|
|
||||||
|
|
||||||
<section id="cogl-deprecated">
|
|
||||||
|
|
||||||
<title>About the deprecated API</title>
|
|
||||||
|
|
||||||
<para>Cogl has evolved from once being a thin abstraction over
|
|
||||||
OpenGL and GLES where a lot of OpenGL's state machine style APIs
|
|
||||||
were simply rebranded as Cogl API into the more distinguished API
|
|
||||||
style we have today. The result of this evolution though is that
|
|
||||||
some of the APIs are considered deprecated and because we plan to
|
|
||||||
remove them at the next opportunity we have to break the API
|
|
||||||
developers should aim to avoid these functions to keep their code
|
|
||||||
working with future major versions of Cogl.</para>
|
|
||||||
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<xi:include href="xml/cogl-deprecated.xml"/>
|
|
||||||
<xi:include href="xml/cogl-texture-deprecated.xml"/>
|
|
||||||
<xi:include href="xml/cogl-material-deprecated.xml"/>
|
|
||||||
<xi:include href="xml/cogl-clipping-deprecated.xml"/>
|
|
||||||
<xi:include href="xml/cogl-vertex-buffer-deprecated.xml"/>
|
|
||||||
<xi:include href="xml/cogl-shaders-deprecated.xml"/>
|
|
||||||
<xi:include href="xml/cogl-offscreen-deprecated.xml"/>
|
|
||||||
|
|
||||||
</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>
|
|
||||||
|
|
||||||
<index role="1.6">
|
|
||||||
<title>Index of new symbols in 1.6</title>
|
|
||||||
<xi:include href="xml/api-index-1.6.xml"><xi:fallback /></xi:include>
|
|
||||||
</index>
|
|
||||||
|
|
||||||
<index role="1.8">
|
|
||||||
<title>Index of new symbols in 1.8</title>
|
|
||||||
<xi:include href="xml/api-index-1.8.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>
|
|
@ -1,715 +0,0 @@
|
|||||||
<SECTION>
|
|
||||||
<FILE>cogl</FILE>
|
|
||||||
<TITLE>General API</TITLE>
|
|
||||||
CoglObject
|
|
||||||
cogl_object_ref
|
|
||||||
cogl_object_unref
|
|
||||||
CoglUserDataKey
|
|
||||||
cogl_object_get_user_data
|
|
||||||
cogl_object_set_user_data
|
|
||||||
COGL_INVALID_HANDLE
|
|
||||||
CoglHandle
|
|
||||||
cogl_handle_ref
|
|
||||||
cogl_handle_unref
|
|
||||||
|
|
||||||
<SUBSECTION>
|
|
||||||
CoglFuncPtr
|
|
||||||
CoglPixelFormat
|
|
||||||
CoglBufferTarget
|
|
||||||
CoglBufferBit
|
|
||||||
CoglAttributeType
|
|
||||||
|
|
||||||
<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>
|
|
||||||
CoglFogMode
|
|
||||||
cogl_set_fog
|
|
||||||
cogl_disable_fog
|
|
||||||
|
|
||||||
<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_FIXED
|
|
||||||
COGL_TYPE_FOG_MODE
|
|
||||||
COGL_TYPE_HANDLE
|
|
||||||
COGL_TYPE_INDICES_TYPE
|
|
||||||
COGL_TYPE_MATERIAL_ALPHA_FUNC
|
|
||||||
COGL_TYPE_MATERIAL_FILTER
|
|
||||||
COGL_TYPE_MATERIAL_LAYER_TYPE
|
|
||||||
COGL_TYPE_PIXEL_FORMAT
|
|
||||||
COGL_TYPE_READ_PIXELS_FLAGS
|
|
||||||
COGL_TYPE_SHADER_TYPE
|
|
||||||
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_handle_get_type
|
|
||||||
cogl_indices_type_get_type
|
|
||||||
cogl_material_alpha_func_get_type
|
|
||||||
cogl_material_filter_get_type
|
|
||||||
cogl_material_layer_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_PREMULT_BIT
|
|
||||||
</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-primitives</FILE>
|
|
||||||
<TITLE>Primitives</TITLE>
|
|
||||||
cogl_rectangle
|
|
||||||
cogl_rectangles
|
|
||||||
cogl_rectangle_with_texture_coords
|
|
||||||
cogl_rectangles_with_texture_coords
|
|
||||||
cogl_rectangle_with_multitexture_coords
|
|
||||||
cogl_polygon
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>cogl-paths</FILE>
|
|
||||||
<TITLE>Path Primitives</TITLE>
|
|
||||||
cogl_is_path
|
|
||||||
cogl_path_new
|
|
||||||
cogl_get_path
|
|
||||||
cogl_set_path
|
|
||||||
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_fill_preserve
|
|
||||||
cogl_path_stroke
|
|
||||||
cogl_path_stroke_preserve
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>cogl-bitmap</FILE>
|
|
||||||
<TITLE>Bitmaps</TITLE>
|
|
||||||
CoglBitmap
|
|
||||||
cogl_bitmap_new_from_file
|
|
||||||
cogl_bitmap_get_size_from_file
|
|
||||||
cogl_is_bitmap
|
|
||||||
CoglBitmapError
|
|
||||||
COGL_BITMAP_ERROR
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
cogl_bitmap_error_get_type
|
|
||||||
cogl_bitmap_error_quark
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>cogl-texture</FILE>
|
|
||||||
<TITLE>Textures</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-2d</FILE>
|
|
||||||
<TITLE>2D textures</TITLE>
|
|
||||||
CoglTexture2D
|
|
||||||
cogl_is_texture_2d
|
|
||||||
cogl_texture_2d_new_with_size
|
|
||||||
cogl_texture_2d_new_from_data
|
|
||||||
cogl_texture_2d_gl_new_from_foreign
|
|
||||||
</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-shaders</FILE>
|
|
||||||
<TITLE>Shaders and Programmable Pipeline</TITLE>
|
|
||||||
CoglShaderType
|
|
||||||
cogl_create_shader
|
|
||||||
cogl_is_shader
|
|
||||||
cogl_shader_source
|
|
||||||
cogl_shader_compile
|
|
||||||
cogl_shader_get_info_log
|
|
||||||
cogl_shader_get_type
|
|
||||||
cogl_shader_is_compiled
|
|
||||||
|
|
||||||
<SUBSECTION>
|
|
||||||
cogl_create_program
|
|
||||||
cogl_is_program
|
|
||||||
cogl_program_attach_shader
|
|
||||||
cogl_program_link
|
|
||||||
cogl_program_get_uniform_location
|
|
||||||
cogl_program_set_uniform_1f
|
|
||||||
cogl_program_set_uniform_1i
|
|
||||||
cogl_program_set_uniform_float
|
|
||||||
cogl_program_set_uniform_int
|
|
||||||
cogl_program_set_uniform_matrix
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>cogl-offscreen</FILE>
|
|
||||||
<TITLE>Offscreen Buffers</TITLE>
|
|
||||||
cogl_offscreen_new_with_texture
|
|
||||||
cogl_offscreen_new_to_texture
|
|
||||||
cogl_is_offscreen
|
|
||||||
cogl_set_framebuffer
|
|
||||||
cogl_push_framebuffer
|
|
||||||
cogl_pop_framebuffer
|
|
||||||
cogl_set_draw_buffer
|
|
||||||
cogl_pop_draw_buffer
|
|
||||||
cogl_push_draw_buffer
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>cogl-fixed</FILE>
|
|
||||||
<TITLE>Fixed Point API</TITLE>
|
|
||||||
CoglFixed
|
|
||||||
COGL_FIXED_BITS
|
|
||||||
COGL_FIXED_Q
|
|
||||||
COGL_FIXED_MAX
|
|
||||||
COGL_FIXED_MIN
|
|
||||||
|
|
||||||
<SUBSECTION>
|
|
||||||
COGL_FIXED_FROM_FLOAT
|
|
||||||
COGL_FIXED_TO_FLOAT
|
|
||||||
COGL_FIXED_FROM_INT
|
|
||||||
COGL_FIXED_TO_INT
|
|
||||||
COGL_FIXED_FROM_DOUBLE
|
|
||||||
COGL_FIXED_TO_DOUBLE
|
|
||||||
COGL_FLOAT_TO_INT
|
|
||||||
COGL_FLOAT_TO_UINT
|
|
||||||
|
|
||||||
<SUBSECTION>
|
|
||||||
COGL_FIXED_EPSILON
|
|
||||||
COGL_FIXED_1
|
|
||||||
COGL_FIXED_0_5
|
|
||||||
COGL_FIXED_30
|
|
||||||
COGL_FIXED_45
|
|
||||||
COGL_FIXED_60
|
|
||||||
COGL_FIXED_90
|
|
||||||
COGL_FIXED_120
|
|
||||||
COGL_FIXED_180
|
|
||||||
COGL_FIXED_240
|
|
||||||
COGL_FIXED_255
|
|
||||||
COGL_FIXED_270
|
|
||||||
COGL_FIXED_360
|
|
||||||
|
|
||||||
<SUBSECTION>
|
|
||||||
COGL_FIXED_MUL
|
|
||||||
COGL_FIXED_DIV
|
|
||||||
COGL_FIXED_MUL_DIV
|
|
||||||
COGL_FIXED_FAST_DIV
|
|
||||||
COGL_FIXED_FAST_MUL
|
|
||||||
COGL_FIXED_FRACTION
|
|
||||||
COGL_FIXED_FLOOR
|
|
||||||
COGL_FIXED_CEIL
|
|
||||||
|
|
||||||
<SUBSECTION>
|
|
||||||
COGL_FIXED_2_PI
|
|
||||||
COGL_FIXED_PI
|
|
||||||
COGL_FIXED_PI_2
|
|
||||||
COGL_FIXED_PI_4
|
|
||||||
COGL_RADIANS_TO_DEGREES
|
|
||||||
|
|
||||||
<SUBSECTION>
|
|
||||||
COGL_SQRTI_ARG_10_PERCENT
|
|
||||||
COGL_SQRTI_ARG_5_PERCENT
|
|
||||||
COGL_SQRTI_ARG_MAX
|
|
||||||
cogl_sqrti
|
|
||||||
|
|
||||||
<SUBSECTION>
|
|
||||||
cogl_fixed_atan2
|
|
||||||
cogl_fixed_atan
|
|
||||||
cogl_fixed_cos
|
|
||||||
cogl_fixed_log2
|
|
||||||
cogl_fixed_pow
|
|
||||||
cogl_fixed_pow2
|
|
||||||
cogl_fixed_sin
|
|
||||||
cogl_fixed_sqrt
|
|
||||||
cogl_fixed_tan
|
|
||||||
cogl_fixed_div
|
|
||||||
cogl_fixed_mul
|
|
||||||
cogl_fixed_mul_div
|
|
||||||
|
|
||||||
<SUBSECTION>
|
|
||||||
CoglAngle
|
|
||||||
COGL_ANGLE_FROM_DEG
|
|
||||||
COGL_ANGLE_FROM_DEGX
|
|
||||||
COGL_ANGLE_TO_DEG
|
|
||||||
COGL_ANGLE_TO_DEGX
|
|
||||||
cogl_angle_cos
|
|
||||||
cogl_angle_sin
|
|
||||||
cogl_angle_tan
|
|
||||||
|
|
||||||
<SUBSECTION Private>
|
|
||||||
cogl_double_to_fixed
|
|
||||||
cogl_double_to_int
|
|
||||||
cogl_double_to_uint
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>cogl-color</FILE>
|
|
||||||
<TITLE>Color Type</TITLE>
|
|
||||||
CoglColor
|
|
||||||
cogl_color_new
|
|
||||||
cogl_color_copy
|
|
||||||
cogl_color_free
|
|
||||||
cogl_color_init_from_4f
|
|
||||||
cogl_color_init_from_4fv
|
|
||||||
cogl_color_init_from_4ub
|
|
||||||
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
|
|
||||||
|
|
||||||
<SUBSECTION>
|
|
||||||
cogl_color_init_from_hsl
|
|
||||||
cogl_color_to_hsl
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>cogl-vertex-buffer</FILE>
|
|
||||||
<TITLE>Vertex Buffers</TITLE>
|
|
||||||
cogl_vertex_buffer_new
|
|
||||||
cogl_vertex_buffer_get_n_vertices
|
|
||||||
cogl_vertex_buffer_add
|
|
||||||
cogl_vertex_buffer_delete
|
|
||||||
cogl_vertex_buffer_submit
|
|
||||||
cogl_vertex_buffer_disable
|
|
||||||
cogl_vertex_buffer_enable
|
|
||||||
CoglVerticesMode
|
|
||||||
cogl_vertex_buffer_draw
|
|
||||||
cogl_is_vertex_buffer
|
|
||||||
|
|
||||||
<SUBSECTION>
|
|
||||||
CoglIndicesType
|
|
||||||
cogl_vertex_buffer_indices_new
|
|
||||||
cogl_vertex_buffer_draw_elements
|
|
||||||
cogl_vertex_buffer_indices_get_for_quads
|
|
||||||
cogl_is_vertex_buffer_indices
|
|
||||||
|
|
||||||
<SUBSECTION Private>
|
|
||||||
cogl_vertex_buffer_indices_get_type
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>cogl-matrix</FILE>
|
|
||||||
<TITLE>Matrices</TITLE>
|
|
||||||
CoglMatrix
|
|
||||||
cogl_matrix_init_identity
|
|
||||||
cogl_matrix_copy
|
|
||||||
cogl_matrix_equal
|
|
||||||
cogl_matrix_free
|
|
||||||
cogl_matrix_frustum
|
|
||||||
cogl_matrix_ortho
|
|
||||||
cogl_matrix_perspective
|
|
||||||
cogl_matrix_multiply
|
|
||||||
cogl_matrix_rotate
|
|
||||||
cogl_matrix_translate
|
|
||||||
cogl_matrix_scale
|
|
||||||
cogl_matrix_transpose
|
|
||||||
cogl_matrix_init_from_array
|
|
||||||
cogl_matrix_get_array
|
|
||||||
cogl_matrix_get_inverse
|
|
||||||
cogl_matrix_transform_point
|
|
||||||
cogl_matrix_project_points
|
|
||||||
cogl_matrix_transform_points
|
|
||||||
cogl_matrix_is_identity
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>cogl-material</FILE>
|
|
||||||
<TITLE>Materials</TITLE>
|
|
||||||
CoglMaterial
|
|
||||||
CoglMaterialLayer
|
|
||||||
CoglMaterialLayerCallback
|
|
||||||
cogl_material_new
|
|
||||||
cogl_material_copy
|
|
||||||
cogl_is_material
|
|
||||||
cogl_material_set_color
|
|
||||||
cogl_material_set_color4ub
|
|
||||||
cogl_material_set_color4f
|
|
||||||
cogl_material_get_color
|
|
||||||
cogl_material_set_ambient
|
|
||||||
cogl_material_get_ambient
|
|
||||||
cogl_material_set_diffuse
|
|
||||||
cogl_material_get_diffuse
|
|
||||||
cogl_material_set_ambient_and_diffuse
|
|
||||||
cogl_material_set_emission
|
|
||||||
cogl_material_get_emission
|
|
||||||
cogl_material_set_specular
|
|
||||||
cogl_material_get_specular
|
|
||||||
cogl_material_set_shininess
|
|
||||||
cogl_material_get_shininess
|
|
||||||
CoglMaterialAlphaFunc
|
|
||||||
cogl_material_set_alpha_test_function
|
|
||||||
COGL_BLEND_STRING_ERROR
|
|
||||||
CoglBlendStringError
|
|
||||||
cogl_material_set_blend
|
|
||||||
cogl_material_set_blend_constant
|
|
||||||
cogl_material_set_point_size
|
|
||||||
cogl_material_get_point_size
|
|
||||||
cogl_material_set_layer
|
|
||||||
cogl_material_remove_layer
|
|
||||||
cogl_material_set_layer_combine
|
|
||||||
cogl_material_set_layer_combine_constant
|
|
||||||
cogl_material_set_layer_matrix
|
|
||||||
cogl_material_set_layer_point_sprite_coords_enabled
|
|
||||||
cogl_material_get_layer_point_sprite_coords_enabled
|
|
||||||
cogl_material_get_n_layers
|
|
||||||
CoglMaterialFilter
|
|
||||||
cogl_material_set_layer_filters
|
|
||||||
CoglMaterialLayerType
|
|
||||||
cogl_material_layer_get_type
|
|
||||||
cogl_material_layer_get_texture
|
|
||||||
cogl_material_layer_get_min_filter
|
|
||||||
cogl_material_layer_get_mag_filter
|
|
||||||
CoglMaterialWrapMode
|
|
||||||
cogl_material_set_layer_wrap_mode
|
|
||||||
cogl_material_set_layer_wrap_mode_s
|
|
||||||
cogl_material_set_layer_wrap_mode_t
|
|
||||||
cogl_material_set_layer_wrap_mode_p
|
|
||||||
cogl_material_get_layer_wrap_mode_s
|
|
||||||
cogl_material_get_layer_wrap_mode_t
|
|
||||||
cogl_material_get_layer_wrap_mode_p
|
|
||||||
cogl_material_wrap_mode_get_type
|
|
||||||
cogl_material_set_user_program
|
|
||||||
cogl_material_get_user_program
|
|
||||||
cogl_material_foreach_layer
|
|
||||||
|
|
||||||
<SUBSECTION Private>
|
|
||||||
cogl_blend_string_error_get_type
|
|
||||||
cogl_blend_string_error_quark
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>cogl-depth-state</FILE>
|
|
||||||
CoglDepthState
|
|
||||||
cogl_depth_state_init
|
|
||||||
cogl_depth_state_set_test_enabled
|
|
||||||
cogl_depth_state_get_test_enabled
|
|
||||||
cogl_depth_state_set_test_function
|
|
||||||
cogl_depth_state_get_test_function
|
|
||||||
cogl_depth_state_set_writing_enabled
|
|
||||||
cogl_depth_state_get_writing_enabled
|
|
||||||
cogl_depth_state_set_range
|
|
||||||
cogl_depth_state_get_range
|
|
||||||
</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
|
|
||||||
|
|
||||||
<SUBSECTION>
|
|
||||||
cogl_pixel_buffer_new
|
|
||||||
cogl_is_pixel_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>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-gtype</FILE>
|
|
||||||
<TITLE>GType Integration API</TITLE>
|
|
||||||
cogl_gtype_matrix_get_type
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>cogl-deprecated</FILE>
|
|
||||||
<TITLE>General API (Deprecated)</TITLE>
|
|
||||||
cogl_check_extension
|
|
||||||
cogl_viewport
|
|
||||||
|
|
||||||
cogl_get_bitmasks
|
|
||||||
|
|
||||||
cogl_set_depth_test_enabled
|
|
||||||
cogl_get_depth_test_enabled
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>cogl-clipping-deprecated</FILE>
|
|
||||||
<TITLE>Clipping (Deprecated)</TITLE>
|
|
||||||
cogl_clip_push
|
|
||||||
cogl_clip_push_window_rect
|
|
||||||
cogl_clip_ensure
|
|
||||||
cogl_clip_stack_save
|
|
||||||
cogl_clip_stack_restore
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>cogl-texture-deprecated</FILE>
|
|
||||||
<TITLE>Textures (Deprecated)</TITLE>
|
|
||||||
cogl_texture_ref
|
|
||||||
cogl_texture_unref
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>cogl-material-deprecated</FILE>
|
|
||||||
<TITLE>Materials (Deprecated)</TITLE>
|
|
||||||
cogl_material_ref
|
|
||||||
cogl_material_unref
|
|
||||||
cogl_material_get_layers
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>cogl-vertex-buffer-deprecated</FILE>
|
|
||||||
<TITLE>Vertex Buffers (Deprecated)</TITLE>
|
|
||||||
cogl_vertex_buffer_ref
|
|
||||||
cogl_vertex_buffer_unref
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>cogl-shaders-deprecated</FILE>
|
|
||||||
<TITLE>Shaders and Programmable Pipeline (Deprecated)</TITLE>
|
|
||||||
cogl_shader_ref
|
|
||||||
cogl_shader_unref
|
|
||||||
|
|
||||||
<SUBSECTION>
|
|
||||||
cogl_program_ref
|
|
||||||
cogl_program_unref
|
|
||||||
cogl_program_use
|
|
||||||
cogl_program_uniform_1f
|
|
||||||
cogl_program_uniform_1i
|
|
||||||
cogl_program_uniform_float
|
|
||||||
cogl_program_uniform_int
|
|
||||||
cogl_program_uniform_matrix
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>cogl-offscreen-deprecated</FILE>
|
|
||||||
<TITLE>Offscreen Buffers (Deprecated)</TITLE>
|
|
||||||
cogl_offscreen_ref
|
|
||||||
cogl_offscreen_unref
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>cogl-euler</FILE>
|
|
||||||
<TITLE>Eulers (Rotations)</TITLE>
|
|
||||||
CoglEuler
|
|
||||||
cogl_euler_init
|
|
||||||
cogl_euler_init_from_matrix
|
|
||||||
cogl_euler_init_from_quaternion
|
|
||||||
cogl_euler_equal
|
|
||||||
cogl_euler_copy
|
|
||||||
cogl_euler_free
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>cogl-quaternion</FILE>
|
|
||||||
<TITLE>Quaternions (Rotations)</TITLE>
|
|
||||||
CoglQuaternion
|
|
||||||
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
|
|
||||||
</SECTION>
|
|
Before Width: | Height: | Size: 12 KiB |
Before Width: | Height: | Size: 3.0 KiB |
Before Width: | Height: | Size: 3.1 KiB |
Before Width: | Height: | Size: 2.6 KiB |
Before Width: | Height: | Size: 7.8 KiB |