summaryrefslogtreecommitdiff
path: root/gst-libs/gst/gl/gstglslstage.c
diff options
context:
space:
mode:
authorMatthew Waters <matthew@centricular.com>2016-03-06 19:35:38 +1100
committerMatthew Waters <matthew@centricular.com>2016-03-06 19:36:17 +1100
commit23806d4953d9014067105ae2a05dd3ff14fa41b7 (patch)
tree376b9555c303de731c6bda736fb467c40d42530b /gst-libs/gst/gl/gstglslstage.c
parentdff43480ee70321609b6dc2072f58edb87f78d11 (diff)
gl: misc docs fixes/additions
Diffstat (limited to 'gst-libs/gst/gl/gstglslstage.c')
-rw-r--r--gst-libs/gst/gl/gstglslstage.c19
1 files changed, 18 insertions, 1 deletions
diff --git a/gst-libs/gst/gl/gstglslstage.c b/gst-libs/gst/gl/gstglslstage.c
index 581320126..caa5860bf 100644
--- a/gst-libs/gst/gl/gstglslstage.c
+++ b/gst-libs/gst/gl/gstglslstage.c
@@ -27,6 +27,15 @@
#include "gstglslstage.h"
#include "gstglsl_private.h"
+/**
+ * SECTION:gstglslstage
+ * @short_description: object for dealing with OpenGL shader stages
+ * @title: GstGLSLStage
+ * @see_also: #GstGLShader
+ *
+ * #GstGLSLStage holds and represents a single OpenGL shader stage.
+ */
+
static const gchar *es2_version_header = "#version 100\n";
GST_DEBUG_CATEGORY_STATIC (gst_glsl_stage_debug);
@@ -185,6 +194,10 @@ _ensure_shader (GstGLSLStage * stage)
* gst_glsl_stage_new_with_strings:
* @context: a #GstGLContext
* @type: the GL enum shader stage type
+ * @version: the #GstGLSLVersion
+ * @profile: the #GstGLSLProfile
+ * @n_strings: the number of strings in @str
+ * @str: an array of strings concatted together to produce a shader
*
* Returns: (transfer full): a new #GstGLSLStage of the specified @type
*/
@@ -216,9 +229,12 @@ gst_glsl_stage_new_with_strings (GstGLContext * context, guint type,
}
/**
- * gst_glsl_stage_new_with_strings:
+ * gst_glsl_stage_new_with_string:
* @context: a #GstGLContext
* @type: the GL enum shader stage type
+ * @version: the #GstGLSLVersion
+ * @profile: the #GstGLSLProfile
+ * @str: a shader string
*
* Returns: (transfer full): a new #GstGLSLStage of the specified @type
*/
@@ -484,6 +500,7 @@ _compile_shader (GstGLContext * context, struct compile *data)
/**
* gst_glsl_stage_compile:
* @stage: a #GstGLSLStage
+ * @error: a #GError to use on failure
*
* Returns: whether the compilation suceeded
*/