Skip to main content

CanvasBackground

Enum CanvasBackground 

Source
pub enum CanvasBackground {
    None,
    Dots(PatternConfig),
    Grid(PatternConfig),
    Crosshatch(PatternConfig),
}
Expand description

Background pattern for an infinite canvas.

Set via kit.set_background() or kit.with_background(). Drawn automatically by kit.element() before the user’s render callback.

Variants§

§

None

No background pattern.

§

Dots(PatternConfig)

Dot grid at regular spacing.

§

Grid(PatternConfig)

Horizontal + vertical lines.

§

Crosshatch(PatternConfig)

Diagonal lines at ±45°.

Implementations§

Source§

impl CanvasBackground

Source

pub fn dots() -> Self

Dot grid with defaults: spacing=50, light gray, size=2.

Source

pub fn grid() -> Self

Line grid with defaults: spacing=50, light gray, size=1.

Source

pub fn crosshatch() -> Self

Crosshatch with defaults: spacing=40, light gray, size=1.

Source

pub fn with_spacing(self, spacing: f32) -> Self

Customize spacing.

Source

pub fn with_color(self, color: Color) -> Self

Customize color.

Source

pub fn with_size(self, size: f32) -> Self

Customize dot size or line width.

Source

pub fn with_zoom_adaptive(self, threshold: f32, coarse_factor: u32) -> Self

Enable zoom-adaptive rendering.

Below threshold zoom, show every coarse_factor-th element.

Source§

impl CanvasBackground

Source

pub fn draw( &self, ctx: &mut dyn DrawContext, viewport: &CanvasViewport, screen_w: f32, screen_h: f32, )

Draw the background pattern for the visible viewport region.

Called with the viewport transform already pushed on DrawContext. screen_w / screen_h come from CanvasBounds.

Trait Implementations§

Source§

impl Clone for CanvasBackground

Source§

fn clone(&self) -> CanvasBackground

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for CanvasBackground

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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> NodeState for T
where T: Send + 'static,

Source§

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

Get self as Any for downcasting
Source§

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

Get self as mutable Any for downcasting
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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