gstreamer/gst-libs/gst/gl/gstglsyncmeta.h
Matthew Waters 9bafa08a5d gl/docs: massive update
- add Since: markers where necessary.
- document structs
- add documentation headers for each module (short_description,
  see_also, etc)
- reduce the number of warnings gtk-doc outputs
- fix spelling mistakes
2017-12-09 19:32:23 +00:00

95 lines
3.7 KiB
C

/*
* GStreamer
* Copyright (C) 2014 Matthew Waters <matthew@centricular.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef __GST_GL_SYNC_META_H__
#define __GST_GL_SYNC_META_H__
#include <gst/gl/gstgl_fwd.h>
G_BEGIN_DECLS
#define GST_GL_SYNC_META_API_TYPE (gst_gl_sync_meta_api_get_type())
#define GST_GL_SYNC_META_INFO (gst_gl_sync_meta_get_info())
typedef struct _GstGLSyncMeta GstGLSyncMeta;
/**
* GST_BUFFER_POOL_OPTION_GL_SYNC_META:
*
* An option that can be activated on bufferpools to request OpenGL
* synchronization metadata on buffers from the pool.
*/
#define GST_BUFFER_POOL_OPTION_GL_SYNC_META "GstBufferPoolOptionGLSyncMeta"
/**
* GstGLSyncMeta:
* @parent: the parent #GstMeta
* @context: the #GstGLContext used to allocate the meta
* @data: a custom data pointer for the implementation
* @set_sync: set a sync point in the OpenGL command stream
* @set_sync_gl: the same as @set_sync but called from @context's thread
* @wait: execute a wait on the previously set sync point into the OpenGL command stream
* @wait_gl: the same as @wait but called from @context's thread
* @wait_cpu: wait for the previously set sync point to pass from the CPU
* @wait_cpu_gl: the same as @wait_cpu but called from @context's thread
* @copy: copy @data into a new #GstGLSyncMeta
* @free: free @data
* @free_gl: free @data in @context's thread
*/
struct _GstGLSyncMeta
{
GstMeta parent;
GstGLContext *context;
gpointer data;
void (*set_sync) (GstGLSyncMeta * sync, GstGLContext * context);
void (*set_sync_gl) (GstGLSyncMeta * sync, GstGLContext * context);
void (*wait) (GstGLSyncMeta * sync, GstGLContext * context);
void (*wait_gl) (GstGLSyncMeta * sync, GstGLContext * context);
void (*wait_cpu) (GstGLSyncMeta * sync, GstGLContext * context);
void (*wait_cpu_gl) (GstGLSyncMeta * sync, GstGLContext * context);
void (*copy) (GstGLSyncMeta * src, GstBuffer * sbuffer, GstGLSyncMeta * dest, GstBuffer * dbuffer);
void (*free) (GstGLSyncMeta * sync, GstGLContext * context);
void (*free_gl) (GstGLSyncMeta * sync, GstGLContext * context);
};
GST_EXPORT
GType gst_gl_sync_meta_api_get_type (void);
GST_EXPORT
const GstMetaInfo * gst_gl_sync_meta_get_info (void);
#define gst_buffer_get_gl_sync_meta(b) ((GstGLSyncMeta*)gst_buffer_get_meta((b),GST_GL_SYNC_META_API_TYPE))
GST_EXPORT
GstGLSyncMeta * gst_buffer_add_gl_sync_meta (GstGLContext * context, GstBuffer *buffer);
GST_EXPORT
GstGLSyncMeta * gst_buffer_add_gl_sync_meta_full (GstGLContext * context, GstBuffer * buffer,
gpointer data);
GST_EXPORT
void gst_gl_sync_meta_set_sync_point (GstGLSyncMeta * sync_meta, GstGLContext * context);
GST_EXPORT
void gst_gl_sync_meta_wait (GstGLSyncMeta * sync_meta, GstGLContext * context);
GST_EXPORT
void gst_gl_sync_meta_wait_cpu (GstGLSyncMeta * sync_meta, GstGLContext * context);
G_END_DECLS
#endif /* __GST_GL_SYNC_META_H__ */