srcgl/glgdk/GLPixmap.d

   1 /*
   2  * This file is part of duit.
   3  *
   4  * duit 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  * duit 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 duit; 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  = /usr/share/doc/libgtkglext1-doc/html/gtkglext/gtkglext-gdkglpixmap.html
  26  * outPack = glgdk
  27  * outFile = GLPixmap
  28  * strct   = GdkGLPixmap
  29  * realStrct=
  30  * ctorStrct=
  31  * clss    = GLPixmap
  32  * interf  =
  33  * class Code: No
  34  * interface Code: No
  35  * template for:
  36  * extend  =
  37  * implements:
  38  * prefixes:
  39  *      - gdk_gl_pixmap_
  40  * omit structs:
  41  * omit prefixes:
  42  * omit code:
  43  * imports:
  44  *      - glgdk.GLConfig
  45  * structWrap:
  46  *      - GdkGLCondif* -> GLConfig
  47  * local aliases:
  48  */
  49
  50 module glgdk.GLPixmap;
  51
  52 private import glgdk.glgdktypes;
  53
  54 private import lib.glgdk;
  55
  56 private import glgdk.GLConfig;
  57
  58 /**
  59  * Description
  60  */
  61 private import gdk.Drawable;
  62 public class GLPixmap : Drawable
  63 {
  64
  65         /** the main Gtk struct */
  66         protected GdkGLPixmap* gdkGLPixmap;
  67
  68
  69         public GdkGLPixmap* getGLPixmapStruct()
  70         {
  71                 return gdkGLPixmap;
  72         }
  73
  74
  75         /** the main Gtk struct as a void* */
  76         protected void* getStruct()
  77         {
  78                 return cast(void*)gdkGLPixmap;
  79         }
  80
  81         /**
  82          * Sets our main struct and passes it to the parent class
  83          */
  84         public this (GdkGLPixmap* gdkGLPixmap)
  85         {
  86                 super(cast(GdkDrawable*)gdkGLPixmap);
  87                 this.gdkGLPixmap = gdkGLPixmap;
  88         }
  89
  90         /**
  91          */
  92
  93
  94         /**
  95          * Creates an off-screen rendering area.
  96          * attrib_list is currently unused. This must be set to NULL or empty
  97          * (first attribute of None). See GLX 1.3 spec.
  98          * glconfig : a GdkGLConfig.
  99          * pixmap : the GdkPixmap to be used as the rendering area.
 100          * attrib_list : this must be set to NULL or empty (first attribute of None).
 101          * Returns : the new GdkGLPixmap.
 102          */
 103         public this (GdkGLConfig* glconfig, GdkPixmap* pixmap, int* attribList)
 104         {
 105                 // GdkGLPixmap* gdk_gl_pixmap_new (GdkGLConfig *glconfig,  GdkPixmap *pixmap,  const int *attrib_list);
 106                 this(cast(GdkGLPixmap*)gdk_gl_pixmap_new(glconfig, pixmap, attribList) );
 107         }
 108
 109         /**
 110          * Destroys the OpenGL resources associated with glpixmap and
 111          * decrements glpixmap's reference count.
 112          * glpixmap : a GdkGLPixmap.
 113          */
 114         public void destroy()
 115         {
 116                 // void gdk_gl_pixmap_destroy (GdkGLPixmap *glpixmap);
 117                 gdk_gl_pixmap_destroy(gdkGLPixmap);
 118         }
 119
 120         /**
 121          * Returns the GdkPixmap associated with glpixmap.
 122          * Notice that GdkGLPixmap is not GdkPixmap, but another
 123          * GdkDrawable which have an associated GdkPixmap.
 124          * glpixmap : a GdkGLPixmap.
 125          * Returns : the GdkPixmap associated with glpixmap.
 126          */
 127         public GdkPixmap* getPixmap()
 128         {
 129                 // GdkPixmap* gdk_gl_pixmap_get_pixmap (GdkGLPixmap *glpixmap);
 130                 return gdk_gl_pixmap_get_pixmap(gdkGLPixmap);
 131         }
 132
 133         /**
 134          * Set the OpenGL-capability to the pixmap.
 135          * This function creates a new GdkGLPixmap held by the pixmap.
 136          * attrib_list is currently unused. This must be set to NULL or empty
 137          * (first attribute of None).
 138          * pixmap : the GdkPixmap to be used as the rendering area.
 139          * glconfig : a GdkGLConfig.
 140          * attrib_list : this must be set to NULL or empty (first attribute of None).
 141          * Returns : the GdkGLPixmap used by the pixmap if it is successful,
 142          *  NULL otherwise.
 143          */
 144         public static GdkGLPixmap* gdkPixmapSetGLCapability(GdkPixmap* pixmap, GdkGLConfig* glconfig, int* attribList)
 145         {
 146                 // GdkGLPixmap* gdk_pixmap_set_gl_capability (GdkPixmap *pixmap,  GdkGLConfig *glconfig,  const int *attrib_list);
 147                 return gdk_pixmap_set_gl_capability(pixmap, glconfig, attribList);
 148         }
 149
 150         /**
 151          * Unset the OpenGL-capability of the pixmap.
 152          * This function destroys the GdkGLPixmap held by the pixmap.
 153          * pixmap : a GdkPixmap.
 154          */
 155         public static void gdkPixmapUnsetGLCapability(GdkPixmap* pixmap)
 156         {
 157                 // void gdk_pixmap_unset_gl_capability (GdkPixmap *pixmap);
 158                 gdk_pixmap_unset_gl_capability(pixmap);
 159         }
 160
 161         /**
 162          * Returns whether the pixmap is OpenGL-capable.
 163          * pixmap : a GdkPixmap.
 164          * Returns : TRUE if the pixmap is OpenGL-capable, FALSE otherwise.
 165          */
 166         public static int gdkPixmapIsGLCapable(GdkPixmap* pixmap)
 167         {
 168                 // gboolean gdk_pixmap_is_gl_capable (GdkPixmap *pixmap);
 169                 return gdk_pixmap_is_gl_capable(pixmap);
 170         }
 171
 172         /**
 173          * Returns the GdkGLPixmap held by the pixmap.
 174          * pixmap : a GdkPixmap.
 175          * Returns : the GdkGLPixmap.
 176          */
 177         public static GdkGLPixmap* gdkPixmapGetGLPixmap(GdkPixmap* pixmap)
 178         {
 179                 // GdkGLPixmap* gdk_pixmap_get_gl_pixmap (GdkPixmap *pixmap);
 180                 return gdk_pixmap_get_gl_pixmap(pixmap);
 181         }
 182
 183 }