Struct kludgine::drawing::Renderer

pub struct Renderer<'render, 'gfx> { /* private fields */ }

An easy-to-use graphics renderer that batches operations on the GPU automatically.

Using the draw operations on this type don’t immediately draw. Instead, once this type is dropped, the Drawing that created this renderer will be updated with the new drawing instructions. All of the pending operations can be drawn using Drawing::render.

Implementations

impl<'render, 'gfx> Renderer<'render, 'gfx>

pub fn as_plot_area( &mut self ) -> DrawingArea<PlotterBackend<'_, 'render, 'gfx>, Shift>

Returns this renderer as a [DrawingArea] compatible with the plotters crate.

impl<'gfx> Renderer<'_, 'gfx>

pub fn measure_text<'a, Unit>( &mut self, text: impl Into<Text<'a, Unit>> ) -> MeasuredText<Unit>

where Unit: ScreenUnit,

Measures text using the current text settings.

default_color does not affect the

pub fn draw_text<'a, Unit, Source>(&mut self, text: Source)

where Unit: ScreenUnit, Source: Into<Drawable<Text<'a, Unit>, Unit>>,

Draws text using the current text settings.

pub fn draw_text_buffer<'a, Unit>( &mut self, buffer: impl Into<Drawable<&'a Buffer, Unit>>, default_color: Color, origin: TextOrigin<Px> )

where Unit: ScreenUnit,

Prepares the text layout contained in buffer to be rendered.

When the text in buffer has no color defined, default_color will be used.

origin allows controlling how the text will be drawn relative to the coordinate provided in render().

pub fn measure_text_buffer<Unit>( &mut self, buffer: &Buffer, default_color: Color ) -> MeasuredText<Unit>

where Unit: ScreenUnit,

Measures buffer and caches the results using default_color when the buffer has no color associated with text.

pub fn draw_measured_text<'a, Unit>( &mut self, text: impl Into<Drawable<&'a MeasuredText<Unit>, Unit>>, origin: TextOrigin<Unit> )

where Unit: ScreenUnit,

Prepares the text layout contained in buffer to be rendered.

When the text in buffer has no color defined, default_color will be used.

origin allows controlling how the text will be drawn relative to the coordinate provided in render().

impl<'render, 'gfx> Renderer<'render, 'gfx>

pub fn draw_shape<'shape, Unit>( &mut self, shape: impl Into<Drawable<&'shape Shape<Unit, false>, Unit>> )

where Unit: Zero + ShaderScalable + ScreenUnit + Unit + Copy,

Draws a shape at the origin, rotating and scaling as needed.

pub fn draw_texture<Unit>( &mut self, texture: &impl TextureSource, destination: Rect<Unit>, opacity: f32 )

where Unit: Unit + ScreenUnit + ShaderScalable, i32: From<<Unit as IntoSigned>::Signed>,

Draws texture at destination, scaling as necessary.

pub fn draw_texture_at<Unit>( &mut self, texture: &impl TextureSource, destination: Point<Unit>, opacity: f32 )

where Unit: Unit + ScreenUnit + ShaderScalable, i32: From<<Unit as IntoSigned>::Signed>,

Draws texture at destination.

pub fn draw_textured_shape<'shape, Unit, Shape>( &mut self, shape: impl Into<Drawable<&'shape Shape, Unit>>, texture: &impl TextureSource )

where Unit: Zero + ShaderScalable + ScreenUnit + Unit + Copy, i32: From<<Unit as IntoSigned>::Signed>, Shape: ShapeSource<Unit, true> + 'shape,

Draws a shape that was created with texture coordinates, applying the provided texture.

pub fn vertex_count(&self) -> usize

Returns the number of vertexes that compose the drawing commands.

pub fn triangle_count(&self) -> usize

Returns the number of triangles that are being rendered in the drawing commands.

pub fn command_count(&self) -> usize

Returns the number of drawing operations that will be sent to the GPU during render().

pub fn clipped_to(&mut self, clip: Rect<UPx>) -> ClipGuard<'_, Self>

Returns a ClipGuard that causes all drawing operations to be offset and clipped to clip until it is dropped.

This function causes the Renderer to act as if the origin of the context is clip.origin, and the size of the context is clip.size. This means that rendering at 0,0 will actually render at the effective clip rect’s origin.

clip is relative to the current clip rect and cannot extend the current clipping rectangle.

