Merged clutter-ivan branch into trunk.
svn merge \ https://svn.o-hand.com/repos/clutter/trunk/clutter@2509 \ https://svn.o-hand.com/repos/clutter/branches/clutter-ivan@HEAD
This commit is contained in:
Neil Roberts
93
doc/reference/cogl/Makefile.am
Normal file
93
doc/reference/cogl/Makefile.am
Normal file
@ -0,0 +1,93 @@
|
||||
## 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.sgml
|
||||
|
||||
# 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
|
||||
|
||||
# Extra options to pass to gtkdoc-scangobj. Not normally needed.
|
||||
SCANGOBJ_OPTIONS=
|
||||
|
||||
# Extra options to supply to gtkdoc-scan.
|
||||
# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
|
||||
SCAN_OPTIONS=--deprecated-guards="CLUTTER_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
|
||||
|
||||
# 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 \
|
||||
--extra-dir=$(top_srcdir)/doc/reference/clutter/html
|
||||
|
||||
# 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/*.h \
|
||||
$(top_srcdir)/clutter/cogl/common/*.h
|
||||
CFILE_GLOB=\
|
||||
$(top_srcdir)/clutter/cogl/common/*.c
|
||||
|
||||
# Header files to ignore when scanning.
|
||||
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
|
||||
IGNORE_HFILES=\
|
||||
cogl-bitmap.h \
|
||||
cogl-context.h \
|
||||
cogl-defines.h \
|
||||
cogl-internal.h \
|
||||
cogl-primitives.h \
|
||||
cogl-texture.h
|
||||
|
||||
EXTRA_HFILES=
|
||||
|
||||
# Images to copy into HTML directory.
|
||||
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
|
||||
HTML_IMAGES=
|
||||
|
||||
# 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=
|
||||
|
||||
# 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=
|
||||
|
||||
# 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 $(CLUTTER_CFLAGS)
|
||||
GTKDOC_LIBS=$(top_builddir)/clutter/libclutter-@CLUTTER_FLAVOUR@-@CLUTTER_MAJORMINOR@.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 =
|
||||
57
doc/reference/cogl/cogl-docs.sgml
Normal file
57
doc/reference/cogl/cogl-docs.sgml
Normal file
@ -0,0 +1,57 @@
|
||||
<?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">
|
||||
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
|
||||
<bookinfo>
|
||||
<title>COGL Reference Manual</title>
|
||||
<releaseinfo>
|
||||
</releaseinfo>
|
||||
|
||||
<copyright>
|
||||
<year>2008</year>
|
||||
<holder>OpenedHand LTD</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 - GL Abstraction API</title>
|
||||
|
||||
<section id="cogl-intro">
|
||||
<title>About COGL</title>
|
||||
<para>
|
||||
FIXME
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<xi:include href="xml/cogl.xml"/>
|
||||
<xi:include href="xml/cogl-primitives.xml"/>
|
||||
<xi:include href="xml/cogl-util.xml"/>
|
||||
<xi:include href="xml/cogl-texture.xml"/>
|
||||
<xi:include href="xml/cogl-shaders.xml"/>
|
||||
<xi:include href="xml/cogl-offscreen.xml"/>
|
||||
</chapter>
|
||||
</book>
|
||||
148
doc/reference/cogl/cogl-sections.txt
Normal file
148
doc/reference/cogl/cogl-sections.txt
Normal file
@ -0,0 +1,148 @@
|
||||
<SECTION>
|
||||
<FILE>cogl</FILE>
|
||||
<TITLE>General API</TITLE>
|
||||
COGL_PIXEL_FORMAT_24
|
||||
COGL_PIXEL_FORMAT_32
|
||||
COGL_A_BIT
|
||||
COGL_BGR_BIT
|
||||
COGL_AFIRST_BIT
|
||||
COGL_PREMULT_BIT
|
||||
COGL_UNORDERED_MASK
|
||||
COGL_UNPREMULT_MASK
|
||||
CoglPixelFormat
|
||||
CoglBufferTarget
|
||||
<SUBSECTION>
|
||||
cogl_perspective
|
||||
cogl_setup_viewport
|
||||
cogl_get_modelview_matrix
|
||||
cogl_get_projection_matrix
|
||||
cogl_get_viewport
|
||||
<SUBSECTION>
|
||||
cogl_push_matrix
|
||||
cogl_pop_matrix
|
||||
cogl_scale
|
||||
cogl_translatex
|
||||
cogl_translate
|
||||
cogl_rotatex
|
||||
cogl_rotate
|
||||
<SUBSECTION>
|
||||
cogl_clip_set
|
||||
cogl_clip_unset
|
||||
<SUBSECTION>
|
||||
cogl_enable_depth_test
|
||||
cogl_alpha_func
|
||||
cogl_fog_set
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>cogl-util</FILE>
|
||||
<TITLE>Utility API</TITLE>
|
||||
cogl_create_context
|
||||
cogl_destroy_context
|
||||
COGL_INVALID_HANDLE
|
||||
CoglHandle
|
||||
CoglFuncPtr
|
||||
<SUBSECTION>
|
||||
CoglFeatureFlags
|
||||
cogl_get_features
|
||||
cogl_features_available
|
||||
<SUBSECTION>
|
||||
cogl_get_proc_address
|
||||
cogl_check_extension
|
||||
cogl_get_bitmasks
|
||||
cogl_paint_init
|
||||
<SUBSECTION>
|
||||
cogl_util_next_p2
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>cogl-primitives</FILE>
|
||||
<TITLE>Primitives</TITLE>
|
||||
cogl_color
|
||||
cogl_fast_fill_rectangle
|
||||
cogl_fast_fill_rectanglex
|
||||
cogl_fast_fill_trapezoid
|
||||
cogl_fast_fill_trapezoidx
|
||||
cogl_fill
|
||||
cogl_stroke
|
||||
cogl_path_move_to
|
||||
cogl_path_move_to_rel
|
||||
cogl_path_line_to
|
||||
cogl_path_line_to_rel
|
||||
cogl_path_h_line_to
|
||||
cogl_path_v_line_to
|
||||
cogl_path_h_line_to_rel
|
||||
cogl_path_v_line_to_rel
|
||||
cogl_path_arc
|
||||
cogl_path_arc_rel
|
||||
cogl_path_bezier2_to
|
||||
cogl_path_bezier2_to_rel
|
||||
cogl_path_bezier3_to
|
||||
cogl_path_bezier3_to_rel
|
||||
cogl_path_close
|
||||
cogl_line
|
||||
cogl_polyline
|
||||
cogl_polygon
|
||||
cogl_rectangle
|
||||
cogl_arc
|
||||
cogl_ellipse
|
||||
cogl_round_rectangle
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>cogl-texture</FILE>
|
||||
<TITLE>Textures</TITLE>
|
||||
CoglTextureVertex
|
||||
cogl_texture_new_with_size
|
||||
cogl_texture_new_from_file
|
||||
cogl_texture_new_from_data
|
||||
cogl_texture_new_from_foreign
|
||||
cogl_is_texture
|
||||
cogl_texture_get_width
|
||||
cogl_texture_get_height
|
||||
cogl_texture_get_format
|
||||
cogl_texture_get_rowstride
|
||||
cogl_texture_get_max_waste
|
||||
cogl_texture_get_min_filter
|
||||
cogl_texture_get_mag_filter
|
||||
cogl_texture_is_sliced
|
||||
cogl_texture_get_gl_texture
|
||||
cogl_texture_get_data
|
||||
cogl_texture_set_filters
|
||||
cogl_texture_set_region
|
||||
cogl_texture_ref
|
||||
cogl_texture_unref
|
||||
cogl_texture_rectangle
|
||||
cogl_texture_polygon
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>cogl-shaders</FILE>
|
||||
<TITLE>Shaders and Programmable Pipeline</TITLE>
|
||||
cogl_create_shader
|
||||
cogl_shader_destroy
|
||||
cogl_shader_source
|
||||
cogl_shader_compile
|
||||
cogl_shader_get_info_log
|
||||
cogl_shader_get_parameteriv
|
||||
<SUBSECTION>
|
||||
cogl_create_program
|
||||
cogl_program_destroy
|
||||
cogl_program_attach_shader
|
||||
cogl_program_link
|
||||
cogl_program_use
|
||||
cogl_program_get_uniform_location
|
||||
cogl_program_uniform_1f
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>cogl-offscreen</FILE>
|
||||
<TITLE>Offscreen Buffers</TITLE>
|
||||
cogl_offscreen_new_to_texture
|
||||
cogl_offscreen_new_multisample
|
||||
cogl_offscreen_ref
|
||||
cogl_offscreen_unref
|
||||
cogl_offscreen_blit
|
||||
cogl_offscreen_blit_region
|
||||
cogl_draw_buffer
|
||||
</SECTION>
|
||||
Reference in New Issue
Block a user