2008-03-26 Neil Roberts <neil@o-hand.com>

* clutter/win32/clutter-win32.h: Added gtk-doc documentation for
	the Win32 backend section.

	* clutter/win32/clutter-stage-win32.c
	(clutter_win32_get_stage_window): Fixed punctuation in the
	documentation.

	* README: Added notes about the Win32 backend.

2008-03-26  Neil Roberts  <neil@o-hand.com>

	* clutter-sections.txt: Added a section for the Win32 specific
	API.

	* clutter-docs.sgml: Added comments about the Win32 backend.

	* Makefile.am: Added bits to ignore the headers for the Win32
	backend.
This commit is contained in:
Neil Roberts 2008-03-26 22:22:32 +00:00
parent 9b52136be4
commit dd7ff3e829
8 changed files with 68 additions and 9 deletions

View File

@ -1,3 +1,14 @@
2008-03-26 Neil Roberts <neil@o-hand.com>
* clutter/win32/clutter-win32.h: Added gtk-doc documentation for
the Win32 backend section.
* clutter/win32/clutter-stage-win32.c
(clutter_win32_get_stage_window): Fixed punctuation in the
documentation.
* README: Added notes about the Win32 backend.
2008-03-26 Neil Roberts <neil@o-hand.com> 2008-03-26 Neil Roberts <neil@o-hand.com>
* clutter/win32/clutter-event-win32.c (clutter_event_check): * clutter/win32/clutter-event-win32.c (clutter_event_check):

9
README
View File

@ -10,7 +10,7 @@ Clutter currently requires:
* GdkPixbuf * GdkPixbuf
* Pango >= 1.18 * Pango >= 1.18
* OpenGL >= 1.2 or OpenGL ES 1.1 * OpenGL >= 1.2 or OpenGL ES 1.1
* GLX, SDL or an EGL Implementation * GLX, SDL, WGL or an EGL Implementation
The official website is: The official website is:
http://www.clutter-project.org http://www.clutter-project.org
@ -53,7 +53,7 @@ See the INSTALL file. Info on specific Clutter options;
Assume target hardware has no floating point unit. Useful only Assume target hardware has no floating point unit. Useful only
for embedded targets such as ARM. for embedded targets such as ARM.
--with-flavour=[glx/eglx/eglnative/sdl/osx] --with-flavour=[glx/eglx/eglnative/sdl/osx/win32]
Select the Clutter backend: (default=glx) Select the Clutter backend: (default=glx)
glx: Fully featured GLX backend. Using Open GL. glx: Fully featured GLX backend. Using Open GL.
@ -71,6 +71,9 @@ See the INSTALL file. Info on specific Clutter options;
osx: OS X backend. (experimental) osx: OS X backend. (experimental)
win32:
Windows WGL backend
VERSIONING VERSIONING
==== ====
@ -142,6 +145,8 @@ wanting to port to newer releases (See NEWS for general new feature info).
Release Notes for Clutter 0.8 Release Notes for Clutter 0.8
------------------------------- -------------------------------
* There is now an experimental native Win32 WGL backend.
* Some more focused timeline unit tests have been added and some tweaks to * Some more focused timeline unit tests have been added and some tweaks to
timeline semantics were made; E.g. For a 10 frame timeline here are some timeline semantics were made; E.g. For a 10 frame timeline here are some
points about the semantics: points about the semantics:

View File

@ -585,7 +585,7 @@ clutter_stage_win32_init (ClutterStageWin32 *stage)
* clutter_win32_get_stage_window: * clutter_win32_get_stage_window:
* @stage: a #ClutterStage * @stage: a #ClutterStage
* *
* Gets the stages window handle * Gets the stage's window handle
* *
* Return value: An HWND for the stage window. * Return value: An HWND for the stage window.
* *

View File

