Struct GlowRenderer 

pub struct GlowRenderer { /* private fields */ }

Available on crate feature renderer_glow only.

A renderer utilizing OpenGL ES 2 and [glow] on top for easier custom rendering.

Implementations

impl GlowRenderer

pub unsafe fn supported_capabilities( context: &EGLContext, ) -> Result<Vec<Capability>, GlesError>

Get the supported Capabilities of the renderer

Safety

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

pub unsafe fn new(context: EGLContext) -> Result<GlowRenderer, GlesError>

Creates a new OpenGL ES 2 + Glow renderer from a given EGLContext with all supported capabilities.

Safety

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

See: with_capabilities for more information

pub unsafe fn with_capabilities( context: EGLContext, capabilities: impl IntoIterator<Item = Capability>, ) -> Result<GlowRenderer, GlesError>

Creates a new OpenGL ES 2 + Glow renderer from a given EGLContext with the specified Capabilities. If a requested Capability is not supported an error will be returned.

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.
• Texture filtering starts with Linear-downscaling and Linear-upscaling

pub fn egl_context(&self) -> &EGLContext

Get access to the underlying EGLContext.

Note: Modifying the context state, might result in rendering issues. The context state is considered an implementation detail and no guarantee is made about what can or cannot be changed. To make sure a certain modification does not interfere with the renderer’s behaviour, check the source.

pub fn with_context<F, R>(&mut self, func: F) -> Result<R, GlesError>

where F: FnOnce(&Arc<Context>) -> R,

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

The OpenGL state of the renderer is considered an implementation detail and no guarantee is made about what can or cannot be changed, as such you should reset everything you change back to its previous value or check the source code of the version of Smithay you are using to ensure your changes don’t interfere with the renderer’s behavior. Doing otherwise can lead to rendering errors while using other functions of this renderer.

Trait Implementations

impl AsMut<GlowRenderer> for GlowFrameGuard<'_, '_, '_>

fn as_mut(&mut self) -> &mut GlowRenderer

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<GlowRenderer> for GlowFrameGuard<'_, '_, '_>

fn as_ref(&self) -> &GlowRenderer

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> Bind<T> for GlowRenderer

where GlesRenderer: Bind<T>,

fn bind<'a>(&mut self, target: &'a mut T) -> Result<GlesTarget<'a>, GlesError>

Initialize a framebuffer with a given rendering target.

fn supported_formats(&self) -> Option<FormatSet>

Supported pixel formats for given targets, if applicable.

impl Blit for GlowRenderer

fn blit( &mut self, from: &GlesTarget<'_>, to: &mut GlesTarget<'_>, src: Rectangle<i32, Physical>, dst: Rectangle<i32, Physical>, filter: TextureFilter, ) -> Result<SyncPoint, GlesError>

Copies the contents of src from one provided target to dst in the other provided target, applying filter if necessary.

impl Borrow<GlesRenderer> for GlowRenderer

fn borrow(&self) -> &GlesRenderer

Immutably borrows from an owned value.

impl BorrowMut<GlesRenderer> for GlowRenderer

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

Mutably borrows from an owned value.

impl Debug for GlowRenderer

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

Formats the value using the given formatter.

impl ExportMem for GlowRenderer

type TextureMapping = GlesMapping

Texture type representing a downloaded pixel buffer.

fn copy_framebuffer( &mut self, from: &GlesTarget<'_>, region: Rectangle<i32, BufferCoord>, format: Fourcc, ) -> Result<Self::TextureMapping, Self::Error>

Copies the contents of the provided target.

fn copy_texture( &mut self, texture: &Self::TextureId, region: Rectangle<i32, BufferCoord>, format: Fourcc, ) -> Result<Self::TextureMapping, Self::Error>

Copies the contents of the passed texture. Note: This function may change or invalidate the current bind.

fn can_read_texture( &mut self, texture: &Self::TextureId, ) -> Result<bool, Self::Error>

Returns whether the renderer should be able to read-back from the given texture.

fn map_texture<'a>( &mut self, texture_mapping: &'a Self::TextureMapping, ) -> Result<&'a [u8], Self::Error>

Returns a read-only pointer to a previously created texture mapping.

impl<'a, 'frame, 'buffer> FrameContext<'a, 'frame, 'buffer, GlowRenderer> for GlowFrame<'frame, 'buffer>

where 'frame: 'a,

type Guard = GlowFrameGuard<'a, 'frame, 'buffer>

Type returned by FrameContext::renderer which derefs into the underlying Renderer.

fn renderer(&'a mut self) -> Self::Guard

Receive the underlying Renderer

impl From<GlesRenderer> for GlowRenderer

fn from(renderer: GlesRenderer) -> GlowRenderer

Converts to this type from the input type.

impl ImportDma for GlowRenderer

fn import_dmabuf( &mut self, buffer: &Dmabuf, damage: Option<&[Rectangle<i32, BufferCoord>]>, ) -> Result<GlesTexture, GlesError>

Import a given raw dmabuf into the renderer.

fn dmabuf_formats(&self) -> FormatSet

Returns supported formats for dmabufs.

fn has_dmabuf_format(&self, format: Format) -> bool

Test if a specific dmabuf Format is supported

impl ImportDmaWl for GlowRenderer

Available on crate feature wayland_frontend only.

fn import_dma_buffer( &mut self, buffer: &WlBuffer, _surface: Option<&SurfaceData>, damage: &[Rectangle<i32, BufferCoord>], ) -> Result<Self::TextureId, Self::Error>

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

impl ImportEgl for GlowRenderer

Available on crate features wayland_frontend and backend_egl and use_system_lib only.

fn bind_wl_display(&mut self, display: &DisplayHandle) -> 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, surface: Option<&SurfaceData>, damage: &[Rectangle<i32, BufferCoord>], ) -> Result<GlesTexture, GlesError>

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

