Struct GLContext

Source

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 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

GLib type: GObject with reference counted clone semantics.

Implementations§

Source §

impl GLContext

Source

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

Source

pub fn new(display: &impl IsA<GLDisplay>) -> GLContext

Create a new GLContext with the specified display

§`display`

a GLDisplay

§Returns

a new GLContext

Source

pub fn current() -> Option<GLContext>

§Returns

the GLContext active in the current thread or None

Source

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

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

Source §

impl GLContext

Source

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`

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

Source

pub fn current_gl_context(context_type: GLPlatform) -> uintptr_t

§`context_type`

a GLPlatform specifying the type of context to retrieve

§Returns

The OpenGL context handle current in the calling thread or None

Source

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.

§`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§

Source §

impl Clone for GLContext

Source §

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.

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for GLContext

Source §

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

Formats the value using the given formatter. Read more

Source §

impl HasParamSpec for GLContext

Source §

type ParamSpec = ParamSpecObject

Source §

type SetValue = GLContext

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

Source §

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

Hashes the memory address of this object.

1.3.0 · Source§

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

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

Source §

impl Ord for GLContext

Source §

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more

1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more

1.50.0 · Source§

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

Restrict a value to a certain interval. Read more

Source §

impl ParentClassIs for GLContext

Source §

type Parent = Object

Source §

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

Source §

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

1.0.0 · Source§

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

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

Source §

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

Source §

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

1.0.0 · Source§

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

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

1.0.0 · Source§

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

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

1.0.0 · Source§

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

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

1.0.0 · Source§

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

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

Source §

impl StaticType for GLContext

Source §

fn static_type() -> Type

Returns the type identifier of Self.

Source §

impl Eq for GLContext

Source §

impl IsA<Object> for GLContext

Source §

impl Send for GLContext

Source §

impl Sync for GLContext

Auto Trait Implementations§

§

impl Freeze for GLContext

§

impl RefUnwindSafe for GLContext

§

impl Unpin for GLContext

§

impl UnwindSafe for GLContext

Blanket Implementations§

Source §

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

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

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

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

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

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

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

Source §

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

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

Source §

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

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

Source §

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

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

Source §

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

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

Source §

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

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 upcast will do many checks at compile-time already. downcast will perform the same checks at runtime as dynamic_cast, but will also ensure some amount of compile-time safety. Read more

Source §

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

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

Source §

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

Casts to T unconditionally. Read more

Source §

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

Casts to &T unconditionally. Read more

Source §

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

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

Source §

unsafe fn from_glib_none_num_as_vec(ptr: *const GList, num: usize) -> Vec<T>

Source §

unsafe fn from_glib_container_num_as_vec(_: *const GList, _: usize) -> Vec<T>

Source §

unsafe fn from_glib_full_num_as_vec(_: *const GList, _: usize) -> Vec<T>

Source §

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

Source §

unsafe fn from_glib_none_num_as_vec(ptr: *const GPtrArray, num: usize) -> Vec<T>

Source §

unsafe fn from_glib_container_num_as_vec( _: *const GPtrArray, _: usize, ) -> Vec<T>

Source §

unsafe fn from_glib_full_num_as_vec(_: *const GPtrArray, _: usize) -> Vec<T>

Source §

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

Source §

unsafe fn from_glib_none_num_as_vec(ptr: *const GSList, num: usize) -> Vec<T>

Source §

unsafe fn from_glib_container_num_as_vec(_: *const GSList, _: usize) -> Vec<T>

Source §

unsafe fn from_glib_full_num_as_vec(_: *const GSList, _: usize) -> Vec<T>

Source §

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

Source §

unsafe fn from_glib_none_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

Source §

unsafe fn from_glib_container_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

Source §

unsafe fn from_glib_full_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

Source §

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

Source §

unsafe fn from_glib_none_num_as_vec(ptr: *mut GPtrArray, num: usize) -> Vec<T>

Source §

unsafe fn from_glib_container_num_as_vec( ptr: *mut GPtrArray, num: usize, ) -> Vec<T>

Source §

unsafe fn from_glib_full_num_as_vec(ptr: *mut GPtrArray, num: usize) -> Vec<T>

Source §

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

Source §

unsafe fn from_glib_none_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

Source §

unsafe fn from_glib_container_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

Source §

