mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-26 19:51:11 +00:00
Code Issues 1 Projects Releases Wiki Activity

gl/docs: add to new docs system

Browse source
This commit is contained in:
Matthew Waters 2019-05-20 11:14:27 +10:00
parent ed33011502
commit 51f2d05ff6
49 changed files with 208 additions and 123 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/libs/gl/index.md Normal file
View file

@ -0,0 +1,4 @@
# GStreamer OpenGL Library
This library should be linked to by getting cflags and libs from
`gstreamer-gl-{{ gst_api_version.md }}.pc`.

1
docs/libs/gl/sitemap.txt Normal file
View file

@ -0,0 +1 @@
gi-index

20
docs/meson.build
View file

@ -71,10 +71,11 @@ foreach h: ['pbutils-private.h', 'gsttageditingprivate.h', 'id3v2.h',
'_kiss_fft_guts_f32.h', '_kiss_fft_guts_f64.h', '_kiss_fft_guts_s16.h',
'_kiss_fft_guts_s16.h', '_kiss_fft_guts_s32.h', '_kiss_fft_guts_s32.h',
'pbutils-marshal.h', 'audio-resampler-private.h', '*orc-dist.*',
'*-neon.h', 'audio-resampler-macros.[ch]', '*-prelude.h'
'*-neon.h', 'audio-resampler-macros.[ch]', '*-prelude.h', '*_private.h',
'gstglfuncs.[ch]', 'gstgl_fwd.h'
]
libs_excludes += [join_paths(meson.current_source_dir(), '..', 'gst-libs/gst/*/', h)]
libs_excludes += [join_paths(meson.current_source_dir(), '..', 'gst-libs/gst/*/', h)]
endforeach
libs = [
@ -91,7 +92,14 @@ libs = [
]
if build_gstgl
libs + [['gl', gl_gir, gstgl_dep]]
libs += [['gl', gl_gir, gstgl_dep, [
join_paths('../gst-libs/gst', 'gl', 'egl', 'gstegl.[ch]'),
join_paths('../gst-libs/gst', 'gl', 'egl', 'gsteglimage.[ch]'),
join_paths('../gst-libs/gst', 'gl', 'egl', 'gstgldisplay_egl.[ch]'),
join_paths('../gst-libs/gst', 'gl', 'egl', 'gstglmemoryegl.[ch]'),
join_paths('../gst-libs/gst', 'gl', 'x11', 'gstgldisplay_x11.[ch]'),
join_paths('../gst-libs/gst', 'gl', 'wayland', 'gstgldisplay_wayland.[ch]'),
]]]
endif
libs_doc = []
@ -99,9 +107,13 @@ foreach lib: libs
name = lib[0]
gir = lib[1]
deps = [lib[2], gir]
extra_sources = []
if lib.length() >= 4
extra_sources = lib[3]
endif
libs_doc += [hotdoc.generate_doc('gst-plugins-base-' + name,
project_version: api_version,
gi_c_sources: [join_paths('../gst-libs/gst', name, '*.[hc]')],
gi_c_sources: [join_paths('../gst-libs/gst', name, '*.[hc]')] + extra_sources,
gi_sources: gir[0].full_path(),
gi_c_source_filters: libs_excludes,
gi_c_source_roots: [join_paths(meson.current_source_dir(), '../gst-libs/gst/' + name), ],

1
ext/gl/gstglalpha.h
View file

@ -65,7 +65,6 @@ GstGLAlphaMethod;
struct _GstGLAlpha {
GstGLFilter videofilter;
/* < private > */
GstGLShader *alpha_shader;
GstGLShader *chroma_key_shader;

1
ext/gl/gstglcolorbalance.h
View file

@ -49,7 +49,6 @@ typedef struct _GstGLColorBalanceClass GstGLColorBalanceClass;
struct _GstGLColorBalance {
GstGLFilter videofilter;
/* < private > */
GstGLShader *shader;
/* channels for interface */

2
ext/gl/gstgldownloadelement.h
View file

@ -41,7 +41,6 @@ typedef struct _GstGLDownloadElementClass GstGLDownloadElementClass;
struct _GstGLDownloadElement
{
/* <private> */
GstGLBaseFilter parent;
gboolean do_pbo_transfers;
@ -51,7 +50,6 @@ struct _GstGLDownloadElement
struct _GstGLDownloadElementClass
{
/* <private> */
GstGLBaseFilterClass object_class;
};

1
ext/gl/gstgloverlay.h
View file

@ -53,7 +53,6 @@ struct _GstGLOverlay
gdouble alpha;
/* <private> */
GstGLShader *shader;
GstGLMemory *image_memory;

1
ext/gl/gstgluploadelement.h
View file

@ -46,7 +46,6 @@ typedef struct _GstGLUploadElementPrivate GstGLUploadElementPrivate;
*/
struct _GstGLUploadElement
{
/* <private> */
GstGLBaseFilter parent;
GstGLUpload *upload;

1
ext/gl/gstglvideomixer.c
View file

@ -545,7 +545,6 @@ struct _GstGLVideoMixerPad
{
GstGLMixerPad parent;
/* < private > */
/* properties */
gint xpos, ypos;
gint width, height;

8
gst-libs/gst/gl/egl/gstegl.c
View file

@ -17,6 +17,14 @@
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
/**
* SECTION:gstegl
* @short_description: EGL helpers
* @title: GstEGL
* @see_also: #GstGLDisplayEGL, #GstEGLImage
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

8
gst-libs/gst/gl/egl/gsteglimage.c
View file

@ -27,11 +27,11 @@
* @title: GstEGLImage
* @see_also: #GstGLMemoryEGL, #GstGLContext
*
* #GstEGLImage represents and holds an #EGLImage handle.
* #GstEGLImage represents and holds an `EGLImage` handle.
*
* A #GstEGLImage can be created from a dmabuf with gst_egl_image_from_dmabuf(),
* or gst_egl_image_from_dmabuf_direct(), or #GstGLMemoryEGL provides a
* #GstAllocator to allocate #EGLImage's bound to and OpenGL texture.
* #GstAllocator to allocate `EGLImage`'s bound to and OpenGL texture.
*/
#ifdef HAVE_CONFIG_H
@ -200,7 +200,7 @@ gst_egl_image_ensure_debug_category (void)
* gst_egl_image_get_image:
* @image: a #GstEGLImage
*
* Returns: the #EGLImageKHR of @image
* Returns: the `EGLImage` of @image
*/
gpointer
gst_egl_image_get_image (GstEGLImage * image)
@ -400,7 +400,7 @@ _destroy_egl_image (GstEGLImage * image, gpointer user_data)
* gst_egl_image_from_texture:
* @context: a #GstGLContext (must be an EGL context)
* @gl_mem: a #GstGLMemory
* @attribs: additional attributes to add to the eglCreateImage() call.
* @attribs: additional attributes to add to the `eglCreateImage`() call.
*
* Returns: (transfer full): a #GstEGLImage wrapping @gl_mem or %NULL on failure
*/

2
gst-libs/gst/gl/egl/gsteglimage.h
View file

@ -43,7 +43,7 @@ typedef struct _GstEGLImage GstEGLImage;
* @data: user data passed to gst_egl_image_new_wrapped()
*
* Function to be called when the GstEGLImage is destroyed. It should free
* the associated #EGLImage if necessary
* the associated `EGLImage` if necessary
*/
typedef void (*GstEGLImageDestroyNotify) (GstEGLImage * image,
gpointer data);

4
gst-libs/gst/gl/egl/gstglcontext_egl.h
View file

@ -50,7 +50,7 @@ G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstGLContextEGL, gst_object_unref)
*/
struct _GstGLContextEGL
{
/* <private> */
/*< private >*/
GstGLContext context;
GstGLDisplayEGL *display_egl;
@ -78,7 +78,7 @@ struct _GstGLContextEGL
*/
struct _GstGLContextEGLClass
{
/* <private> */
/*< private >*/
GstGLContextClass parent;
};

15
gst-libs/gst/gl/egl/gstgldisplay_egl.c
View file

@ -18,6 +18,17 @@
* Boston, MA 02110-1301, USA.
*/
/**
* SECTION:gstgldisplay_egl
* @short_description: EGL Display connection
* @title: GstGLDisplayEGL
* @see_also: #GstGLDisplay
*
* #GstGLDisplayEGL represents a connection to an EGL `EGLDisplay` handle created
* internally (gst_gl_display_egl_new()) or wrapped by the application
* (gst_gl_display_egl_new_with_egl_display())
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
@ -92,11 +103,11 @@ gst_gl_display_egl_finalize (GObject * object)
* @type: a #GstGLDisplayType
* @display: pointer to a display (or 0)
*
* Attempts to create a new #EGLDisplay from @display. If @type is
* Attempts to create a new `EGLDisplay` from @display. If @type is
* %GST_GL_DISPLAY_TYPE_ANY, then @display must be 0. @type must not be
* %GST_GL_DISPLAY_TYPE_NONE.
*
* Returns: A #EGLDisplay or %EGL_NO_DISPLAY
* Returns: A `EGLDisplay` or `EGL_NO_DISPLAY`
*
* Since: 1.12
*/

2
gst-libs/gst/gl/egl/gstgldisplay_egl.h
View file

@ -48,7 +48,7 @@ struct _GstGLDisplayEGL
{
GstGLDisplay parent;
/* <private> */
/*< private >*/
gpointer display;
gboolean foreign_display;

1
gst-libs/gst/gl/egl/gstglmemoryegl.c
View file

@ -25,6 +25,7 @@
/**
* SECTION:gstglmemoryegl
* @short_description: memory subclass for EGLImage's
* @title: GstGLMemoryEGL
* @see_also: #GstGLMemory, #GstGLBaseMemoryAllocator, #GstGLBufferPool
*
* #GstGLMemoryEGL is created or wrapped through gst_gl_base_memory_alloc()

8
gst-libs/gst/gl/egl/gstglmemoryegl.h
View file

@ -46,7 +46,7 @@ GST_GL_API GType gst_gl_memory_egl_allocator_get_type(void);
*/
struct _GstGLMemoryEGL
{
/* <private> */
/*< private >*/
GstGLMemory mem;
GstEGLImage *image;
@ -74,13 +74,13 @@ GST_GL_API
gpointer gst_gl_memory_egl_get_display (GstGLMemoryEGL * mem);
/**
* GstGLMemoryEGLAllocator
* GstGLMemoryEGLAllocator:
*
* Opaque #GstGLMemoryEGLAllocator struct
*/
struct _GstGLMemoryEGLAllocator
{
/* <private> */
/*< private >*/
GstGLMemoryAllocator parent;
@ -94,7 +94,7 @@ struct _GstGLMemoryEGLAllocator
*/
struct _GstGLMemoryEGLAllocatorClass
{
/* <private> */
/*< private >*/
GstGLMemoryAllocatorClass parent_class;
gpointer _padding[GST_PADDING];

2
gst-libs/gst/gl/gbm/gstgldisplay_gbm.h
View file

@ -48,7 +48,7 @@ struct _GstGLDisplayGBM
{
GstGLDisplay parent;
/* <private> */
/*< private >*/
int drm_fd;
drmModeRes *drm_mode_resources;

9
gst-libs/gst/gl/gstglapi.c
View file

@ -33,6 +33,15 @@
#include "gstglapi.h"
/**
* GstGLFuncs:
*
* Structure containing function pointers to OpenGL functions.
*
* Each field is named exactly the same as the OpenGL function without the
* `gl` prefix.
*/
/**
* gst_gl_api_to_string:
* @api: a #GstGLAPI to stringify

4
gst-libs/gst/gl/gstglbasefilter.c
View file

@ -35,8 +35,8 @@
*
* #GstGLBaseFilter handles the nitty gritty details of retrieving an OpenGL
* context. It also provided some wrappers around #GstBaseTransform's
* start(), stop() and set_caps() virtual methods that ensure an OpenGL context
* is available and current in the calling thread.
* `start()`, `stop()` and `set_caps()` virtual methods that ensure an OpenGL
* context is available and current in the calling thread.
*/
#define GST_CAT_DEFAULT gst_gl_base_filter_debug

5
gst-libs/gst/gl/gstglbasememory.c
View file

@ -53,6 +53,11 @@ GST_DEBUG_CATEGORY_STATIC (GST_CAT_GL_BASE_MEMORY);
GST_DEFINE_MINI_OBJECT_TYPE (GstGLBaseMemory, gst_gl_base_memory);
/**
* gst_gl_base_memory_error_quark:
*
* Returns: the quark used for #GstGLBaseMemory in #GError's
*/
GQuark
gst_gl_base_memory_error_quark (void)
{

8
gst-libs/gst/gl/gstglbasememory.h
View file

@ -107,7 +107,7 @@ struct _GstGLBaseMemory
GstGLContext *context;
/* <protected> */
/*< protected >*/
GMutex lock;
GstMapFlags map_flags; /* cumulative map flags */
@ -118,7 +118,7 @@ struct _GstGLBaseMemory
GstGLQuery *query;
/* <private> */
/*< private >*/
gsize alloc_size; /* because maxsize is used for mapping */
gpointer alloc_data;
@ -215,7 +215,7 @@ struct _GstGLAllocationParams
/* GST_GL_ALLOCATION_PARAMS_ALLOC_FLAG_WRAP_GPU_HANDLE only */
gpointer gl_handle;
/* <private> */
/*< private >*/
gpointer _padding[GST_PADDING];
};
@ -370,8 +370,8 @@ struct _GstGLBaseMemoryAllocatorClass
GstGLBaseMemoryAllocatorUnmapFunction unmap;
GstGLBaseMemoryAllocatorCopyFunction copy;
GstGLBaseMemoryAllocatorDestroyFunction destroy;
/* <private> */
/*< private >*/
gpointer _padding[GST_PADDING];
};

6
gst-libs/gst/gl/gstglbuffer.h
View file

@ -80,7 +80,7 @@ struct _GstGLBufferAllocationParams
guint gl_target;
guint gl_usage;
/* <private> */
/*< private >*/
gpointer _padding[GST_PADDING];
};
@ -100,7 +100,7 @@ struct _GstGLBufferAllocator
{
GstGLBaseMemoryAllocator parent;
/* <private> */
/*< private >*/
gpointer _padding[GST_PADDING];
};
@ -113,7 +113,7 @@ struct _GstGLBufferAllocatorClass
{
GstGLBaseMemoryAllocatorClass parent_class;
/* <private> */
/*< private >*/
gpointer _padding[GST_PADDING];
};

4
gst-libs/gst/gl/gstglbufferpool.h
View file

@ -47,7 +47,7 @@ struct _GstGLBufferPool
GstGLContext *context;
/* <private> */
/*< private >*/
GstGLBufferPoolPrivate *priv;
gpointer _padding[GST_PADDING];
@ -62,7 +62,7 @@ struct _GstGLBufferPoolClass
{
GstBufferPoolClass parent_class;
/* <private> */
/*< private >*/
gpointer _padding[GST_PADDING];
};

6
gst-libs/gst/gl/gstglcolorconvert.h
View file

@ -44,7 +44,7 @@ GType gst_gl_color_convert_get_type (void);
*/
struct _GstGLColorConvert
{
/* <private> */
/*< private >*/
GstObject parent;
GstGLContext *context;
@ -63,7 +63,7 @@ struct _GstGLColorConvert
GstGLFramebuffer *fbo;
GstGLShader *shader;
/* <private> */
/*< private >*/
GstGLColorConvertPrivate *priv;
gpointer _reserved[GST_PADDING];
@ -76,7 +76,7 @@ struct _GstGLColorConvert
*/
struct _GstGLColorConvertClass
{
/* <private> */
/*< private >*/
GstObjectClass object_class;
gpointer _padding[GST_PADDING];

7
gst-libs/gst/gl/gstglcontext.c
View file

@ -246,6 +246,11 @@ G_DEFINE_TYPE (GstGLWrappedContext, gst_gl_wrapped_context,
#define GST_IS_GL_WRAPPED_CONTEXT_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE((k), GST_TYPE_GL_WRAPPED_CONTEXT))
#define GST_GL_WRAPPED_CONTEXT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS((o), GST_TYPE_GL_WRAPPED_CONTEXT, GstGLWrappedContextClass))
/**
* gst_gl_context_error_quark:
*
* Returns: the quark used for #GstGLContext in #GError's
*/
GQuark
gst_gl_context_error_quark (void)
{
@ -837,7 +842,7 @@ gst_gl_context_get_gl_api (GstGLContext * context)
*
* Note: On success, you need to cast the returned function pointer to the
* correct type to be able to call it correctly. On 32-bit Windows, this will
* include the %GSTGLAPI identifier to use the correct calling convention.
* include the `GSTGLAPI` identifier to use the correct calling convention.
* e.g.
*
* |[<!-- language="C" -->

4
gst-libs/gst/gl/gstgldebug.c
View file

@ -420,7 +420,7 @@ gst_gl_insert_debug_marker (GstGLContext * context, const gchar * format, ...)
* gst_gl_async_debug_store_log_msg_valist:
* @ad: the #GstGLAsyncDebug to store the message in
* @cat: the #GstDebugCategory to output the message in
* @level: the #GstLevel
* @level: the #GstDebugLevel
* @file: the file where the debug message originates from
* @function: the function where the debug message originates from
* @line: the line in @file where the debug message originates from
@ -487,7 +487,7 @@ gst_gl_async_debug_output_log_msg (GstGLAsyncDebug * ad)
* gst_gl_async_debug_store_log_msg:
* @ad: the #GstGLAsyncDebug to store the message in
* @cat: the #GstDebugCategory to output the message in
* @level: the #GstLevel
* @level: the #GstDebugLevel
* @file: the file where the debug message originates from
* @function: the function where the debug message originates from
* @line: the line in @file where the debug message originates from

8
gst-libs/gst/gl/gstgldebug.h
View file

@ -35,7 +35,7 @@ typedef gchar * (*GstGLAsyncDebugLogGetMessage) (gpointer user_data);
*/
struct _GstGLAsyncDebug
{
/* <private> */
/*< private >*/
guint state_flags;
GstDebugCategory *cat;
GstDebugLevel level;
@ -45,7 +45,7 @@ struct _GstGLAsyncDebug
GObject *object;
gchar *debug_msg;
/* <protected> */
/*< protected >*/
GstGLAsyncDebugLogGetMessage callback;
gpointer user_data;
GDestroyNotify notify;
@ -70,7 +70,7 @@ void gst_gl_async_debug_thaw (GstGLAsyncDebug
* GST_GL_ASYNC_CAT_LEVEL_LOG_valist:
* @ad: the #GstGLAsyncDebug to store the message in
* @cat: the #GstDebugCategory to output the message in
* @level: the #GstLevel
* @level: the #GstDebugLevel
* @object: (allow-none): a #GObject to associate with the debug message
* @format: a printf style format string
* @varargs: the list of arguments for @format
@ -85,7 +85,7 @@ void gst_gl_async_debug_thaw (GstGLAsyncDebug
* GST_GL_ASYNC_CAT_LEVEL_LOG:
* @ad: the #GstGLAsyncDebug to store the message in
* @cat: the #GstDebugCategory to output the message in
* @level: the #GstLevel
* @level: the #GstDebugLevel
* @object: (allow-none): a #GObject to associate with the debug message
* @format: a printf style format string
* @...: the list of arguments for @format

6
gst-libs/gst/gl/gstgldisplay.h
View file

@ -75,12 +75,12 @@ typedef enum
*/
struct _GstGLDisplay
{
/* <private> */
/*< private >*/
GstObject object;
GstGLDisplayType type;
/* <protected> */
/*< protected >*/
GList *windows; /* OBJECT lock */
GMainContext *main_context;
GMainLoop *main_loop;
@ -96,7 +96,7 @@ struct _GstGLDisplayClass
guintptr (*get_handle) (GstGLDisplay * display);
GstGLWindow * (*create_window) (GstGLDisplay * display);
/* <private> */
/*< private >*/
gpointer _padding[GST_PADDING];
};

7
gst-libs/gst/gl/gstglfeature.c
View file

@ -18,6 +18,13 @@
* Boston, MA 02110-1301, USA.
*/
/**
* SECTION:gstglfeature
* @short_description: OpenGL feature checking
* @title: GstGLFeature
* @see_also: #GstGLContext
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

8
gst-libs/gst/gl/gstglformat.c
View file

@ -116,8 +116,8 @@ _gl_type_n_bytes (guint type)
/**
* gst_gl_format_type_n_bytes:
* @format: the OpenGL format, %GL_RGBA, %GL_LUMINANCE, etc
* @type: the OpenGL type, %GL_UNSIGNED_BYTE, %GL_FLOAT, etc
* @format: the OpenGL format, `GL_RGBA`, `GL_LUMINANCE`, etc
* @type: the OpenGL type, `GL_UNSIGNED_BYTE`, `GL_FLOAT`, etc
*
* Returns: the number of bytes the specified @format, @type combination takes
* per pixel
@ -216,8 +216,8 @@ gst_gl_format_from_video_info (GstGLContext * context, GstVideoInfo * vinfo,
/**
* gst_gl_sized_gl_format_from_gl_format_type:
* @context: a #GstGLContext
* @format: an OpenGL format, %GL_RGBA, %GL_LUMINANCE, etc
* @type: an OpenGL type, %GL_UNSIGNED_BYTE, %GL_FLOAT, etc
* @format: an OpenGL format, `GL_RGBA`, `GL_LUMINANCE`, etc
* @type: an OpenGL type, `GL_UNSIGNED_BYTE`, `GL_FLOAT`, etc
*
* Returns: the sized internal format specified by @format and @type that can
* be used in @context

4
gst-libs/gst/gl/gstglframebuffer.h
View file

@ -52,7 +52,7 @@ typedef gboolean (*GstGLFramebufferFunc) (gpointer stuff);
*/
struct _GstGLFramebuffer
{
/* <private> */
/*< private >*/
GstObject object;
GstGLContext *context;
@ -72,7 +72,7 @@ struct _GstGLFramebuffer
*/
struct _GstGLFramebufferClass
{
/* <private> */
/*< private >*/
GstObjectClass object_class;
gpointer _padding[GST_PADDING];

4
gst-libs/gst/gl/gstglmemory.c
View file

@ -363,8 +363,8 @@ gst_gl_memory_init (GstGLMemory * mem, GstAllocator * allocator,
* @read_pointer: the data pointer to pass to glReadPixels
*
* Reads the texture in #GstGLMemory into @read_pointer if no buffer is bound
* to %GL_PIXEL_PACK_BUFFER. Otherwise @read_pointer is the byte offset into
* the currently bound %GL_PIXEL_PACK_BUFFER buffer to store the result of
* to `GL_PIXEL_PACK_BUFFER`. Otherwise @read_pointer is the byte offset into
* the currently bound `GL_PIXEL_PACK_BUFFER` buffer to store the result of
* glReadPixels. See the OpenGL specification for glReadPixels for more
* details.
*

14
gst-libs/gst/gl/gstglmemory.h
View file

@ -80,12 +80,12 @@ struct _GstGLMemory
guint plane;
gfloat tex_scaling[2];
/* <protected> */
/*< protected >*/
gboolean texture_wrapped;
guint unpack_length;
guint tex_width;
/* <private> */
/*< private >*/
gpointer _padding[GST_PADDING];
};
@ -122,7 +122,7 @@ struct _GstGLVideoAllocationParams
GstGLTextureTarget target;
GstGLFormat tex_format;
/* <private> */
/*< private >*/
gpointer _padding[GST_PADDING];
};
@ -202,7 +202,7 @@ void gst_gl_video_allocation_params_copy_data (GstGLVideoAllocatio
*/
struct _GstGLMemoryAllocator
{
/* <private> */
/*< private >*/
GstGLBaseMemoryAllocator parent;
gpointer _padding[GST_PADDING];
@ -216,15 +216,15 @@ struct _GstGLMemoryAllocator
*/
struct _GstGLMemoryAllocatorClass
{
/* <private> */
/*< private >*/
GstGLBaseMemoryAllocatorClass parent_class;
/* <public> */
/*< public >*/
GstGLBaseMemoryAllocatorMapFunction map;
GstGLBaseMemoryAllocatorCopyFunction copy;
GstGLBaseMemoryAllocatorUnmapFunction unmap;
/* <private> */
/*< private >*/
gpointer _padding[GST_PADDING];
};

6
gst-libs/gst/gl/gstglmemorypbo.h
View file

@ -44,7 +44,7 @@ GType gst_gl_memory_pbo_allocator_get_type(void);
*/
struct _GstGLMemoryPBO
{
/* <private> */
/*< private >*/
GstGLMemory mem;
GstGLBuffer *pbo;
@ -88,7 +88,7 @@ struct _GstGLMemoryPBOAllocator
{
GstGLMemoryAllocator parent;
/* <private> */
/*< private >*/
gpointer _padding[GST_PADDING];
};
@ -101,7 +101,7 @@ struct _GstGLMemoryPBOAllocatorClass
{
GstGLMemoryAllocatorClass parent_class;
/* <private> */
/*< private >*/
gpointer _padding[GST_PADDING];
};

4
gst-libs/gst/gl/gstgloverlaycompositor.h
View file

@ -43,7 +43,7 @@ GType gst_gl_overlay_compositor_get_type (void);
*/
struct _GstGLOverlayCompositor
{
/* <private> */
/*< private >*/
GstObject parent;
GstGLContext *context;
@ -68,7 +68,7 @@ struct _GstGLOverlayCompositorClass
{
GstObjectClass object_class;
/* <private> */
/*< private >*/
gpointer _padding[GST_PADDING];
};

3
gst-libs/gst/gl/gstglquery.h
View file

@ -46,7 +46,7 @@ typedef enum
*/
struct _GstGLQuery
{
/* <private> */
/*< private >*/
GstGLContext * context;
guint query_type;
guint query_id;
@ -55,7 +55,6 @@ struct _GstGLQuery
gboolean start_called;
GstGLAsyncDebug debug;
/* <private> */
gpointer _padding[GST_PADDING];
};

10
gst-libs/gst/gl/gstglrenderbuffer.h
View file

@ -64,10 +64,10 @@ struct _GstGLRenderbuffer
guint width;
guint height;
/* <protected> */
/*< protected >*/
gboolean renderbuffer_wrapped;
/* <private> */
/*< private >*/
gpointer _padding[GST_PADDING];
};
@ -80,7 +80,7 @@ struct _GstGLRenderbufferAllocator
{
GstGLBaseMemoryAllocator parent;
/* <private> */
/*< private >*/
gpointer _padding[GST_PADDING];
};
@ -93,7 +93,7 @@ struct _GstGLRenderbufferAllocatorClass
{
GstGLBaseMemoryAllocatorClass parent_class;
/* <private> */
/*< private >*/
gpointer _padding[GST_PADDING];
};
@ -122,7 +122,7 @@ struct _GstGLRenderbufferAllocationParams
guint width;
guint height;
/* <private> */
/*< private >*/
gpointer _padding[GST_PADDING];
};

54
gst-libs/gst/gl/gstglshader.c
View file

@ -906,7 +906,7 @@ G_PASTE(gst_gl_shader_set_uniform_,gl_suffix) (GstGLShader * shader, \
* @name: name of the uniform
* @value: value to set
*
* Perform glUniform1f() for @name on @shader
* Perform `glUniform1f()` for @name on @shader
*/
set_uniform_func_decl(1f, float value)
set_uniform_body(1f, "%f", value);
@ -918,7 +918,7 @@ set_uniform_body(1f, "%f", value);
* @count: number of values to set
* @value: (array length=count): values to set
*
* Perform glUniform1fv() for @name on @shader
* Perform `glUniform1fv()` for @name on @shader
*/
set_uniform_v(1fv, float, 1, "%f", item[0]);
@ -928,7 +928,7 @@ set_uniform_v(1fv, float, 1, "%f", item[0]);
* @name: name of the uniform
* @value: value to set
*
* Perform glUniform1i() for @name on @shader
* Perform `glUniform1i()` for @name on @shader
*/
set_uniform_func_decl(1i, int value)
set_uniform_body(1i, "%i", value);
@ -940,7 +940,7 @@ set_uniform_body(1i, "%i", value);
* @count: number of values to set
* @value: (array length=count): values to set
*
* Perform glUniform1iv() for @name on @shader
* Perform `glUniform1iv()` for @name on @shader
*/
set_uniform_v(1iv, int, 1, "%i", item[0]);
@ -951,7 +951,7 @@ set_uniform_v(1iv, int, 1, "%i", item[0]);
* @v0: first value to set
* @v1: second value to set
*
* Perform glUniform2f() for @name on @shader
* Perform `glUniform2f()` for @name on @shader
*/
set_uniform_func_decl(2f, float v0, float v1)
set_uniform_body(2f, "%f, %f", v0, v1);
@ -963,7 +963,7 @@ set_uniform_body(2f, "%f, %f", v0, v1);
* @count: number of values to set
* @value: (array length=count): values to set
*
* Perform glUniform2fv() for @name on @shader
* Perform `glUniform2fv()` for @name on @shader
*/
set_uniform_v(2fv, float, 2, "%f, %f", item[0], item[1]);
@ -974,7 +974,7 @@ set_uniform_v(2fv, float, 2, "%f, %f", item[0], item[1]);
* @v0: first value to set
* @v1: second value to set
*
* Perform glUniform2i() for @name on @shader
* Perform `glUniform2i()` for @name on @shader
*/
set_uniform_func_decl(2i, int v0, int v1)
set_uniform_body(2i, "%i, %i", v0, v1);
@ -986,7 +986,7 @@ set_uniform_body(2i, "%i, %i", v0, v1);
* @count: number of values to set
* @value: (array length=count): values to set
*
* Perform glUniform2iv() for @name on @shader
* Perform `glUniform2iv()` for @name on @shader
*/
set_uniform_v(2iv, int, 2, "%i, %i", item[0], item[1]);
@ -998,7 +998,7 @@ set_uniform_v(2iv, int, 2, "%i, %i", item[0], item[1]);
* @v1: second value to set
* @v2: third value to set
*
* Perform glUniform3f() for @name on @shader
* Perform `glUniform3f()` for @name on @shader
*/
set_uniform_func_decl(3f, float v0, float v1, float v2)
set_uniform_body(3f, "%f, %f, %f", v0, v1, v2);
@ -1010,7 +1010,7 @@ set_uniform_body(3f, "%f, %f, %f", v0, v1, v2);
* @count: number of values to set
* @value: (array length=count): values to set
*
* Perform glUniform3fv() for @name on @shader
* Perform `glUniform3fv()` for @name on @shader
*/
set_uniform_v(3fv, float, 3, "%f, %f, %f", item[0], item[1], item[2]);
@ -1022,7 +1022,7 @@ set_uniform_v(3fv, float, 3, "%f, %f, %f", item[0], item[1], item[2]);
* @v1: second value to set
* @v2: third value to set
*
* Perform glUniform3i() for @name on @shader
* Perform `glUniform3i()` for @name on @shader
*/
set_uniform_func_decl(3i, int v0, int v1, int v2)
set_uniform_body(3i, "%i, %i, %i", v0, v1, v2);
@ -1034,7 +1034,7 @@ set_uniform_body(3i, "%i, %i, %i", v0, v1, v2);
* @count: number of values to set
* @value: (array length=count): values to set
*
* Perform glUniform3iv() for @name on @shader
* Perform `glUniform3iv()` for @name on @shader
*/
set_uniform_v(3iv, int, 3, "%i, %i, %i", item[0], item[1], item[2]);
@ -1047,7 +1047,7 @@ set_uniform_v(3iv, int, 3, "%i, %i, %i", item[0], item[1], item[2]);
* @v2: third value to set
* @v3: fourth value to set
*
* Perform glUniform4f() for @name on @shader
* Perform `glUniform4f()` for @name on @shader
*/
set_uniform_func_decl(4f, float v0, float v1, float v2, float v3)
set_uniform_body(4f, "%f, %f, %f, %f", v0, v1, v2, v3);
@ -1059,7 +1059,7 @@ set_uniform_body(4f, "%f, %f, %f, %f", v0, v1, v2, v3);
* @count: number of values to set
* @value: (array length=count): values to set
*
* Perform glUniform4fv() for @name on @shader
* Perform `glUniform4fv()` for @name on @shader
*/
set_uniform_v(4fv, float, 4, "%f, %f, %f, %f", item[0], item[1], item[2], item[3]);
@ -1072,7 +1072,7 @@ set_uniform_v(4fv, float, 4, "%f, %f, %f, %f", item[0], item[1], item[2], item[3
* @v2: third value to set
* @v3: fourth value to set
*
* Perform glUniform4i() for @name on @shader
* Perform `glUniform4i()` for @name on @shader
*/
set_uniform_func_decl(4i, int v0, int v1, int v2, int v3)
set_uniform_body(4i, "%i, %i, %i, %i", v0, v1, v2, v3);
@ -1084,7 +1084,7 @@ set_uniform_body(4i, "%i, %i, %i, %i", v0, v1, v2, v3);
* @count: number of values to set
* @value: (array length=count): values to set
*
* Perform glUniform4iv() for @name on @shader
* Perform `glUniform4iv()` for @name on @shader
*/
set_uniform_v(4iv, int, 4, "%i, %i, %i, %i", item[0], item[1], item[2], item[3]);
/* *INDENT-ON* */
@ -1097,7 +1097,7 @@ set_uniform_v(4iv, int, 4, "%i, %i, %i, %i", item[0], item[1], item[2], item[3])
* @transpose: transpose the matrix
* @value: matrix to set
*
* Perform glUniformMatrix2fv() for @name on @shader
* Perform `glUniformMatrix2fv()` for @name on @shader
*/
void
gst_gl_shader_set_uniform_matrix_2fv (GstGLShader * shader, const gchar * name,
@ -1116,7 +1116,7 @@ gst_gl_shader_set_uniform_matrix_2fv (GstGLShader * shader, const gchar * name,
* @transpose: transpose the matrix
* @value: values to set
*
* Perform glUniformMatrix3fv() for @name on @shader
* Perform `glUniformMatrix3fv()` for @name on @shader
*/
void
gst_gl_shader_set_uniform_matrix_3fv (GstGLShader * shader, const gchar * name,
@ -1135,7 +1135,7 @@ gst_gl_shader_set_uniform_matrix_3fv (GstGLShader * shader, const gchar * name,
* @transpose: transpose the matrix
* @value: values to set
*
* Perform glUniformMatrix4fv() for @name on @shader
* Perform `glUniformMatrix4fv()` for @name on @shader
*/
void
gst_gl_shader_set_uniform_matrix_4fv (GstGLShader * shader, const gchar * name,
@ -1154,7 +1154,7 @@ gst_gl_shader_set_uniform_matrix_4fv (GstGLShader * shader, const gchar * name,
* @transpose: transpose the matrix
* @value: values to set
*
* Perform glUniformMatrix2x3fv() for @name on @shader
* Perform `glUniformMatrix2x3fv()` for @name on @shader
*/
void
gst_gl_shader_set_uniform_matrix_2x3fv (GstGLShader * shader,
@ -1173,7 +1173,7 @@ gst_gl_shader_set_uniform_matrix_2x3fv (GstGLShader * shader,
* @transpose: transpose the matrix
* @value: values to set
*
* Perform glUniformMatrix2x4fv() for @name on @shader
* Perform `glUniformMatrix2x4fv()` for @name on @shader
*/
void
gst_gl_shader_set_uniform_matrix_2x4fv (GstGLShader * shader,
@ -1192,7 +1192,7 @@ gst_gl_shader_set_uniform_matrix_2x4fv (GstGLShader * shader,
* @transpose: transpose the matrix
* @value: values to set
*
* Perform glUniformMatrix3x2fv() for @name on @shader
* Perform `glUniformMatrix3x2fv()` for @name on @shader
*/
void
gst_gl_shader_set_uniform_matrix_3x2fv (GstGLShader * shader,
@ -1211,7 +1211,7 @@ gst_gl_shader_set_uniform_matrix_3x2fv (GstGLShader * shader,
* @transpose: transpose the matrix
* @value: values to set
*
* Perform glUniformMatrix3x4fv() for @name on @shader
* Perform `glUniformMatrix3x4fv()` for @name on @shader
*/
void
gst_gl_shader_set_uniform_matrix_3x4fv (GstGLShader * shader,
@ -1230,7 +1230,7 @@ gst_gl_shader_set_uniform_matrix_3x4fv (GstGLShader * shader,
* @transpose: transpose the matrix
* @value: values to set
*
* Perform glUniformMatrix4x2fv() for @name on @shader
* Perform `glUniformMatrix4x2fv()` for @name on @shader
*/
void
gst_gl_shader_set_uniform_matrix_4x2fv (GstGLShader * shader,
@ -1249,7 +1249,7 @@ gst_gl_shader_set_uniform_matrix_4x2fv (GstGLShader * shader,
* @transpose: transpose the matrix
* @value: values to set
*
* Perform glUniformMatrix4x3fv() for @name on @shader
* Perform `glUniformMatrix4x3fv()` for @name on @shader
*/
void
gst_gl_shader_set_uniform_matrix_4x3fv (GstGLShader * shader,
@ -1292,7 +1292,7 @@ gst_gl_shader_get_attribute_location (GstGLShader * shader, const gchar * name)
* @name: name of the attribute
*
* Bind attribute @name to the specified location @index using
* glBindAttributeLocation().
* `glBindAttributeLocation()`.
*/
void
gst_gl_shader_bind_attribute_location (GstGLShader * shader, GLuint index,
@ -1315,7 +1315,7 @@ gst_gl_shader_bind_attribute_location (GstGLShader * shader, GLuint index,
* @name: name of the attribute
*
* Bind attribute @name to the specified location @index using
* glBindFragDataLocation().
* `glBindFragDataLocation()`.
*/
void
gst_gl_shader_bind_frag_data_location (GstGLShader * shader,

19
gst-libs/gst/gl/gstglsl.c
View file

@ -49,6 +49,11 @@ _init_debug (void)
}
}
/**
* gst_glsl_error_quark:
*
* Returns: the quark used for GstGLSL in #GError's
*/
GQuark
gst_glsl_error_quark (void)
{
@ -232,7 +237,7 @@ _is_valid_version_profile (GstGLSLVersion version, GstGLSLProfile profile)
* @version: a #GstGLSLVersion
* @profile: a #GstGLSLVersion
*
* Returns: the combined GLSL #version string for @version and @profile
* Returns: the combined GLSL `#version` string for @version and @profile
*/
gchar *
gst_glsl_version_profile_to_string (GstGLSLVersion version,
@ -295,14 +300,14 @@ _check_valid_version_preprocessor_string (const gchar * str)
/**
* gst_glsl_version_profile_from_string:
* @string: a valid GLSL #version string
* @string: a valid GLSL `#version` string
* @version_ret: (out): resulting #GstGLSLVersion
* @profile_ret: (out): resulting #GstGLSLVersion
*
* Note: this function expects either a #version GLSL preprocesser directive
* Note: this function expects either a `#version` GLSL preprocesser directive
* or a valid GLSL version and/or profile.
*
* Returns: TRUE if a valid #version string was found, FALSE otherwise
* Returns: TRUE if a valid `#version` string was found, FALSE otherwise
*/
gboolean
gst_glsl_version_profile_from_string (const gchar * string,
@ -461,14 +466,14 @@ _gst_glsl_shader_string_find_version (const gchar * str)
/**
* gst_glsl_string_get_version_profile:
* @s: string to search for a valid #version string
* @s: string to search for a valid `#version` string
* @version: (out): resulting #GstGLSLVersion
* @profile: (out): resulting #GstGLSLProfile
*
* Note: this function first searches the first 1 kilobytes for a #version
* Note: this function first searches the first 1 kilobytes for a `#version`
* preprocessor directive and then executes gst_glsl_version_profile_from_string().
*
* Returns: TRUE if a valid #version string was found, FALSE otherwise
* Returns: TRUE if a valid `#version` string was found, FALSE otherwise
*/
gboolean
gst_glsl_string_get_version_profile (const gchar * s, GstGLSLVersion * version,

2
gst-libs/gst/gl/gstglslstage.h
View file

@ -56,7 +56,7 @@ struct _GstGLSLStage
*/
struct _GstGLSLStageClass
{
/* <private> */
/*< private >*/
GstObjectClass parent;
gpointer _padding[GST_PADDING];

6
gst-libs/gst/gl/gstglupload.h
View file

@ -50,7 +50,7 @@ typedef enum
GST_GL_UPLOAD_ERROR = -1,
GST_GL_UPLOAD_UNSUPPORTED = -2,
GST_GL_UPLOAD_RECONFIGURE = -3,
/* <private> */
/*< private >*/
GST_GL_UPLOAD_UNSHARED_GL_CONTEXT = -100,
} GstGLUploadReturn;
@ -65,7 +65,7 @@ struct _GstGLUpload
GstGLContext *context;
/* <private> */
/*< private >*/
GstGLUploadPrivate *priv;
gpointer _reserved[GST_PADDING];
@ -80,7 +80,7 @@ struct _GstGLUploadClass
{
GstObjectClass object_class;
/* <private> */
/*< private >*/
gpointer _padding[GST_PADDING];
};

4
gst-libs/gst/gl/gstglviewconvert.h
View file

@ -89,7 +89,7 @@ struct _GstGLViewConvert
GstGLFramebuffer *fbo;
/* <private> */
/*< private >*/
GstGLViewConvertPrivate *priv;
gpointer _padding[GST_PADDING];
@ -102,7 +102,7 @@ struct _GstGLViewConvert
*/
struct _GstGLViewConvertClass
{
/* <private> */
/*< private >*/
GstObjectClass object_class;
gpointer _padding[GST_PADDING];

5
gst-libs/gst/gl/gstglwindow.c
View file

@ -129,6 +129,11 @@ enum
static guint gst_gl_window_signals[LAST_SIGNAL] = { 0 };
/**
* gst_gl_window_error_quark:
*
* Returns: the quark used for #GstGLWindow in #GError's
*/
GQuark
gst_gl_window_error_quark (void)
{

2
gst-libs/gst/gl/viv-fb/gstgldisplay_viv_fb.h
View file

@ -51,7 +51,7 @@ struct _GstGLDisplayVivFB
{
GstGLDisplay parent;
/* <private> */
/*< private >*/
gint disp_idx;
EGLNativeDisplayType display;
};

2
gst-libs/gst/gl/viv-fb/gstglwindow_viv_fb_egl.h
View file

@ -41,7 +41,6 @@ struct _GstGLWindowVivFBEGL {
/*< private >*/
GstGLWindow parent;
/* <private> */
EGLNativeWindowType win_id;
gboolean external_window;
gint window_width, window_height;
@ -54,7 +53,6 @@ struct _GstGLWindowVivFBEGLClass {
/*< private >*/
GstGLWindowClass parent_class;
/*< private >*/
gpointer _reserved[GST_PADDING];
};

13
gst-libs/gst/gl/wayland/gstgldisplay_wayland.c
View file

@ -18,6 +18,17 @@
* Boston, MA 02110-1301, USA.
*/
/**
* SECTION:gstgldisplay_wayland
* @short_description: Wayland display connection
* @title: GstGLDisplayWayland
* @see_also: #GstGLDisplay
*
* #GstGLDisplayWayland represents a connection to a Wayland `wl_display` handle
* created internally (gst_gl_display_wayland_new()) or wrapped by the application
* (gst_gl_display_wayland_new_with_display())
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
@ -137,7 +148,7 @@ gst_gl_display_wayland_finalize (GObject * object)
* gst_gl_display_wayland_new:
* @name: (allow-none): a display name
*
* Create a new #GstGLDisplayWayland from the wayland display name. See wl_display_connect()
* Create a new #GstGLDisplayWayland from the wayland display name. See `wl_display_connect`()
* for details on what is a valid name.
*
* Returns: (transfer full): a new #GstGLDisplayWayland or %NULL

2
gst-libs/gst/gl/wayland/gstgldisplay_wayland.h
View file

@ -60,7 +60,7 @@ struct _GstGLDisplayWayland
/* Basic shell, see private struct for others (e.g. XDG-shell) */
struct wl_shell *shell;
/* <private> */
/*< private >*/
gboolean foreign_display;
gpointer _padding[GST_PADDING];

13
gst-libs/gst/gl/x11/gstgldisplay_x11.c
View file

@ -18,6 +18,17 @@
* Boston, MA 02110-1301, USA.
*/
/**
* SECTION:gstgldisplay_x11
* @short_description: X11 Display connection
* @title: GstGLDisplayX11
* @see_also: #GstGLDisplay
*
* #GstGLDisplayX11 represents a connection to an X11 `Display` handle created
* internally (gst_gl_display_x11_new()) or wrapped by the application
* (gst_gl_display_x11_new_with_display())
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
@ -77,7 +88,7 @@ gst_gl_display_x11_finalize (GObject * object)
* gst_gl_display_x11_new:
* @name: (allow-none): a display name
*
* Create a new #GstGLDisplayX11 from the x11 display name. See XOpenDisplay()
* Create a new #GstGLDisplayX11 from the x11 display name. See `XOpenDisplay`()
* for details on what is a valid name.
*
* Returns: (transfer full): a new #GstGLDisplayX11 or %NULL