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>
impl<'a> DrawContext<'a>
pub fn draw_image(
&mut self,
image: LoadedImage,
x: f32,
y: f32,
width: f32,
height: f32,
)
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)
pub fn draw_circle(&mut self, params: Circle)
Draw a filled circle.
pub fn draw_ring(&mut self, params: CircleRing)
pub fn draw_ring(&mut self, params: CircleRing)
Draw a ring (hollow circle).
pub fn draw_segment(&mut self, params: Segment)
pub fn draw_segment(&mut self, params: Segment)
Draw a line segment.
pub fn draw_triangle(&mut self, params: Triangle)
pub fn draw_triangle(&mut self, params: Triangle)
Draw a triangle.
pub fn draw_hexagon(&mut self, params: Hexagon)
pub fn draw_hexagon(&mut self, params: Hexagon)
Draw a hexagon.
pub fn draw_quadratic_bezier(&mut self, params: QuadraticBezier)
pub fn draw_quadratic_bezier(&mut self, params: QuadraticBezier)
Draw a quadratic bezier curve.
pub fn draw_dashed_box_outline(&mut self, params: DashedBoxOutline)
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)
pub fn draw_dashed_hexagon_outline(&mut self, params: DashedHexagonOutline)
Draw a dashed hexagon outline.
pub fn set_transform(&mut self, transform: Transform)
pub fn set_transform(&mut self, transform: Transform)
Set a transform for subsequent draw calls.
pub fn clear_transform(&mut self)
pub fn clear_transform(&mut self)
Clear the current transform, resetting to identity.
pub fn insert_clip_rect(&mut self, clip_rect: ClipRect) -> ClipRectHandle
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)
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)
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>
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
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)
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>
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>
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)
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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