Struct Kludgine

pub struct Kludgine { /* private fields */ }

A 2d graphics instance.

This type contains the GPU state for a single instance of Kludgine. To render graphics correctly, it must know the size and scale of the surface being rendered to. These values are provided in the constructor, but can be updated using resize().

To draw using Kludgine, create a Frame using next_frame(). [wgpu] has lifetime requirements on the [wgpu::RenderPass] which causes each item being rendered to be attached to the lifetime of the render pass. This means that no temporary variables can be used to render.

Instead, graphics must be prepared before rendering, and stored somewhere during the remainder of the RenderingGraphics. To prepare graphics to be rendered, call Frame::prepare() to receive a Graphics instance that can be used in various Kludgine APIs such as Shape::prepare.

Implementations

impl 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.

impl Kludgine

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

The features that wgpu requires in compatible devices.

pub fn new( device: &Device, queue: &Queue, format: TextureFormat, multisample: MultisampleState, initial_size: Size<UPx>, scale: f32, ) -> Self

Returns a new instance of Kludgine with the provided parameters.

pub const fn texture_format(&self) -> TextureFormat

Returns the texture format this instance was initialized with.

pub const fn multisample_state(&self) -> MultisampleState

Returns the multisample state this instance was initialized with.

pub fn adjust_limits(limits: Limits) -> Limits

Adjusts and returns the wgpu limits to support features used by Kludgine.

pub const 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 const fn size(&self) -> Size<UPx>

Returns the currently configured size to render.

pub const fn scale(&self) -> Fraction

Returns the effective scale to apply to graphics contexts.

pub const fn dpi_scale(&self) -> Fraction

Returns the DPI scale of the underlying context.

pub const fn zoom(&self) -> Fraction

Returns the current zoom applied.

Trait Implementations

impl Debug for Kludgine

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

Formats the value using the given formatter.