gstreamer_gl/auto/

gl_display.rs

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git)
// DO NOT EDIT

use crate::{GLAPI, GLContext, GLDisplayType, GLWindow, ffi};
use glib::{
    object::ObjectType as _,
    prelude::*,
    signal::{SignalHandlerId, connect_raw},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    ///  example of such a function is X11's XInitThreads\().
    ///
    /// ## Signals
    ///
    ///
    /// #### `create-context`
    ///  Overrides the [`GLContext`][crate::GLContext] creation mechanism.
    /// It can be called in any thread and it is emitted with
    /// display's object lock held.
    ///
    ///
    /// <details><summary><h4>Object</h4></summary>
    ///
    ///
    /// #### `deep-notify`
    ///  The deep notify signal is used to be notified of property changes. It is
    /// typically attached to the toplevel bin to receive notifications from all
    /// the elements contained in that bin.
    ///
    /// Detailed
    /// </details>
    ///
    /// # Implements
    ///
    /// [`GLDisplayExt`][trait@crate::prelude::GLDisplayExt], [`trait@gst::prelude::ObjectExt`], [`trait@glib::ObjectExt`], [`GLDisplayExtManual`][trait@crate::prelude::GLDisplayExtManual]
    #[doc(alias = "GstGLDisplay")]
    pub struct GLDisplay(Object<ffi::GstGLDisplay, ffi::GstGLDisplayClass>) @extends gst::Object;

    match fn {
        type_ => || ffi::gst_gl_display_get_type(),
    }
}

impl GLDisplay {
    pub const NONE: Option<&'static GLDisplay> = None;

    ///
    /// # Returns
    ///
    /// a new [`GLDisplay`][crate::GLDisplay]
    #[doc(alias = "gst_gl_display_new")]
    pub fn new() -> GLDisplay {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::gst_gl_display_new()) }
    }

    /// Will always return a [`GLDisplay`][crate::GLDisplay] of a single type. This differs from
    /// [`new()`][Self::new()] and the seemingly equivalent call
    /// gst_gl_display_new_with_type (GST_GL_DISPLAY_TYPE_ANY) in that the latter
    /// may return NULL.
    /// ## `type_`
    /// [`GLDisplayType`][crate::GLDisplayType]
    ///
    /// # Returns
    ///
    /// a new [`GLDisplay`][crate::GLDisplay] or [`None`] if `type_` is
    ///  not supported
    #[cfg(feature = "v1_20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_20")))]
    #[doc(alias = "gst_gl_display_new_with_type")]
    #[doc(alias = "new_with_type")]
    pub fn with_type(type_: GLDisplayType) -> Option<GLDisplay> {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::gst_gl_display_new_with_type(type_.into_glib())) }
    }
}

impl Default for GLDisplay {
    fn default() -> Self {
        Self::new()
    }
}

unsafe impl Send for GLDisplay {}
unsafe impl Sync for GLDisplay {}

