gstreamer_gl/auto/

gl_window.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::{GLContext, GLDisplay, ffi};
use glib::{
    object::ObjectType as _,
    prelude::*,
    signal::{SignalHandlerId, connect_raw},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// GstGLWindow represents a window that elements can render into. A window can
    /// either be a user visible window (onscreen) or hidden (offscreen).
    ///
    /// This is an Abstract Base Class, you cannot instantiate it.
    ///
    /// ## Signals
    ///
    ///
    /// #### `key-event`
    ///  Will be emitted when a key event is received by the GstGLwindow.
    ///
    ///
    ///
    ///
    /// #### `mouse-event`
    ///  Will be emitted when a mouse event is received by the GstGLwindow.
    ///
    ///
    ///
    ///
    /// #### `scroll-event`
    ///  Will be emitted when a mouse scroll event is received by the GstGLwindow.
    ///
    ///
    ///
    ///
    /// #### `window-handle-changed`
    ///  Will be emitted when the window handle has been set into the native
    /// implementation, but before the context is re-activated. By using this
    /// signal, elements can refresh associated resource without relying on
    /// direct handle comparision.
    ///
    ///
    /// <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
    ///
    /// [`GLWindowExt`][trait@crate::prelude::GLWindowExt], [`trait@gst::prelude::ObjectExt`], [`trait@glib::ObjectExt`]
    #[doc(alias = "GstGLWindow")]
    pub struct GLWindow(Object<ffi::GstGLWindow, ffi::GstGLWindowClass>) @extends gst::Object;

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

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

    /// ## `display`
    /// a [`GLDisplay`][crate::GLDisplay]
    ///
    /// # Returns
    ///
    /// a new [`GLWindow`][crate::GLWindow] using `display`'s connection
    #[doc(alias = "gst_gl_window_new")]
    pub fn new(display: &impl IsA<GLDisplay>) -> GLWindow {
        skip_assert_initialized!();
        unsafe { from_glib_full(ffi::gst_gl_window_new(display.as_ref().to_glib_none().0)) }
    }
}

unsafe impl Send for GLWindow {}
unsafe impl Sync for GLWindow {}