unsafe fn from_glib_full_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

Source §

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

Source §

unsafe fn from_glib_none_as_vec(ptr: *const GList) -> Vec<T>

Source §

unsafe fn from_glib_container_as_vec(_: *const GList) -> Vec<T>

Source §

unsafe fn from_glib_full_as_vec(_: *const GList) -> Vec<T>

Source §

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

Source §

unsafe fn from_glib_none_as_vec(ptr: *const GPtrArray) -> Vec<T>

Source §

unsafe fn from_glib_container_as_vec(_: *const GPtrArray) -> Vec<T>

Source §

unsafe fn from_glib_full_as_vec(_: *const GPtrArray) -> Vec<T>

Source §

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

Source §

unsafe fn from_glib_none_as_vec(ptr: *const GSList) -> Vec<T>

Source §

unsafe fn from_glib_container_as_vec(_: *const GSList) -> Vec<T>

Source §

unsafe fn from_glib_full_as_vec(_: *const GSList) -> Vec<T>

Source §

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

Source §

unsafe fn from_glib_none_as_vec(ptr: *mut GList) -> Vec<T>

Source §

unsafe fn from_glib_container_as_vec(ptr: *mut GList) -> Vec<T>

Source §

unsafe fn from_glib_full_as_vec(ptr: *mut GList) -> Vec<T>

Source §

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

Source §

unsafe fn from_glib_none_as_vec(ptr: *mut GPtrArray) -> Vec<T>

Source §

unsafe fn from_glib_container_as_vec(ptr: *mut GPtrArray) -> Vec<T>

Source §

unsafe fn from_glib_full_as_vec(ptr: *mut GPtrArray) -> Vec<T>

Source §

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

Source §

unsafe fn from_glib_none_as_vec(ptr: *mut GSList) -> Vec<T>

Source §

unsafe fn from_glib_container_as_vec(ptr: *mut GSList) -> Vec<T>

Source §

unsafe fn from_glib_full_as_vec(ptr: *mut GSList) -> Vec<T>

Source §

impl<O> GLContextExt for O
where O: IsA<GLContext>,

Source §

fn activate(&self, activate: bool) -> Result<(), BoolError>

(De)activate the OpenGL context represented by this self. Read more

Source §

fn can_share(&self, other_context: &impl IsA<GLContext>) -> bool

Note: This will always fail for two wrapped GLContext’s Read more

Source §

fn check_feature(&self, feature: &str) -> bool

Check for an OpenGL feature being supported. Read more

Source §

fn check_framebuffer_status(&self, fbo_target: u32) -> bool

Must be called with self current. Read more

Source §

fn check_gl_version(&self, api: GLAPI, maj: i32, min: i32) -> bool

api Read more

Source §

fn clear_framebuffer(&self)

Unbind the current framebuffer

Source §

fn clear_shader(&self)

Clear’s the currently set shader from the GL state machine. Read more

Source §

fn create( &self, other_context: Option<&impl IsA<GLContext>>, ) -> Result<(), Error>

Creates an OpenGL context with the specified other_context as a context to share shareable OpenGL objects with. See the OpenGL specification for what is shared between OpenGL contexts. Read more

Source §

fn destroy(&self)

Source §

fn fill_info(&self) -> Result<(), Error>

Fills self’s info (version, extensions, vtable, etc) from the GL context in the current thread. Typically used with wrapped contexts to allow wrapped contexts to be used as regular GLContext’s.

Source §

fn config(&self) -> Option<Structure>

Retrieve the OpenGL configuration for this context. The context must have been successfully created for this function to return a valid value. Read more

Source §

fn display(&self) -> GLDisplay

Returns Read more

Source §

fn gl_api(&self) -> GLAPI

Get the currently enabled OpenGL api. Read more

Source §

fn gl_platform(&self) -> GLPlatform

Gets the OpenGL platform that used by self. Read more

Source §

fn gl_platform_version(&self) -> (i32, i32)

Get the version of the OpenGL platform (GLX, EGL, etc) used. Only valid after a call to create(). Read more

Source §

fn gl_version(&self) -> (i32, i32)

Returns the OpenGL version implemented by self. See gl_api() for retrieving the OpenGL api implemented by self. Read more

Source §

fn window(&self) -> Option<GLWindow>

Returns Read more

