gl: Add various missing Since: 1.16 markers
authorSebastian Dröge <sebastian@centricular.com>
Tue, 23 Apr 2019 11:31:45 +0000 (14:31 +0300)
committerTim-Philipp Müller <tim@centricular.com>
Tue, 6 Aug 2019 23:12:35 +0000 (00:12 +0100)
And add some missing function documentation.

gst-libs/gst/gl/gstglformat.c
gst-libs/gst/gl/gstglshaderstrings.c
gst-libs/gst/gl/gstglsl.c
gst-libs/gst/gl/gstglwindow.c

index 422ef9e..3a5603c 100644 (file)
@@ -300,6 +300,8 @@ gst_gl_sized_gl_format_from_gl_format_type (GstGLContext * context,
  *
  * Get the unsized format and type from @format for usage in glReadPixels,
  * glTex{Sub}Image*, glTexImage* and similar functions.
+ *
+ * Since: 1.16
  */
 void
 gst_gl_format_type_from_sized_gl_format (GstGLFormat format,
@@ -362,6 +364,8 @@ gst_gl_format_type_from_sized_gl_format (GstGLFormat format,
  *
  * Returns: Whether @format is supported by @context based on the OpenGL API,
  *          version, or available OpenGL extension/s.
+ *
+ * Since: 1.16
  */
 gboolean
 gst_gl_format_is_supported (GstGLContext * context, GstGLFormat format)
index 6e9aa10..4d7ac3d 100644 (file)
@@ -113,6 +113,8 @@ const gchar *gst_gl_shader_string_fragment_external_oes_default =
  *
  * Returns: a shader string defining the precision of float types based on
  *      @context, @version and @profile
+ *
+ * Since: 1.16
  */
 const gchar *
 gst_gl_shader_string_get_highest_precision (GstGLContext * context,
@@ -135,6 +137,8 @@ gst_gl_shader_string_get_highest_precision (GstGLContext * context,
  *
  * Returns: a passthrough shader string for copying an input texture to
  *          the output
+ *
+ * Since: 1.16
  */
 gchar *
 gst_gl_shader_string_fragment_get_default (GstGLContext * context,
@@ -154,6 +158,8 @@ gst_gl_shader_string_fragment_get_default (GstGLContext * context,
  *
  * Returns: a passthrough shader string for copying an input external-oes
  *          texture to the output
+ *
+ * Since: 1.16
  */
 gchar *
 gst_gl_shader_string_fragment_external_oes_get_default (GstGLContext * context,
index 257ab59..a57587a 100644 (file)
@@ -937,6 +937,8 @@ _gst_glsl_mangle_shader (const gchar * str, guint shader_type,
  * @profile: a #GstGLSLProfile
  *
  * Returns: whether @context supports the 'precision' specifier in GLSL shaders
+ *
+ * Since: 1.16
  */
 gboolean
 gst_gl_context_supports_precision (GstGLContext * context,
@@ -962,6 +964,8 @@ gst_gl_context_supports_precision (GstGLContext * context,
  * @profile: a #GstGLSLProfile
  *
  * Returns: whether @context supports the 'precision highp' specifier in GLSL shaders
+ *
+ * Since: 1.16
  */
 gboolean
 gst_gl_context_supports_precision_highp (GstGLContext * context,
index 1044b98..13ffa18 100644 (file)
@@ -926,6 +926,12 @@ gst_gl_window_set_render_rectangle (GstGLWindow * window, gint x, gint y,
   return ret;
 }
 
+/**
+ * gst_gl_window_queue_resize:
+ * @window: a #GstGLWindow
+ *
+ * Queue resizing of @window.
+ */
 void
 gst_gl_window_queue_resize (GstGLWindow * window)
 {
@@ -954,6 +960,14 @@ _on_resize (gpointer data)
       resize->height);
 }
 
+/**
+ * gst_gl_window_resize:
+ * @window: a #GstGLWindow
+ * @width: new width
+ * @height: new height
+ *
+ * Resize @window to the given @width and @height.
+ */
 void
 gst_gl_window_resize (GstGLWindow * window, guint width, guint height)
 {
@@ -975,6 +989,16 @@ gst_gl_window_resize (GstGLWindow * window, guint width, guint height)
   window->queue_resize = FALSE;
 }
 
+/**
+ * gst_gl_window_controls_viewport:
+ * @window: a #GstGLWindow
+ *
+ * Checks if @window controls the GL viewport.
+ *
+ * Returns: %TRUE if @window controls the GL viewport, otherwise %FALSE
+ *
+ * Since: 1.16
+ */
 gboolean
 gst_gl_window_controls_viewport (GstGLWindow * window)
 {