/// Trait containing all [`struct@GLWindow`] methods.
///
/// # Implementors
///
/// [`GLWindow`][struct@crate::GLWindow]
pub trait GLWindowExt: IsA<GLWindow> + 'static {
    /// Checks if `self` controls the GL viewport.
    ///
    /// # Returns
    ///
    /// [`true`] if `self` controls the GL viewport, otherwise [`false`]
    #[cfg(feature = "v1_16")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_16")))]
    #[doc(alias = "gst_gl_window_controls_viewport")]
    fn controls_viewport(&self) -> bool {
        unsafe {
            from_glib(ffi::gst_gl_window_controls_viewport(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Redraw the window contents. Implementations should invoke the draw callback.
    #[doc(alias = "gst_gl_window_draw")]
    fn draw(&self) {
        unsafe {
            ffi::gst_gl_window_draw(self.as_ref().to_glib_none().0);
        }
    }

    ///
    /// # Returns
    ///
    /// the [`GLContext`][crate::GLContext] associated with this `self`
    #[doc(alias = "gst_gl_window_get_context")]
    #[doc(alias = "get_context")]
    fn context(&self) -> GLContext {
        unsafe {
            from_glib_full(ffi::gst_gl_window_get_context(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    ///
    /// # Returns
    ///
    /// whether an visible output surface has been requested
    #[cfg(feature = "v1_28")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_28")))]
    #[doc(alias = "gst_gl_window_get_request_output_surface")]
    #[doc(alias = "get_request_output_surface")]
    fn is_request_output_surface(&self) -> bool {
        unsafe {
            from_glib(ffi::gst_gl_window_get_request_output_surface(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    ///
    /// # Returns
    ///
    ///
    /// ## `width`
    /// resulting surface width
    ///
    /// ## `height`
    /// resulting surface height
    #[doc(alias = "gst_gl_window_get_surface_dimensions")]
    #[doc(alias = "get_surface_dimensions")]
    fn surface_dimensions(&self) -> (u32, u32) {
        unsafe {
            let mut width = std::mem::MaybeUninit::uninit();
            let mut height = std::mem::MaybeUninit::uninit();
            ffi::gst_gl_window_get_surface_dimensions(
                self.as_ref().to_glib_none().0,
                width.as_mut_ptr(),
                height.as_mut_ptr(),
            );
            (width.assume_init(), height.assume_init())
        }
    }

    /// Tell a `self` that it should handle events from the window system. These
    /// events are forwarded upstream as navigation events. In some window systems
    /// events are not propagated in the window hierarchy if a client is listening
    /// for them. This method allows you to disable events handling completely
    /// from the `self`.
    /// ## `handle_events`
    /// a `gboolean` indicating if events should be handled or not.
    #[doc(alias = "gst_gl_window_handle_events")]
    fn handle_events(&self, handle_events: bool) {
        unsafe {
            ffi::gst_gl_window_handle_events(
                self.as_ref().to_glib_none().0,
                handle_events.into_glib(),
            );
        }
    }

    /// Query whether `self` has output surface or not
    ///
    /// # Returns
    ///
    /// [`true`] if `self` has useable output surface
    #[cfg(feature = "v1_18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_18")))]
    #[doc(alias = "gst_gl_window_has_output_surface")]
    fn has_output_surface(&self) -> bool {
        unsafe {
            from_glib(ffi::gst_gl_window_has_output_surface(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Queue resizing of `self`.
    #[doc(alias = "gst_gl_window_queue_resize")]
    fn queue_resize(&self) {
        unsafe {
            ffi::gst_gl_window_queue_resize(self.as_ref().to_glib_none().0);
        }
    }

    /// Quit the runloop's execution.
    #[doc(alias = "gst_gl_window_quit")]
    fn quit(&self) {
        unsafe {
            ffi::gst_gl_window_quit(self.as_ref().to_glib_none().0);
        }
    }

    /// Resize `self` to the given `width` and `height`.
    /// ## `width`
    /// new width
    /// ## `height`
    /// new height
    #[doc(alias = "gst_gl_window_resize")]
    fn resize(&self, width: u32, height: u32) {
        unsafe {
            ffi::gst_gl_window_resize(self.as_ref().to_glib_none().0, width, height);
        }
    }

    /// Start the execution of the runloop.
    #[doc(alias = "gst_gl_window_run")]
    fn run(&self) {
        unsafe {
            ffi::gst_gl_window_run(self.as_ref().to_glib_none().0);
        }
    }

    #[doc(alias = "gst_gl_window_send_key_event")]
    fn send_key_event(&self, event_type: &str, key_str: &str) {
        unsafe {
            ffi::gst_gl_window_send_key_event(
                self.as_ref().to_glib_none().0,
                event_type.to_glib_none().0,
                key_str.to_glib_none().0,
            );
        }
    }

    #[doc(alias = "gst_gl_window_send_mouse_event")]
    fn send_mouse_event(&self, event_type: &str, button: i32, posx: f64, posy: f64) {
        unsafe {
            ffi::gst_gl_window_send_mouse_event(
                self.as_ref().to_glib_none().0,
                event_type.to_glib_none().0,
                button,
                posx,
                posy,
            );
        }
    }

    /// Notify a `self` about a scroll event. A scroll signal holding the event
    /// coordinates will be emitted.
    /// ## `posx`
    /// x position of the mouse cursor
    /// ## `posy`
    /// y position of the mouse cursor
    /// ## `delta_x`
    /// the x offset of the scroll event
    /// ## `delta_y`
    /// the y offset of the scroll event
    #[cfg(feature = "v1_18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_18")))]
    #[doc(alias = "gst_gl_window_send_scroll_event")]
    fn send_scroll_event(&self, posx: f64, posy: f64, delta_x: f64, delta_y: f64) {
        unsafe {
            ffi::gst_gl_window_send_scroll_event(
                self.as_ref().to_glib_none().0,
                posx,
                posy,
                delta_x,
                delta_y,
            );
        }
    }

    /// Set the preferred width and height of the window. Implementations are free
    /// to ignore this information.
    /// ## `width`
    /// new preferred width
    /// ## `height`
    /// new preferred height
    #[doc(alias = "gst_gl_window_set_preferred_size")]
    fn set_preferred_size(&self, width: i32, height: i32) {
        unsafe {
            ffi::gst_gl_window_set_preferred_size(self.as_ref().to_glib_none().0, width, height);
        }
    }

    /// Tell a `self` that it should render into a specific region of the window
    /// according to the [`gst_video::VideoOverlay`][crate::gst_video::VideoOverlay] interface.
    /// ## `x`
    /// x position
    /// ## `y`
    /// y position
    /// ## `width`
    /// width
    /// ## `height`
    /// height
    ///
    /// # Returns
    ///
    /// whether the specified region could be set
    #[doc(alias = "gst_gl_window_set_render_rectangle")]
    fn set_render_rectangle(
        &self,
        x: i32,
        y: i32,
        width: i32,
        height: i32,
    ) -> Result<(), glib::error::BoolError> {
        unsafe {
            glib::result_from_gboolean!(
                ffi::gst_gl_window_set_render_rectangle(
                    self.as_ref().to_glib_none().0,
                    x,
                    y,
                    width,
                    height
                ),
                "Failed to set the specified region"
            )
        }
    }

    /// Configure whether a visible output surface is requested.
    /// ## `output_surface`
    /// whether to request an output surface.
    #[cfg(feature = "v1_28")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_28")))]
    #[doc(alias = "gst_gl_window_set_request_output_surface")]
    fn set_request_output_surface(&self, output_surface: bool) {
        unsafe {
            ffi::gst_gl_window_set_request_output_surface(
                self.as_ref().to_glib_none().0,
                output_surface.into_glib(),
            );
        }
    }

    /// Present the window to the screen.
    #[doc(alias = "gst_gl_window_show")]
    fn show(&self) {
        unsafe {
            ffi::gst_gl_window_show(self.as_ref().to_glib_none().0);
        }
    }

    /// Will be emitted when a key event is received by the GstGLwindow.
    /// ## `id`
    /// the name of the event
    /// ## `key`
    /// the id of the key pressed
    #[doc(alias = "key-event")]
    fn connect_key_event<F: Fn(&Self, &str, &str) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn key_event_trampoline<
            P: IsA<GLWindow>,
            F: Fn(&P, &str, &str) + Send + Sync + 'static,
        >(
            this: *mut ffi::GstGLWindow,
            id: *mut std::ffi::c_char,
            key: *mut std::ffi::c_char,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(
                    GLWindow::from_glib_borrow(this).unsafe_cast_ref(),
                    &glib::GString::from_glib_borrow(id),
                    &glib::GString::from_glib_borrow(key),
                )
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"key-event".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    key_event_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Will be emitted when a mouse event is received by the GstGLwindow.
    /// ## `id`
    /// the name of the event
    /// ## `button`
    /// the id of the button
    /// ## `x`
    /// the x coordinate of the mouse event
    /// ## `y`
    /// the y coordinate of the mouse event
    #[doc(alias = "mouse-event")]
    fn connect_mouse_event<F: Fn(&Self, &str, i32, f64, f64) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn mouse_event_trampoline<
            P: IsA<GLWindow>,
            F: Fn(&P, &str, i32, f64, f64) + Send + Sync + 'static,
        >(
            this: *mut ffi::GstGLWindow,
            id: *mut std::ffi::c_char,
            button: std::ffi::c_int,
            x: std::ffi::c_double,
            y: std::ffi::c_double,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(
                    GLWindow::from_glib_borrow(this).unsafe_cast_ref(),
                    &glib::GString::from_glib_borrow(id),
                    button,
                    x,
                    y,
                )
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"mouse-event".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    mouse_event_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Will be emitted when a mouse scroll event is received by the GstGLwindow.
    /// ## `x`
    /// the x coordinate of the mouse event
    /// ## `y`
    /// the y coordinate of the mouse event
    /// ## `delta_x`
    /// the x offset of the scroll event
    /// ## `delta_y`
    /// the y offset of the scroll event
    #[cfg(feature = "v1_18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_18")))]
    #[doc(alias = "scroll-event")]
    fn connect_scroll_event<F: Fn(&Self, f64, f64, f64, f64) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn scroll_event_trampoline<
            P: IsA<GLWindow>,
            F: Fn(&P, f64, f64, f64, f64) + Send + Sync + 'static,
        >(
            this: *mut ffi::GstGLWindow,
            x: std::ffi::c_double,
            y: std::ffi::c_double,
            delta_x: std::ffi::c_double,
            delta_y: std::ffi::c_double,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(
                    GLWindow::from_glib_borrow(this).unsafe_cast_ref(),
                    x,
                    y,
                    delta_x,
                    delta_y,
                )
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"scroll-event".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    scroll_event_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Will be emitted when the window handle has been set into the native
    /// implementation, but before the context is re-activated. By using this
    /// signal, elements can refresh associated resource without relying on
    /// direct handle comparision.
    #[cfg(feature = "v1_20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_20")))]
    #[doc(alias = "window-handle-changed")]
    fn connect_window_handle_changed<F: Fn(&Self) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn window_handle_changed_trampoline<
            P: IsA<GLWindow>,
            F: Fn(&P) + Send + Sync + 'static,
        >(
            this: *mut ffi::GstGLWindow,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(GLWindow::from_glib_borrow(this).unsafe_cast_ref())
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"window-handle-changed".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    window_handle_changed_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl<O: IsA<GLWindow>> GLWindowExt for O {}