Methods from Deref<Target = Graphics<'gfx>>

pub fn prepare_text( &mut self, buffer: &Buffer, default_color: Color, origin: TextOrigin<Px> ) -> PreparedText

Prepares the text layout contained in buffer to be rendered.

When the text in buffer has no color defined, default_color will be used.

origin allows controlling how the text will be drawn relative to the coordinate provided in render().

pub fn device(&self) -> &'gfx Device

Returns a reference to the underlying [wgpu::Device].

pub fn queue(&self) -> &'gfx Queue

Returns a reference to the underlying [wgpu::Queue].

pub fn font_system(&mut self) -> &mut FontSystem

Returns a mutable reference to the [cosmic_text::FontSystem] used when rendering text.

pub fn size(&self) -> Size<UPx>

Returns the current clipped size of the context.

If this context has not been clipped, the value returned will be equivalent to Kludgine::size.

pub fn clip_rect(&self) -> Rect<UPx>

Returns the current rectangular area of the context.

If this context has not been clipped, the value returned will be equivalent to Kludgine::size with an origin of 0,0.

Methods from Deref<Target = Kludgine>

pub fn font_system(&mut self) -> &mut FontSystem

Returns a mutable reference to the [cosmic_text::FontSystem] used when rendering text.

pub fn rebuild_font_system(&mut self)

Rebuilds the font system, invalidating font database caches.

This function can be invoked after loading fonts into the font database to ensure that all future text rendering considers the newly loaded fonts.

pub fn set_font_size(&mut self, size: impl ScreenScale<Lp = Lp>)

Sets the font size.

pub fn font_size(&self) -> Lp

Returns the current font size.

pub fn set_line_height(&mut self, size: impl ScreenScale<Lp = Lp>)

Sets the line height for multi-line layout.

pub fn line_height(&self) -> Lp

Returns the current line height.

pub fn set_font_family(&mut self, family: FamilyOwned)

Sets the current font family.

pub fn font_family(&self) -> Family<'_>

Returns the current font family.

pub fn set_font_style(&mut self, style: Style)

Sets the current font style.

pub fn font_style(&self) -> Style

Returns the current font style.

pub fn set_font_weight(&mut self, weight: Weight)

Sets the current font weight.

pub fn font_weight(&self) -> Weight

Returns the current font weight.

pub fn set_text_stretch(&mut self, width: Stretch)

Sets the current text stretching.

pub fn text_stretch(&self) -> Stretch

Returns the current text stretch.

pub fn text_attrs(&self) -> Attrs<'_>

Returns the current text attributes.

pub fn set_text_attributes(&mut self, attrs: Attrs<'_>)

Sets the current text attributes.

pub fn reset_text_attributes(&mut self)

Resets all of the text related properties to their default settings.

pub const REQURED_FEATURES: Features = wgpu::Features::PUSH_CONSTANTS

pub fn id(&self) -> KludgineId

Returns the unique id of this instance.

pub fn resize(&mut self, new_size: Size<UPx>, new_scale: f32, queue: &Queue)

Updates the size and scale of this Kludgine instance.

This function updates data stored in the GPU that affects how graphics are rendered. It should be called before calling next_frame() if the size or scale of the underlying surface has changed.

pub fn next_frame(&mut self) -> Frame<'_>

Begins rendering a new frame.

pub fn size(&self) -> Size<UPx>

Returns the currently configured size to render.

pub fn scale(&self) -> Fraction

Returns the current scaling factor for the display this instance is rendering to.

Trait Implementations

impl Clipped for Renderer<'_, '_>

fn push_clip(&mut self, clip: Rect<UPx>)

Pushes a new clipping state to the clipping stack.

fn pop_clip(&mut self)

Restores the clipping rect to the previous state before the last call to Clipped::push_clip().

fn clipped_to(&mut self, clip: Rect<UPx>) -> ClipGuard<'_, Self>

Returns a ClipGuard that causes all drawing operations to be offset and clipped to clip until it is dropped.

impl<'render, 'gfx> Debug for Renderer<'render, 'gfx>

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

Formats the value using the given formatter.

impl<'gfx> Deref for Renderer<'_, 'gfx>

type Target = Graphics<'gfx>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'gfx> DerefMut for Renderer<'_, 'gfx>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Drop for Renderer<'_, '_>

fn drop(&mut self)

Executes the destructor for this type.