Trait gstreamer_gl::prelude::GLDisplayExt

pub trait GLDisplayExt: 'static {
    fn add_context<P: IsA<GLContext>>(
        &self, 
        context: &P
    ) -> Result<(), BoolError>;
    fn create_context<P: IsA<GLContext>>(
        &self, 
        other_context: &P
    ) -> Result<GLContext, Error>;
    fn create_window(&self) -> Result<GLWindow, BoolError>;
    fn filter_gl_api(&self, gl_api: GLAPI);
    fn gl_api(&self) -> GLAPI;
    fn gl_api_unlocked(&self) -> GLAPI;
    fn handle_type(&self) -> GLDisplayType;
    fn remove_context<P: IsA<GLContext>>(&self, context: &P);
    fn remove_window<P: IsA<GLWindow>>(
        &self, 
        window: &P
    ) -> Result<(), BoolError>;
    fn connect_create_context<F: Fn(&Self, &GLContext) -> GLContext + Send + Sync + 'static>(
        &self, 
        f: F
    ) -> SignalHandlerId;
}

Trait containing all GLDisplay methods.

Implementors

GLDisplay

Required methods

fn add_context<P: IsA<GLContext>>(&self, context: &P) -> Result<(), BoolError>

context

a GLContext

Returns

whether context was successfully added. false may be returned if there already exists another context for context’s active thread.

Must be called with the object lock held.

fn create_context<P: IsA<GLContext>>(
    &self,
    other_context: &P
) -> Result<GLContext, Error>

It requires the display’s object lock to be held.

other_context

other GLContext to share resources with.

Returns

whether a new context could be created.

p_context

resulting GLContext

fn create_window(&self) -> Result<GLWindow, BoolError>

Returns

a new GLWindow for self or None.

fn filter_gl_api(&self, gl_api: GLAPI)

limit the use of OpenGL to the requested gl_api. This is intended to allow application and elements to request a specific set of OpenGL API’s based on what they support. See GLContextExt::gl_api() for the retrieving the API supported by a GLContext.

gl_api

a GLAPI to filter with

fn gl_api(&self) -> GLAPI

see filter_gl_api() for what the returned value represents

Returns

the GLAPI configured for self

fn gl_api_unlocked(&self) -> GLAPI

fn handle_type(&self) -> GLDisplayType

Returns

the GLDisplayType of self

fn remove_context<P: IsA<GLContext>>(&self, context: &P)

This is supported on crate feature v1_18 only.

Must be called with the object lock held.

context

the GLContext to remove

fn remove_window<P: IsA<GLWindow>>(&self, window: &P) -> Result<(), BoolError>

window

a GLWindow to remove

Returns

if window could be removed from self

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

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

context

other context to share resources with.

Returns

the new context.

Implementors

impl<O: IsA<GLDisplay>> GLDisplayExt for O

fn add_context<P: IsA<GLContext>>(&self, context: &P) -> Result<(), BoolError>

fn create_context<P: IsA<GLContext>>(
    &self,
    other_context: &P
) -> Result<GLContext, Error>

fn create_window(&self) -> Result<GLWindow, BoolError>

fn filter_gl_api(&self, gl_api: GLAPI)

fn gl_api(&self) -> GLAPI

fn gl_api_unlocked(&self) -> GLAPI

fn handle_type(&self) -> GLDisplayType

fn remove_context<P: IsA<GLContext>>(&self, context: &P)

This is supported on crate feature v1_18 only.

fn remove_window<P: IsA<GLWindow>>(&self, window: &P) -> Result<(), BoolError>

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