gtkD/srcgl/glgdk/GLWindow.d

   1 /*
   2  * This file is part of gtkD.
   3  *
   4  * gtkD is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU Lesser General Public License as published by
   6  * the Free Software Foundation; either version 2.1 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * gtkD is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public License
  15  * along with gtkD; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17  */
  18
  19 // generated automatically - do not change
  20 // find conversion definition on APILookup.txt
  21 // implement new conversion functionalities on the wrap.utils pakage
  22
  23 /*
  24  * Conversion parameters:
  25  * inFile  = gtkglext-gdkglwindow.html
  26  * outPack = glgdk
  27  * outFile = GLWindow
  28  * strct   = GdkGLWindow
  29  * realStrct=
  30  * ctorStrct=
  31  * clss    = GLWindow
  32  * interf  =
  33  * class Code: No
  34  * interface Code: No
  35  * template for:
  36  * extend  =
  37  * implements:
  38  * prefixes:
  39  *      - gdk_gl_window_
  40  * omit structs:
  41  * omit prefixes:
  42  * omit code:
  43  * imports:
  44  *      - glgdk.GLConfig
  45  * structWrap:
  46  *      - GdkGLCondif* -> GLConfig
  47  * module aliases:
  48  * local aliases:
  49  */
  50
  51 module glgdk.GLWindow;
  52
  53 version(noAssert)
  54 {
  55         version(Tango)
  56         {
  57                 import tango.io.Stdout; // use the tango loging?
  58         }
  59 }
  60
  61 private import gtkglc.glgdktypes;
  62
  63 private import gtkglc.glgdk;
  64
  65
  66 private import glgdk.GLConfig;
  67
  68
  69
  70
  71 /**
  72  * Description
  73  */
  74 private import gdk.Drawable;
  75 public class GLWindow : Drawable
  76 {
  77
  78         /** the main Gtk struct */
  79         protected GdkGLWindow* gdkGLWindow;
  80
  81
  82         public GdkGLWindow* getGLWindowStruct()
  83         {
  84                 return gdkGLWindow;
  85         }
  86
  87
  88         /** the main Gtk struct as a void* */
  89         protected void* getStruct()
  90         {
  91                 return cast(void*)gdkGLWindow;
  92         }
  93
  94         /**
  95          * Sets our main struct and passes it to the parent class
  96          */
  97         public this (GdkGLWindow* gdkGLWindow)
  98         {
  99                 version(noAssert)
 100                 {
 101                         if ( gdkGLWindow is null )
 102                         {
 103                                 int zero = 0;
 104                                 version(Tango)
 105                                 {
 106                                         Stdout("struct gdkGLWindow is null on constructor").newline;
 107                                 }
 108                                 else
 109                                 {
 110                                         printf("struct gdkGLWindow is null on constructor");
 111                                 }
 112                                 zero = zero / zero;
 113                         }
 114                 }
 115                 else
 116                 {
 117                         assert(gdkGLWindow !is null, "struct gdkGLWindow is null on constructor");
 118                 }
 119                 super(cast(GdkDrawable*)gdkGLWindow);
 120                 this.gdkGLWindow = gdkGLWindow;
 121         }
 122
 123         /**
 124          */
 125
 126
 127         /**
 128          * Creates an on-screen rendering area.
 129          * attrib_list is currently unused. This must be set to NULL or empty
 130          * (first attribute of None). See GLX 1.3 spec.
 131          * glconfig:
 132          *  a GdkGLConfig.
 133          * window:
 134          *  the GdkWindow to be used as the rendering area.
 135          * attrib_list:
 136          *  this must be set to NULL or empty (first attribute of None).
 137          * Returns:
 138          *  the new GdkGLWindow.
 139          */
 140         public this (GdkGLConfig* glconfig, GdkWindow* window, int* attribList)
 141         {
 142                 // GdkGLWindow* gdk_gl_window_new (GdkGLConfig *glconfig,  GdkWindow *window,  const int *attrib_list);
 143                 this(cast(GdkGLWindow*)gdk_gl_window_new(glconfig, window, attribList) );
 144         }
 145
 146         /**
 147          * Destroys the OpenGL resources associated with glwindow and
 148          * decrements glwindow's reference count.
 149          * glwindow:
 150          *  a GdkGLWindow.
 151          */
 152         public void destroy()
 153         {
 154                 // void gdk_gl_window_destroy (GdkGLWindow *glwindow);
 155                 gdk_gl_window_destroy(gdkGLWindow);
 156         }
 157
 158         /**
 159          * Returns the GdkWindow associated with glwindow.
 160          * Notice that GdkGLWindow is not GdkWindow, but another
 161          * GdkDrawable which have an associated GdkWindow.
 162          * glwindow:
 163          *  a GdkGLWindow.
 164          * Returns:
 165          *  the GdkWindow associated with glwindow.
 166          */
 167         public GdkWindow* getWindow()
 168         {
 169                 // GdkWindow* gdk_gl_window_get_window (GdkGLWindow *glwindow);
 170                 return gdk_gl_window_get_window(gdkGLWindow);
 171         }
 172
 173         /**
 174          * Set the OpenGL-capability to the window.
 175          * This function creates a new GdkGLWindow held by the window.
 176          * attrib_list is currently unused. This must be set to NULL or empty
 177          * (first attribute of None).
 178          * window:
 179          *  the GdkWindow to be used as the rendering area.
 180          * glconfig:
 181          *  a GdkGLConfig.
 182          * attrib_list:
 183          *  this must be set to NULL or empty (first attribute of None).
 184          * Returns:
 185          *  the GdkGLWindow used by the window if it is successful,
 186          *  NULL otherwise.
 187          */
 188         public static GdkGLWindow* gdkWindowSetGLCapability(GdkWindow* window, GdkGLConfig* glconfig, int* attribList)
 189         {
 190                 // GdkGLWindow* gdk_window_set_gl_capability (GdkWindow *window,  GdkGLConfig *glconfig,  const int *attrib_list);
 191                 return gdk_window_set_gl_capability(window, glconfig, attribList);
 192         }
 193
 194         /**
 195          * Unset the OpenGL-capability of the window.
 196          * This function destroys the GdkGLWindow held by the window.
 197          * window:
 198          *  a GdkWindow.
 199          */
 200         public static void gdkWindowUnsetGLCapability(GdkWindow* window)
 201         {
 202                 // void gdk_window_unset_gl_capability (GdkWindow *window);
 203                 gdk_window_unset_gl_capability(window);
 204         }
 205
 206         /**
 207          * Returns whether the window is OpenGL-capable.
 208          * window:
 209          *  a GdkWindow.
 210          * Returns:
 211          *  TRUE if the window is OpenGL-capable, FALSE otherwise.
 212          */
 213         public static int gdkWindowIsGLCapable(GdkWindow* window)
 214         {
 215                 // gboolean gdk_window_is_gl_capable (GdkWindow *window);
 216                 return gdk_window_is_gl_capable(window);
 217         }
 218
 219         /**
 220          * Returns the GdkGLWindow held by the window.
 221          * window:
 222          *  a GdkWindow.
 223          * Returns:
 224          *  the GdkGLWindow.
 225          */
 226         public static GdkGLWindow* gdkWindowGetGLWindow(GdkWindow* window)
 227         {
 228                 // GdkGLWindow* gdk_window_get_gl_window (GdkWindow *window);
 229                 return gdk_window_get_gl_window(window);
 230         }
 231
 232 }