Source §

fn is_shared(&self) -> bool

Returns Read more

Source §

fn request_config(&self, gl_config: Option<Structure>) -> bool

Set the OpenGL configuration for this context. The context must not have been created for this function to succeed. Setting a None config has the affect of removing any specific configuration request. Read more

Source §

fn set_shared_with(&self, share: &impl IsA<GLContext>)

Will internally set self as shared with share Read more

Source §

fn set_window(&self, window: impl IsA<GLWindow>) -> Result<(), BoolError>

Set’s the current window on self to window. The window can only be changed before create() has been called and the window is not already running. Read more

Source §

fn supports_glsl_profile_version( &self, version: GLSLVersion, profile: GLSLProfile, ) -> bool

version Read more

Source §

fn supports_precision(&self, version: GLSLVersion, profile: GLSLProfile) -> bool

version Read more

Source §

fn supports_precision_highp( &self, version: GLSLVersion, profile: GLSLProfile, ) -> bool

version Read more

Source §

fn swap_buffers(&self)

Swap the front and back buffers on the window attached to self. This will display the frame on the next refresh cycle.

Source §

impl<O> GLContextExtManual for O
where O: IsA<GLContext>,

Source §

fn gl_context(&self) -> uintptr_t

Gets the backing OpenGL context used by self. Read more

Source §

fn proc_address(&self, name: &str) -> uintptr_t

Get a function pointer to a specified opengl function, name. If the the specific function does not exist, NULL is returned instead. Read more

Source §

fn thread_add<F: FnOnce(&Self) + Send>(&self, func: F)

Execute func in the OpenGL thread of self with data Read more

Source §

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

Source §

fn set_property_from_str(&self, name: &str, value: &str)

Source §

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

Source §

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

Source §

fn default_error(&self, error: &Error, debug: Option<&str>)

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

Source §

fn control_binding(&self, property_name: &str) -> Option<ControlBinding>

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

Source §

fn control_rate(&self) -> Option<ClockTime>

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

Source §

fn name(&self) -> GString

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

Source §

fn parent(&self) -> Option<Object>

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

Source §

fn path_string(&self) -> GString

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

Source §

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

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

Source §

fn has_active_control_bindings(&self) -> bool

Check if the self has active controlled properties. Read more

Source §

fn has_ancestor(&self, ancestor: &impl IsA<Object>) -> bool

Check if self has an ancestor ancestor somewhere up in the hierarchy. One can e.g. check if a Element is inside a Pipeline. Read more

Source §

fn has_as_ancestor(&self, ancestor: &impl IsA<Object>) -> bool

Check if self has an ancestor ancestor somewhere up in the hierarchy. One can e.g. check if a Element is inside a Pipeline. Read more

Source §

fn has_as_parent(&self, parent: &impl IsA<Object>) -> bool

Check if parent is the parent of self. E.g. a Element can check if it owns a given Pad. Read more

Source §

fn remove_control_binding(&self, binding: &impl IsA<ControlBinding>) -> bool

Removes the corresponding ControlBinding. If it was the last ref of the binding, it will be disposed. Read more

Source §

fn set_control_binding_disabled(&self, property_name: &str, disabled: bool)

This function is used to disable the control bindings on a property for some time, i.e. sync_values() will do nothing for the property. Read more

Source §

fn set_control_bindings_disabled(&self, disabled: bool)

This function is used to disable all controlled properties of the self for some time, i.e. sync_values() will do nothing. Read more

Source §

fn set_control_rate(&self, control_rate: impl Into<Option<ClockTime>>)

Change 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

Source §

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

Sets the parent of self to parent. The object’s reference count will be incremented, and any floating reference will be removed (see gst_object_ref_sink()). Read more

Source §

fn suggest_next_sync(&self) -> Option<ClockTime>

Returns a suggestion for timestamps where buffers should be split to get best controller results. Read more

Source §

fn sync_values(&self, timestamp: ClockTime) -> Result<(), BoolError>

Sets the properties of the object, according to the GstControlSources that (maybe) handle them and for the given timestamp. Read more

Source §

fn unparent(&self)

Clear the parent of self, removing the associated reference. This function decreases the refcount of self. Read more

Source §

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

Source §

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

Source §

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

Source §

fn set_object_flags(&self, flags: ObjectFlags)

