Struct gstreamer_gl::GLContext

pub struct GLContext { /* private fields */ }

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

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

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

Create a new GLContext with the specified display

display

a GLDisplay

Returns

a new GLContext

pub fn current() -> Option<GLContext>

See also GLContextExt::activate().

Returns

the GLContext active in the current thread or None

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

impl GLContext

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

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

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

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GLContext

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

Formats the value using the given formatter.

impl HasParamSpec for GLContext

type ParamSpec = ParamSpecObject

type SetValue = GLContext

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for GLContext

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

where H: Hasher,

Feeds this value into the given Hasher.

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 GLContext

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

This method returns an Ordering between self and other.

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 GLContext

type Parent = Object

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

impl StaticType for GLContext

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for GLContext

impl IsA<Object> for GLContext

impl Send for GLContext

impl Sync for GLContext