Struct lyon_tessellation::StrokeOptions

pub struct StrokeOptions {
    pub start_cap: LineCap,
    pub end_cap: LineCap,
    pub line_join: LineJoin,
    pub line_width: f32,
    pub miter_limit: f32,
    pub tolerance: f32,
    pub apply_line_width: bool,
    // some fields omitted
}

Parameters for the tessellator.

Fields

start_cap: LineCap

What cap to use at the start of each sub-path.

Default value: LineCap::Butt.

end_cap: LineCap

What cap to use at the end of each sub-path.

Default value: LineCap::Butt.

line_join: LineJoin

See the SVG specification.

Default value: LineJoin::Miter.

line_width: f32

Line width

Default value: StrokeOptions::DEFAULT_LINE_WIDTH.

miter_limit: f32

See the SVG specification.

Must be greater than or equal to 1.0. Default value: StrokeOptions::DEFAULT_MITER_LIMIT.

tolerance: f32

Maximum allowed distance to the path when building an approximation.

See Flattening and tolerance. Default value: StrokeOptions::DEFAULT_TOLERANCE.

apply_line_width: bool

Apply line width

When set to false, the generated vertices will all be positioned in the centre of the line. The width can be applied later on (eg in a vertex shader) by adding the vertex normal multiplied by the line with to each vertex position.

Default value: true.

Methods

impl StrokeOptions

pub const MINIMUM_MITER_LIMIT: f32

MINIMUM_MITER_LIMIT: f32 = 1.0

Minimum miter limit as defined by the SVG specification.

See StrokeMiterLimitProperty

pub const DEFAULT_MITER_LIMIT: f32

DEFAULT_MITER_LIMIT: f32 = 4.0

Default miter limit as defined by the SVG specification.

See StrokeMiterLimitProperty

pub const DEFAULT_LINE_CAP: LineCap

DEFAULT_LINE_CAP: LineCap = LineCap::Butt

pub const DEFAULT_LINE_JOIN: LineJoin

DEFAULT_LINE_JOIN: LineJoin = LineJoin::Miter

pub const DEFAULT_LINE_WIDTH: f32

DEFAULT_LINE_WIDTH: f32 = 1.0

pub const DEFAULT_TOLERANCE: f32

DEFAULT_TOLERANCE: f32 = 0.1

pub const DEFAULT: Self

DEFAULT: Self = StrokeOptions{start_cap: <Self>::DEFAULT_LINE_CAP,
              end_cap: <Self>::DEFAULT_LINE_CAP,
              line_join: <Self>::DEFAULT_LINE_JOIN,
              line_width: <Self>::DEFAULT_LINE_WIDTH,
              miter_limit: <Self>::DEFAULT_MITER_LIMIT,
              tolerance: <Self>::DEFAULT_TOLERANCE,
              apply_line_width: true,
              _private: (),}

pub fn tolerance(tolerance: f32) -> Self

pub fn with_tolerance(self, tolerance: f32) -> Self

pub fn with_line_cap(self, cap: LineCap) -> Self

pub fn with_start_cap(self, cap: LineCap) -> Self

pub fn with_end_cap(self, cap: LineCap) -> Self

pub fn with_line_join(self, join: LineJoin) -> Self

pub fn with_line_width(self, width: f32) -> Self

pub fn with_miter_limit(self, limit: f32) -> Self

pub fn dont_apply_line_width(self) -> Self

Trait Implementations

impl Copy for StrokeOptions

impl Clone for StrokeOptions

fn clone(&self) -> StrokeOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StrokeOptions

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

Formats the value using the given formatter.

impl PartialEq for StrokeOptions

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

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

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

This method tests for !=.

impl Default for StrokeOptions

fn default() -> Self

Returns the "default value" for a type.