Struct ggez::graphics::StrokeOptions

#[non_exhaustive]
pub struct StrokeOptions {
    pub start_cap: LineCap,
    pub end_cap: LineCap,
    pub line_join: LineJoin,
    pub line_width: f32,
    pub variable_line_width: Option<usize>,
    pub miter_limit: f32,
    pub tolerance: f32,
}

Parameters for the tessellator.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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.

variable_line_width: Option<usize>

Index of a custom attribute defining a per-vertex factor to modulate the line width.

Default value: None.

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.

Implementations

impl StrokeOptions

pub const MINIMUM_MITER_LIMIT: f32 = 1f32

Minimum miter limit as defined by the SVG specification.

See StrokeMiterLimitProperty

pub const DEFAULT_MITER_LIMIT: f32 = 4f32

Default miter limit as defined by the SVG specification.

See StrokeMiterLimitProperty

pub const DEFAULT_LINE_CAP: LineCap = LineCap::Butt

pub const DEFAULT_LINE_JOIN: LineJoin = LineJoin::Miter

pub const DEFAULT_LINE_WIDTH: f32 = 1f32

pub const DEFAULT_TOLERANCE: f32 = 0.100000001f32

pub const DEFAULT: StrokeOptions = 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, variable_line_width: None, miter_limit: Self::DEFAULT_MITER_LIMIT, tolerance: Self::DEFAULT_TOLERANCE,}

pub fn tolerance(tolerance: f32) -> StrokeOptions

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

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

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

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

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

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

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

pub const fn with_variable_line_width(self, idx: usize) -> StrokeOptions

Trait Implementations

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<(), Error>

Formats the value using the given formatter.

impl Default for StrokeOptions

fn default() -> StrokeOptions

Returns the “default value” for a type.

impl PartialEq<StrokeOptions> 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: &Rhs) -> bool

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

impl Copy for StrokeOptions

impl StructuralPartialEq for StrokeOptions