Struct smithay::backend::renderer::gles2::Gles2Renderer

pub struct Gles2Renderer { /* fields omitted */ }

A renderer utilizing OpenGL ES 2

Implementations

impl Gles2Renderer

pub unsafe fn new<L>(
    context: EGLContext,
    logger: L
) -> Result<Gles2Renderer, Gles2Error> where
    L: Into<Option<Logger>>, 

Creates a new OpenGL ES 2 renderer from a given EGLContext.

Safety

This operation will cause undefined behavior if the given EGLContext is active in another thread.

Implementation details

• Texture handles created by the resulting renderer are valid for every rendered created with an EGLContext shared with the given one (see EGLContext::new_shared) and can be used on any of these renderers.
• This renderer has no default framebuffer, use Bind::bind before rendering.
• Binding a new target, while another one is already bound, will replace the current target.
• Shm buffers can be released after a successful import, without the texture handle becoming invalid.

impl Gles2Renderer

pub fn with_context<F, R>(&mut self, func: F) -> Result<R, Gles2Error> where
    F: FnOnce(&mut Self, &Gles2) -> R, 

Run custom code in the GL context owned by this renderer.

Note: Any changes to the GL state should be restored at the end of this function. Otherwise this can lead to rendering errors while using functions of this renderer. Relying on any state set by the renderer may break on any smithay update as the details about how this renderer works are considered an implementation detail.

Trait Implementations

impl Bind<Dmabuf> for Gles2Renderer

fn bind(&mut self, dmabuf: Dmabuf) -> Result<(), Gles2Error>

Bind a given rendering target, which will contain the rendering results until unbind is called.

fn supported_formats(&self) -> Option<HashSet<Format>>

Supported pixel formats for given targets, if applicable.

impl Bind<Rc<EGLSurface>> for Gles2Renderer

fn bind(&mut self, surface: Rc<EGLSurface>) -> Result<(), Gles2Error>

Bind a given rendering target, which will contain the rendering results until unbind is called.

fn supported_formats(&self) -> Option<HashSet<Format>>

Supported pixel formats for given targets, if applicable.

impl Debug for Gles2Renderer

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

Formats the value using the given formatter.

impl Drop for Gles2Renderer

fn drop(&mut self)

Executes the destructor for this type.

impl ImportDma for Gles2Renderer

fn import_dmabuf(&mut self, buffer: &Dmabuf) -> Result<Gles2Texture, Gles2Error>

Import a given raw dmabuf into the renderer.

fn dmabuf_formats<'a>(&'a self) -> Box<dyn Iterator<Item = &'a Format> + 'a>

Returns supported formats for dmabufs.

fn import_dma_buffer(
    &mut self,
    buffer: &WlBuffer
) -> Result<<Self as Renderer>::TextureId, <Self as Renderer>::Error>

Import a given dmabuf-based buffer into the renderer (see buffer_type).

impl ImportEgl for Gles2Renderer

fn bind_wl_display(&mut self, display: &Display) -> Result<(), Error>

Binds the underlying EGL display to the given Wayland display.

fn unbind_wl_display(&mut self)

Unbinds a previously bound egl display, if existing.

fn egl_reader(&self) -> Option<&EGLBufferReader>

Returns the underlying EGLBufferReader.

fn import_egl_buffer(
    &mut self,
    buffer: &WlBuffer
) -> Result<Gles2Texture, Gles2Error>

Import a given wl_drm-based buffer into the renderer (see buffer_type).

impl ImportShm for Gles2Renderer

fn import_shm_buffer(
    &mut self,
    buffer: &WlBuffer,
    surface: Option<&SurfaceData>,
    damage: &[Rectangle<i32, Buffer>]
) -> Result<Gles2Texture, Gles2Error>

Import a given shm-based buffer into the renderer (see buffer_type).

fn shm_formats(&self) -> &[Format]

Returns supported formats for shared memory buffers.

impl Renderer for Gles2Renderer

type Error = Gles2Error

Error type returned by the rendering operations of this renderer.

type TextureId = Gles2Texture

Texture Handle type used by this renderer.

type Frame = Gles2Frame

Type representing a currently in-progress frame during the Renderer::render-call

fn render<F, R>(
    &mut self,
    size: Size<i32, Physical>,
    transform: Transform,
    rendering: F
) -> Result<R, Self::Error> where
    F: FnOnce(&mut Self, &mut Self::Frame) -> R, 

Initialize a rendering context on the current rendering target with given dimensions and transformation.

impl Unbind for Gles2Renderer

fn unbind(&mut self) -> Result<(), <Self as Renderer>::Error>

Unbind the current rendering target.