Source §

fn unset_object_flags(&self, flags: ObjectFlags)

Source §

fn object_flags(&self) -> ObjectFlags

Source §

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

Source §

fn object_lock(&self) -> ObjectLockGuard<'_, Self>

Source §

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

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoClosureReturnValue for T
where T: Into<Value>,

Source §

fn into_closure_return_value(self) -> Option<Value>

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

impl IsSubclassableExt for U
where U: IsClass + ParentClassIs,

Source §

fn parent_class_init<T>(class: &mut Class)
where T: ObjectSubclass, ::Parent: IsSubclassable<T>,

Source §

fn parent_instance_init<T>(instance: &mut InitializingObject<T>)
where T: ObjectSubclass, ::Parent: IsSubclassable<T>,

Source §

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

Source §

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

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

Source §

fn type_(&self) -> Type

Returns the type of the object.

Source §

fn object_class(&self) -> &Class<Object>

Returns the ObjectClass of the object. Read more

Source §

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

Returns the class of the object.

Source §

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

Returns the class of the object in the given type T. Read more

Source §

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

Returns the interface T of the object. Read more

Source §

fn set_property(&self, property_name: &str, value: impl Into<Value>)

Sets the property property_name of the object to value value. Read more

Source §

fn set_property_from_value(&self, property_name: &str, value: &Value)

Sets the property property_name of the object to value value. Read more

Source §

fn set_properties(&self, property_values: &[(&str, &dyn ToValue)])

Sets multiple properties of the object at once. Read more

Source §

fn set_properties_from_value(&self, property_values: &[(&str, Value)])

Sets multiple properties of the object at once. Read more

Source §

fn property<V>(&self, property_name: &str) -> V
where V: for<'b> FromValue<'b> + 'static,

Gets the property property_name of the object and cast it to the type V. Read more

Source §

fn property_value(&self, property_name: &str) -> Value

Gets the property property_name of the object. Read more

Source §

fn has_property(&self, property_name: &str) -> bool

Check if the object has a property property_name.

Source §

fn has_property_with_type(&self, property_name: &str, type_: Type) -> bool

Check if the object has a property property_name of the given type_.

Source §

fn property_type(&self, property_name: &str) -> Option<Type>

Get the type of the property property_name of this object. Read more

Source §

fn find_property(&self, property_name: &str) -> Option<ParamSpec>

Get the ParamSpec of the property property_name of this object.

Source §

fn list_properties(&self) -> PtrSlice<ParamSpec>

Return all ParamSpec of the properties of this object.

Source §

fn freeze_notify(&self) -> PropertyNotificationFreezeGuard

Freeze all property notifications until the return guard object is dropped. Read more

Source §

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

Set arbitrary data on this object with the given key. Read more

Source §

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

Return previously set arbitrary data of this object with the given key. Read more

Source §

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

Retrieve previously set arbitrary data of this object with the given key. Read more

Source §

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

Set arbitrary data on this object with the given key. Read more

Source §

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

Return previously set arbitrary data of this object with the given key. Read more

Source §

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

Retrieve previously set arbitrary data of this object with the given key. Read more

Source §

fn block_signal(&self, handler_id: &SignalHandlerId)

Block a given signal handler. Read more

Source §

fn unblock_signal(&self, handler_id: &SignalHandlerId)

Unblock a given signal handler.

Source §

fn stop_signal_emission(&self, signal_id: SignalId, detail: Option<Quark>)

Stop emission of the currently emitted signal.

Source §

fn stop_signal_emission_by_name(&self, signal_name: &str)

Stop emission of the currently emitted signal by the (possibly detailed) signal name.

Source §

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

Connect to the signal signal_name on this object. Read more

Source §

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

Connect to the signal signal_id on this object. Read more

Source §

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

Connect to the signal signal_name on this object. Read more

Source §

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

Connect to the signal signal_id on this object. Read more

Source §

unsafe fn connect_unsafe<F>( &self, signal_name: &str, after: bool, callback: F, ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value>,

Connect to the signal signal_name on this object. Read more

Source §

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

Connect to the signal signal_id on this object. Read more

Source §

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

Source §

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

Source §

fn watch_closure(&self, closure: &impl AsRef<Closure>)

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 invoke_with_values, or invoke when using Rust closures.

Source §