Struct gstreamer_gl::GLContext[−][src]

pub struct GLContext(_);

Expand description

GLContext wraps an OpenGL context object in a uniform API. As a result of the limitation on OpenGL context, this object is not thread safe unless specified and must only be activated in a single thread.

Environment variables:

GST_GL_API: select which OpenGL API to create and OpenGL context for. Depending on the platform, the available values are ‘opengl’, ‘opengl3’ (core profile), and ‘gles2’. See the the GLAPI enumeration for more details.
GST_GL_PLATFORM: select which OpenGL platform to create an OpenGL context with. Depending on the platform and the dependencies available build-time, the available values are, ‘glx’, ‘egl’, ‘cgl’, ‘wgl’, and ‘eagl’
GST_GL_CONFIG: select the configuration used for creating the OpenGL context and OpenGL surface. Written out as a GstStructure that has been serialized to string. e.g. GST_GL_CONFIG="gst-gl-context-config,red-size=8,green-size=8,blue-size=8,alpha-size=8,depth-size=16". Not all platforms will support the same level of functionality.

This is an Abstract Base Class, you cannot instantiate it.

Implements

GLContextExt, gst::prelude::ObjectExt, trait@glib::ObjectExt, GLContextExtManual

Implementations

impl GLContext[src]

pub fn new<P: IsA<GLDisplay>>(display: &P) -> GLContext[src]

Create a new GLContext with the specified display

`display`

a GLDisplay

Returns

a new GLContext

pub fn current() -> Option<GLContext>[src]

Returns

the GLContext active in the current thread or None

pub fn current_gl_api(platform: GLPlatform) -> (GLAPI, u32, u32)[src]

If an error occurs, major and minor are not modified and GST_GL_API_NONE is returned.

`platform`

the GLPlatform to retrieve the API for

Returns

The version supported by the OpenGL context current in the calling thread or GST_GL_API_NONE

`major`

the major version

`minor`

the minor version

impl GLContext[src]

pub unsafe fn new_wrapped<T: IsA<GLDisplay>>(
    display: &T, 
    handle: uintptr_t, 
    context_type: GLPlatform, 
    available_apis: GLAPI
) -> Option<Self>

[src]

Wraps an existing OpenGL context into a GLContext.

Note: The caller is responsible for ensuring that the OpenGL context represented by handle stays alive while the returned GLContext is active.

context_type must not be GST_GL_PLATFORM_NONE or GST_GL_PLATFORM_ANY

available_apis must not be GST_GL_API_NONE or GST_GL_API_ANY

`display`

a GLDisplay

`handle`

the OpenGL context to wrap

`context_type`

a GLPlatform specifying the type of context in handle

`available_apis`

a GLAPI containing the available OpenGL apis in handle

Returns

a GLContext wrapping handle

pub fn current_gl_context(context_type: GLPlatform) -> uintptr_t[src]

`context_type`

a GLPlatform specifying the type of context to retrieve

Returns

The OpenGL context handle current in the calling thread or None

pub fn proc_address_with_platform(
    context_type: GLPlatform, 
    gl_api: GLAPI, 
    name: &str
) -> uintptr_t

[src]

Attempts to use the context_type specific GetProcAddress implementations to retrieve name.

`context_type`

a GLPlatform

`gl_api`

a GLAPI

`name`

the name of the function to retrieve

Returns

a function pointer for name, or None

Trait Implementations

impl Clone for GLContext[src]

