[gtkglarea/jjardon/namespace_change: 3/4] docs: Change docs to new namespace



commit 363cb3c4eacb68191d5e9cbaf53548ecca1a39dd
Author: Javier Jardón <jjardon gnome org>
Date:   Wed Mar 26 20:45:59 2014 +0000

    docs: Change docs to new namespace

 docs/HOWTO.txt     |   16 +++++-----
 docs/gdkgl.txt     |   76 ++++++++++++++++++++++++++--------------------------
 docs/gtkglarea.txt |   28 +++++++++---------
 3 files changed, 60 insertions(+), 60 deletions(-)
---
diff --git a/docs/HOWTO.txt b/docs/HOWTO.txt
index 5b14045..e221696 100644
--- a/docs/HOWTO.txt
+++ b/docs/HOWTO.txt
@@ -15,8 +15,8 @@
     Your widget needs an OpenGL capable visual.
     The widget must also have an X window (not all widgets have it).
 
-    /* get visual using gdk_gl_choose_visual */
-    visual = gdk_gl_choose_visual(visual_attributes);
+    /* get visual using ggla_choose_visual */
+    visual = ggla_choose_visual(visual_attributes);
 
     /* create your widget */
     widget = gtk_foobar_new();
@@ -30,26 +30,26 @@
 
     Create a GL context and connect it to the widget's GdkDrawable.
 
-    context = gdk_gl_context(visual);
+    context = ggla_context(visual);
 
     /* connect to gdk window of widget */