/// Trait containing all [`struct@GLDisplay`] methods.
///
/// # Implementors
///
/// [`GLDisplay`][struct@crate::GLDisplay]
pub trait GLDisplayExt: IsA<GLDisplay> + 'static {
    ///
    /// # Returns
    ///
    /// a new [`GLWindow`][crate::GLWindow] for `self` or [`None`].
    #[doc(alias = "gst_gl_display_create_window")]
    fn create_window(&self) -> Result<GLWindow, glib::BoolError> {
        unsafe {
            Option::<_>::from_glib_full(ffi::gst_gl_display_create_window(
                self.as_ref().to_glib_none().0,
            ))
            .ok_or_else(|| glib::bool_error!("Failed to create window"))
        }
    }

    /// limit the use of OpenGL to the requested `gl_api`. This is intended to allow
    /// application and elements to request a specific set of OpenGL API's based on
    /// what they support. See [`GLContextExt::gl_api()`][crate::prelude::GLContextExt::gl_api()] for the retrieving the
    /// API supported by a [`GLContext`][crate::GLContext].
    /// ## `gl_api`
    /// a [`GLAPI`][crate::GLAPI] to filter with
    #[doc(alias = "gst_gl_display_filter_gl_api")]
    fn filter_gl_api(&self, gl_api: GLAPI) {
        unsafe {
            ffi::gst_gl_display_filter_gl_api(self.as_ref().to_glib_none().0, gl_api.into_glib());
        }
    }

    /// see [`filter_gl_api()`][Self::filter_gl_api()] for what the returned value represents
    ///
    /// # Returns
    ///
    /// the [`GLAPI`][crate::GLAPI] configured for `self`
    #[doc(alias = "gst_gl_display_get_gl_api")]
    #[doc(alias = "get_gl_api")]
    fn gl_api(&self) -> GLAPI {
        unsafe {
            from_glib(ffi::gst_gl_display_get_gl_api(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    #[doc(alias = "gst_gl_display_get_gl_api_unlocked")]
    #[doc(alias = "get_gl_api_unlocked")]
    fn gl_api_unlocked(&self) -> GLAPI {
        unsafe {
            from_glib(ffi::gst_gl_display_get_gl_api_unlocked(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    ///
    /// # Returns
    ///
    /// the [`GLDisplayType`][crate::GLDisplayType] of `self`
    #[doc(alias = "gst_gl_display_get_handle_type")]
    #[doc(alias = "get_handle_type")]
    fn handle_type(&self) -> GLDisplayType {
        unsafe {
            from_glib(ffi::gst_gl_display_get_handle_type(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// ## `window`
    /// a [`GLWindow`][crate::GLWindow] to remove
    ///
    /// # Returns
    ///
    /// if `window` could be removed from `self`
    #[doc(alias = "gst_gl_display_remove_window")]
    fn remove_window(&self, window: &impl IsA<GLWindow>) -> Result<(), glib::error::BoolError> {
        unsafe {
            glib::result_from_gboolean!(
                ffi::gst_gl_display_remove_window(
                    self.as_ref().to_glib_none().0,
                    window.as_ref().to_glib_none().0
                ),
                "Failed to remove window"
            )
        }
    }

    //#[cfg(feature = "v1_18")]
    //#[cfg_attr(docsrs, doc(cfg(feature = "v1_18")))]
    //#[doc(alias = "gst_gl_display_retrieve_window")]
    //fn retrieve_window(&self, data: /*Unimplemented*/Option<Basic: Pointer>, compare_func: /*Unimplemented*/FnMut(/*Unimplemented*/Option<Basic: Pointer>) -> i32) -> Option<GLWindow> {
    //    unsafe { TODO: call ffi:gst_gl_display_retrieve_window() }
    //}

    /// Overrides the [`GLContext`][crate::GLContext] creation mechanism.
    /// It can be called in any thread and it is emitted with
    /// display's object lock held.
    /// ## `context`
    /// other context to share resources with.
    ///
    /// # Returns
    ///
    /// the new context.
    #[doc(alias = "create-context")]
    fn connect_create_context<
        F: Fn(&Self, &GLContext) -> Option<GLContext> + Send + Sync + 'static,
    >(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn create_context_trampoline<
            P: IsA<GLDisplay>,
            F: Fn(&P, &GLContext) -> Option<GLContext> + Send + Sync + 'static,
        >(
            this: *mut ffi::GstGLDisplay,
            context: *mut ffi::GstGLContext,
            f: glib::ffi::gpointer,
        ) -> *mut ffi::GstGLContext {
            unsafe {
                let f: &F = &*(f as *const F);
                f(
                    GLDisplay::from_glib_borrow(this).unsafe_cast_ref(),
                    &from_glib_borrow(context),
                )
                .to_glib_full()
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"create-context".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    create_context_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl<O: IsA<GLDisplay>> GLDisplayExt for O {}