Struct vizia::context::DrawContext

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

A context used when drawing a view.

The DrawContext is provided by the draw method in View and can be used to immutably access the computed style and layout properties of the current view.

Example

pub struct CustomView {}

impl CustomView {
    pub fn new(cx: &mut Context) -> Handle<Self> {
        Self{}.build(cx, |_|{})
    }
}

impl View for CustomView {
    fn draw(&self, cx: &mut DrawContext, canvas: &Canvas) {
        // Get the computed bounds after layout of the current view
        let bounds = cx.bounds();
        // Draw to the canvas using the bounds of the current view
        let path = vg::Path::new();
        path.rect(bounds.x, bounds.y, bounds.w, bounds.h);
        let mut paint = vg::Paint::default();
        paint.set_color(Color::rgb(200, 100, 100));
        canvas.draw_path(&path, &paint);
    }
}

Implementations

impl<'a> DrawContext<'a>

pub fn bounds(&self) -> BoundingBox

Returns the bounds of the current view.

pub fn z_index(&self) -> i32

Returns the z-index of the current view.

pub fn scale_factor(&self) -> f32

Returns the scale factor.

pub fn modifiers(&self) -> &Modifiers

Returns a reference to the keyboard modifiers state.

pub fn mouse(&self) -> &MouseState<Entity>

Returns a reference to the mouse state.

pub fn clip_path(&self) -> Option<Handle<SkPath>>

Returns the clip path of the current view.

pub fn transform(&self) -> Matrix

Returns the 2D transform of the current view.

pub fn visibility(&self) -> Option<Visibility>

Returns the visibility of the current view.

pub fn display(&self) -> Display

Returns the display of the current view.

pub fn opacity(&self) -> f32

Returns the opacity of the current view.

pub fn default_font(&self) -> &[FamilyOwned]

Returns the lookup pattern to pick the default font.

pub fn font_size(&self) -> f32

Returns the font-size of the current view in physical pixels.

pub fn font_weight(&self) -> FontWeight

Returns the font-weight of the current view.

pub fn font_width(&self) -> FontWidth

Returns the font-width of the current view.

pub fn font_slant(&self) -> FontSlant

Returns the font-slant of the current view.

pub fn font_variation_settings(&self) -> &[FontVariation]

Returns the font variation settings of the current view.

pub fn logical_to_physical(&self, logical: f32) -> f32

Function to convert logical points to physical pixels.

pub fn physical_to_logical(&self, physical: f32) -> f32

Function to convert physical pixels to logical points.

pub fn border_width(&self) -> f32

Returns the border width of the current view in physical pixels.

pub fn outline_color(&self) -> Color

Returns the outline color of the current view.

pub fn outline_width(&self) -> f32

Returns the outline width of the current view in physical pixels.

pub fn outline_offset(&self) -> f32

Returns the outline offset of the current view in physcial pixels.

pub fn corner_top_left_radius(&self) -> f32

Returns the corner radius for the top-left corner of the current view.

pub fn corner_top_right_radius(&self) -> f32

Returns the corner radius for the top-right corner of the current view.

pub fn corner_bottom_left_radius(&self) -> f32

Returns the corner radius for the bottom-left corner of the current view.

pub fn corner_bottom_right_radius(&self) -> f32

Returns the corner radius for the bottom-right corner of the current view.

pub fn corner_top_left_shape(&self) -> CornerShape

Returns the corner shape for the top-left corner of the current view.

pub fn corner_top_right_shape(&self) -> CornerShape

Returns the corner shape for the top-left corner of the current view.

pub fn corner_bottom_left_shape(&self) -> CornerShape

Returns the corner shape for the top-left corner of the current view.

pub fn corner_bottom_right_shape(&self) -> CornerShape

Returns the corner shape for the top-left corner of the current view.

pub fn corner_top_left_smoothing(&self) -> f32

Returns the corner smoothing for the top-left corner of the current view.

pub fn corner_top_right_smoothing(&self) -> f32

Returns the corner shape for the top-left corner of the current view.

pub fn corner_bottom_left_smoothing(&self) -> f32

Returns the corner shape for the top-left corner of the current view.

pub fn corner_bottom_right_smoothing(&self) -> f32

Returns the corner shape for the top-left corner of the current view.

pub fn child_left(&self) -> Units

Returns the child-left space of the current view.

pub fn child_right(&self) -> Units

Returns the child-right space of the current view.

pub fn child_top(&self) -> Units

Returns the child-top space of the current view.

pub fn child_bottom(&self) -> Units

Returns the child-bottom space of the current view.

pub fn background_color(&self) -> Color

pub fn border_color(&self) -> Color

pub fn border_style(&self) -> BorderStyleKeyword

Returns the border style of the current view.

pub fn selection_color(&self) -> Color

pub fn caret_color(&self) -> Color

pub fn font_color(&self) -> Color

pub fn text_wrap(&self) -> bool

Returns whether the current view should have its text wrapped.

pub fn text_align(&self) -> TextAlign

Returns the text alignment of the current view.

pub fn text_overflow(&self) -> TextOverflow

Returns the text overflow preference of the current view.

pub fn line_clamp(&self) -> Option<usize>

Returns the line clamp Of the current view.

pub fn shadows(&self) -> Option<&Vec<Shadow>>

Returns a reference to the shadows of the current view.

pub fn backdrop_filter(&self) -> Option<&Filter>

pub fn background_images(&self) -> Option<&Vec<ImageOrGradient>>

pub fn background_size(&self) -> Vec<BackgroundSize>

pub fn build_path( &self, bounds: BoundingBox, outset: (f32, f32), ) -> Handle<SkPath>

Get the vector path of the current view.

pub fn draw_background(&mut self, canvas: &Canvas)

Draw background color or background image (including gradients) for the current view.

pub fn draw_border(&mut self, canvas: &Canvas)

Draw the border of the current view.

pub fn draw_outline(&mut self, canvas: &Canvas)

Draw the outline of the current view.

pub fn draw_shadows(&mut self, canvas: &Canvas)

Draw shadows for the current view.

pub fn draw_text(&mut self, canvas: &Canvas)

Draw any text for the current view.

Trait Implementations

impl<'a> DataContext for DrawContext<'a>

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

where T: 'static,

Get model/view data from the context. Returns None if the data does not exist.

fn as_context(&self) -> Option<LocalizationContext<'_>>