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
// 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, GLBaseMemory, GLContext};
use glib::{prelude::*, translate::*};
glib::wrapper! {
/// A [`GLFramebuffer`][crate::GLFramebuffer] represents and holds an OpenGL framebuffer object with
/// it's associated attachments.
///
/// A [`GLFramebuffer`][crate::GLFramebuffer] can be created with [`new()`][Self::new()] or
/// [`with_default_depth()`][Self::with_default_depth()] and bound with
/// [`GLFramebufferExt::bind()`][crate::prelude::GLFramebufferExt::bind()]. Other resources can be bound with
/// [`GLFramebufferExt::attach()`][crate::prelude::GLFramebufferExt::attach()]
///
/// Note: OpenGL framebuffers are not shareable resources so cannot be used
/// between multiple OpenGL contexts.
///
/// # Implements
///
/// [`GLFramebufferExt`][trait@crate::prelude::GLFramebufferExt], [`trait@gst::prelude::ObjectExt`], [`trait@glib::ObjectExt`], [`GLFramebufferExtManual`][trait@crate::prelude::GLFramebufferExtManual]
#[doc(alias = "GstGLFramebuffer")]
pub struct GLFramebuffer(Object<ffi::GstGLFramebuffer, ffi::GstGLFramebufferClass>) @extends gst::Object;
match fn {
type_ => || ffi::gst_gl_framebuffer_get_type(),
}
}
impl GLFramebuffer {
pub const NONE: Option<&'static GLFramebuffer> = None;
/// This function will internally create an OpenGL framebuffer object and must
/// be called on `context`'s OpenGL thread.
/// ## `context`
/// a [`GLContext`][crate::GLContext]
///
/// # Returns
///
/// a new [`GLFramebuffer`][crate::GLFramebuffer]
#[doc(alias = "gst_gl_framebuffer_new")]
pub fn new(context: &impl IsA<GLContext>) -> GLFramebuffer {
skip_assert_initialized!();
unsafe {
from_glib_full(ffi::gst_gl_framebuffer_new(
context.as_ref().to_glib_none().0,
))
}
}
/// This function will internally create an OpenGL framebuffer object and must
/// be called on `context`'s OpenGL thread.
/// ## `context`
/// a [`GLContext`][crate::GLContext]
/// ## `width`
/// width for the depth buffer
/// ## `height`
/// for the depth buffer
///
/// # Returns
///
/// a new [`GLFramebuffer`][crate::GLFramebuffer] with a depth buffer of `width` and `height`
#[doc(alias = "gst_gl_framebuffer_new_with_default_depth")]
#[doc(alias = "new_with_default_depth")]
pub fn with_default_depth(
context: &impl IsA<GLContext>,
width: u32,
height: u32,
) -> GLFramebuffer {
skip_assert_initialized!();
unsafe {
from_glib_none(ffi::gst_gl_framebuffer_new_with_default_depth(
context.as_ref().to_glib_none().0,
width,
height,
))
}
}
}
unsafe impl Send for GLFramebuffer {}
unsafe impl Sync for GLFramebuffer {}
mod sealed {
pub trait Sealed {}
impl<T: super::IsA<super::GLFramebuffer>> Sealed for T {}
}
/// Trait containing all [`struct@GLFramebuffer`] methods.
///
/// # Implementors
///
/// [`GLFramebuffer`][struct@crate::GLFramebuffer]
pub trait GLFramebufferExt: IsA<GLFramebuffer> + sealed::Sealed + 'static {
/// attach `mem` to `attachment_point`
///
/// Must be called with the same OpenGL context current that `self` was created
/// with.
/// ## `attachment_point`
/// the OpenGL attachment point to bind `mem` to
/// ## `mem`
/// the memory object to bind to `attachment_point`
#[doc(alias = "gst_gl_framebuffer_attach")]
unsafe fn attach(&self, attachment_point: u32, mem: &mut GLBaseMemory) {
ffi::gst_gl_framebuffer_attach(
self.as_ref().to_glib_none().0,
attachment_point,
mem.to_glib_none_mut().0,
);
}
/// Bind `self` into the current thread
///
/// Must be called with the same OpenGL context current that `self` was created
/// with.
#[doc(alias = "gst_gl_framebuffer_bind")]
fn bind(&self) {
unsafe {
ffi::gst_gl_framebuffer_bind(self.as_ref().to_glib_none().0);
}
}
/// Retrieve the effective dimensions from the current attachments attached to
/// `self`.
///
/// # Returns
///
///
/// ## `width`
/// output width
///
/// ## `height`
/// output height
#[doc(alias = "gst_gl_framebuffer_get_effective_dimensions")]
#[doc(alias = "get_effective_dimensions")]
fn effective_dimensions(&self) -> (u32, u32) {
unsafe {
let mut width = std::mem::MaybeUninit::uninit();
let mut height = std::mem::MaybeUninit::uninit();
ffi::gst_gl_framebuffer_get_effective_dimensions(
self.as_ref().to_glib_none().0,
width.as_mut_ptr(),
height.as_mut_ptr(),
);
(width.assume_init(), height.assume_init())
}
}
///
/// # Returns
///
/// the OpenGL id for `self`
#[doc(alias = "gst_gl_framebuffer_get_id")]
#[doc(alias = "get_id")]
fn id(&self) -> u32 {
unsafe { ffi::gst_gl_framebuffer_get_id(self.as_ref().to_glib_none().0) }
}
}
impl<O: IsA<GLFramebuffer>> GLFramebufferExt for O {}