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.

diff --git a/ChangeLog b/ChangeLog
index 876f398..cd580f6 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,16 @@
 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/win32/clutter-event-win32.c (clutter_event_check):
        Removed the pointless parameter in the call to check_msg_pending.
        (check_msg_pending): Fixed to use PeekMessageW instead of

diff --git a/README b/README
index 89e6226..83d024a 100644 (file)
--- a/README
+++ b/README
@@ -10,7 +10,7 @@ Clutter currently requires:
   * GdkPixbuf
   * Pango >= 1.18
   * 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:                
    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
        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)
 
          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)
 
+          win32:
+                Windows WGL backend
+
 
 VERSIONING
 ====
@@ -142,6 +145,8 @@ wanting to port to newer releases (See NEWS for general new feature info).
 
 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
   timeline semantics were made; E.g. For a 10 frame timeline here are some
   points about the semantics:

diff --git a/clutter/win32/clutter-stage-win32.c b/clutter/win32/clutter-stage-win32.c
index 256e49e..bd6fa18 100644 (file)
--- a/clutter/win32/clutter-stage-win32.c
+++ b/clutter/win32/clutter-stage-win32.c
@@ -585,7 +585,7 @@ clutter_stage_win32_init (ClutterStageWin32 *stage)
  * clutter_win32_get_stage_window:
  * @stage: a #ClutterStage
  *
- * Gets the stages window handle
+ * Gets the stage's window handle
  *
  * Return value: An HWND for the stage window.
  *

diff --git a/clutter/win32/clutter-win32.h b/clutter/win32/clutter-win32.h
index 6997d8f..3f9019b 100644 (file)
--- a/clutter/win32/clutter-win32.h
+++ b/clutter/win32/clutter-win32.h
@@ -23,6 +23,17 @@
  * 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__
 #define __CLUTTER_WIN32_H__
 

diff --git a/doc/reference/ChangeLog b/doc/reference/ChangeLog
index f74f9ca..244977a 100644 (file)
--- a/doc/reference/ChangeLog
+++ b/doc/reference/ChangeLog
@@ -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>
 
        * clutter-section.txt: Update after API change in ClutterScore.

diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
index 84c4257..e9b5d65 100644 (file)
--- a/doc/reference/Makefile.am
+++ b/doc/reference/Makefile.am
@@ -47,7 +47,8 @@ FIXXREF_OPTIONS=\
 # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
 # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
 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
 
 # Header files to ignore when scanning.
@@ -75,10 +76,12 @@ IGNORE_HFILES=\
        x11 \
        json \
        pango \
-       sdl
+       sdl \
+       win32
 
 EXTRA_HFILES=\
-        ../../clutter/x11/clutter-x11.h
+        ../../clutter/x11/clutter-x11.h \
+       ../../clutter/win32/clutter-win32.h
 
 # Images to copy into HTML directory.
 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png

diff --git a/doc/reference/clutter-docs.sgml b/doc/reference/clutter-docs.sgml
index 52ab5d1..444cc25 100644 (file)
--- a/doc/reference/clutter-docs.sgml
+++ b/doc/reference/clutter-docs.sgml
@@ -147,7 +147,7 @@
           </listitem>
           <term>Backend Windowing System Library</term>
           <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>
           <term>Graphics Rendering </term>
           <listitem>
@@ -260,7 +260,20 @@
             will need to first install the required dependencies.
             </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>
       </section>
 
@@ -410,7 +423,7 @@
 
     <xi:include href="xml/clutter-backend.xml"/>
     <xi:include href="xml/clutter-x11.xml"/>
-
+    <xi:include href="xml/clutter-win32.xml"/>
   </part>
 
   <part>

diff --git a/doc/reference/clutter-sections.txt b/doc/reference/clutter-sections.txt
index 9575f72..c618ff7 100644 (file)
--- a/doc/reference/clutter-sections.txt
+++ b/doc/reference/clutter-sections.txt
@@ -1006,6 +1006,12 @@ clutter_x11_remove_filter
 </SECTION>
 
 <SECTION>
+<FILE>clutter-win32</FILE>
+<TITLE>Win32 Specific Support</TITLE>
+clutter_win32_get_stage_window
+</SECTION>
+
+<SECTION>
 <FILE>clutter-version</FILE>
 <TITLE>Versioning Macros</TITLE>
 CLUTTER_MAJOR_VERSION