1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
// 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;
use crate::GLDisplayType;
use crate::GLWindow;
use crate::GLAPI;
use glib::object::Cast;
use glib::object::IsA;
use glib::signal::connect_raw;
use glib::signal::SignalHandlerId;
use glib::translate::*;
use std::boxed::Box as Box_;
use std::mem::transmute;
use std::ptr;
glib::wrapper! {
/// [`GLDisplay`][crate::GLDisplay] represents a connection to the underlying windowing system.
/// Elements are required to make use of [`gst::Context`][crate::gst::Context] to share and propagate
/// a [`GLDisplay`][crate::GLDisplay].
///
/// There are a number of environment variables that influence the choice of
/// platform and window system specific functionality.
/// - GST_GL_WINDOW influences the window system to use. Common values are
/// 'x11', 'wayland', 'win32' or 'cocoa'.
/// - GST_GL_PLATFORM influences the OpenGL platform to use. Common values are
/// 'egl', 'glx', 'wgl' or 'cgl'.
/// - GST_GL_API influences the OpenGL API requested by the OpenGL platform.
/// Common values are 'opengl', 'opengl3' and 'gles2'.
///
/// > Certain window systems require a special function to be called to
/// > initialize threading support. As this GStreamer GL library does not preclude
/// > concurrent access to the windowing system, it is strongly advised that
/// > applications ensure that threading support has been initialized before any
/// > other toolkit/library functionality is accessed. Failure to do so could
/// > result in sudden application abortion during execution. The most notably
/// > example of such a function is X11's XInitThreads\().
///
/// # Implements
///
/// [`GLDisplayExt`][trait@crate::prelude::GLDisplayExt], [`trait@gst::prelude::ObjectExt`], [`trait@glib::ObjectExt`]
#[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(any(feature = "v1_20", feature = "dox"))]
#[cfg_attr(feature = "dox", 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: 'static {
/// ## `context`
/// a [`GLContext`][crate::GLContext]
///
/// # Returns
///
/// whether `context` was successfully added. [`false`] may be returned
/// if there already exists another context for `context`'s active thread.
///
/// Must be called with the object lock held.
#[doc(alias = "gst_gl_display_add_context")]
fn add_context(&self, context: &impl IsA<GLContext>) -> Result<(), glib::error::BoolError>;
/// It requires the display's object lock to be held.
/// ## `other_context`
/// other [`GLContext`][crate::GLContext] to share resources with.
///
/// # Returns
///
/// whether a new context could be created.
///
/// ## `p_context`
/// resulting [`GLContext`][crate::GLContext]
#[doc(alias = "gst_gl_display_create_context")]
fn create_context(&self, other_context: &impl IsA<GLContext>)
-> Result<GLContext, glib::Error>;
///
/// # 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>;
/// 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);
/// 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;
#[doc(alias = "gst_gl_display_get_gl_api_unlocked")]
#[doc(alias = "get_gl_api_unlocked")]
fn gl_api_unlocked(&self) -> GLAPI;
///
/// # 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;
/// Must be called with the object lock held.
/// ## `context`
/// the [`GLContext`][crate::GLContext] to remove
#[cfg(any(feature = "v1_18", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v1_18")))]
#[doc(alias = "gst_gl_display_remove_context")]
fn remove_context(&self, context: &impl IsA<GLContext>);
/// ## `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>;
//#[cfg(any(feature = "v1_18", feature = "dox"))]
//#[cfg_attr(feature = "dox", doc(cfg(feature = "v1_18")))]
//#[doc(alias = "gst_gl_display_retrieve_window")]
//fn retrieve_window(&self, data: /*Unimplemented*/Option<Fundamental: Pointer>, compare_func: /*Unimplemented*/FnMut(/*Unimplemented*/Option<Fundamental: Pointer>, /*Unimplemented*/Option<Fundamental: Pointer>) -> i32) -> Option<GLWindow>;
/// 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) -> GLContext + Send + Sync + 'static>(
&self,
f: F,
) -> SignalHandlerId;
}
impl<O: IsA<GLDisplay>> GLDisplayExt for O {
fn add_context(&self, context: &impl IsA<GLContext>) -> Result<(), glib::error::BoolError> {
unsafe {
glib::result_from_gboolean!(
ffi::gst_gl_display_add_context(
self.as_ref().to_glib_none().0,
context.as_ref().to_glib_none().0
),
"Failed to add OpenGL context"
)
}
}
fn create_context(
&self,
other_context: &impl IsA<GLContext>,
) -> Result<GLContext, glib::Error> {
unsafe {
let mut p_context = ptr::null_mut();
let mut error = ptr::null_mut();
let is_ok = ffi::gst_gl_display_create_context(
self.as_ref().to_glib_none().0,
other_context.as_ref().to_glib_none().0,
&mut p_context,
&mut error,
);
assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(from_glib_full(p_context))
} else {
Err(from_glib_full(error))
}
}
}
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"))
}
}
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());
}
}
fn gl_api(&self) -> GLAPI {
unsafe {
from_glib(ffi::gst_gl_display_get_gl_api(
self.as_ref().to_glib_none().0,
))
}
}
fn gl_api_unlocked(&self) -> GLAPI {
unsafe {
from_glib(ffi::gst_gl_display_get_gl_api_unlocked(
self.as_ref().to_glib_none().0,
))
}
}
fn handle_type(&self) -> GLDisplayType {
unsafe {
from_glib(ffi::gst_gl_display_get_handle_type(
self.as_ref().to_glib_none().0,
))
}
}
#[cfg(any(feature = "v1_18", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v1_18")))]
fn remove_context(&self, context: &impl IsA<GLContext>) {
unsafe {
ffi::gst_gl_display_remove_context(
self.as_ref().to_glib_none().0,
context.as_ref().to_glib_none().0,
);
}
}
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(any(feature = "v1_18", feature = "dox"))]
//#[cfg_attr(feature = "dox", doc(cfg(feature = "v1_18")))]
//fn retrieve_window(&self, data: /*Unimplemented*/Option<Fundamental: Pointer>, compare_func: /*Unimplemented*/FnMut(/*Unimplemented*/Option<Fundamental: Pointer>, /*Unimplemented*/Option<Fundamental: Pointer>) -> i32) -> Option<GLWindow> {
// unsafe { TODO: call ffi:gst_gl_display_retrieve_window() }
//}
fn connect_create_context<F: Fn(&Self, &GLContext) -> GLContext + Send + Sync + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn create_context_trampoline<
P: IsA<GLDisplay>,
F: Fn(&P, &GLContext) -> GLContext + Send + Sync + 'static,
>(
this: *mut ffi::GstGLDisplay,
context: *mut ffi::GstGLContext,
f: glib::ffi::gpointer,
) -> *mut ffi::GstGLContext {
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 _,
b"create-context\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
create_context_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}