Struct gstreamer_gl::GLDisplay

pub struct GLDisplay { /* private fields */ }

GLDisplay represents a connection to the underlying windowing system. Elements are required to make use of gst::Context to share and propagate a 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’, ‘surfaceless’, ‘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().

Signals

create-context

Overrides the GLContext creation mechanism. It can be called in any thread and it is emitted with display’s object lock held.

Object

deep-notify

The deep notify signal is used to be notified of property changes. It is typically attached to the toplevel bin to receive notifications from all the elements contained in that bin.

Detailed

Implements

GLDisplayExt, gst::prelude::ObjectExt, [trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl GLDisplay

pub const NONE: Option<&'static GLDisplay> = None

pub fn new() -> GLDisplay

Returns

a new GLDisplay

pub fn with_type(type_: GLDisplayType) -> Option<GLDisplay>

Will always return a GLDisplay of a single type. This differs from 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

Returns

a new GLDisplay or None if type_ is not supported

impl GLDisplay

pub fn get_gl_context_for_current_thread( display: &ObjectLockGuard<'_, GLDisplay>, ) -> Option<GLContext>

pub fn create_context( display: &ObjectLockGuard<'_, GLDisplay>, other_context: Option<&impl IsA<GLContext>>, ) -> Result<GLContext, Error>

pub fn add_context( display: &ObjectLockGuard<'_, GLDisplay>, context: &impl IsA<GLContext>, ) -> Result<(), BoolError>

pub fn remove_context( display: &ObjectLockGuard<'_, GLDisplay>, context: &impl IsA<GLContext>, )

Trait Implementations

impl Clone for GLDisplay

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GLDisplay

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GLDisplay

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for GLDisplay

type ParamSpec = ParamSpecObject

type SetValue = GLDisplay

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, GLDisplay>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for GLDisplay

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for GLDisplay

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for GLDisplay

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for GLDisplay

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for GLDisplay

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for GLDisplay

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for GLDisplay

impl IsA<Object> for GLDisplay

impl Send for GLDisplay

impl Sync for GLDisplay