fn clone(&self) -> GLContext[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0 [src]

Performs copy-assignment from source. Read more

impl Debug for GLContext[src]

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

Formats the value using the given formatter. Read more

impl Hash for GLContext[src]

fn hash<__H: Hasher>(&self, state: &mut __H)[src]

Feeds this value into the given Hasher. Read more

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

1.3.0 [src]

Feeds a slice of this type into the given Hasher. Read more

impl Ord for GLContext[src]

fn cmp(&self, other: &GLContext) -> Ordering[src]

This method returns an Ordering between self and other. Read more

#[must_use]
fn max(self, other: Self) -> Self

1.21.0 [src]

Compares and returns the maximum of two values. Read more

#[must_use]
fn min(self, other: Self) -> Self

1.21.0 [src]

Compares and returns the minimum of two values. Read more

#[must_use]
fn clamp(self, min: Self, max: Self) -> Self

1.50.0 [src]

Restrict a value to a certain interval. Read more

impl ParentClassIs for GLContext[src]

type Parent = Object

impl<T: ObjectType> PartialEq<T> for GLContext[src]

fn eq(&self, other: &T) -> bool[src]

This method tests for self and other values to be equal, and is used by ==. Read more

#[must_use]
fn ne(&self, other: &Rhs) -> bool

1.0.0 [src]

This method tests for !=.

impl<T: ObjectType> PartialOrd<T> for GLContext[src]

fn partial_cmp(&self, other: &T) -> Option<Ordering>[src]

This method returns an ordering between self and other values if one exists. Read more

#[must_use]
fn lt(&self, other: &Rhs) -> bool

1.0.0 [src]

This method tests less than (for self and other) and is used by the < operator. Read more

#[must_use]
fn le(&self, other: &Rhs) -> bool

1.0.0 [src]

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

#[must_use]
fn gt(&self, other: &Rhs) -> bool

1.0.0 [src]

This method tests greater than (for self and other) and is used by the > operator. Read more

#[must_use]
fn ge(&self, other: &Rhs) -> bool

1.0.0 [src]

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl StaticType for GLContext[src]

fn static_type() -> Type[src]

Returns the type identifier of Self.

impl Eq for GLContext[src]

impl IsA<Object> for GLContext[src]

impl Send for GLContext[src]

impl StructuralEq for GLContext[src]

impl Sync for GLContext[src]

Auto Trait Implementations

impl RefUnwindSafe for GLContext

impl Unpin for GLContext

impl UnwindSafe for GLContext

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized,

[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> Cast for T where
    T: ObjectType,

[src]

fn upcast<T>(self) -> T where
    Self: IsA<T>,
    T: ObjectType,

[src]

Upcasts an object to a superclass or interface T. Read more

fn upcast_ref<T>(&self) -> &T where
    Self: IsA<T>,
    T: ObjectType,

[src]

Upcasts an object to a reference of its superclass or interface T. Read more

fn downcast<T>(self) -> Result<T, Self> where
    Self: CanDowncast<T>,
    T: ObjectType,

[src]

Tries to downcast to a subclass or interface implementor T. Read more

fn downcast_ref<T>(&self) -> Option<&T> where
    Self: CanDowncast<T>,
    T: ObjectType,

[src]

Tries to downcast to a reference of its subclass or interface implementor T. Read more

fn dynamic_cast<T>(self) -> Result<T, Self> where
    T: ObjectType,

[src]

Tries to cast to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more

fn dynamic_cast_ref<T>(&self) -> Option<&T> where
    T: ObjectType,

[src]

Tries to cast to reference to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more

unsafe fn unsafe_cast<T>(self) -> T where
    T: ObjectType,

[src]

Casts to T unconditionally. Read more

unsafe fn unsafe_cast_ref<T>(&self) -> &T where
    T: ObjectType,

[src]

Casts to &T unconditionally. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<O> GObjectExtManualGst for O where
    O: IsA<Object>,

[src]

pub fn set_property_from_str(&self, name: &str, value: &str)[src]

impl<O> GstObjectExt for O where
    O: IsA<Object>,

[src]

pub fn add_control_binding<P>(&self, binding: &P) -> Result<(), BoolError> where
    P: IsA<ControlBinding>,

[src]

Attach the ControlBinding to the object. If there already was a ControlBinding for this property it will be replaced. Read more

pub fn default_error(&self, error: &Error, debug: Option<&str>)[src]

A default error function that uses g_printerr() to display the error message and the optional debug string.. Read more

pub fn control_binding(&self, property_name: &str) -> Option<ControlBinding>[src]

Gets the corresponding ControlBinding for the property. This should be unreferenced again after use. Read more

pub fn control_rate(&self) -> Option<ClockTime>[src]

Obtain the control-rate for this self. Audio processing Element objects will use this rate to sub-divide their processing loop and call sync_values() in between. The length of the processing segment should be up to control-rate nanoseconds. Read more

pub fn name(&self) -> GString[src]

Returns a copy of the name of self. Caller should g_free() the return value after usage. For a nameless object, this returns None, which you can safely g_free() as well. Read more

pub fn parent(&self) -> Option<Object>[src]

Returns the parent of self. This function increases the refcount of the parent object so you should gst_object_unref() it after usage. Read more

pub fn path_string(&self) -> GString[src]

Generates a string describing the path of self in the object hierarchy. Only useful (or used) for debugging. Read more

pub fn value(
    &self, 
    property_name: &str, 
    timestamp: impl Into<Option<ClockTime>>
) -> Option<Value>

[src]

Gets the value for the given controlled property at the requested time. Read more

pub fn has_active_control_bindings(&self) -> bool[src]

pub fn has_ancestor<P>(&self, ancestor: &P) -> bool where
    P: IsA<Object>,

[src]

pub fn has_as_ancestor<P>(&self, ancestor: &P) -> bool where
    P: IsA<Object>,

[src]

pub fn has_as_parent<P>(&self, parent: &P) -> bool where
    P: IsA<Object>,

[src]

pub fn remove_control_binding<P>(&self, binding: &P) -> bool where
    P: IsA<ControlBinding>,

[src]

pub fn set_control_binding_disabled(&self, property_name: &str, disabled: bool)[src]

pub fn set_control_bindings_disabled(&self, disabled: bool)[src]

pub fn set_control_rate(&self, control_rate: impl Into<Option<ClockTime>>)[src]

pub fn set_parent<P>(&self, parent: &P) -> Result<(), BoolError> where
    P: IsA<Object>,

[src]

pub fn suggest_next_sync(&self) -> Option<ClockTime>[src]

pub fn sync_values(&self, timestamp: ClockTime) -> Result<(), BoolError>[src]

pub fn unparent(&self)[src]

pub fn connect_parent_notify<F>(&self, f: F) -> SignalHandlerId where
    F: 'static + Fn(&O) + Send + Sync,

[src]

impl<O> GstObjectExtManual for O where
    O: IsA<Object>,

[src]

pub fn connect_deep_notify<F>(
    &self, 
    name: Option<&str>, 
    f: F
) -> SignalHandlerId where
    F: 'static + Fn(&O, &Object, &ParamSpec) + Send + Sync,

[src]

pub fn set_object_flags(&self, flags: ObjectFlags)[src]

pub fn unset_object_flags(&self, flags: ObjectFlags)[src]

pub fn object_flags(&self) -> ObjectFlags[src]

pub fn g_value_array(
    &self, 
    property_name: &str, 
    timestamp: ClockTime, 
    interval: ClockTime, 
    values: &mut [Value]
) -> Result<(), BoolError>

[src]

impl<T, U> Into<U> for T where
    U: From<T>,

[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ObjectExt for T where
    T: ObjectType,

[src]

pub fn is<U>(&self) -> bool where
    U: StaticType,

[src]

Returns true if the object is an instance of (can be cast to) T.

pub fn type_(&self) -> Type[src]

pub fn object_class(&self) -> &Class<Object>[src]

pub fn class(&self) -> &Class<T> where
    T: IsClass,

[src]

pub fn class_of<U>(&self) -> Option<&Class<U>> where
    U: IsClass,

[src]

pub fn interface<U>(&self) -> Option<InterfaceRef<'_, U>> where
    U: IsInterface,

[src]

pub fn set_properties(
    &self, 
    property_values: &[(&str, &dyn ToValue)]
) -> Result<(), BoolError>

[src]

pub fn set_properties_from_value(
    &self, 
    property_values: &[(&str, Value)]
) -> Result<(), BoolError>

[src]

pub fn set_property<'a, N, V>(
    &self, 
    property_name: N, 
    value: V
) -> Result<(), BoolError> where
    V: ToValue,
    N: Into<&'a str>,

[src]

pub fn set_property_from_value<'a, N>(
    &self, 
    property_name: N, 
    value: &Value
) -> Result<(), BoolError> where
    N: Into<&'a str>,

[src]

pub fn property<'a, N>(&self, property_name: N) -> Result<Value, BoolError> where
    N: Into<&'a str>,

[src]

pub unsafe fn set_qdata<QD>(&self, key: Quark, value: QD) where
    QD: 'static,

[src]

Safety Read more

pub unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>> where
    QD: 'static,

[src]

Safety Read more

pub unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD> where
    QD: 'static,

[src]

Safety Read more

pub unsafe fn set_data<QD>(&self, key: &str, value: QD) where
    QD: 'static,

[src]

Safety Read more

pub unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>> where
    QD: 'static,

[src]

Safety Read more

pub unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD> where
    QD: 'static,

[src]

Safety Read more

pub fn block_signal(&self, handler_id: &SignalHandlerId)[src]

pub fn unblock_signal(&self, handler_id: &SignalHandlerId)[src]

pub fn stop_signal_emission(&self, signal_name: &str)[src]

pub fn disconnect(&self, handler_id: SignalHandlerId)[src]

pub fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where
    F: 'static + Fn(&T, &ParamSpec) + Send + Sync,

[src]

pub fn connect_notify_local<F>(
    &self, 
    name: Option<&str>, 
    f: F
) -> SignalHandlerId where
    F: 'static + Fn(&T, &ParamSpec),

[src]

pub unsafe fn connect_notify_unsafe<F>(
    &self, 
    name: Option<&str>, 
    f: F
) -> SignalHandlerId where
    F: Fn(&T, &ParamSpec),

[src]

pub fn notify<'a, N>(&self, property_name: N) where
    N: Into<&'a str>,

[src]

pub fn notify_by_pspec(&self, pspec: &ParamSpec)[src]

pub fn has_property<'a, N>(&self, property_name: N, type_: Option<Type>) -> bool where
    N: Into<&'a str>,

[src]

pub fn property_type<'a, N>(&self, property_name: N) -> Option<Type> where
    N: Into<&'a str>,

[src]

pub fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where
    N: Into<&'a str>,

[src]

pub fn list_properties(&self) -> Vec<ParamSpec, Global>[src]

pub fn freeze_notify(&self) -> PropertyNotificationFreezeGuard[src]

pub fn connect<'a, N, F>(
    &self, 
    signal_name: N, 
    after: bool, 
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,
    N: Into<&'a str>,

[src]

pub fn connect_id<F>(
    &self, 
    signal_id: SignalId, 
    details: Option<Quark>, 
    after: bool, 
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,

[src]

Same as connect but takes a SignalId instead of a signal name.

pub fn connect_local<'a, N, F>(
    &self, 
    signal_name: N, 
    after: bool, 
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    F: Fn(&[Value]) -> Option<Value> + 'static,
    N: Into<&'a str>,

[src]

pub fn connect_local_id<F>(
    &self, 
    signal_id: SignalId, 
    details: Option<Quark>, 
    after: bool, 
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    F: Fn(&[Value]) -> Option<Value> + 'static,

[src]

Same as connect_local but takes a SignalId instead of a signal name.

pub unsafe fn connect_unsafe<'a, N, F>(
    &self, 
    signal_name: N, 
    after: bool, 
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    F: Fn(&[Value]) -> Option<Value>,
    N: Into<&'a str>,

[src]

pub unsafe fn connect_unsafe_id<F>(
    &self, 
    signal_id: SignalId, 
    details: Option<Quark>, 
    after: bool, 
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    F: Fn(&[Value]) -> Option<Value>,

[src]

Same as connect_unsafe but takes a SignalId instead of a signal name.

pub fn emit(
    &self, 
    signal_id: SignalId, 
    args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError>

[src]

Emit signal by signal id.

pub fn emit_with_details(
    &self, 
    signal_id: SignalId, 
    details: Quark, 
    args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError>

[src]

Emit signal with details by signal id.

pub fn emit_by_name<'a, N>(
    &self, 
    signal_name: N, 
    args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError> where
    N: Into<&'a str>,

[src]

Emit signal by it’s name.

pub fn downgrade(&self) -> WeakRef<T>[src]

pub fn bind_property<'a, O, N, M>(
    &'a self, 
    source_property: N, 
    target: &'a O, 
    target_property: M
) -> BindingBuilder<'a> where
    O: ObjectType,
    N: Into<&'a str>,
    M: Into<&'a str>,

[src]

pub fn ref_count(&self) -> u32[src]

pub fn emit_with_values(
    &self, 
    signal_id: SignalId, 
    args: &[Value]
) -> Result<Option<Value>, BoolError>

[src]

Same as emit but takes Value for the arguments.

pub fn emit_by_name_with_values<'a, N>(
    &self, 
    signal_name: N, 
    args: &[Value]
) -> Result<Option<Value>, BoolError> where
    N: Into<&'a str>,

[src]

Same as emit_by_name but takes Value for the arguments.

pub fn emit_with_details_and_values(
    &self, 
    signal_id: SignalId, 
    details: Quark, 
    args: &[Value]
) -> Result<Option<Value>, BoolError>

[src]

Same as emit_with_details but takes Value for the arguments.

impl<T> ToOwned for T where
    T: Clone,

[src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToSendValue for T where
    T: Send + ToValue + ?Sized,

[src]

pub fn to_send_value(&self) -> SendValue[src]

Returns a SendValue clone of self.

impl<T, U> TryFrom<U> for T where
    U: Into<T>,

[src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>,

[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.

impl<Super, Sub> CanDowncast<Sub> for Super where
    Sub: IsA<Super>,
    Super: IsA<Super>,

[src]

impl<'a, T, C> FromValueOptional<'a> for T where
    C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError>,
    T: FromValue<'a, Checker = C>,

[src]