Struct Graphics

pub struct Graphics<'clip, 'gfx, 'pass> { /* private fields */ }

A 2d graphics context

Implementations

impl<'gfx, 'pass> Graphics<'_, 'gfx, 'pass>

pub fn new(renderer: Renderer<'gfx, 'pass>) -> Self

Returns a new graphics context for the given [Renderer].

pub fn translation(&self) -> Point<Px>

Returns the offset relative to the clipping rect that the graphics context renders at.

This is used when rendering controls that are partially offscreen to the left or top of the window’s origin.

In general, this is handled automatically. This function should only be needed when using inner_graphics().

pub fn inner_graphics(&mut self) -> &mut Renderer<'gfx, 'pass>

Returns the underlying renderer.

Note: Kludgine graphics contexts only support clipping. This type adds self.translation() to the offset of each drawing call. When using the underlying renderer, any drawing calls will need this offset as well, otherwise the widget that is being rendered will not render correctly when placed in a Scroll widget.

pub fn clipped_to(&mut self, clip: Rect<Px>) -> Graphics<'_, 'gfx, 'pass>

Returns a context that has been clipped to clip.

The new clipping rectangle is interpreted relative to the current clipping rectangle. As a side effect, this function can never expand the clipping rect beyond the current clipping rect.

The returned context will report the clipped size, and all drawing operations will be relative to the origin of clip.

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

Returns the current clipping rectangle.

The clipping rectangle is represented in unsigned pixels in the window’s coordinate system.

pub fn region(&self) -> Rect<Px>

Returns the current region being rendered to.

The rendering region utilizes signed pixels, which allows it to represent regions that are out of bounds of the window’s visible region.

pub fn visible_rect(&self) -> Option<Rect<UPx>>

Returns the visible region of the graphics context.

This is the intersection of Self::region() and Self::clip_rect().

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

Returns the size of the current region.

This is self.region().size converted to unsigned pixels.

pub fn scale(&self) -> Fraction

Returns the current DPI scaling factor applied to the window this context is attached to.

pub fn fill(&mut self, color: Color)

Fills the entire context with color.

If the alpha channel of color is 0, this function does nothing.

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

where Unit: Zero + ShaderScalable + ScreenUnit + 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: ZeroToOne, )

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

Draws texture at destination, scaling as necessary.

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

where Unit: Zero + ShaderScalable + ScreenUnit + 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 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>( &mut self, text: impl Into<Drawable<Text<'a, Unit>, Unit>>, )

where Unit: ScreenUnit,

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 + Round,

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 draw<Op: RenderOperation>(&mut self)

where Op::DrawInfo: Default,

Draws the custom rendering operation when this graphics is presented to the screen.

The rendering operation will be clipped automatically, but the rendering operation will need to position and size itself accordingly.

pub fn draw_with<Op: RenderOperation>(&mut self, context: Op::DrawInfo)

Draws Op with the given context.

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

Returns a reference to the font system used to render.

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

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

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: Width)

Sets the current text stretching.

pub fn text_stretch(&self) -> Width

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 texture_format(&self) -> TextureFormat

Returns the texture format this instance was initialized with.

pub fn multisample_state(&self) -> MultisampleState

Returns the multisample state this instance was initialized with.

pub fn id(&self) -> KludgineId

Returns the unique id of this instance.

pub fn resize( &mut self, new_size: Size<UPx>, new_scale: impl Into<Fraction>, new_zoom: impl Into<Fraction>, 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 set_zoom(&mut self, new_zoom: impl Into<Fraction>, queue: &Queue)

Sets the current zoom level.

Zoom and DPI scale are multiplied to create an effective scale for all DPI-scaled operations.

pub fn set_dpi_scale(&mut self, new_scale: impl Into<Fraction>, queue: &Queue)

Sets the current DPI scale.

This scaling factor should come from the window server when possible.

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 effective scale to apply to graphics contexts.

pub fn dpi_scale(&self) -> Fraction

Returns the DPI scale of the underlying context.

pub fn zoom(&self) -> Fraction

Returns the current zoom applied.

Trait Implementations

impl Deref for Graphics<'_, '_, '_>

type Target = Kludgine

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for Graphics<'_, '_, '_>

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

Mutably dereferences the value.