Skip to main content

DrawContext

Struct DrawContext 

pub struct DrawContext<'a> { /* private fields */ }
Expand description

A context for custom drawing.

This is a limited version of the keru_draw [Renderer] that exposes the methods for drawing, but not the internal ones like [Renderer::clear_for_new_frame].

Implementations§

§

impl<'a> DrawContext<'a>

pub fn draw_box(&mut self, params: Rectangle)

Draw a box/rectangle.

pub fn draw_image( &mut self, image: LoadedImage, x: f32, y: f32, width: f32, height: f32, )

Draw an image.

pub fn draw_circle(&mut self, params: Circle)

Draw a filled circle.

pub fn draw_ring(&mut self, params: CircleRing)

Draw a ring (hollow circle).

pub fn draw_arc(&mut self, params: CircleArc)

Draw an arc.

pub fn draw_pie(&mut self, params: CirclePie)

Draw a pie slice.

pub fn draw_segment(&mut self, params: Segment)

Draw a line segment.

pub fn draw_grid(&mut self, params: Grid)

Draw a grid.

pub fn draw_triangle(&mut self, params: Triangle)

Draw a triangle.

pub fn draw_hexagon(&mut self, params: Hexagon)

Draw a hexagon.

pub fn draw_quadratic_bezier(&mut self, params: QuadraticBezier)

Draw a quadratic bezier curve.

pub fn draw_dashed_box_outline(&mut self, params: DashedBoxOutline)

Draw a dashed box outline.

pub fn draw_dashed_hexagon_outline(&mut self, params: DashedHexagonOutline)

Draw a dashed hexagon outline.

pub fn set_transform(&mut self, transform: Transform)

Set a transform for subsequent draw calls.

pub fn clear_transform(&mut self)

Clear the current transform, resetting to identity.

pub fn insert_clip_rect(&mut self, clip_rect: ClipRect) -> ClipRectHandle

Create a clip rect for this frame.

pub fn set_clip_rect(&mut self, clip_rect: ClipRect)

Set a clip rect for subsequent draw calls.

pub fn clear_clip_rect(&mut self)

Clear the current clip rect, resetting to no clip.

pub fn load_svg( &mut self, svg_data: &[u8], width: u32, height: u32, ) -> Option<LoadedImage>

Load and rasterize an SVG, returning the loaded image.

Must be unloaded manually with Self::unload_image().

pub fn rerasterize_svg_if_needed( &mut self, loaded: &mut LoadedImage, width: u32, height: u32, ) -> bool

Rerasterize an SVG at a new size if needed.

pub fn unload_svg(&mut self, loaded: &LoadedImage)

Remove a loaded SVG and free its atlas space..

Must be unloaded manually with Self::unload_image().

pub fn load_rgba8_image( &mut self, rgba_data: &[u8], width: u32, height: u32, ) -> Option<LoadedImage>

Load a raster image from raw RGBA8 bytes.

Returns None if the image couldn’t be stored in the atlas..

Must be unloaded manually with Self::unload_image().

pub fn load_encoded_image(&mut self, image_data: &[u8]) -> Option<LoadedImage>

Load a raster image from encoded bytes (PNG, JPEG, etc.).

Returns None if the image couldn’t be stored in the atlas..

Must be unloaded manually with Self::unload_image().

pub fn unload_image(&mut self, loaded: &LoadedImage)

Remove a loaded image and free its atlas space..

Must be unloaded manually with Self::unload_image().

Auto Trait Implementations§

§

impl<'a> Freeze for DrawContext<'a>

§

impl<'a> !RefUnwindSafe for DrawContext<'a>

§

impl<'a> !Send for DrawContext<'a>

§

impl<'a> !Sync for DrawContext<'a>

§

impl<'a> Unpin for DrawContext<'a>

§

impl<'a> UnsafeUnpin for DrawContext<'a>

§

impl<'a> !UnwindSafe for DrawContext<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,