2012-01-31 12:03:14 -05:00
|
|
|
DOC_MODULE = clutter
|
|
|
|
|
DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.xml
|
2008-04-25 09:37:36 -04:00
|
|
|
|
|
|
|
|
# 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
|
2015-03-03 10:54:36 -05:00
|
|
|
DOC_SOURCE_DIR = $(top_srcdir)/clutter $(top_builddir)/clutter
|
2008-04-25 09:37:36 -04:00
|
|
|
|
|
|
|
|
# Extra options to pass to gtkdoc-scangobj. Not normally needed.
|
2012-01-31 12:03:14 -05:00
|
|
|
SCANGOBJ_OPTIONS = --type-init-func="clutter_base_init()"
|
2008-04-25 09:37:36 -04:00
|
|
|
|
|
|
|
|
# Extra options to supply to gtkdoc-scan.
|
Intial Re-layout of the Cogl source code and introduction of a Cogl Winsys
As part of an incremental process to have Cogl be a standalone project we
want to re-consider how we organise the Cogl source code.
Currently this is the structure I'm aiming for:
cogl/
cogl/
<put common source here>
winsys/
cogl-glx.c
cogl-wgl.c
driver/
gl/
gles/
os/ ?
utils/
cogl-fixed
cogl-matrix-stack?
cogl-journal?
cogl-primitives?
pango/
The new winsys component is a starting point for migrating window system
code (i.e. x11,glx,wgl,osx,egl etc) from Clutter to Cogl.
The utils/ and pango/ directories aren't added by this commit, but they are
noted because I plan to add them soon.
Overview of the planned structure:
* The winsys/ API is the API that binds OpenGL to a specific window system,
be that X11 or win32 etc. Example are glx, wgl and egl. Much of the logic
under clutter/{glx,osx,win32 etc} should migrate here.
* Note there is also the idea of a winsys-base that may represent a window
system for which there are multiple winsys APIs. An example of this is
x11, since glx and egl may both be used with x11. (currently only Clutter
has the idea of a winsys-base)
* The driver/ represents a specific varient of OpenGL. Currently we have "gl"
representing OpenGL 1.4-2.1 (mostly fixed function) and "gles" representing
GLES 1.1 (fixed funciton) and 2.0 (fully shader based)
* Everything under cogl/ should fundamentally be supporting access to the
GPU. Essentially Cogl's most basic requirement is to provide a nice GPU
Graphics API and drawing a line between this and the utility functionality
we add to support Clutter should help keep this lean and maintainable.
* Code under utils/ as suggested builds on cogl/ adding more convenient
APIs or mechanism to optimize special cases. Broadly speaking you can
compare cogl/ to OpenGL and utils/ to GLU.
* clutter/pango will be moved to clutter/cogl/pango
How some of the internal configure.ac/pkg-config terminology has changed:
backendextra -> CLUTTER_WINSYS_BASE # e.g. "x11"
backendextralib -> CLUTTER_WINSYS_BASE_LIB # e.g. "x11/libclutter-x11.la"
clutterbackend -> {CLUTTER,COGL}_WINSYS # e.g. "glx"
CLUTTER_FLAVOUR -> {CLUTTER,COGL}_WINSYS
clutterbackendlib -> CLUTTER_WINSYS_LIB
CLUTTER_COGL -> COGL_DRIVER # e.g. "gl"
Note: The CLUTTER_FLAVOUR and CLUTTER_COGL defines are kept for apps
As the first thing to take advantage of the new winsys component in Cogl;
cogl_get_proc_address() has been moved from cogl/{gl,gles}/cogl.c into
cogl/common/cogl.c and this common implementation first trys
_cogl_winsys_get_proc_address() but if that fails then it falls back to
gmodule.
2009-07-27 21:02:02 -04:00
|
|
|
# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
|
2015-03-15 12:05:10 -04:00
|
|
|
SCAN_OPTIONS =
|
2008-04-25 09:37:36 -04:00
|
|
|
|
|
|
|
|
# Extra options to supply to gtkdoc-mkdb.
|
|
|
|
|
# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
|
2014-03-17 19:11:29 -04:00
|
|
|
MKDB_OPTIONS = --output-format=xml --name-space=clutter
|
2008-04-25 09:37:36 -04:00
|
|
|
|
|
|
|
|
# Extra options to supply to gtkdoc-mktmpl
|
|
|
|
|
# e.g. MKTMPL_OPTIONS=--only-section-tmpl
|
2012-01-31 12:03:14 -05:00
|
|
|
MKTMPL_OPTIONS =
|
2008-04-25 09:37:36 -04:00
|
|
|
|
|
|
|
|
# Extra options to supply to gtkdoc-fixref. Not normally needed.
|
|
|
|
|
# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
|
2012-01-31 12:03:14 -05:00
|
|
|
FIXXREF_OPTIONS = \
|
2008-04-25 09:37:36 -04:00
|
|
|
--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/glib \
|
2009-09-09 11:15:54 -04:00
|
|
|
--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gobject \
|
|
|
|
|
--extra-dir=$(CAIRO_PREFIX)/share/gtk-doc/html/cairo \
|
2011-06-20 08:56:46 -04:00
|
|
|
--extra-dir=$(PANGO_PREFIX)/share/gtk-doc/html/pango \
|
|
|
|
|
--extra-dir=$(COGL_PREFIX)/share/gtk-doc/html/cogl
|
2008-04-25 09:37:36 -04:00
|
|
|
|
|
|
|
|
# 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
|
2012-01-31 12:03:14 -05:00
|
|
|
HFILE_GLOB = \
|
2011-06-20 08:56:46 -04:00
|
|
|
$(top_srcdir)/clutter/*.h \
|
2010-06-30 10:50:47 -04:00
|
|
|
$(top_builddir)/clutter/*.h \
|
2014-12-15 19:15:18 -05:00
|
|
|
$(top_srcdir)/clutter/deprecated/*.h \
|
2008-04-25 09:37:36 -04:00
|
|
|
$(top_srcdir)/clutter/x11/clutter-x11.h \
|
2009-03-18 13:06:56 -04:00
|
|
|
$(top_srcdir)/clutter/x11/clutter-x11-texture-pixmap.h \
|
2011-11-03 12:05:36 -04:00
|
|
|
$(top_srcdir)/clutter/x11/clutter-glx-texture-pixmap.h \
|
|
|
|
|
$(top_srcdir)/clutter/egl/clutter-egl.h \
|
2014-12-15 19:15:18 -05:00
|
|
|
$(top_builddir)/clutter/cex100/clutter-cex100.h \
|
2011-11-03 12:05:36 -04:00
|
|
|
$(top_srcdir)/clutter/win32/clutter-win32.h \
|
2011-12-20 08:32:37 -05:00
|
|
|
$(top_srcdir)/clutter/gdk/clutter-gdk.h \
|
2013-05-13 07:07:26 -04:00
|
|
|
$(top_srcdir)/clutter/wayland/clutter-wayland.h \
|
2011-12-20 08:32:37 -05:00
|
|
|
$(top_srcdir)/clutter/wayland/clutter-wayland-compositor.h \
|
2015-03-03 11:14:45 -05:00
|
|
|
$(top_srcdir)/clutter/wayland/clutter-wayland-surface.h \
|
|
|
|
|
$(top_srcdir)/clutter/mir/clutter-mir.h
|
2011-06-20 08:56:46 -04:00
|
|
|
|
2012-01-31 12:03:14 -05:00
|
|
|
CFILE_GLOB = \
|
2011-06-20 08:56:46 -04:00
|
|
|
$(top_srcdir)/clutter/*.c \
|
|
|
|
|
$(top_srcdir)/clutter/cogl/*.c \
|
2009-03-18 13:06:56 -04:00
|
|
|
$(top_srcdir)/clutter/x11/*.c \
|
2011-11-03 12:05:36 -04:00
|
|
|
$(top_srcdir)/clutter/win32/*.c \
|
|
|
|
|
$(top_srcdir)/clutter/gdk/*.c \
|
2011-11-10 13:01:48 -05:00
|
|
|
$(top_srcdir)/clutter/cex100/*.c \
|
2011-12-20 08:32:37 -05:00
|
|
|
$(top_srcdir)/clutter/egl/*.c \
|
2014-12-15 19:15:18 -05:00
|
|
|
$(top_srcdir)/clutter/wayland/*.c \
|
2015-03-12 13:39:26 -04:00
|
|
|
$(top_srcdir)/clutter/mir/*.c \
|
2014-12-15 19:15:18 -05:00
|
|
|
$(top_srcdir)/clutter/deprecated/*.c
|
2008-04-25 09:37:36 -04:00
|
|
|
|
|
|
|
|
# Header files to ignore when scanning.
|
|
|
|
|
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
|
2012-01-31 12:03:14 -05:00
|
|
|
IGNORE_HFILES = \
|
2012-08-07 04:39:04 -04:00
|
|
|
config.h \
|
2010-01-15 09:47:20 -05:00
|
|
|
clutter.h \
|
2010-05-19 11:10:05 -04:00
|
|
|
clutter-actor-meta-private.h \
|
2010-11-08 11:01:19 -05:00
|
|
|
clutter-actor-private.h \
|
|
|
|
|
clutter-backend-private.h \
|
2010-01-15 09:47:20 -05:00
|
|
|
clutter-bezier.h \
|
2012-02-23 06:50:43 -05:00
|
|
|
clutter-cogl-compat.h \
|
2010-04-06 05:54:20 -04:00
|
|
|
clutter-color-static.h \
|
2011-01-19 12:54:28 -05:00
|
|
|
clutter-config.h \
|
2014-12-14 09:20:53 -05:00
|
|
|
clutter-constraint-private.h \
|
2010-01-15 09:47:20 -05:00
|
|
|
clutter-debug.h \
|
|
|
|
|
clutter-deprecated.h \
|
2010-11-08 11:01:19 -05:00
|
|
|
clutter-device-manager-private.h \
|
2012-02-23 06:50:43 -05:00
|
|
|
clutter-easing.h \
|
2010-01-15 09:47:20 -05:00
|
|
|
clutter-enum-types.h \
|
2011-01-18 09:09:04 -05:00
|
|
|
clutter-event-translator.h \
|
2011-06-09 10:40:57 -04:00
|
|
|
clutter-flatten-effect.h \
|
2012-11-29 04:18:37 -05:00
|
|
|
clutter-gesture-action-private.h \
|
2010-01-15 09:47:20 -05:00
|
|
|
clutter-id-pool.h \
|
|
|
|
|
clutter-keysyms.h \
|
2010-09-10 08:41:49 -04:00
|
|
|
clutter-keysyms-compat.h \
|
2010-01-15 09:47:20 -05:00
|
|
|
clutter-keysyms-table.h \
|
|
|
|
|
clutter-marshal.h \
|
2015-03-03 11:14:45 -05:00
|
|
|
clutter-master-clock-default.h \
|
2010-01-15 09:47:20 -05:00
|
|
|
clutter-master-clock.h \
|
|
|
|
|
clutter-model-private.h \
|
2012-02-02 09:51:17 -05:00
|
|
|
clutter-paint-node-private.h \
|
2010-11-08 11:01:19 -05:00
|
|
|
clutter-paint-volume-private.h \
|
2010-01-15 09:47:20 -05:00
|
|
|
clutter-private.h \
|
|
|
|
|
clutter-script-private.h \
|
2014-09-15 11:42:54 -04:00
|
|
|
clutter-settings-private.h \
|
2010-11-08 11:01:19 -05:00
|
|
|
clutter-stage-manager-private.h \
|
|
|
|
|
clutter-stage-private.h \
|
2010-01-15 09:47:20 -05:00
|
|
|
clutter-stage-window.h \
|
|
|
|
|
clutter-timeout-interval.h \
|
2010-07-05 08:59:36 -04:00
|
|
|
cally \
|
2011-11-21 19:29:08 -05:00
|
|
|
cex100 \
|
2010-01-15 09:47:20 -05:00
|
|
|
cogl \
|
2011-11-03 12:05:36 -04:00
|
|
|
egl \
|
2010-12-09 10:06:12 -05:00
|
|
|
evdev \
|
2011-11-03 12:05:36 -04:00
|
|
|
gdk \
|
2015-03-03 11:14:45 -05:00
|
|
|
mir \
|
2010-01-15 09:47:20 -05:00
|
|
|
osx \
|
2011-11-03 12:05:36 -04:00
|
|
|
tslib \
|
2010-01-15 09:47:20 -05:00
|
|
|
x11 \
|
2010-11-08 11:01:19 -05:00
|
|
|
wayland \
|
2008-04-25 09:37:36 -04:00
|
|
|
win32
|
|
|
|
|
|
2012-01-31 12:03:14 -05:00
|
|
|
EXTRA_HFILES = \
|
2009-06-10 09:24:33 -04:00
|
|
|
$(top_srcdir)/clutter/x11/clutter-x11.h \
|
|
|
|
|
$(top_srcdir)/clutter/x11/clutter-x11-texture-pixmap.h \
|
2011-11-03 12:05:36 -04:00
|
|
|
$(top_srcdir)/clutter/x11/clutter-glx-texture-pixmap.h \
|
|
|
|
|
$(top_srcdir)/clutter/egl/clutter-egl.h \
|
2011-11-10 13:01:48 -05:00
|
|
|
$(top_srcdir)/clutter/cex100/clutter-cex100.h \
|
2011-11-03 12:05:36 -04:00
|
|
|
$(top_srcdir)/clutter/win32/clutter-win32.h \
|
2011-12-20 08:32:37 -05:00
|
|
|
$(top_srcdir)/clutter/gdk/clutter-gdk.h \
|
2013-05-13 07:07:26 -04:00
|
|
|
$(top_srcdir)/clutter/wayland/clutter-wayland.h \
|
2011-12-20 08:32:37 -05:00
|
|
|
$(top_srcdir)/clutter/wayland/clutter-wayland-compositor.h \
|
2015-03-12 13:39:26 -04:00
|
|
|
$(top_srcdir)/clutter/wayland/clutter-wayland-surface.h \
|
|
|
|
|
$(top_srcdir)/clutter/mir/clutter-mir.h
|
2008-04-25 09:37:36 -04:00
|
|
|
|
|
|
|
|
# Images to copy into HTML directory.
|
|
|
|
|
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
|
2012-01-31 12:03:14 -05:00
|
|
|
HTML_IMAGES = \
|
2008-04-25 09:37:36 -04:00
|
|
|
actor-box.png \
|
2012-02-29 10:05:44 -05:00
|
|
|
actor-example.png \
|
2010-02-25 12:09:55 -05:00
|
|
|
animator-key-frames.png \
|
2009-10-23 12:32:18 -04:00
|
|
|
bin-layout.png \
|
|
|
|
|
box-layout.png \
|
2010-11-15 10:02:07 -05:00
|
|
|
constraints-example.png \
|
2009-01-20 13:13:36 -05:00
|
|
|
easing-modes.png \
|
2008-04-25 09:37:36 -04:00
|
|
|
event-flow.png \
|
2012-02-29 10:12:55 -05:00
|
|
|
flow-layout.png \
|
2011-02-28 10:05:51 -05:00
|
|
|
path-alpha-func.png \
|
2012-02-29 10:12:55 -05:00
|
|
|
offscreen-redirect.png \
|
|
|
|
|
table-layout.png
|
2008-04-25 09:37:36 -04:00
|
|
|
|
2012-01-31 12:03:14 -05:00
|
|
|
# SVG used to generate the images above
|
|
|
|
|
SVG_IMAGES = \
|
|
|
|
|
animator-key-frames.svg \
|
|
|
|
|
easing-modes.svg
|
|
|
|
|
|
2008-04-25 09:37:36 -04:00
|
|
|
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
|
|
|
|
|
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
|
2012-01-31 12:03:14 -05:00
|
|
|
content_files = \
|
2009-09-03 11:51:14 -04:00
|
|
|
glossary.xml \
|
2008-06-26 05:02:58 -04:00
|
|
|
clutter-overview.xml \
|
2009-02-23 08:44:03 -05:00
|
|
|
building-clutter.xml \
|
2009-06-23 10:25:16 -04:00
|
|
|
running-clutter.xml \
|
2012-08-20 09:28:17 -04:00
|
|
|
migrating-ClutterAnimation.xml \
|
|
|
|
|
migrating-ClutterBehaviour.xml \
|
2009-09-09 11:01:07 -04:00
|
|
|
migrating-ClutterEffect.xml \
|
2012-08-20 09:28:17 -04:00
|
|
|
migrating-ClutterPath.xml
|
2008-04-25 09:37:36 -04:00
|
|
|
|
|
|
|
|
# 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
|
2012-01-31 12:03:14 -05:00
|
|
|
expand_content_files = \
|
2009-09-03 11:51:14 -04:00
|
|
|
glossary.xml \
|
2008-06-26 05:02:58 -04:00
|
|
|
clutter-overview.xml \
|
2009-02-23 08:44:03 -05:00
|
|
|
building-clutter.xml \
|
2009-06-23 10:25:16 -04:00
|
|
|
running-clutter.xml \
|
2012-08-20 09:28:17 -04:00
|
|
|
migrating-ClutterAnimation.xml \
|
|
|
|
|
migrating-ClutterBehaviour.xml \
|
2009-09-09 11:01:07 -04:00
|
|
|
migrating-ClutterEffect.xml \
|
2012-08-20 09:28:17 -04:00
|
|
|
migrating-ClutterPath.xml
|
2008-04-25 09:37:36 -04:00
|
|
|
|
|
|
|
|
# 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)
|
|
|
|
|
|
2013-05-15 10:18:13 -04:00
|
|
|
AM_CPPFLAGS = \
|
|
|
|
|
-I$(top_srcdir) \
|
|
|
|
|
-I$(top_srcdir)/clutter \
|
|
|
|
|
-I$(top_builddir) \
|
|
|
|
|
-I$(top_builddir)/clutter \
|
|
|
|
|
-DCLUTTER_DISABLE_DEPRECATION_WARNINGS
|
|
|
|
|
AM_CFLAGS = $(CLUTTER_CFLAGS)
|
2012-01-31 12:03:14 -05:00
|
|
|
GTKDOC_LIBS = $(top_builddir)/clutter/libclutter-@CLUTTER_API_VERSION@.la $(CLUTTER_LIBS)
|
2008-04-25 09:37:36 -04:00
|
|
|
|
|
|
|
|
# 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
|
2012-01-31 12:03:14 -05:00
|
|
|
EXTRA_DIST += $(HTML_IMAGES) $(SVG_IMAGES)
|
2015-03-03 11:14:45 -05:00
|
|
|
|
|
|
|
|
if ENABLE_GTK_DOC
|
|
|
|
|
TESTS_ENVIRONMENT = \
|
|
|
|
|
DOC_MODULE=$(DOC_MODULE) \
|
|
|
|
|
DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
|
|
|
|
|
SRCDIR=$(abs_srcdir) \
|
|
|
|
|
BUILDDIR=$(abs_builddir)
|
|
|
|
|
|
2015-03-12 13:40:24 -04:00
|
|
|
TESTS = $(GTKDOC_CHECK)
|
2015-03-03 11:14:45 -05:00
|
|
|
endif
|