gstreamer_vulkan/auto/

vulkan_full_screen_quad.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::{VulkanCommandBuffer, VulkanFence, VulkanHandle, VulkanQueue, ffi};
use glib::{prelude::*, translate::*};

glib::wrapper! {
    ///
    ///
    /// # Implements
    ///
    /// [`VulkanFullScreenQuadExt`][trait@crate::prelude::VulkanFullScreenQuadExt], [`trait@gst::prelude::ObjectExt`], [`trait@glib::ObjectExt`], [`VulkanFullScreenQuadExtManual`][trait@crate::prelude::VulkanFullScreenQuadExtManual]
    #[doc(alias = "GstVulkanFullScreenQuad")]
    pub struct VulkanFullScreenQuad(Object<ffi::GstVulkanFullScreenQuad, ffi::GstVulkanFullScreenQuadClass>) @extends gst::Object;

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

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

    /// ## `queue`
    /// a [`VulkanQueue`][crate::VulkanQueue]
    ///
    /// # Returns
    ///
    /// a new [`VulkanFullScreenQuad`][crate::VulkanFullScreenQuad]
    #[doc(alias = "gst_vulkan_full_screen_quad_new")]
    pub fn new(queue: &impl IsA<VulkanQueue>) -> VulkanFullScreenQuad {
        skip_assert_initialized!();
        unsafe {
            from_glib_full(ffi::gst_vulkan_full_screen_quad_new(
                queue.as_ref().to_glib_none().0,
            ))
        }
    }
}

unsafe impl Send for VulkanFullScreenQuad {}
unsafe impl Sync for VulkanFullScreenQuad {}