impl ImportMem for GlowRenderer

fn import_memory( &mut self, data: &[u8], format: Fourcc, size: Size<i32, BufferCoord>, flipped: bool, ) -> Result<GlesTexture, GlesError>

Import a given chunk of memory into the renderer.

fn update_memory( &mut self, texture: &Self::TextureId, data: &[u8], region: Rectangle<i32, BufferCoord>, ) -> Result<(), Self::Error>

Update a portion of a given chunk of memory into an existing texture.

fn mem_formats(&self) -> Box<dyn Iterator<Item = Fourcc>>

Returns supported formats for memory imports.

impl ImportMemWl for GlowRenderer

Available on crate feature wayland_frontend only.

fn import_shm_buffer( &mut self, buffer: &WlBuffer, surface: Option<&SurfaceData>, damage: &[Rectangle<i32, BufferCoord>], ) -> Result<GlesTexture, GlesError>

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

fn shm_formats(&self) -> Box<dyn Iterator<Item = Format>>

Returns supported formats for shared memory buffers.

impl<T> Offscreen<T> for GlowRenderer

where GlesRenderer: Offscreen<T>,

fn create_buffer( &mut self, format: Fourcc, size: Size<i32, BufferCoord>, ) -> Result<T, GlesError>

Create a new instance of a framebuffer.

impl RenderElement<GlowRenderer> for PixelShaderElement

fn draw( &self, frame: &mut GlowFrame<'_, '_>, src: Rectangle<f64, BufferCoord>, dst: Rectangle<i32, Physical>, damage: &[Rectangle<i32, Physical>], opaque_regions: &[Rectangle<i32, Physical>], cache: Option<&UserDataMap>, ) -> Result<(), GlesError>

Draw this element

fn underlying_storage( &self, renderer: &mut GlowRenderer, ) -> Option<UnderlyingStorage<'_>>

Get the underlying storage of this element, may be used to optimize rendering (eg. drm planes)

fn capture_framebuffer( &self, frame: &mut R::Frame<'_, '_>, src: Rectangle<f64, BufferCoords>, dst: Rectangle<i32, Physical>, cache: &UserDataMap, ) -> Result<(), R::Error>

Notification, that the underlying framebuffer has changed allowing the element to blit the contents of the frame.

impl RenderElement<GlowRenderer> for TextureShaderElement

fn draw( &self, frame: &mut GlowFrame<'_, '_>, src: Rectangle<f64, BufferCoord>, dst: Rectangle<i32, Physical>, damage: &[Rectangle<i32, Physical>], opaque_regions: &[Rectangle<i32, Physical>], cache: Option<&UserDataMap>, ) -> Result<(), GlesError>

Draw this element

fn underlying_storage( &self, renderer: &mut GlowRenderer, ) -> Option<UnderlyingStorage<'_>>

Get the underlying storage of this element, may be used to optimize rendering (eg. drm planes)

fn capture_framebuffer( &self, frame: &mut R::Frame<'_, '_>, src: Rectangle<f64, BufferCoords>, dst: Rectangle<i32, Physical>, cache: &UserDataMap, ) -> Result<(), R::Error>

Notification, that the underlying framebuffer has changed allowing the element to blit the contents of the frame.

impl Renderer for GlowRenderer

fn context_id(&self) -> ContextId<GlesTexture>

Returns the ContextId of this renderer

fn downscale_filter(&mut self, filter: TextureFilter) -> Result<(), Self::Error>

Set the filter method to be used when rendering a texture into a smaller area than its size

fn upscale_filter(&mut self, filter: TextureFilter) -> Result<(), Self::Error>

Set the filter method to be used when rendering a texture into a larger area than its size

fn set_debug_flags(&mut self, flags: DebugFlags)

Set the enabled DebugFlags

fn debug_flags(&self) -> DebugFlags

Returns the current enabled DebugFlags

fn render<'frame, 'buffer>( &'frame mut self, target: &'frame mut GlesTarget<'buffer>, output_size: Size<i32, Physical>, transform: Transform, ) -> Result<GlowFrame<'frame, 'buffer>, Self::Error>

where 'buffer: 'frame,

Initialize a rendering context on the provided framebuffer with given dimensions and transformation.

fn wait(&mut self, sync: &SyncPoint) -> Result<(), Self::Error>

Wait for a SyncPoint to be signaled

fn cleanup_texture_cache(&mut self) -> Result<(), Self::Error>

Forcibly clean up the renderer internal texture cache

impl RendererSuper for GlowRenderer

type Error = GlesError

Error type returned by the rendering operations of this renderer.

type TextureId = GlesTexture

Texture Handle type used by this renderer.

type Framebuffer<'buffer> = GlesTarget<'buffer>

Framebuffer to draw onto

type Frame<'frame, 'buffer> = GlowFrame<'frame, 'buffer> where Self: 'frame, 'buffer: 'frame

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