mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-27 20:21:24 +00:00
gl: sprinkle some Since markers
This commit is contained in:
Matthew Waters
parent
f76d1a2514
commit
f36d6daf51
3 changed files with 81 additions and 2 deletions
|
|
@ -262,6 +262,8 @@ _init_debug (void)
|
|||
* Create a new #GstGLContext with the specified @display
|
||||
*
|
||||
* Returns: a new #GstGLContext
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
GstGLContext *
|
||||
gst_gl_context_new (GstGLDisplay * display)
|
||||
|
|
@ -318,6 +320,8 @@ gst_gl_context_new (GstGLDisplay * display)
|
|||
* Wraps an existing OpenGL context into a #GstGLContext.
|
||||
*
|
||||
* Returns: a #GstGLContext wrapping @handle
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
GstGLContext *
|
||||
gst_gl_context_new_wrapped (GstGLDisplay * display, guintptr handle,
|
||||
|
|
@ -386,6 +390,8 @@ gst_gl_context_new_wrapped (GstGLDisplay * display, guintptr handle,
|
|||
* @context_type: a #GstGLPlatform specifying the type of context to retreive
|
||||
*
|
||||
* Returns: The OpenGL context handle current in the calling thread or %NULL
|
||||
*
|
||||
* Since: 1.6
|
||||
*/
|
||||
guintptr
|
||||
gst_gl_context_get_current_gl_context (GstGLPlatform context_type)
|
||||
|
|
@ -432,6 +438,8 @@ gst_gl_context_get_current_gl_context (GstGLPlatform context_type)
|
|||
*
|
||||
* Returns: The version supported by the OpenGL context current in the calling
|
||||
* thread or %GST_GL_API_NONE
|
||||
*
|
||||
* Since: 1.6
|
||||
*/
|
||||
GstGLAPI
|
||||
gst_gl_context_get_current_gl_api (guint * major, guint * minor)
|
||||
|
|
@ -580,6 +588,8 @@ gst_gl_context_finalize (GObject * object)
|
|||
* currently set window. See gst_gl_context_set_window() for details.
|
||||
*
|
||||
* Returns: Whether the activation succeeded
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
gboolean
|
||||
gst_gl_context_activate (GstGLContext * context, gboolean activate)
|
||||
|
|
@ -632,7 +642,9 @@ gst_gl_context_get_thread (GstGLContext * context)
|
|||
* The currently available API may be limited by the #GstGLDisplay in use and/or
|
||||
* the #GstGLWindow chosen.
|
||||
*
|
||||
* Returns: the currently available OpenGL api
|
||||
* Returns: the available OpenGL api
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
GstGLAPI
|
||||
gst_gl_context_get_gl_api (GstGLContext * context)
|
||||
|
|
@ -666,6 +678,8 @@ _default_get_proc_address (GstGLContext * context, const gchar * name)
|
|||
* be retreived using this method.
|
||||
*
|
||||
* Returns: a function pointer or NULL
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
gpointer
|
||||
gst_gl_context_get_proc_address (GstGLContext * context, const gchar * name)
|
||||
|
|
@ -723,6 +737,8 @@ gst_gl_context_default_get_proc_address (GstGLAPI gl_api, const gchar * name)
|
|||
* already running.
|
||||
*
|
||||
* Returns: Whether the window was successfully updated
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
gboolean
|
||||
gst_gl_context_set_window (GstGLContext * context, GstGLWindow * window)
|
||||
|
|
@ -753,6 +769,8 @@ gst_gl_context_set_window (GstGLContext * context, GstGLWindow * window)
|
|||
* @context: a #GstGLContext
|
||||
*
|
||||
* Returns: the currently set window
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
GstGLWindow *
|
||||
gst_gl_context_get_window (GstGLContext * context)
|
||||
|
|
@ -850,6 +868,8 @@ gst_gl_context_can_share (GstGLContext * context, GstGLContext * other_context)
|
|||
* Should only be called once.
|
||||
*
|
||||
* Returns: whether the context could successfully be created
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
gboolean
|
||||
gst_gl_context_create (GstGLContext * context,
|
||||
|
|
@ -1336,6 +1356,8 @@ failure:
|
|||
*
|
||||
* Should only be called after gst_gl_context_create() has been successfully
|
||||
* called for this context.
|
||||
*
|
||||
* Since: 1.6
|
||||
*/
|
||||
void
|
||||
gst_gl_context_destroy (GstGLContext * context)
|
||||
|
|
@ -1356,6 +1378,8 @@ gst_gl_context_destroy (GstGLContext * context)
|
|||
* Gets the backing OpenGL context used by @context.
|
||||
*
|
||||
* Returns: The platform specific backing OpenGL context
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
guintptr
|
||||
gst_gl_context_get_gl_context (GstGLContext * context)
|
||||
|
|
@ -1379,6 +1403,8 @@ gst_gl_context_get_gl_context (GstGLContext * context)
|
|||
* Gets the OpenGL platform that used by @context.
|
||||
*
|
||||
* Returns: The platform specific backing OpenGL context
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
GstGLPlatform
|
||||
gst_gl_context_get_gl_platform (GstGLContext * context)
|
||||
|
|
@ -1397,6 +1423,8 @@ gst_gl_context_get_gl_platform (GstGLContext * context)
|
|||
* @context: a #GstGLContext:
|
||||
*
|
||||
* Returns: the #GstGLDisplay associated with this @context
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
GstGLDisplay *
|
||||
gst_gl_context_get_display (GstGLContext * context)
|
||||
|
|
@ -1430,6 +1458,8 @@ _gst_gl_context_thread_run_generic (RunGenericData * data)
|
|||
* Execute @func in the OpenGL thread of @context with @data
|
||||
*
|
||||
* MT-safe
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
void
|
||||
gst_gl_context_thread_add (GstGLContext * context,
|
||||
|
|
@ -1463,6 +1493,8 @@ gst_gl_context_thread_add (GstGLContext * context,
|
|||
* Returns the OpenGL version implemented by @context. See
|
||||
* gst_gl_context_get_gl_api() for retreiving the OpenGL api implemented by
|
||||
* @context.
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
void
|
||||
gst_gl_context_get_gl_version (GstGLContext * context, gint * maj, gint * min)
|
||||
|
|
@ -1486,6 +1518,8 @@ gst_gl_context_get_gl_version (GstGLContext * context, gint * maj, gint * min)
|
|||
*
|
||||
* Returns: whether OpenGL context implements the required api and specified
|
||||
* version.
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
gboolean
|
||||
gst_gl_context_check_gl_version (GstGLContext * context, GstGLAPI api,
|
||||
|
|
@ -1517,6 +1551,8 @@ gst_gl_context_check_gl_version (GstGLContext * context, GstGLAPI api,
|
|||
* determine their existence and so will fail if that is not the case.
|
||||
*
|
||||
* Returns: Whether @feature is supported by @context
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
gboolean
|
||||
gst_gl_context_check_feature (GstGLContext * context, const gchar * feature)
|
||||
|
|
|
|||
|
|
@ -124,6 +124,8 @@ gst_gl_display_finalize (GObject * object)
|
|||
* gst_gl_display_new:
|
||||
*
|
||||
* Returns: (transfer full): a new #GstGLDisplay
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
GstGLDisplay *
|
||||
gst_gl_display_new (void)
|
||||
|
|
@ -195,6 +197,8 @@ gst_gl_display_default_get_handle (GstGLDisplay * display)
|
|||
* @display: a #GstGLDisplay
|
||||
*
|
||||
* Returns: the #GstGLDisplayType of @display
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
GstGLDisplayType
|
||||
gst_gl_display_get_handle_type (GstGLDisplay * display)
|
||||
|
|
@ -210,6 +214,8 @@ gst_gl_display_get_handle_type (GstGLDisplay * display)
|
|||
* @display: resulting #GstGLDisplay
|
||||
*
|
||||
* Sets @display on @context
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
void
|
||||
gst_context_set_gl_display (GstContext * context, GstGLDisplay * display)
|
||||
|
|
@ -232,6 +238,8 @@ gst_context_set_gl_display (GstContext * context, GstGLDisplay * display)
|
|||
* @display: resulting #GstGLDisplay
|
||||
*
|
||||
* Returns: Whether @display was in @context
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
gboolean
|
||||
gst_context_get_gl_display (GstContext * context, GstGLDisplay ** display)
|
||||
|
|
|
|||
|
|
@ -163,6 +163,7 @@ gst_gl_window_class_init (GstGLWindowClass * klass)
|
|||
*
|
||||
* Will be emitted when a mouse event is received by the GstGLwindow.
|
||||
*
|
||||
* Since: 1.6
|
||||
*/
|
||||
gst_gl_window_signals[EVENT_MOUSE_SIGNAL] =
|
||||
g_signal_new ("mouse-event", G_TYPE_FROM_CLASS (klass),
|
||||
|
|
@ -177,6 +178,7 @@ gst_gl_window_class_init (GstGLWindowClass * klass)
|
|||
*
|
||||
* Will be emitted when a key event is received by the GstGLwindow.
|
||||
*
|
||||
* Since: 1.6
|
||||
*/
|
||||
gst_gl_window_signals[EVENT_KEY_SIGNAL] =
|
||||
g_signal_new ("key-event", G_TYPE_FROM_CLASS (klass),
|
||||
|
|
@ -189,6 +191,8 @@ gst_gl_window_class_init (GstGLWindowClass * klass)
|
|||
* @display: a #GstGLDisplay
|
||||
*
|
||||
* Returns: (transfer full): a new #GstGLWindow using @display's connection
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
GstGLWindow *
|
||||
gst_gl_window_new (GstGLDisplay * display)
|
||||
|
|
@ -293,6 +297,8 @@ gst_gl_window_finalize (GObject * object)
|
|||
*
|
||||
* Sets the window that this @window should render into. Some implementations
|
||||
* require this to be called with a valid handle before drawing can commence.
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
void
|
||||
gst_gl_window_set_window_handle (GstGLWindow * window, guintptr handle)
|
||||
|
|
@ -314,6 +320,8 @@ gst_gl_window_set_window_handle (GstGLWindow * window, guintptr handle)
|
|||
* @height: requested height of the window
|
||||
*
|
||||
* Redraw the window contents. Implementations should invoke the draw callback.
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
void
|
||||
gst_gl_window_draw_unlocked (GstGLWindow * window, guint width, guint height)
|
||||
|
|
@ -334,6 +342,8 @@ gst_gl_window_draw_unlocked (GstGLWindow * window, guint width, guint height)
|
|||
* @height: requested height of the window
|
||||
*
|
||||
* Redraw the window contents. Implementations should invoke the draw callback.
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
void
|
||||
gst_gl_window_draw (GstGLWindow * window, guint width, guint height)
|
||||
|
|
@ -357,6 +367,8 @@ gst_gl_window_draw (GstGLWindow * window, guint width, guint height)
|
|||
* @window: a #GstGLWindow
|
||||
*
|
||||
* Start the execution of the runloop.
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
void
|
||||
gst_gl_window_run (GstGLWindow * window)
|
||||
|
|
@ -376,6 +388,8 @@ gst_gl_window_run (GstGLWindow * window)
|
|||
* @window: a #GstGLWindow
|
||||
*
|
||||
* Start the execution of the navigation runloop.
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
void
|
||||
gst_gl_window_run_navigation (GstGLWindow * window)
|
||||
|
|
@ -391,6 +405,8 @@ gst_gl_window_run_navigation (GstGLWindow * window)
|
|||
* @window: a #GstGLWindow
|
||||
*
|
||||
* Quit the runloop's execution.
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
void
|
||||
gst_gl_window_quit (GstGLWindow * window)
|
||||
|
|
@ -469,6 +485,8 @@ gst_gl_window_default_send_message (GstGLWindow * window,
|
|||
*
|
||||
* Invoke @callback with data on the window thread. @callback is guarenteed to
|
||||
* have executed when this function returns.
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
void
|
||||
gst_gl_window_send_message (GstGLWindow * window, GstGLWindowCB callback,
|
||||
|
|
@ -493,6 +511,8 @@ gst_gl_window_send_message (GstGLWindow * window, GstGLWindowCB callback,
|
|||
*
|
||||
* Invoke @callback with @data on the window thread. The callback may not
|
||||
* have been executed when this function returns.
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
void
|
||||
gst_gl_window_send_message_async (GstGLWindow * window, GstGLWindowCB callback,
|
||||
|
|
@ -516,6 +536,8 @@ gst_gl_window_send_message_async (GstGLWindow * window, GstGLWindowCB callback,
|
|||
* @destroy_notify: (destroy): called when @data is not needed any more
|
||||
*
|
||||
* Sets the draw callback called everytime gst_gl_window_draw() is called
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
void
|
||||
gst_gl_window_set_draw_callback (GstGLWindow * window, GstGLWindowCB callback,
|
||||
|
|
@ -543,6 +565,8 @@ gst_gl_window_set_draw_callback (GstGLWindow * window, GstGLWindowCB callback,
|
|||
* @destroy_notify: (destroy): called when @data is not needed any more
|
||||
*
|
||||
* Sets the resize callback called everytime a resize of the window occurs.
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
void
|
||||
gst_gl_window_set_resize_callback (GstGLWindow * window,
|
||||
|
|
@ -570,6 +594,8 @@ gst_gl_window_set_resize_callback (GstGLWindow * window,
|
|||
* @destroy_notify: (destroy): called when @data is not needed any more
|
||||
*
|
||||
* Sets the callback called when the window is about to close.
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
void
|
||||
gst_gl_window_set_close_callback (GstGLWindow * window, GstGLWindowCB callback,
|
||||
|
|
@ -594,6 +620,8 @@ gst_gl_window_set_close_callback (GstGLWindow * window, GstGLWindowCB callback,
|
|||
* @window: a #GstGLWindow
|
||||
*
|
||||
* Whether the runloop is running
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
gboolean
|
||||
gst_gl_window_is_running (GstGLWindow * window)
|
||||
|
|
@ -606,6 +634,8 @@ gst_gl_window_is_running (GstGLWindow * window)
|
|||
* @window: a #GstGLWindow
|
||||
*
|
||||
* Returns: the windowing system display handle for this @window
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
guintptr
|
||||
gst_gl_window_get_display (GstGLWindow * window)
|
||||
|
|
@ -624,6 +654,8 @@ gst_gl_window_get_display (GstGLWindow * window)
|
|||
* @window: a #GstGLWindow
|
||||
*
|
||||
* Returns: the window handle we are currently rendering into
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
guintptr
|
||||
gst_gl_window_get_window_handle (GstGLWindow * window)
|
||||
|
|
@ -642,6 +674,8 @@ gst_gl_window_get_window_handle (GstGLWindow * window)
|
|||
* @window: a #GstGLWindow
|
||||
*
|
||||
* Returns: (transfer full): the #GstGLContext associated with this @window
|
||||
*
|
||||
* Since: 1.4
|
||||
*/
|
||||
GstGLContext *
|
||||
gst_gl_window_get_context (GstGLWindow * window)
|
||||
|
|
@ -656,8 +690,9 @@ gst_gl_window_get_context (GstGLWindow * window)
|
|||
* @window: a #GstGLWindow
|
||||
* @width: (out): resulting surface width
|
||||
* @height: (out): resulting surface height
|
||||
*
|
||||
* Since: 1.6
|
||||
*/
|
||||
|
||||
void
|
||||
gst_gl_window_get_surface_dimensions (GstGLWindow * window, guint * width,
|
||||
guint * height)
|
||||
|
|
|
|||
Loading…
Reference in a new issue