@ -23,6 +23,17 @@
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/**
* SECTION:clutter-win32
* @short_description: Win32 specific API
*
* The Win32 backend for Clutter provides some specific API, allowing
* integration with the Win32 API for embedding and manipulating the
* stage window.
*
* The ClutterWin32 API is available since Clutter 0.8
*/
#ifndef __CLUTTER_WIN32_H__ #ifndef __CLUTTER_WIN32_H__
#define __CLUTTER_WIN32_H__ #define __CLUTTER_WIN32_H__

View File

@ -1,3 +1,13 @@
2008-03-26 Neil Roberts <neil@o-hand.com>
* clutter-sections.txt: Added a section for the Win32 specific
API.
* clutter-docs.sgml: Added comments about the Win32 backend.
* Makefile.am: Added bits to ignore the headers for the Win32
backend.
2008-03-18 Emmanuele Bassi <ebassi@openedhand.com> 2008-03-18 Emmanuele Bassi <ebassi@openedhand.com>
* clutter-section.txt: Update after API change in ClutterScore. * clutter-section.txt: Update after API change in ClutterScore.

View File

@ -47,7 +47,8 @@ FIXXREF_OPTIONS=\
# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
HFILE_GLOB=$(top_srcdir)/clutter/*.h \ HFILE_GLOB=$(top_srcdir)/clutter/*.h \
$(top_srcdir)/clutter/x11/clutter-x11.h $(top_srcdir)/clutter/x11/clutter-x11.h \
$(top_srcdir)/clutter/win32/clutter-win32.h
CFILE_GLOB=$(top_srcdir)/clutter/*.c CFILE_GLOB=$(top_srcdir)/clutter/*.c
# Header files to ignore when scanning. # Header files to ignore when scanning.
@ -75,10 +76,12 @@ IGNORE_HFILES=\
x11 \ x11 \
json \ json \
pango \ pango \
sdl sdl \
win32
EXTRA_HFILES=\ EXTRA_HFILES=\
../../clutter/x11/clutter-x11.h ../../clutter/x11/clutter-x11.h \
../../clutter/win32/clutter-win32.h
# Images to copy into HTML directory. # Images to copy into HTML directory.
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png

View File

@ -147,7 +147,7 @@
</listitem> </listitem>
<term>Backend Windowing System Library</term> <term>Backend Windowing System Library</term>
<listitem> <listitem>
<para>GLX, EGL (1.1), SDL and Cocoa (OS X)</para> <para>GLX, EGL (1.1), SDL, Cocoa (OS X) and WGL (Windows)</para>
</listitem> </listitem>
<term>Graphics Rendering </term> <term>Graphics Rendering </term>
<listitem> <listitem>
@ -260,7 +260,20 @@
will need to first install the required dependencies. will need to first install the required dependencies.
</para> </para>
<para> <para>
Clutter on Windows currently uses the SDL backend for windowing There are currently two backends that are supported on
Windows. One uses the Win32 and WGL APIs directly and the
other is built on top of SDL. You must choose one of the
backends when running the configure script using the
following argument:
<variablelist>
<varlistentry>
<term>--with-flavour=[win32/sdl]</term>
<listitem>
<para>Select the Clutter backend; default=glx.
</para>
</listitem>
</varlistentry>
</variablelist>
</para> </para>
</section> </section>
@ -410,7 +423,7 @@
<xi:include href="xml/clutter-backend.xml"/> <xi:include href="xml/clutter-backend.xml"/>
<xi:include href="xml/clutter-x11.xml"/> <xi:include href="xml/clutter-x11.xml"/>
<xi:include href="xml/clutter-win32.xml"/>
</part> </part>
<part> <part>

View File

@ -1005,6 +1005,12 @@ clutter_x11_add_filter
clutter_x11_remove_filter clutter_x11_remove_filter
</SECTION> </SECTION>
<SECTION>
<FILE>clutter-win32</FILE>
<TITLE>Win32 Specific Support</TITLE>
clutter_win32_get_stage_window
</SECTION>
<SECTION> <SECTION>
<FILE>clutter-version</FILE> <FILE>clutter-version</FILE>
<TITLE>Versioning Macros</TITLE> <TITLE>Versioning Macros</TITLE>