Struct kludgine::Graphics

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

A context used to prepare graphics to render.

This type is used in these APIs:

• Shape::prepare
• Texture::prepare
• Texture::prepare_partial
• CollectedTexture::prepare
• Drawing::new_frame

Implementations

impl<'gfx> 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().

impl<'gfx> Graphics<'gfx>

pub fn new( kludgine: &'gfx mut Kludgine, device: &'gfx Device, queue: &'gfx Queue ) -> Self

Returns a new instance.

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

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

pub const 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 const 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 const 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 AsRef<Device> for Graphics<'_>

fn as_ref(&self) -> &Device

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

impl AsRef<Queue> for Graphics<'_>

fn as_ref(&self) -> &Queue

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

impl Clipped for Graphics<'_>

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<'gfx> Debug for Graphics<'gfx>

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

Formats the value using the given formatter.

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.

impl KludgineGraphics for Graphics<'_>