Struct gstreamer_gl::GLContext
source · [−]#[repr(transparent)]pub struct GLContext { /* private fields */ }
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 theGLAPI
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
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
pub unsafe fn new_wrapped<T: IsA<GLDisplay>>(
display: &T,
handle: uintptr_t,
context_type: GLPlatform,
available_apis: GLAPI
) -> Option<Self>
pub unsafe fn new_wrapped<T: IsA<GLDisplay>>(
display: &T,
handle: uintptr_t,
context_type: GLPlatform,
available_apis: GLAPI
) -> Option<Self>
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
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
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
pub fn proc_address_with_platform(
context_type: GLPlatform,
gl_api: GLAPI,
name: &str
) -> uintptr_t
Attempts to use the context_type
specific GetProcAddress implementations
to retrieve name
.
See also GLContextExtManual::proc_address()
.
context_type
gl_api
a GLAPI
name
the name of the function to retrieve
Returns
a function pointer for name
, or None
Trait Implementations
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
Returns the type identifier of Self
.
Auto Trait Implementations
Blanket Implementations
Mutably borrows from an owned value. Read more
Upcasts an object to a superclass or interface T
. Read more
Upcasts an object to a reference of its superclass or interface T
. Read more
Tries to downcast to a subclass or interface implementor T
. Read more
Tries to downcast to a reference of its subclass or interface implementor T
. Read more
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
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
Casts to T
unconditionally. Read more
Casts to &T
unconditionally. Read more
pub fn add_control_binding(
&self,
binding: &impl IsA<ControlBinding>
) -> Result<(), BoolError>
pub fn add_control_binding(
&self,
binding: &impl IsA<ControlBinding>
) -> Result<(), BoolError>
Attach the ControlBinding
to the object. If there already was a
ControlBinding
for this property it will be replaced. Read more
A default error function that uses g_printerr()
to display the error message
and the optional debug string.. Read more
Gets the corresponding ControlBinding
for the property. This should be
unreferenced again after use. Read more
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
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
Generates a string describing the path of self
in
the object hierarchy. Only useful (or used) for debugging. Read more
Gets the value for the given controlled property at the requested time. Read more
pub fn connect_parent_notify<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O) + Send + Sync,
pub fn connect_deep_notify<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: 'static + Fn(&O, &Object, &ParamSpec) + Send + Sync,
pub fn parent_class_init<T>(class: &mut Class<U>) where
T: ObjectSubclass,
<U as ParentClassIs>::Parent: IsSubclassable<T>,
pub fn parent_instance_init<T>(instance: &mut InitializingObject<T>) where
T: ObjectSubclass,
<U as ParentClassIs>::Parent: IsSubclassable<T>,
Returns true
if the object is an instance of (can be cast to) T
.
Returns the ObjectClass
of the object. Read more
Returns the class of the object in the given type T
. Read more
Returns the interface T
of the object. Read more
Similar to Self::set_property
but fails instead of panicking.
Sets the property property_name
of the object to value value
. Read more
Similar to Self::set_property
but fails instead of panicking.
Sets the property property_name
of the object to value value
. Read more
Similar to Self::set_properties
but fails instead of panicking.
Sets multiple properties of the object at once. Read more
Similar to Self::set_properties_from_value
but fails instead of panicking.
Sets multiple properties of the object at once. Read more
Similar to Self::property
but fails instead of panicking.
Gets the property property_name
of the object and cast it to the type V. Read more
Similar to Self::property_value
but fails instead of panicking.
Gets the property property_name
of the object. Read more
Check if the object has a property property_name
of the given type_
. Read more
Get the type of the property property_name
of this object. Read more
Get the ParamSpec
of the property property_name
of this object.
Return all ParamSpec
of the properties of this object.
Freeze all property notifications until the return guard object is dropped. Read more
Set arbitrary data on this object with the given key
. Read more
Return previously set arbitrary data of this object with the given key
. Read more
Retrieve previously set arbitrary data of this object with the given key
. Read more
Set arbitrary data on this object with the given key
. Read more
Return previously set arbitrary data of this object with the given key
. Read more
Retrieve previously set arbitrary data of this object with the given key
. Read more
Block a given signal handler. Read more
Unblock a given signal handler.
Stop emission of the currently emitted signal.
Stop emission of the currently emitted signal by the (possibly detailed) signal name.
Similar to Self::connect
but fails instead of panicking.
Connect to the signal signal_name
on this object. Read more
Similar to Self::connect_id
but fails instead of panicking.
Connect to the signal signal_id
on this object. Read more
Similar to Self::connect_local
but fails instead of panicking.
Connect to the signal signal_name
on this object. Read more
Similar to Self::connect_local_id
but fails instead of panicking.
Connect to the signal signal_id
on this object. Read more
Similar to Self::connect_unsafe
but fails instead of panicking.
Connect to the signal signal_name
on this object. Read more
Similar to Self::connect_unsafe_id
but fails instead of panicking.
pub fn try_connect_closure(
&self,
signal_name: &str,
after: bool,
closure: RustClosure
) -> Result<SignalHandlerId, BoolError>
pub fn try_connect_closure(
&self,
signal_name: &str,
after: bool,
closure: RustClosure
) -> Result<SignalHandlerId, BoolError>
Similar to Self::connect_closure
but fails instead of panicking.
pub fn connect_closure(
&self,
signal_name: &str,
after: bool,
closure: RustClosure
) -> SignalHandlerId
pub fn connect_closure(
&self,
signal_name: &str,
after: bool,
closure: RustClosure
) -> SignalHandlerId
Connect a closure to the signal signal_name
on this object. Read more
pub fn try_connect_closure_id(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
closure: RustClosure
) -> Result<SignalHandlerId, BoolError>
pub fn try_connect_closure_id(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
closure: RustClosure
) -> Result<SignalHandlerId, BoolError>
Similar to Self::connect_closure_id
but fails instead of panicking.
pub fn connect_closure_id(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
closure: RustClosure
) -> SignalHandlerId
pub fn connect_closure_id(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
closure: RustClosure
) -> SignalHandlerId
Connect a closure to the signal signal_id
on this object. Read more
Limits the lifetime of closure
to the lifetime of the object. When
the object’s reference count drops to zero, the closure will be
invalidated. An invalidated closure will ignore any calls to
Closure::invoke
. Read more
Connect to the signal signal_id
on this object. Read more
Similar to Self::emit
but fails instead of panicking.
Emit signal by signal id. Read more
Similar to Self::emit_with_values
but fails instead of panicking.
Same as Self::emit
but takes Value
for the arguments.
pub fn try_emit_by_name<R>(
&self,
signal_name: &str,
args: &[&dyn ToValue]
) -> Result<R, BoolError> where
R: TryFromClosureReturnValue,
pub fn try_emit_by_name<R>(
&self,
signal_name: &str,
args: &[&dyn ToValue]
) -> Result<R, BoolError> where
R: TryFromClosureReturnValue,
Similar to Self::emit_by_name
but fails instead of panicking.
pub fn emit_by_name<R>(&self, signal_name: &str, args: &[&dyn ToValue]) -> R where
R: TryFromClosureReturnValue,
pub fn emit_by_name<R>(&self, signal_name: &str, args: &[&dyn ToValue]) -> R where
R: TryFromClosureReturnValue,
Emit signal by its name. Read more
Similar to Self::emit_by_name_with_values
but fails instead of panicking.
Emit signal by its name. Read more
pub fn try_emit_with_details<R>(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue]
) -> Result<R, BoolError> where
R: TryFromClosureReturnValue,
pub fn try_emit_with_details<R>(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue]
) -> Result<R, BoolError> where
R: TryFromClosureReturnValue,
Similar to Self::emit_with_details
but fails instead of panicking.
pub fn emit_with_details<R>(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue]
) -> R where
R: TryFromClosureReturnValue,
pub fn emit_with_details<R>(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue]
) -> R where
R: TryFromClosureReturnValue,
Emit signal by signal id with details. Read more
Similar to Self::emit_with_details_and_values
but fails instead of panicking.
Emit signal by signal id with details. Read more
Disconnect a previously connected signal handler.
pub fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec) + Send + Sync,
pub fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec) + Send + Sync,
Connect to the notify
signal of the object. Read more
pub fn connect_notify_local<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec),
pub fn connect_notify_local<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec),
Connect to the notify
signal of the object. Read more
pub unsafe fn connect_notify_unsafe<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: Fn(&T, &ParamSpec),
pub unsafe fn connect_notify_unsafe<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: Fn(&T, &ParamSpec),
Connect to the notify
signal of the object. Read more
Notify that the given property has changed its value. Read more
Notify that the given property has changed its value. Read more
pub fn bind_property<O>(
&'a self,
source_property: &'a str,
target: &'a O,
target_property: &'a str
) -> BindingBuilder<'a> where
O: ObjectType,
pub fn bind_property<O>(
&'a self,
source_property: &'a str,
target: &'a O,
target_property: &'a str
) -> BindingBuilder<'a> where
O: ObjectType,
Bind property source_property
on this object to the target_property
on the target
object. Read more
Ensures that the type has been registered with the type system.
Returns a SendValue
clone of self
.