srcgl/glgdk/GLdInit.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-gdkglinit.html
  26  * outPack = glgdk
  27  * outFile = GLdInit
  28  * strct   =
  29  * realStrct=
  30  * ctorStrct=
  31  * clss    = GLdInit
  32  * interf  =
  33  * class Code: No
  34  * interface Code: No
  35  * template for:
  36  * extend  =
  37  * implements:
  38  * prefixes:
  39  *      - gdk_gl_
  40  * omit structs:
  41  * omit prefixes:
  42  * omit code:
  43  * imports:
  44  * structWrap:
  45  * local aliases:
  46  */
  47
  48 module glgdk.GLdInit;
  49
  50 private import glgdk.glgdktypes;
  51
  52 private import lib.glgdk;
  53
  54
  55 /**
  56  * Description
  57  */
  58 public class GLdInit
  59 {
  60
  61         /**
  62          */
  63
  64         /**
  65          * Call this function before using any other GdkGLExt functions in your
  66          * applications. It will initialize everything needed to operate the library
  67          * and parses some standard command line options. argc and
  68          * argv are adjusted accordingly so your own code will
  69          * never see those standard arguments.
  70          * Note
  71          * This function will terminate your program if it was unable to initialize
  72          * the library for some reason. If you want your program to fall back to a
  73          * textual interface you want to call gdk_gl_init_check() instead.
  74          * argc : Address of the argc parameter of your
  75          *  main() function. Changed if any arguments
  76          *  were handled.
  77          * argv : Address of the argv parameter of
  78          *  main(). Any parameters understood by
  79          *  gdk_gl_init() are stripped before return.
  80          */
  81         public static void init(int* argc, char*** argv)
  82         {
  83                 // void gdk_gl_init (int *argc,  char ***argv);
  84                 gdk_gl_init(argc, argv);
  85         }
  86
  87         /**
  88          * This function does the same work as gdk_gl_init() with only
  89          * a single change: It does not terminate the program if the library can't be
  90          * initialized. Instead it returns FALSE on failure.
  91          * This way the application can fall back to some other means of communication
  92          * with the user - for example a curses or command line interface.
  93          * argc : Address of the argc parameter of your
  94          *  main() function. Changed if any arguments
  95          *  were handled.
  96          * argv : Address of the argv parameter of
  97          *  main(). Any parameters understood by
  98          *  gdk_gl_init() are stripped before return.
  99          * Returns : TRUE if the GUI has been successfully initialized,
 100          *  FALSE otherwise.
 101          */
 102         public static int initCheck(int* argc, char*** argv)
 103         {
 104                 // gboolean gdk_gl_init_check (int *argc,  char ***argv);
 105                 return gdk_gl_init_check(argc, argv);
 106         }
 107
 108         /**
 109          * Parses command line arguments, and initializes global
 110          * attributes of GdkGLExt.
 111          * Any arguments used by GdkGLExt are removed from the array and
 112          * argc and argv are updated accordingly.
 113          * You shouldn't call this function explicitely if you are using
 114          * gdk_gl_init(), or gdk_gl_init_check().
 115          * argc : the number of command line arguments.
 116          * argv : the array of command line arguments.
 117          * Returns : TRUE if initialization succeeded, otherwise FALSE.
 118          * << Part II. GdkGLExt API ReferenceQuery >>
 119          */
 120         public static int parseArgs(int* argc, char*** argv)
 121         {
 122                 // gboolean gdk_gl_parse_args (int *argc,  char ***argv);
 123                 return gdk_gl_parse_args(argc, argv);
 124         }
 125 }