Enum epaint::shape::Shape

source ·
pub enum Shape {
    Noop,
    Vec(Vec<Shape>),
    Circle(CircleShape),
    LineSegment {
        points: [Pos2; 2],
        stroke: Stroke,
    },
    Path(PathShape),
    Rect(RectShape),
    Text(TextShape),
    Mesh(Mesh),
    QuadraticBezier(QuadraticBezierShape),
    CubicBezier(CubicBezierShape),
    Callback(PaintCallback),
}
Expand description

A paint primitive such as a circle or a piece of text. Coordinates are all screen space points (not physical pixels).

You should generally recreate your Shapes each frame, but storing them should also be fine with one exception: Shape::Text depends on the current pixels_per_point (dpi scale) and so must be recreated every time pixels_per_point changes.

Variants§

§

Noop

Paint nothing. This can be useful as a placeholder.

§

Vec(Vec<Shape>)

Recursively nest more shapes - sometimes a convenience to be able to do. For performance reasons it is better to avoid it.

§

Circle(CircleShape)

Circle with optional outline and fill.

§

LineSegment

Fields

§points: [Pos2; 2]
§stroke: Stroke

A line between two points.

§

Path(PathShape)

A series of lines between points. The path can have a stroke and/or fill (if closed).

§

Rect(RectShape)

Rectangle with optional outline and fill.

§

Text(TextShape)

Text.

This needs to be recreated if pixels_per_point (dpi scale) changes.

§

Mesh(Mesh)

A general triangle mesh.

Can be used to display images.

§

QuadraticBezier(QuadraticBezierShape)

A quadratic Bézier Curve.

§

CubicBezier(CubicBezierShape)

A cubic Bézier Curve.

§

Callback(PaintCallback)

Backend-specific painting.

Implementations§

source§

impl Shape

source

pub fn line_segment(points: [Pos2; 2], stroke: impl Into<Stroke>) -> Self

A line between two points. More efficient than calling Self::line.

source

pub fn hline(x: RangeInclusive<f32>, y: f32, stroke: impl Into<Stroke>) -> Self

A horizontal line.

source

pub fn vline(x: f32, y: RangeInclusive<f32>, stroke: impl Into<Stroke>) -> Self

A vertical line.

source

pub fn line(points: Vec<Pos2>, stroke: impl Into<Stroke>) -> Self

A line through many points.

Use Self::line_segment instead if your line only connects two points.

source

pub fn closed_line(points: Vec<Pos2>, stroke: impl Into<Stroke>) -> Self

A line that closes back to the start point again.

source

pub fn dotted_line( path: &[Pos2], color: impl Into<Color32>, spacing: f32, radius: f32 ) -> Vec<Self>

Turn a line into equally spaced dots.

source

pub fn dashed_line( path: &[Pos2], stroke: impl Into<Stroke>, dash_length: f32, gap_length: f32 ) -> Vec<Self>

Turn a line into dashes.

source

pub fn dashed_line_many( points: &[Pos2], stroke: impl Into<Stroke>, dash_length: f32, gap_length: f32, shapes: &mut Vec<Shape> )

Turn a line into dashes. If you need to create many dashed lines use this instead of Self::dashed_line

source

pub fn convex_polygon( points: Vec<Pos2>, fill: impl Into<Color32>, stroke: impl Into<Stroke> ) -> Self

A convex polygon with a fill and optional stroke.

The most performant winding order is clockwise.

source

pub fn circle_filled( center: Pos2, radius: f32, fill_color: impl Into<Color32> ) -> Self

source

pub fn circle_stroke( center: Pos2, radius: f32, stroke: impl Into<Stroke> ) -> Self

source

pub fn rect_filled( rect: Rect, rounding: impl Into<Rounding>, fill_color: impl Into<Color32> ) -> Self

source

pub fn rect_stroke( rect: Rect, rounding: impl Into<Rounding>, stroke: impl Into<Stroke> ) -> Self

source

pub fn text( fonts: &Fonts, pos: Pos2, anchor: Align2, text: impl ToString, font_id: FontId, color: Color32 ) -> Self

source

pub fn galley(pos: Pos2, galley: Arc<Galley>) -> Self

source

pub fn galley_with_color( pos: Pos2, galley: Arc<Galley>, text_color: Color32 ) -> Self

The text color in the Galley will be replaced with the given color.

source

pub fn mesh(mesh: Mesh) -> Self

source

pub fn image(texture_id: TextureId, rect: Rect, uv: Rect, tint: Color32) -> Self

An image at the given position.

uv should normally be Rect::from_min_max(pos2(0.0, 0.0), pos2(1.0, 1.0)) unless you want to crop or flip the image.

tint is a color multiplier. Use Color32::WHITE if you don’t want to tint the image.

source

pub fn visual_bounding_rect(&self) -> Rect

The visual bounding rectangle (includes stroke widths)

source§

impl Shape

source

pub fn texture_id(&self) -> TextureId

source

pub fn translate(&mut self, delta: Vec2)

Move the shape by this many points, in-place.

Trait Implementations§

source§

impl Clone for Shape

source§

fn clone(&self) -> Shape

Returns a copy 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 Shape

source§

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

Formats the value using the given formatter. Read more
source§

impl From<CircleShape> for Shape

source§

fn from(shape: CircleShape) -> Self

Converts to this type from the input type.
source§

impl From<CubicBezierShape> for Shape

source§

fn from(shape: CubicBezierShape) -> Self

Converts to this type from the input type.
source§

impl From<Mesh> for Shape

source§

fn from(mesh: Mesh) -> Self

Converts to this type from the input type.
source§

impl From<PaintCallback> for Shape

source§

fn from(shape: PaintCallback) -> Self

Converts to this type from the input type.
source§

impl From<PathShape> for Shape

source§

fn from(shape: PathShape) -> Self

Converts to this type from the input type.
source§

impl From<QuadraticBezierShape> for Shape

source§

fn from(shape: QuadraticBezierShape) -> Self

Converts to this type from the input type.
source§

impl From<RectShape> for Shape

source§

fn from(shape: RectShape) -> Self

Converts to this type from the input type.
source§

impl From<TextShape> for Shape

source§

fn from(shape: TextShape) -> Self

Converts to this type from the input type.
source§

impl From<Vec<Shape, Global>> for Shape

source§

fn from(shapes: Vec<Shape>) -> Self

Converts to this type from the input type.
source§

impl PartialEq<Shape> for Shape

source§

fn eq(&self, other: &Shape) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for Shape

Auto Trait Implementations§

§

impl !RefUnwindSafe for Shape

§

impl Send for Shape

§

impl Sync for Shape

§

impl Unpin for Shape

§

impl !UnwindSafe for Shape

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

const: unstable · 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> ToOwned for Twhere T: Clone,

§

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 Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.