diff options
| author | Emmanuele Bassi <ebassi@gnome.org> | 2015-10-07 08:50:23 +0100 |
|---|---|---|
| committer | Emmanuele Bassi <ebassi@gnome.org> | 2015-10-07 16:21:57 +0100 |
| commit | 59d02afec0918bfb56e50067ad0360b12c543848 (patch) | |
| tree | fa117f9e80aa83aa60e1ec25dcc047310abe476c /gdk/gdkglcontext.c | |
| parent | 9601479f0c6c18558603989cccb9cb9cea1dc158 (diff) | |
| download | gtk+-59d02afec0918bfb56e50067ad0360b12c543848.tar.gz | |
docs: Improve description of gdk_gl_context_is_legacy()
Explain why this function is available, and why you may need it.
https://bugzilla.gnome.org/show_bug.cgi?id=756142
Diffstat (limited to 'gdk/gdkglcontext.c')
| -rw-r--r-- | gdk/gdkglcontext.c | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/gdk/gdkglcontext.c b/gdk/gdkglcontext.c index d7420e9b3f..06cd01922c 100644 --- a/gdk/gdkglcontext.c +++ b/gdk/gdkglcontext.c @@ -564,7 +564,20 @@ gdk_gl_context_get_required_version (GdkGLContext *context, * * Whether the #GdkGLContext is in legacy mode or not. * - * The #GdkGLContext must be realized. + * The #GdkGLContext must be realized before calling this function. + * + * When realizing a GL context, GDK will try to use the OpenGL 3.2 core + * profile; this profile removes all the OpenGL API that was deprecated + * prior to the 3.2 version of the specification. If the realization is + * successful, this function will return %FALSE. + * + * If the underlying OpenGL implementation does not support core profiles, + * GDK will fall back to a pre-3.2 compatibility profile, and this function + * will return %TRUE. + * + * You can use the value returned by this function to decide which kind + * of OpenGL API to use, or whether to do extension discovery, or what + * kind of shader programs to load. * * Returns: %TRUE if the GL context is in legacy mode * |