[gtk/wip/matthiasc/gsk-hdr] Clarify the docs



commit 6ca5ea63856b0f37beb204fe39f2e2007afb2aa6
Author: Matthias Clasen <mclasen redhat com>
Date:   Wed Oct 6 11:32:27 2021 -0400

    Clarify the docs
    
    My mention of specific formats was just meant as an
    example. Make that clearer.

 gsk/ngl/gskngldriver.c | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)
---
diff --git a/gsk/ngl/gskngldriver.c b/gsk/ngl/gskngldriver.c
index 5293ad5d49..87f2864241 100644
--- a/gsk/ngl/gskngldriver.c
+++ b/gsk/ngl/gskngldriver.c
@@ -824,7 +824,7 @@ gsk_ngl_driver_load_texture (GskNglDriver *self,
  * @self: a `GskNglDriver`
  * @width: the width of the texture
  * @height: the height of the texture
- * @format: format for the texture. Should be GL_RGBA8, GL_RGBA16F or GL_RGBA32F
+ * @format: format for the texture
  * @min_filter: GL_NEAREST or GL_LINEAR
  * @mag_filter: GL_NEAREST or GL_FILTER
  *
@@ -832,6 +832,8 @@ gsk_ngl_driver_load_texture (GskNglDriver *self,
  * to upload data, map to a framebuffer, or other uses which may
  * modify the texture immediately.
  *
+ * Typical examples for @format are GK_RGBA8, GL_RGBA16F or GL_RGBA32F.
+ *
  * Use gsk_ngl_driver_release_texture() to release this texture back into
  * the pool so it may be reused later in the pipeline.
  *
@@ -904,8 +906,7 @@ gsk_ngl_driver_release_texture (GskNglDriver  *self,
  * @self: a `GskNglDriver`
  * @width: the width for the render target
  * @height: the height for the render target
- * @format: the format to use. This should be GL_RGBA8,
- *   GL_RGBA16F or GL_RGBA32F
+ * @format: the format to use
  * @min_filter: the min filter to use for the texture
  * @mag_filter: the mag filter to use for the texture
  * @out_render_target: (out): a location for the render target
@@ -914,6 +915,8 @@ gsk_ngl_driver_release_texture (GskNglDriver  *self,
  * bound to that framebuffer of the size @width x @height and using the
  * appropriate filters.
  *
+ * Typical examples for @format are GK_RGBA8, GL_RGBA16F or GL_RGBA32F.
+ *
  * Use gsk_ngl_driver_release_render_target() when you are finished with
  * the render target to release it. You may steal the texture from the
  * render target when releasing it.


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]