Struct EguiSoftwareRender 

pub struct EguiSoftwareRender { /* private fields */ }

Software render backend for egui.

Implementations

impl EguiSoftwareRender

pub fn new(output_field_order: ColorFieldOrder) -> Self

Arguments

• output_field_order - egui textures and vertex colors will be swizzled before rendering to match the desired output buffer order.

pub fn with_convert_tris_to_rects(self, set: bool) -> Self

If true: attempts to optimize by converting suitable triangle pairs into rectangles for faster rendering. Things should look the same with this set to true while rendering faster.

pub fn with_allow_raster_opt(self, set: bool) -> Self

If false: Rasterize everything with triangles, always calculate vertex colors, uvs, use bilinear everywhere, etc… Things should look the same with this set to true while rendering faster.

pub fn with_caching(self, set: bool) -> Self

If true: rasterized ClippedPrimitives are cached and rendered to an intermediate tiled canvas. That canvas is then rendered over the frame buffer. If false ClippedPrimitives are rendered directly to the frame buffer. Rendering without caching is much slower and primarily intended for testing.

pub fn render( &mut self, buffer_ref: &mut BufferMutRef<'_>, paint_jobs: &[ClippedPrimitive], textures_delta: &TexturesDelta, pixels_per_point: f32, )

Renders the given paint jobs to buffer_ref. Alternatively, when using caching EguiSoftwareRender::render_to_canvas() and subsequently EguiSoftwareRender::blit_canvas_to_buffer() can be run separately so that the primary rendering in render_to_canvas() can happen without a lock on the frame buffer.

Arguments

• paint_jobs - List of egui::ClippedPrimitive from egui to be rendered.
• textures_delta - The change in egui textures since last frame
• pixels_per_point - The number of physical pixels for each logical point.

pub fn render_to_canvas( &mut self, width: usize, height: usize, paint_jobs: &[ClippedPrimitive], textures_delta: &TexturesDelta, pixels_per_point: f32, )

Renders the given paint jobs to an intermediate canvas.

Arguments

• width - The width of the output in pixels. Must match final output buffer dimensions.
• height - The height of the output in pixels. Must match final output buffer dimensions.
• paint_jobs - List of egui::ClippedPrimitive from egui to be rendered.
• textures_delta - The change in egui textures since last frame
• pixels_per_point - The number of physical pixels for each logical point.

pub fn blit_canvas_to_buffer(&mut self, buffer: &mut BufferMutRef<'_>)

Draw canvas alpha over given buffer. Only run after EguiSoftwareRender::render_to_canvas(), or use EguiSoftwareRender::render() to run both. Only writes tile regions that contain pixels that are not fully transparent.