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 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT
use crate::Display;
use crate::Window;
use glib::translate::*;
use std::fmt;
use std::mem;
use std::ptr;
glib::wrapper! {
/// [`GLContext`][crate::GLContext] is an object representing the platform-specific
/// OpenGL drawing context.
///
/// `GdkGLContexts` are created for a [`Window`][crate::Window] using
/// [`Window::create_gl_context()`][crate::Window::create_gl_context()], and the context will match
/// the [`Visual`][crate::Visual] of the window.
///
/// A [`GLContext`][crate::GLContext] is not tied to any particular normal framebuffer.
/// For instance, it cannot draw to the [`Window`][crate::Window] back buffer. The GDK
/// repaint system is in full control of the painting to that. Instead,
/// you can create render buffers or textures and use `gdk_cairo_draw_from_gl()`
/// in the draw function of your widget to draw them. Then GDK will handle
/// the integration of your rendering with that of other widgets.
///
/// Support for [`GLContext`][crate::GLContext] is platform-specific, context creation
/// can fail, returning [`None`] context.
///
/// A [`GLContext`][crate::GLContext] has to be made "current" in order to start using
/// it, otherwise any OpenGL call will be ignored.
///
/// ## Creating a new OpenGL context ##
///
/// In order to create a new [`GLContext`][crate::GLContext] instance you need a
/// [`Window`][crate::Window], which you typically get during the realize call
/// of a widget.
///
/// A [`GLContext`][crate::GLContext] is not realized until either [`make_current()`][Self::make_current()],
/// or until it is realized using [`realize()`][Self::realize()]. It is possible to
/// specify details of the GL context like the OpenGL version to be used, or
/// whether the GL context should have extra state validation enabled after
/// calling [`Window::create_gl_context()`][crate::Window::create_gl_context()] by calling [`realize()`][Self::realize()].
/// If the realization fails you have the option to change the settings of the
/// [`GLContext`][crate::GLContext] and try again.
///
/// ## Using a GdkGLContext ##
///
/// You will need to make the [`GLContext`][crate::GLContext] the current context
/// before issuing OpenGL calls; the system sends OpenGL commands to
/// whichever context is current. It is possible to have multiple
/// contexts, so you always need to ensure that the one which you
/// want to draw with is the current one before issuing commands:
///
///
///
/// **⚠️ The following code is in C ⚠️**
///
/// ```C
/// gdk_gl_context_make_current (context);
/// ```
///
/// You can now perform your drawing using OpenGL commands.
///
/// You can check which [`GLContext`][crate::GLContext] is the current one by using
/// [`current()`][Self::current()]; you can also unset any [`GLContext`][crate::GLContext]
/// that is currently set by calling [`clear_current()`][Self::clear_current()].
///
/// This is an Abstract Base Class, you cannot instantiate it.
#[doc(alias = "GdkGLContext")]
pub struct GLContext(Object<ffi::GdkGLContext>);
match fn {
type_ => || ffi::gdk_gl_context_get_type(),
}
}
impl GLContext {
/// Retrieves the value set using [`set_debug_enabled()`][Self::set_debug_enabled()].
///
/// # Returns
///
/// [`true`] if debugging is enabled
#[doc(alias = "gdk_gl_context_get_debug_enabled")]
#[doc(alias = "get_debug_enabled")]
pub fn is_debug_enabled(&self) -> bool {
unsafe { from_glib(ffi::gdk_gl_context_get_debug_enabled(self.to_glib_none().0)) }
}
/// Retrieves the [`Display`][crate::Display] the `self` is created for
///
/// # Returns
///
/// a [`Display`][crate::Display] or [`None`]
#[doc(alias = "gdk_gl_context_get_display")]
#[doc(alias = "get_display")]
pub fn display(&self) -> Option<Display> {
unsafe { from_glib_none(ffi::gdk_gl_context_get_display(self.to_glib_none().0)) }
}
/// Retrieves the value set using [`set_forward_compatible()`][Self::set_forward_compatible()].
///
/// # Returns
///
/// [`true`] if the context should be forward compatible
#[doc(alias = "gdk_gl_context_get_forward_compatible")]
#[doc(alias = "get_forward_compatible")]
pub fn is_forward_compatible(&self) -> bool {
unsafe {
from_glib(ffi::gdk_gl_context_get_forward_compatible(
self.to_glib_none().0,
))
}
}
/// Retrieves the major and minor version requested by calling
/// [`set_required_version()`][Self::set_required_version()].
///
/// # Returns
///
///
/// ## `major`
/// return location for the major version to request
///
/// ## `minor`
/// return location for the minor version to request
#[doc(alias = "gdk_gl_context_get_required_version")]
#[doc(alias = "get_required_version")]
pub fn required_version(&self) -> (i32, i32) {
unsafe {
let mut major = mem::MaybeUninit::uninit();
let mut minor = mem::MaybeUninit::uninit();
ffi::gdk_gl_context_get_required_version(
self.to_glib_none().0,
major.as_mut_ptr(),
minor.as_mut_ptr(),
);
let major = major.assume_init();
let minor = minor.assume_init();
(major, minor)
}
}
/// Retrieves the [`GLContext`][crate::GLContext] that this `self` share data with.
///
/// # Returns
///
/// a [`GLContext`][crate::GLContext] or [`None`]
#[doc(alias = "gdk_gl_context_get_shared_context")]
#[doc(alias = "get_shared_context")]
#[must_use]
pub fn shared_context(&self) -> Option<GLContext> {
unsafe {
from_glib_none(ffi::gdk_gl_context_get_shared_context(
self.to_glib_none().0,
))
}
}
/// Checks whether the `self` is using an OpenGL or OpenGL ES profile.
///
/// # Returns
///
/// [`true`] if the [`GLContext`][crate::GLContext] is using an OpenGL ES profile
#[cfg(any(feature = "v3_22", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v3_22")))]
#[doc(alias = "gdk_gl_context_get_use_es")]
#[doc(alias = "get_use_es")]
pub fn uses_es(&self) -> bool {
unsafe { from_glib(ffi::gdk_gl_context_get_use_es(self.to_glib_none().0)) }
}
/// Retrieves the OpenGL version of the `self`.
///
/// The `self` must be realized prior to calling this function.
///
/// # Returns
///
///
/// ## `major`
/// return location for the major version
///
/// ## `minor`
/// return location for the minor version
#[doc(alias = "gdk_gl_context_get_version")]
#[doc(alias = "get_version")]
pub fn version(&self) -> (i32, i32) {
unsafe {
let mut major = mem::MaybeUninit::uninit();
let mut minor = mem::MaybeUninit::uninit();
ffi::gdk_gl_context_get_version(
self.to_glib_none().0,
major.as_mut_ptr(),
minor.as_mut_ptr(),
);
let major = major.assume_init();
let minor = minor.assume_init();
(major, minor)
}
}
/// Retrieves the [`Window`][crate::Window] used by the `self`.
///
/// # Returns
///
/// a [`Window`][crate::Window] or [`None`]
#[doc(alias = "gdk_gl_context_get_window")]
#[doc(alias = "get_window")]
pub fn window(&self) -> Option<Window> {
unsafe { from_glib_none(ffi::gdk_gl_context_get_window(self.to_glib_none().0)) }
}
/// Whether the [`GLContext`][crate::GLContext] is in legacy mode or not.
///
/// The [`GLContext`][crate::GLContext] must be realized before calling this function.
///
/// When realizing a GL context, GDK will try to use the OpenGL 3.2 core
/// profile; this profile removes all the OpenGL API that was deprecated
/// prior to the 3.2 version of the specification. If the realization is
/// successful, this function will return [`false`].
///
/// If the underlying OpenGL implementation does not support core profiles,
/// GDK will fall back to a pre-3.2 compatibility profile, and this function
/// will return [`true`].
///
/// You can use the value returned by this function to decide which kind
/// of OpenGL API to use, or whether to do extension discovery, or what
/// kind of shader programs to load.
///
/// # Returns
///
/// [`true`] if the GL context is in legacy mode
#[cfg(any(feature = "v3_20", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v3_20")))]
#[doc(alias = "gdk_gl_context_is_legacy")]
pub fn is_legacy(&self) -> bool {
unsafe { from_glib(ffi::gdk_gl_context_is_legacy(self.to_glib_none().0)) }
}
/// Makes the `self` the current one.
#[doc(alias = "gdk_gl_context_make_current")]
pub fn make_current(&self) {
unsafe {
ffi::gdk_gl_context_make_current(self.to_glib_none().0);
}
}
/// Realizes the given [`GLContext`][crate::GLContext].
///
/// It is safe to call this function on a realized [`GLContext`][crate::GLContext].
///
/// # Returns
///
/// [`true`] if the context is realized
#[doc(alias = "gdk_gl_context_realize")]
pub fn realize(&self) -> Result<(), glib::Error> {
unsafe {
let mut error = ptr::null_mut();
let is_ok = ffi::gdk_gl_context_realize(self.to_glib_none().0, &mut error);
assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Sets whether the [`GLContext`][crate::GLContext] should perform extra validations and
/// run time checking. This is useful during development, but has
/// additional overhead.
///
/// The [`GLContext`][crate::GLContext] must not be realized or made current prior to
/// calling this function.
/// ## `enabled`
/// whether to enable debugging in the context
#[doc(alias = "gdk_gl_context_set_debug_enabled")]
pub fn set_debug_enabled(&self, enabled: bool) {
unsafe {
ffi::gdk_gl_context_set_debug_enabled(self.to_glib_none().0, enabled.into_glib());
}
}
/// Sets whether the [`GLContext`][crate::GLContext] should be forward compatible.
///
/// Forward compatibile contexts must not support OpenGL functionality that
/// has been marked as deprecated in the requested version; non-forward
/// compatible contexts, on the other hand, must support both deprecated and
/// non deprecated functionality.
///
/// The [`GLContext`][crate::GLContext] must not be realized or made current prior to calling
/// this function.
/// ## `compatible`
/// whether the context should be forward compatible
#[doc(alias = "gdk_gl_context_set_forward_compatible")]
pub fn set_forward_compatible(&self, compatible: bool) {
unsafe {
ffi::gdk_gl_context_set_forward_compatible(
self.to_glib_none().0,
compatible.into_glib(),
);
}
}
/// Sets the major and minor version of OpenGL to request.
///
/// Setting `major` and `minor` to zero will use the default values.
///
/// The [`GLContext`][crate::GLContext] must not be realized or made current prior to calling
/// this function.
/// ## `major`
/// the major version to request
/// ## `minor`
/// the minor version to request
#[doc(alias = "gdk_gl_context_set_required_version")]
pub fn set_required_version(&self, major: i32, minor: i32) {
unsafe {
ffi::gdk_gl_context_set_required_version(self.to_glib_none().0, major, minor);
}
}
/// Requests that GDK create a OpenGL ES context instead of an OpenGL one,
/// if the platform and windowing system allows it.
///
/// The `self` must not have been realized.
///
/// By default, GDK will attempt to automatically detect whether the
/// underlying GL implementation is OpenGL or OpenGL ES once the `self`
/// is realized.
///
/// You should check the return value of [`uses_es()`][Self::uses_es()] after
/// calling [`realize()`][Self::realize()] to decide whether to use the OpenGL or
/// OpenGL ES API, extensions, or shaders.
/// ## `use_es`
/// whether the context should use OpenGL ES instead of OpenGL,
/// or -1 to allow auto-detection
#[cfg(any(feature = "v3_22", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v3_22")))]
#[doc(alias = "gdk_gl_context_set_use_es")]
pub fn set_use_es(&self, use_es: i32) {
unsafe {
ffi::gdk_gl_context_set_use_es(self.to_glib_none().0, use_es);
}
}
/// Clears the current [`GLContext`][crate::GLContext].
///
/// Any OpenGL call after this function returns will be ignored
/// until [`make_current()`][Self::make_current()] is called.
#[doc(alias = "gdk_gl_context_clear_current")]
pub fn clear_current() {
assert_initialized_main_thread!();
unsafe {
ffi::gdk_gl_context_clear_current();
}
}
/// Retrieves the current [`GLContext`][crate::GLContext].
///
/// # Returns
///
/// the current [`GLContext`][crate::GLContext], or [`None`]
#[doc(alias = "gdk_gl_context_get_current")]
#[doc(alias = "get_current")]
pub fn current() -> Option<GLContext> {
assert_initialized_main_thread!();
unsafe { from_glib_none(ffi::gdk_gl_context_get_current()) }
}
}
impl fmt::Display for GLContext {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("GLContext")
}
}