Trait GLAreaExt

pub trait GLAreaExt:
    IsA<GLArea>
    + Sealed
    + 'static {
    // Provided methods
    fn attach_buffers(&self) { ... }
    fn allowed_apis(&self) -> GLAPI { ... }
    fn api(&self) -> GLAPI { ... }
    fn is_auto_render(&self) -> bool { ... }
    fn context(&self) -> Option<GLContext> { ... }
    fn error(&self) -> Option<Error> { ... }
    fn has_depth_buffer(&self) -> bool { ... }
    fn has_stencil_buffer(&self) -> bool { ... }
    fn required_version(&self) -> (i32, i32) { ... }
    fn uses_es(&self) -> bool { ... }
    fn make_current(&self) { ... }
    fn queue_render(&self) { ... }
    fn set_allowed_apis(&self, apis: GLAPI) { ... }
    fn set_auto_render(&self, auto_render: bool) { ... }
    fn set_error(&self, error: Option<&Error>) { ... }
    fn set_has_depth_buffer(&self, has_depth_buffer: bool) { ... }
    fn set_has_stencil_buffer(&self, has_stencil_buffer: bool) { ... }
    fn set_required_version(&self, major: i32, minor: i32) { ... }
    fn set_use_es(&self, use_es: bool) { ... }
    fn connect_create_context<F: Fn(&Self) -> Option<GLContext> + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_render<F: Fn(&Self, &GLContext) -> Propagation + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_resize<F: Fn(&Self, i32, i32) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_allowed_apis_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_api_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_auto_render_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_context_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_has_depth_buffer_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_has_stencil_buffer_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_use_es_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
}

Trait containing all GLArea methods.

Implementors

GLArea

Provided Methods

fn attach_buffers(&self)

Binds buffers to the framebuffer.

Ensures that the @self framebuffer object is made the current draw and read target, and that all the required buffers for the @self are created and bound to the framebuffer.

This function is automatically called before emitting the render signal, and doesn’t normally need to be called by application code.

fn allowed_apis(&self) -> GLAPI

Available on crate feature v4_12 only.

Gets the allowed APIs.

See set_allowed_apis().

Returns

the allowed APIs

fn api(&self) -> GLAPI

Available on crate feature v4_12 only.

Gets the API that is currently in use.

If the GL area has not been realized yet, 0 is returned.

Returns

the currently used API

fn is_auto_render(&self) -> bool

Returns whether the area is in auto render mode or not.

Returns

true if the @self is auto rendering, false otherwise

fn context(&self) -> Option<GLContext>

Retrieves the gdk::GLContext used by @self.

Returns

the gdk::GLContext

fn error(&self) -> Option<Error>

Gets the current error set on the @self.

Returns

the GError

fn has_depth_buffer(&self) -> bool

Returns whether the area has a depth buffer.

Returns

true if the @self has a depth buffer, false otherwise

fn has_stencil_buffer(&self) -> bool

Returns whether the area has a stencil buffer.

Returns

true if the @self has a stencil buffer, false otherwise

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

Retrieves the required version of OpenGL.

See set_required_version().

Returns

major

return location for the required major version

minor

return location for the required minor version

fn uses_es(&self) -> bool

👎Deprecated: Since 4.12

Returns whether the GLArea should use OpenGL ES.

See set_use_es().

Deprecated since 4.12

Use api()

Returns

true if the GLArea should create an OpenGL ES context and false otherwise

fn make_current(&self)

Ensures that the gdk::GLContext used by @self is associated with the GLArea.

This function is automatically called before emitting the render signal, and doesn’t normally need to be called by application code.

fn queue_render(&self)

Marks the currently rendered data (if any) as invalid, and queues a redraw of the widget.

This ensures that the render signal is emitted during the draw.

This is only needed when set_auto_render() has been called with a false value. The default behaviour is to emit render on each draw.

fn set_allowed_apis(&self, apis: GLAPI)

Available on crate feature v4_12 only.

Sets the allowed APIs to create a context with.

You should check api before drawing with either API.

By default, all APIs are allowed.

apis

the allowed APIs

fn set_auto_render(&self, auto_render: bool)

Sets whether the GLArea is in auto render mode.

If @auto_render is true the render signal will be emitted every time the widget draws. This is the default and is useful if drawing the widget is faster.

If @auto_render is false the data from previous rendering is kept around and will be used for drawing the widget the next time, unless the window is resized. In order to force a rendering queue_render() must be called. This mode is useful when the scene changes seldom, but takes a long time to redraw.

auto_render

a boolean

fn set_error(&self, error: Option<&Error>)

Sets an error on the area which will be shown instead of the GL rendering.

This is useful in the create-context signal if GL context creation fails.

error

a new GError, or None to unset the error

fn set_has_depth_buffer(&self, has_depth_buffer: bool)

Sets whether the GLArea should use a depth buffer.

If @has_depth_buffer is true the widget will allocate and enable a depth buffer for the target framebuffer. Otherwise there will be none.

has_depth_buffer

true to add a depth buffer

fn set_has_stencil_buffer(&self, has_stencil_buffer: bool)

Sets whether the GLArea should use a stencil buffer.

If @has_stencil_buffer is true the widget will allocate and enable a stencil buffer for the target framebuffer. Otherwise there will be none.

has_stencil_buffer

true to add a stencil buffer

fn set_required_version(&self, major: i32, minor: i32)

Sets the required version of OpenGL to be used when creating the context for the widget.

This function must be called before the area has been realized.

major

the major version

minor

the minor version

fn set_use_es(&self, use_es: bool)

👎Deprecated: Since 4.12

Sets whether the @self should create an OpenGL or an OpenGL ES context.

You should check the capabilities of the gdk::GLContext before drawing with either API.

Deprecated since 4.12

Use set_allowed_apis()

use_es

whether to use OpenGL or OpenGL ES

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

Emitted when the widget is being realized.

This allows you to override how the GL context is created. This is useful when you want to reuse an existing GL context, or if you want to try creating different kinds of GL options.

If context creation fails then the signal handler can use set_error() to register a more detailed error of how the construction failed.

Returns

a newly created gdk::GLContext; the GLArea widget will take ownership of the returned value.

fn connect_render<F: Fn(&Self, &GLContext) -> Propagation + 'static>( &self, f: F, ) -> SignalHandlerId

Emitted every time the contents of the GLArea should be redrawn.

The @context is bound to the @area prior to emitting this function, and the buffers are painted to the window once the emission terminates.

context

the gdk::GLContext used by @area

Returns

true to stop other handlers from being invoked for the event. false to propagate the event further.

fn connect_resize<F: Fn(&Self, i32, i32) + 'static>( &self, f: F, ) -> SignalHandlerId

Emitted once when the widget is realized, and then each time the widget is changed while realized.

This is useful in order to keep GL state up to date with the widget size, like for instance camera properties which may depend on the width/height ratio.

The GL context for the area is guaranteed to be current when this signal is emitted.

The default handler sets up the GL viewport.

width

the width of the viewport

height

the height of the viewport

fn connect_allowed_apis_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Available on crate feature v4_12 only.

fn connect_api_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

Available on crate feature v4_12 only.

fn connect_auto_render_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

fn connect_context_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

fn connect_has_depth_buffer_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

fn connect_has_stencil_buffer_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

fn connect_use_es_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

👎Deprecated: Since 4.12

Object Safety

This trait is not object safe.

Implementors

impl<O: IsA<GLArea>> GLAreaExt for O