AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity

GtkGLArea: Formatting fixes

Browse Source
This commit is contained in:
Matthias Clasen 2014-11-21 20:58:25 -05:00
parent 10a7a89311
commit 72a501fe15
1 changed files with 75 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
gtk/gtkglarea.c
View File

@ -731,7 +731,7 @@ gtk_gl_area_class_init (GtkGLAreaClass *klass)
/** /**
* GdkGLArea:profile: * GdkGLArea:profile:
* *
* The #GdkGLProfile to use to create the GL context for the area * The #GdkGLProfile to use to create the GL context for the area.
* *
* Since: 3.16 * Since: 3.16
*/ */
@ -748,13 +748,15 @@ gtk_gl_area_class_init (GtkGLAreaClass *klass)
/** /**
* GtkGLArea:auto-render: * GtkGLArea:auto-render:
* *
* If set to %TRUE the #GtkGLArea::render signal will be emitted every time the widget * If set to %TRUE the #GtkGLArea::render signal will be emitted every time
* draws. This is the default and is useful if drawing the widget is fastr. * the widget draws. This is the default and is useful if drawing the widget
* is faster.
* *
* If set to %FALSE the data from previous rendering is kept around and will be used * If set to %FALSE the data from previous rendering is kept around and will
* for drawing the widget the next time, unless the window is resized. In order to * be used for drawing the widget the next time, unless the window is resized.
* force a rendering gtk_gl_area_queue_render() must be called. This mode is useful * In order to force a rendering gtk_gl_area_queue_render() must be called.
* when the scene changes seldom, but takes a long time to redraw. * This mode is useful when the scene changes seldomly, but takes a long time
* to redraw.
* *
* Since: 3.16 * Since: 3.16
*/ */
@ -768,12 +770,12 @@ gtk_gl_area_class_init (GtkGLAreaClass *klass)
/** /**
* GtkGLArea:has-alpha: * GtkGLArea:has-alpha:
* *
* If set to %TRUE the buffer allocated by the widget will have an alpha channel component, * If set to %TRUE the buffer allocated by the widget will have an alpha channel
* and when rendering to the window the result will be composited over whatever is below * component, and when rendering to the window the result will be composited over
* the widget. * whatever is below the widget.
* *
* If set to %FALSE there will be no alpha channel, and the buffer will fully replace anything * If set to %FALSE there will be no alpha channel, and the buffer will fully
* below the widget. * replace anything below the widget.
* *
* Since: 3.16 * Since: 3.16
*/ */
@ -787,8 +789,8 @@ gtk_gl_area_class_init (GtkGLAreaClass *klass)
/** /**
* GtkGLArea:has-depth-buffer: * GtkGLArea:has-depth-buffer:
* *
* If set to %TRUE the widget will allocate and enable a depth buffer for the target * If set to %TRUE the widget will allocate and enable a depth buffer for the
* framebuffer. * target framebuffer.
* *
* Since: 3.16 * Since: 3.16
*/ */
@ -802,8 +804,8 @@ gtk_gl_area_class_init (GtkGLAreaClass *klass)
/** /**
* GtkGLArea:has-stencil-buffer: * GtkGLArea:has-stencil-buffer:
* *
* If set to %TRUE the widget will allocate and enable a stencil buffer for the target * If set to %TRUE the widget will allocate and enable a stencil buffer for the
* framebuffer. * target framebuffer.
* *
* Since: 3.16 * Since: 3.16
*/ */
@ -855,9 +857,10 @@ gtk_gl_area_class_init (GtkGLAreaClass *klass)
* in order to keep GL state up to date with the widget size, like for * in order to keep GL state up to date with the widget size, like for
* instance camera properties which may depend on the width/height ratio. * instance camera properties which may depend on the width/height ratio.
* *
* The GL context for the area is guaranteed to be current when this is emitted. * The GL context for the area is guaranteed to be current when this signal
* is emitted.
* *
* The default handler sets up the gl Viewport. * The default handler sets up the GL viewport.
* *
* Since: 3.16 * Since: 3.16
*/ */
@ -885,8 +888,8 @@ gtk_gl_area_class_init (GtkGLAreaClass *klass)
* gtk_gl_area_set_error() to register a more detailed error * gtk_gl_area_set_error() to register a more detailed error
* of how the construction failed. * of how the construction failed.
* *
* Returns: (transfer full): a newly created #GdkGLContext; the * Returns: (transfer full): a newly created #GdkGLContext;
* #GtkGLArea widget will take ownership of the returned value. * the #GtkGLArea widget will take ownership of the returned value.
* *
* Since: 3.16 * Since: 3.16
*/ */
@ -934,8 +937,8 @@ gtk_gl_area_new (void)
* @error: (allow-none): a new #GError, or %NULL to unset the error * @error: (allow-none): a new #GError, or %NULL to unset the error
* *
* Sets an error on the area which will be shown instead of the * Sets an error on the area which will be shown instead of the
* gl rendering. This is useful in the ::create-context signal * GL rendering. This is useful in the #GtkGLArea::create-context
* if GL context creation fails. * signal if GL context creation fails.
* *
* Since: 3.16 * Since: 3.16
*/ */
@ -1178,8 +1181,8 @@ gtk_gl_area_set_has_stencil_buffer (GtkGLArea *area,
* gtk_gl_area_queue_render: * gtk_gl_area_queue_render:
* @area: a #GtkGLArea * @area: a #GtkGLArea
* *
* Marks the currently rendered data (if any) as invalid, and queues a * Marks the currently rendered data (if any) as invalid, and queues
* redraw of the widget, ensuring that the #GtkGLArea::render signal * a redraw of the widget, ensuring that the #GtkGLArea::render signal
* is emitted during the draw. * is emitted during the draw.
* *
* This is only needed when the gtk_gl_area_set_auto_render() has * This is only needed when the gtk_gl_area_set_auto_render() has
@ -1228,13 +1231,13 @@ gtk_gl_area_get_auto_render (GtkGLArea *area)
* *
* If @auto_render is %TRUE the #GtkGLArea::render signal will be * If @auto_render is %TRUE the #GtkGLArea::render signal will be
* emitted every time the widget draws. This is the default and is * emitted every time the widget draws. This is the default and is
* useful if drawing the widget is fastr. * useful if drawing the widget is faster.
* *
* If @auto_render is %FALSE the data from previous rendering is kept * If @auto_render is %FALSE the data from previous rendering is kept
* around and will be used for drawing the widget the next time, * around and will be used for drawing the widget the next time,
* unless the window is resized. In order to force a rendering * unless the window is resized. In order to force a rendering
* gtk_gl_area_queue_render() must be called. This mode is useful when * gtk_gl_area_queue_render() must be called. This mode is useful when
* the scene changes seldom, but takes a long time to redraw. * the scene changes seldomly, but takes a long time to redraw.
* *
* Since: 3.16 * Since: 3.16
*/ */