gstreamer_gl_egl/auto/
gl_display_egl.rs

1// This file was generated by gir (https://github.com/gtk-rs/gir)
2// from gir-files (https://github.com/gtk-rs/gir-files)
3// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git)
4// DO NOT EDIT
5
6use crate::ffi;
7use glib::{prelude::*, translate::*};
8
9glib::wrapper! {
10    /// the contents of a [`GLDisplayEGL`][crate::GLDisplayEGL] are private and should only be accessed
11    /// through the provided API
12    ///
13    /// # Implements
14    ///
15    /// [`trait@gst_gl::prelude::GLDisplayExt`], [`trait@gst::prelude::ObjectExt`], [`trait@glib::ObjectExt`]
16    #[doc(alias = "GstGLDisplayEGL")]
17    pub struct GLDisplayEGL(Object<ffi::GstGLDisplayEGL, ffi::GstGLDisplayEGLClass>) @extends gst_gl::GLDisplay, gst::Object;
18
19    match fn {
20        type_ => || ffi::gst_gl_display_egl_get_type(),
21    }
22}
23
24impl GLDisplayEGL {
25    pub const NONE: Option<&'static GLDisplayEGL> = None;
26
27    /// Create a new [`GLDisplayEGL`][crate::GLDisplayEGL] using the default EGL_DEFAULT_DISPLAY.
28    ///
29    /// # Returns
30    ///
31    /// a new [`GLDisplayEGL`][crate::GLDisplayEGL] or [`None`]
32    #[doc(alias = "gst_gl_display_egl_new")]
33    pub fn new() -> Result<GLDisplayEGL, glib::BoolError> {
34        assert_initialized_main_thread!();
35        unsafe {
36            Option::<_>::from_glib_full(ffi::gst_gl_display_egl_new())
37                .ok_or_else(|| glib::bool_error!("Failed to create EGL display"))
38        }
39    }
40
41    /// Create a new surfaceless [`GLDisplayEGL`][crate::GLDisplayEGL] using the Mesa3D
42    /// EGL_PLATFORM_SURFACELESS_MESA extension.
43    ///
44    /// # Returns
45    ///
46    /// a new [`GLDisplayEGL`][crate::GLDisplayEGL] or [`None`]
47    #[cfg(feature = "v1_24")]
48    #[cfg_attr(docsrs, doc(cfg(feature = "v1_24")))]
49    #[doc(alias = "gst_gl_display_egl_new_surfaceless")]
50    pub fn new_surfaceless() -> Result<GLDisplayEGL, glib::BoolError> {
51        assert_initialized_main_thread!();
52        unsafe {
53            Option::<_>::from_glib_full(ffi::gst_gl_display_egl_new_surfaceless())
54                .ok_or_else(|| glib::bool_error!("Failed to create surfaceless EGL display"))
55        }
56    }
57
58    /// Creates a EGL display connection from a native Display.
59    ///
60    /// This function will return the same value for multiple calls with the same
61    /// `display`.
62    /// ## `display`
63    /// an existing [`gst_gl::GLDisplay`][crate::gst_gl::GLDisplay]
64    ///
65    /// # Returns
66    ///
67    /// a new [`GLDisplayEGL`][crate::GLDisplayEGL]
68    #[doc(alias = "gst_gl_display_egl_from_gl_display")]
69    pub fn from_gl_display(display: &impl IsA<gst_gl::GLDisplay>) -> Option<GLDisplayEGL> {
70        assert_initialized_main_thread!();
71        unsafe {
72            from_glib_full(ffi::gst_gl_display_egl_from_gl_display(
73                display.as_ref().to_glib_none().0,
74            ))
75        }
76    }
77}
78
79unsafe impl Send for GLDisplayEGL {}
80unsafe impl Sync for GLDisplayEGL {}