/// Trait containing all [`struct@VulkanFullScreenQuad`] methods.
///
/// # Implementors
///
/// [`VulkanFullScreenQuad`][struct@crate::VulkanFullScreenQuad]
pub trait VulkanFullScreenQuadExt: IsA<VulkanFullScreenQuad> + 'static {
    /// Helper function for creation and submission of a command buffer that draws
    /// a full screen quad. If you need to add other things to the command buffer,
    /// create the command buffer manually and call
    /// [`prepare_draw()`][Self::prepare_draw()],
    /// [`fill_command_buffer()`][Self::fill_command_buffer()] and
    /// [`submit()`][Self::submit()] instead.
    ///
    /// # Returns
    ///
    /// whether the draw was successful
    #[doc(alias = "gst_vulkan_full_screen_quad_draw")]
    fn draw(&self) -> Result<(), glib::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let is_ok =
                ffi::gst_vulkan_full_screen_quad_draw(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))
            }
        }
    }

    /// Enables blending of the input image to the output image.
    ///
    /// See also: `gst_vulkan_full_screen_quad_set_blend_operation()` and
    /// `gst_vulkan_full_screen_quad_set_blend_factors()`.
    /// ## `enable_blend`
    /// whether to enable blending
    #[doc(alias = "gst_vulkan_full_screen_quad_enable_blend")]
    fn enable_blend(&self, enable_blend: bool) {
        unsafe {
            ffi::gst_vulkan_full_screen_quad_enable_blend(
                self.as_ref().to_glib_none().0,
                enable_blend.into_glib(),
            );
        }
    }

    /// ## `enable_clear`
    /// whether to clear the framebuffer on load
    #[doc(alias = "gst_vulkan_full_screen_quad_enable_clear")]
    fn enable_clear(&self, enable_clear: bool) {
        unsafe {
            ffi::gst_vulkan_full_screen_quad_enable_clear(
                self.as_ref().to_glib_none().0,
                enable_clear.into_glib(),
            );
        }
    }

    /// `cmd` must be locked with `gst_vulkan_command_buffer_lock()`.
    /// ## `cmd`
    /// the [`VulkanCommandBuffer`][crate::VulkanCommandBuffer] to fill with commands
    ///
    /// # Returns
    ///
    /// whether `cmd` could be filled with the necessary commands
    #[doc(alias = "gst_vulkan_full_screen_quad_fill_command_buffer")]
    fn fill_command_buffer(
        &self,
        cmd: &mut VulkanCommandBuffer,
        fence: &mut VulkanFence,
    ) -> Result<(), glib::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let is_ok = ffi::gst_vulkan_full_screen_quad_fill_command_buffer(
                self.as_ref().to_glib_none().0,
                cmd.to_glib_none_mut().0,
                fence.to_glib_none_mut().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))
            }
        }
    }

    #[doc(alias = "gst_vulkan_full_screen_quad_get_last_fence")]
    #[doc(alias = "get_last_fence")]
    fn last_fence(&self) -> VulkanFence {
        unsafe {
            from_glib_full(ffi::gst_vulkan_full_screen_quad_get_last_fence(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    ///
    /// # Returns
    ///
    /// The currently configured
    ///  [`VulkanQueue`][crate::VulkanQueue]
    #[doc(alias = "gst_vulkan_full_screen_quad_get_queue")]
    #[doc(alias = "get_queue")]
    fn queue(&self) -> Option<VulkanQueue> {
        unsafe {
            from_glib_full(ffi::gst_vulkan_full_screen_quad_get_queue(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// ## `fence`
    /// a [`VulkanFence`][crate::VulkanFence] that will be signalled after submission
    ///
    /// # Returns
    ///
    /// whether the necessary information could be generated for drawing a
    /// frame.
    #[doc(alias = "gst_vulkan_full_screen_quad_prepare_draw")]
    fn prepare_draw(&self, fence: &mut VulkanFence) -> Result<(), glib::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let is_ok = ffi::gst_vulkan_full_screen_quad_prepare_draw(
                self.as_ref().to_glib_none().0,
                fence.to_glib_none_mut().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))
            }
        }
    }

    //#[doc(alias = "gst_vulkan_full_screen_quad_set_blend_factors")]
    //fn set_blend_factors(&self, src_blend_factor: /*Ignored*/&vulkan::BlendFactor, dst_blend_factor: /*Ignored*/&vulkan::BlendFactor, src_alpha_blend_factor: /*Ignored*/&vulkan::BlendFactor, dst_alpha_blend_factor: /*Ignored*/&vulkan::BlendFactor) {
    //    unsafe { TODO: call ffi:gst_vulkan_full_screen_quad_set_blend_factors() }
    //}

    //#[doc(alias = "gst_vulkan_full_screen_quad_set_blend_operation")]
    //fn set_blend_operation(&self, colour_blend_op: /*Ignored*/&vulkan::BlendOp, alpha_blend_op: /*Ignored*/&vulkan::BlendOp) {
    //    unsafe { TODO: call ffi:gst_vulkan_full_screen_quad_set_blend_operation() }
    //}

    /// Sets the immutable sampler used for input image descriptors. The sampler is
    /// fixed in the descriptor set layout instead of being provided when updating
    /// the descriptor set.
    ///
    /// This is required, for example, for samplers with
    /// `VkSamplerYcbcrConversion`, whose conversion state must be fixed at pipeline
    /// creation time.
    /// ## `sampler`
    /// a [`VulkanHandle`][crate::VulkanHandle]
    ///
    /// # Returns
    ///
    /// whether the sampler was set.
    #[cfg(feature = "v1_30")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_30")))]
    #[doc(alias = "gst_vulkan_full_screen_quad_set_immutable_sampler")]
    fn set_immutable_sampler(&self, sampler: &VulkanHandle) -> bool {
        unsafe {
            from_glib(ffi::gst_vulkan_full_screen_quad_set_immutable_sampler(
                self.as_ref().to_glib_none().0,
                sampler.to_glib_none().0,
            ))
        }
    }

    /// See also [`set_vertex_buffer()`][Self::set_vertex_buffer()]
    /// ## `indices`
    /// the index data. Must be a `GstVulkanBufferMemory`
    /// ## `n_indices`
    /// number of indices in `indices`
    ///
    /// # Returns
    ///
    /// whether the index data could be set
    #[doc(alias = "gst_vulkan_full_screen_quad_set_index_buffer")]
    fn set_index_buffer(&self, indices: &gst::Memory, n_indices: usize) -> Result<(), glib::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let is_ok = ffi::gst_vulkan_full_screen_quad_set_index_buffer(
                self.as_ref().to_glib_none().0,
                indices.to_glib_none().0,
                n_indices,
                &mut error,
            );
            debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
            if error.is_null() {
                Ok(())
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    /// ## `in_info`
    /// the input [`gst_video::VideoInfo`][crate::gst_video::VideoInfo] to set
    /// ## `out_info`
    /// the output [`gst_video::VideoInfo`][crate::gst_video::VideoInfo] to set
    ///
    /// # Returns
    ///
    /// whether the information could be successfully set
    #[doc(alias = "gst_vulkan_full_screen_quad_set_info")]
    fn set_info(&self, in_info: &gst_video::VideoInfo, out_info: &gst_video::VideoInfo) -> bool {
        unsafe {
            from_glib(ffi::gst_vulkan_full_screen_quad_set_info(
                self.as_ref().to_glib_none().0,
                in_info.to_glib_none().0,
                out_info.to_glib_none().0,
            ))
        }
    }

    /// ## `buffer`
    /// the input [`gst::Buffer`][crate::gst::Buffer] to set
    ///
    /// # Returns
    ///
    /// whether the input buffer could be changed
    #[doc(alias = "gst_vulkan_full_screen_quad_set_input_buffer")]
    fn set_input_buffer(&self, buffer: Option<&gst::Buffer>) -> Result<(), glib::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let is_ok = ffi::gst_vulkan_full_screen_quad_set_input_buffer(
                self.as_ref().to_glib_none().0,
                buffer.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))
            }
        }
    }

    /// ## `buffer`
    /// the output [`gst::Buffer`][crate::gst::Buffer] to set
    ///
    /// # Returns
    ///
    /// whether the output buffer could be changed
    #[doc(alias = "gst_vulkan_full_screen_quad_set_output_buffer")]
    fn set_output_buffer(&self, buffer: Option<&gst::Buffer>) -> Result<(), glib::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let is_ok = ffi::gst_vulkan_full_screen_quad_set_output_buffer(
                self.as_ref().to_glib_none().0,
                buffer.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))
            }
        }
    }

    /// Sets the sampler used for input image descriptors. The sampler is provided
    /// when updating the descriptor set.
    /// ## `sampler`
    /// a [`VulkanHandle`][crate::VulkanHandle]
    ///
    /// # Returns
    ///
    /// whether the sampler was set.
    #[cfg(feature = "v1_30")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_30")))]
    #[doc(alias = "gst_vulkan_full_screen_quad_set_sampler")]
    fn set_sampler(&self, sampler: &VulkanHandle) -> bool {
        unsafe {
            from_glib(ffi::gst_vulkan_full_screen_quad_set_sampler(
                self.as_ref().to_glib_none().0,
                sampler.to_glib_none().0,
            ))
        }
    }

    /// ## `vert`
    /// the vertex shader to set
    /// ## `frag`
    /// the fragment shader to set
    ///
    /// # Returns
    ///
    /// whether the shaders could be set
    #[doc(alias = "gst_vulkan_full_screen_quad_set_shaders")]
    fn set_shaders(&self, vert: &VulkanHandle, frag: &VulkanHandle) -> bool {
        unsafe {
            from_glib(ffi::gst_vulkan_full_screen_quad_set_shaders(
                self.as_ref().to_glib_none().0,
                vert.to_glib_none().0,
                frag.to_glib_none().0,
            ))
        }
    }

    /// ## `uniforms`
    /// the uniform data to set. Must be a `GstVulkanBufferMemory`
    ///
    /// # Returns
    ///
    /// whether the uniform buffer could be set
    #[doc(alias = "gst_vulkan_full_screen_quad_set_uniform_buffer")]
    fn set_uniform_buffer(&self, uniforms: &gst::Memory) -> Result<(), glib::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let is_ok = ffi::gst_vulkan_full_screen_quad_set_uniform_buffer(
                self.as_ref().to_glib_none().0,
                uniforms.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))
            }
        }
    }

    /// ## `vertices`
    /// the vertex data. Must be a `GstVulkanBufferMemory`
    ///
    /// # Returns
    ///
    /// whether the vertex data could be set
    #[doc(alias = "gst_vulkan_full_screen_quad_set_vertex_buffer")]
    fn set_vertex_buffer(&self, vertices: &gst::Memory) -> Result<(), glib::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let is_ok = ffi::gst_vulkan_full_screen_quad_set_vertex_buffer(
                self.as_ref().to_glib_none().0,
                vertices.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))
            }
        }
    }

    /// ## `cmd`
    /// a [`VulkanCommandBuffer`][crate::VulkanCommandBuffer] to submit
    /// ## `fence`
    /// a [`VulkanFence`][crate::VulkanFence] to signal on completion
    ///
    /// # Returns
    ///
    /// whether `cmd` could be submitted to the queue
    #[doc(alias = "gst_vulkan_full_screen_quad_submit")]
    fn submit(&self, cmd: VulkanCommandBuffer, fence: &mut VulkanFence) -> Result<(), glib::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let is_ok = ffi::gst_vulkan_full_screen_quad_submit(
                self.as_ref().to_glib_none().0,
                cmd.into_glib_ptr(),
                fence.to_glib_none_mut().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))
            }
        }
    }
}

impl<O: IsA<VulkanFullScreenQuad>> VulkanFullScreenQuadExt for O {}