Struct kludgine::RenderingGraphics

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

A graphics context used to render previously prepared graphics.

This type is used to render these types:

• PreparedGraphic
• PreparedText
• Drawing

Implementations

impl<'gfx, 'pass> RenderingGraphics<'gfx, 'pass>

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

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

Returns the current size of the graphics area being rendered to.

If the graphics has been clipped, this returns the current width of the clipped area.

pub const fn scale(&self) -> Fraction

Returns the current scaling factor of the display being rendered to.

Trait Implementations

impl Clipped for RenderingGraphics<'_, '_>

fn pop_clip(&mut self)

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

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

Pushes a new clipping state to the clipping stack.

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 Drop for RenderingGraphics<'_, '_>

fn drop(&mut self)

Executes the destructor for this type.