-    if (gdk_gl_make_current(widget->window, context)) {
+    if (ggla_make_current(widget->window, context)) {
         /* do opengl stuff... */
 
     }
 
 
 
-6. Can I use gdk_gl functions and GtkGLArea widget in the same program?
+6. Can I use gdk_gl functions and GglaWidget widget in the same program?
 
-    Yes, just remember that gtk_gl_area_make_current() makes the GtkGLArea
+    Yes, just remember that ggla_widgetmake_current() makes the GglaWidget
     widget's internal context the current context and leaves it so.
 
 
 
-7. How do I capture keypress events for GtkGLArea widget?
+7. How do I capture keypress events for GglaWidget widget?
 
-    This is not a GtkGLArea specific question, but here is a solution:
+    This is not a GglaWidget specific question, but here is a solution:
 
     - Set an event mask:
          gtk_widget_set_events(glarea, GDK_KEY_PRESS_MASK);
diff --git a/docs/gdkgl.txt b/docs/gdkgl.txt
index 624193b..54e96a9 100644
--- a/docs/gdkgl.txt
+++ b/docs/gdkgl.txt
@@ -1,5 +1,5 @@
 
-gdk_gl_* functions
+ggla_* functions
        Quite straightforward wrapper around few necessary GLX calls and
        should be easy to understand if you already know GLX.
 
@@ -7,13 +7,13 @@ gdk_gl_* functions
 ---------------------------------------------------------------
 
 NAME
-       gdk_gl_query - query for OpenGL capability
+       ggla_query - query for OpenGL capability
 
 C SPECIFICATION
-       gint gdk_gl_query( void )
+       gint ggla_query( void )
 
 DESCRIPTION
-       gdk_gl_query returns TRUE if OpenGL is supported.
+       ggla_query returns TRUE if OpenGL is supported.
 
 SEE ALSO
        glXQueryExtension
@@ -22,10 +22,10 @@ SEE ALSO
 ---------------------------------------------------------------
 
 NAME
-       gdk_gl_choose_visual - return visual that matches given attributes
+       ggla_choose_visual - return visual that matches given attributes
 
 C SPECIFICATION
-       GdkVisual *gdk_gl_choose_visual( int *attrList )
+       GdkVisual *ggla_choose_visual( int *attrList )
 
 PARAMETERS
 
@@ -42,15 +42,15 @@ DESCRIPTION
 
 SEE ALSO
        glXChooseVisual
-       gdk_gl_context_share_new
+       ggla_context_share_new
        
 ---------------------------------------------------------------
 
 NAME
-       gdk_gl_get_config - return information about visuals
+       ggla_get_config - return information about visuals
 
 C SPECIFICATION
-       gint gdk_gl_get_config( GdkVisual *visual, int attrib )
+       gint ggla_get_config( GdkVisual *visual, int attrib )
 
 PARAMETERS
 
@@ -61,8 +61,8 @@ attrib
        Specifies visual attribute to be returned
 
 DESCRIPTION
-       gdk_gl_get_config return value of attrib of windows or
-       gl pixmap created with respect to visual. gdk_gl_get_config
+       ggla_get_config return value of attrib of windows or
+       gl pixmap created with respect to visual. ggla_get_config
        returns -1 if it fails. For explanation of attributes see
        glXGetConfig man page. Note that GLX_ prefix is changed to
        GDK_GL_.
@@ -75,10 +75,10 @@ SEE ALSO
 
 
 NAME
-       gdk_gl_context_new - create new OpenGL rendering context
+       ggla_context_new - create new OpenGL rendering context
 
 C SPECIFICATION
-       GdkGLContext *gdk_gl_context_new( GdkVisual *visual )
+       GglaContext *ggla_context_new( GdkVisual *visual )
 
 PARAMETERS
 
@@ -88,22 +88,22 @@ visual
 
 DESCRIPTION
        This is backwards compatability/convinence
-       function equal to gdk_gl_context_share_new(visual, NULL, FALSE).
+       function equal to ggla_context_share_new(visual, NULL, FALSE).
 
 SEE ALSO
        glXCreateContext
-       gdk_gl_choosevisual
-       gdk_gl_context_share_new
+       ggla_choosevisual
+       ggla_context_share_new
 
 
 ---------------------------------------------------------------
 
 NAME
-       gdk_gl_context_share_new - create new rendering context
+       ggla_context_share_new - create new rendering context
 
 C SPECIFICATION
-       GdkGLContext *gdk_gl_context_share_new( GdkVisual *visual,
-                                               GdkGLContext *sharelist,
+       GglaContext *ggla_context_share_new( GdkVisual *visual,
+                                               GglaContext *sharelist,
                                                gint direct )
 
 
@@ -123,41 +123,41 @@ direct
 
 
 DESCRIPTION
-       gdk_gl_context_share_new creates new rendering context
+       ggla_context_share_new creates new rendering context
        with reference count of 1 and returns pointer to it.
        If context creation fails NULL is returned.
 
 SEE ALSO
        glXCreateContext
-       gdk_gl_context_new
-       gdk_gl_choose_visual
+       ggla_context_new
+       ggla_choose_visual
 
 ---------------------------------------------------------------
 
 NAME
-       gdk_gl_make_current - attach context to drawable
+       ggla_make_current - attach context to drawable
 
 C SPECIFICATION
-       gint gdk_gl_make_current( GdkDrawable *drawable,
-                                 GdkGLContext *context )
+       gint ggla_make_current( GdkDrawable *drawable,
+                                 GglaContext *context )
 DESCRIPTION
-       gdk_gl_make_current makes context current OpenGL rendering
+       ggla_make_current makes context current OpenGL rendering
        context, and it attaches context to gdk drawable. Drawable
        must have underlying X window and be created with the same
-       visual as context. gdk_gl_make_current returns TRUE if
+       visual as context. ggla_make_current returns TRUE if
        successful.
 
 SEE ALSO
        glXMakeCurrent
-       gdk_gl_pixmap_make_current
+       ggla_pixmap_make_current
 
 ---------------------------------------------------------------
 
 NAME
-       gdk_gl_swap_buffers - exchange front and back buffers
+       ggla_swap_buffers - exchange front and back buffers
 
 C SPECIFICATION
-       void gdk_gl_swap_buffers( GdkDrawable *drawable )
+       void ggla_swap_buffers( GdkDrawable *drawable )
 
 DESCRIPTION
        Promotes back buffer of drawable to front.
@@ -169,33 +169,33 @@ SEE ALSO
 ---------------------------------------------------------------
 
 NAME
-       gdk_gl_wait_gdk - complete gdk execution
+       ggla_wait_gdk - complete gdk execution
 
 C SRECIFICATION
-       void gdk_gl_wait_gdk( void )
+       void ggla_wait_gdk( void )
 
 DESCRIPTION
        Gdk rendering calls made prior to gtk_gl_wait_gdk are
        guarateed to be executed before OpenGL calls made
-       after gdk_gl_wait_gdk.
+       after ggla_wait_gdk.
 
 SEE ALSO
        glXWaitX
-       gdk_gl_wait_gl
+       ggla_wait_gl
 
 ---------------------------------------------------------------
 
 NAME
-       gdk_gl_wait_gl - complete OpenGL execution
+       ggla_wait_gl - complete OpenGL execution
 
 C SRECIFICATION
-       void gdk_gl_wait_gl( void )
+       void ggla_wait_gl( void )
 
 DESCRIPTION
        OpenGL rendering calls made prior to gtk_gl_wait_gdk are
        are guarateed to be executed before OpenGL calls made
-       after gdk_gl_wait_gdk.
+       after ggla_wait_gdk.
 
 SEE ALSO
        glXWaitGL
-       gdk_gl_wait_gdk
+       ggla_wait_gdk
diff --git a/docs/gtkglarea.txt b/docs/gtkglarea.txt
index ee3b90a..4d90bd6 100644
--- a/docs/gtkglarea.txt
+++ b/docs/gtkglarea.txt
@@ -1,4 +1,4 @@
-GtkGLArea widget is derived from GtkDrawingArea widget.
+GglaWidget widget is derived from GtkDrawingArea widget.
 
 examples/simple.c is a good starting point.
 
@@ -6,9 +6,9 @@ examples/simple.c is a good starting point.
 ---------------------------------------------------------
 C SPECIFICATION
 
-GtkWidget* gtk_gl_area_new(int *attrList)
-GtkWidget* gtk_gl_area_share_new(int *attrList, GtkGLArea *share)
-GtkWidget* gtk_gl_area_new_vargs(GtkGLArea *share, ...)
+GtkWidget* ggla_widgetnew(int *attrList)
+GtkWidget* ggla_widgetshare_new(int *attrList, GglaWidget *share)
+GtkWidget* ggla_widgetnew_vargs(GglaWidget *share, ...)
 
 PARAMETERS
 
@@ -29,14 +29,14 @@ DESCRIPTION
        requested type and GLX context is created for this widget. You
        can't do opengl calls on widget until it has X window. X window
        is not created until widget is realized.
-       gtk_gl_area_new_vargs takes attrList as variable arguments,
+       ggla_widgetnew_vargs takes attrList as variable arguments,
        last argument must still be zero.
 
 ---------------------------------------------------------
 
 C SPECIFICATION
 
-gint gtk_gl_area_make_current(GtkGLArea *gl_area)
+gint ggla_widgetmake_current(GglaWidget *gl_area)
 
 PARAMETERS
 
@@ -44,26 +44,26 @@ gl_area
        Specifies a gtkglarea widget.
 
 DESCRIPTION
-       gtk_gl_area_make_current must be called before rendering into
+       ggla_widgetmake_current must be called before rendering into
        OpenGL widget, it returns TRUE if rendering to widget is
        possible. Rendering is not possible if widget is not
-       GtkGLArea widget or widget is not realized.
+       GglaWidget widget or widget is not realized.
 
 ---------------------------------------------------------
 
 C SPECIFICATION
-void gtk_gl_area_swap_buffers(GtkGLArea *gl_area)
-void gtk_gl_area_swapbuffers(GtkGLArea *gl_area)
+void ggla_widgetswap_buffers(GglaWidget *gl_area)
+void ggla_widgetswapbuffers(GglaWidget *gl_area)
 
 PARAMETERS
 
 gl_area
-       Specifies a GtkGLArea widget.
+       Specifies a GglaWidget widget.
 
 DESCRIPTION
-       *** gtk_gl_area_swapbuffers is deprecated (wrong spelling), use
-       gtk_gl_area_swap_buffers ***
-       Wrapper around gdk_gl_swap_buffers. Promotes contents of back buffer
+       *** ggla_widgetswapbuffers is deprecated (wrong spelling), use
+       ggla_widgetswap_buffers ***
+       Wrapper around ggla_swap_buffers. Promotes contents of back buffer
        of widget to front buffer. The contents of front buffer become
        undefined.
 


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]