summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEmmanuele Bassi <ebassi@gmail.com>2022-01-07 19:14:59 +0000
committerEmmanuele Bassi <ebassi@gmail.com>2022-01-07 19:14:59 +0000
commitbed67edd2ebd5daefd0a1f68ea64ef603cbdeb8b (patch)
tree618267fc20ce58b43a706d8946cda931b3f02616
parent464219c0fa665e2ce42341817deb2a2cf6be243c (diff)
parent8a6dd2805ff77113db5d8d64fd2c10c36cf67607 (diff)
downloadgtk+-bed67edd2ebd5daefd0a1f68ea64ef603cbdeb8b.tar.gz
Merge branch 'ebassi/docs-for-main' into 'main'
Document side effect of GLArea:has-depth-buffer Closes #838 See merge request GNOME/gtk!4351
-rw-r--r--gtk/gtkglarea.c4
1 files changed, 4 insertions, 0 deletions
diff --git a/gtk/gtkglarea.c b/gtk/gtkglarea.c
index de7cc7fa0f..af4d46ec91 100644
--- a/gtk/gtkglarea.c
+++ b/gtk/gtkglarea.c
@@ -833,6 +833,10 @@ gtk_gl_area_class_init (GtkGLAreaClass *klass)
*
* If set to %TRUE the widget will allocate and enable a depth buffer for the
* target framebuffer.
+ *
+ * Setting this property will enable GL's depth testing as a side effect. If
+ * you don't need depth testing, you should call `glDisable(GL_DEPTH_TEST)`
+ * in your `GtkGLArea::render` handler.
*/
obj_props[PROP_HAS_DEPTH_BUFFER] =
g_param_spec_boolean ("has-depth-buffer",