gstreamer_vulkan/auto/

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

glib::wrapper! {
    /// [`VulkanWindow`][crate::VulkanWindow] is an opaque struct and should only be accessed through the
    /// provided api.
    ///
    /// This is an Abstract Base Class, you cannot instantiate it.
    ///
    /// ## Properties
    ///
    ///
    /// #### `display`
    ///  Readable
    /// <details><summary><h4>Object</h4></summary>
    ///
    ///
    /// #### `name`
    ///  Readable | Writeable | Construct
    ///
    ///
    /// #### `parent`
    ///  The parent of the object. Please note, that when changing the 'parent'
    /// property, we don't emit [`notify`][struct@crate::glib::Object#notify] and [`deep-notify`][struct@crate::gst::Object#deep-notify]
    /// signals due to locking issues. In some cases one can use
    /// `GstBin::element-added` or `GstBin::element-removed` signals on the parent to
    /// achieve a similar effect.
    ///
    /// Readable | Writeable
    /// </details>
    ///
    /// ## Signals
    ///
    ///
    /// #### `close`
    ///
    ///
    ///
    /// #### `draw`
    ///
    ///
    ///
    /// #### `key-event`
    ///  Will be emitted when a key event is received by the [`VulkanWindow`][crate::VulkanWindow].
    ///
    ///
    ///
    ///
    /// #### `mouse-event`
    ///  Will be emitted when a mouse event is received by the [`VulkanWindow`][crate::VulkanWindow].
    ///
    ///
    ///
    ///
    /// #### `resize`
    ///
    /// <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
    ///
    /// [`VulkanWindowExt`][trait@crate::prelude::VulkanWindowExt], [`trait@gst::prelude::ObjectExt`], [`trait@glib::ObjectExt`]
    #[doc(alias = "GstVulkanWindow")]
    pub struct VulkanWindow(Object<ffi::GstVulkanWindow, ffi::GstVulkanWindowClass>) @extends gst::Object;

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

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

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

unsafe impl Send for VulkanWindow {}
unsafe impl Sync for VulkanWindow {}

/// Trait containing all [`struct@VulkanWindow`] methods.
///
/// # Implementors
///
/// [`VulkanWindow`][struct@crate::VulkanWindow]
pub trait VulkanWindowExt: IsA<VulkanWindow> + 'static {
    /// Attempt to close the window.
    #[doc(alias = "gst_vulkan_window_close")]
    fn close(&self) {
        unsafe {
            ffi::gst_vulkan_window_close(self.as_ref().to_glib_none().0);
        }
    }

    ///
    /// # Returns
    ///
    /// the [`VulkanDisplay`][crate::VulkanDisplay] for `self`
    #[doc(alias = "gst_vulkan_window_get_display")]
    #[doc(alias = "get_display")]
    fn display(&self) -> VulkanDisplay {
        unsafe {
            from_glib_full(ffi::gst_vulkan_window_get_display(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// ## `device`
    /// a [`VulkanDevice`][crate::VulkanDevice]
    /// ## `queue_family_idx`
    /// the queue family
    ///
    /// # Returns
    ///
    /// whether the given combination of `self`, `device` and
    ///  `queue_family_idx` supports presentation
    #[doc(alias = "gst_vulkan_window_get_presentation_support")]
    #[doc(alias = "get_presentation_support")]
    fn is_presentation_support(
        &self,
        device: &impl IsA<VulkanDevice>,
        queue_family_idx: u32,
    ) -> bool {
        unsafe {
            from_glib(ffi::gst_vulkan_window_get_presentation_support(
                self.as_ref().to_glib_none().0,
                device.as_ref().to_glib_none().0,
                queue_family_idx,
            ))
        }
    }

    //#[doc(alias = "gst_vulkan_window_get_surface")]
    //#[doc(alias = "get_surface")]
    //fn surface(&self) -> Result</*Ignored*/vulkan::SurfaceKHR, glib::Error> {
    //    unsafe { TODO: call ffi:gst_vulkan_window_get_surface() }
    //}

    ///
    /// # Returns
    ///
    ///
    /// ## `width`
    /// Current width of `self`
    ///
    /// ## `height`
    /// Current height of `self`
    #[doc(alias = "gst_vulkan_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_vulkan_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_vulkan_window_handle_events")]
    fn handle_events(&self, handle_events: bool) {
        unsafe {
            ffi::gst_vulkan_window_handle_events(
                self.as_ref().to_glib_none().0,
                handle_events.into_glib(),
            );
        }
    }

    ///
    /// # Returns
    ///
    /// whether `self` could be successfully opened
    #[doc(alias = "gst_vulkan_window_open")]
    fn open(&self) -> Result<(), glib::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let is_ok = ffi::gst_vulkan_window_open(self.as_ref().to_glib_none().0, &mut error);
            debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
            if error.is_null() {
                Ok(())
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    /// Ask the `self` to redraw its contents
    #[doc(alias = "gst_vulkan_window_redraw")]
    fn redraw(&self) {
        unsafe {
            ffi::gst_vulkan_window_redraw(self.as_ref().to_glib_none().0);
        }
    }

    /// Resize the output surface.
    ///
    /// Currently intended for subclasses to update internal state.
    /// ## `width`
    /// the new width
    /// ## `height`
    /// the new height
    #[doc(alias = "gst_vulkan_window_resize")]
    fn resize(&self, width: i32, height: i32) {
        unsafe {
            ffi::gst_vulkan_window_resize(self.as_ref().to_glib_none().0, width, height);
        }
    }

    #[doc(alias = "gst_vulkan_window_send_key_event")]
    fn send_key_event(&self, event_type: &str, key_str: &str) {
        unsafe {
            ffi::gst_vulkan_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_vulkan_window_send_mouse_event")]
    fn send_mouse_event(&self, event_type: &str, button: i32, posx: f64, posy: f64) {
        unsafe {
            ffi::gst_vulkan_window_send_mouse_event(
                self.as_ref().to_glib_none().0,
                event_type.to_glib_none().0,
                button,
                posx,
                posy,
            );
        }
    }

    //#[doc(alias = "gst_vulkan_window_set_window_handle")]
    //fn set_window_handle(&self, handle: /*Unimplemented*/Basic: UIntPtr) {
    //    unsafe { TODO: call ffi:gst_vulkan_window_set_window_handle() }
    //}

    #[doc(alias = "close")]
    fn connect_close<F: Fn(&Self) -> bool + Send + Sync + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn close_trampoline<
            P: IsA<VulkanWindow>,
            F: Fn(&P) -> bool + Send + Sync + 'static,
        >(
            this: *mut ffi::GstVulkanWindow,
            f: glib::ffi::gpointer,
        ) -> glib::ffi::gboolean {
            let f: &F = &*(f as *const F);
            f(VulkanWindow::from_glib_borrow(this).unsafe_cast_ref()).into_glib()
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"close".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    close_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "draw")]
    fn connect_draw<F: Fn(&Self) + Send + Sync + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn draw_trampoline<
            P: IsA<VulkanWindow>,
            F: Fn(&P) + Send + Sync + 'static,
        >(
            this: *mut ffi::GstVulkanWindow,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(VulkanWindow::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"draw".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    draw_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Will be emitted when a key event is received by the [`VulkanWindow`][crate::VulkanWindow].
    /// ## `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<VulkanWindow>,
            F: Fn(&P, &str, &str) + Send + Sync + 'static,
        >(
            this: *mut ffi::GstVulkanWindow,
            id: *mut std::ffi::c_char,
            key: *mut std::ffi::c_char,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                VulkanWindow::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() as *const _,
                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 [`VulkanWindow`][crate::VulkanWindow].
    /// ## `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<VulkanWindow>,
            F: Fn(&P, &str, i32, f64, f64) + Send + Sync + 'static,
        >(
            this: *mut ffi::GstVulkanWindow,
            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,
        ) {
            let f: &F = &*(f as *const F);
            f(
                VulkanWindow::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() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    mouse_event_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "resize")]
    fn connect_resize<F: Fn(&Self, u32, u32) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn resize_trampoline<
            P: IsA<VulkanWindow>,
            F: Fn(&P, u32, u32) + Send + Sync + 'static,
        >(
            this: *mut ffi::GstVulkanWindow,
            object: std::ffi::c_uint,
            p0: std::ffi::c_uint,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                VulkanWindow::from_glib_borrow(this).unsafe_cast_ref(),
                object,
                p0,
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"resize".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    resize_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "display")]
    fn connect_display_notify<F: Fn(&Self) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_display_trampoline<
            P: IsA<VulkanWindow>,
            F: Fn(&P) + Send + Sync + 'static,
        >(
            this: *mut ffi::GstVulkanWindow,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(VulkanWindow::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::display".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_display_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl<O: IsA<VulkanWindow>> VulkanWindowExt for O {}