[858/906] glmem: update the docs
authorMatthew Waters <ystreet00@gmail.com>
Sat, 23 Nov 2013 11:56:10 +0000 (22:56 +1100)
committerTim-Philipp Müller <tim@centricular.com>
Sat, 9 Dec 2017 19:31:32 +0000 (19:31 +0000)
gst-libs/gst/gl/gstglmemory.c
gst-libs/gst/gl/gstglmemory.h

index 976b81b..fc335a7 100644 (file)
@@ -391,6 +391,16 @@ _gl_mem_free (GstAllocator * allocator, GstMemory * mem)
   g_slice_free (GstGLMemory, gl_mem);
 }
 
+/**
+ * gst_gl_memory_copy_into_texture:
+ * @gl_mem:a #GstGLMemory
+ * @tex_id:OpenGL texture id
+ *
+ * Copies @gl_mem into the texture specfified by @tex_id.  This assumes that
+ * @tex_id has the same dimensions as @gl_mem.
+ *
+ * Returns: Whether the copy suceeded
+ */
 gboolean
 gst_gl_memory_copy_into_texture (GstGLMemory * gl_mem, guint tex_id)
 {
index 96768b4..013a3da 100644 (file)
@@ -67,7 +67,7 @@ typedef enum
 /**
  * GstGLMemory:
  * @mem: the parent object
- * @display: the #GstGLDisplay to use for GL operations
+ * @context: the #GstGLContext to use for GL operations
  * @tex_id: the texture id for this memory
  * @v_format: the video format of this texture
  * @gl_format: the format of the texture
@@ -121,7 +121,7 @@ struct _GstGLMemory
  * @mem: a #GstGLMemory
  * @flag: a flag
  *
- * Returns: Whether @flag is set on @mem
+ * Whether @flag is set on @mem
  */
 #define GST_GL_MEMORY_FLAG_IS_SET(mem,flag) GST_MEMORY_FLAG_IS_SET(mem,flag)