Initialization

Initialization — Library initialization functions

Synopsis


#include <gtk/gtkgl.h>


void        gtk_gl_init                     (int *argc,
                                             char ***argv);
gboolean    gtk_gl_init_check               (int *argc,
                                             char ***argv);
gboolean    gtk_gl_parse_args               (int *argc,
                                             char ***argv);

Description

Details

gtk_gl_init ()

void        gtk_gl_init                     (int *argc,
                                             char ***argv);

Call this function before using any other GtkGLExt functions in your applications. It will initialize everything needed to operate the library and parses some standard command line options. argc and argv are adjusted accordingly so your own code will never see those standard arguments.

Note

This function will terminate your program if it was unable to initialize the library for some reason. If you want your program to fall back to a textual interface you want to call gtk_gl_init_check() instead.

argc : Address of the argc parameter of your main() function. Changed if any arguments were handled.
argv : Address of the argv parameter of main(). Any parameters understood by gtk_gl_init() are stripped before return.

gtk_gl_init_check ()

gboolean    gtk_gl_init_check               (int *argc,
                                             char ***argv);

This function does the same work as gtk_gl_init() with only a single change: It does not terminate the program if the library can't be initialized. Instead it returns FALSE on failure.

This way the application can fall back to some other means of communication with the user - for example a curses or command line interface.

argc : Address of the argc parameter of your main() function. Changed if any arguments were handled.
argv : Address of the argv parameter of main(). Any parameters understood by gtk_gl_init() are stripped before return.
Returns : TRUE if the GUI has been successfully initialized, FALSE otherwise.

gtk_gl_parse_args ()

gboolean    gtk_gl_parse_args               (int *argc,
                                             char ***argv);

Parses command line arguments, and initializes global attributes of GtkGLExt.

Any arguments used by GtkGLExt are removed from the array and argc and argv are updated accordingly.

You shouldn't call this function explicitely if you are using gtk_gl_init(), or gtk_gl_init_check().

argc : the number of command line arguments.
argv : the array of command line arguments.
Returns : TRUE if initialization succeeded, otherwise FALSE.