Struct usvg::Text

pub struct Text { /* private fields */ }

A text element.

text element in SVG.

Implementations

impl Text

pub fn id(&self) -> &str

Element’s ID.

Taken from the SVG itself. Isn’t automatically generated. Can be empty.

pub fn rendering_mode(&self) -> TextRendering

Rendering mode.

text-rendering in SVG.

pub fn dx(&self) -> &[f32]

A relative X axis offsets.

One offset for each Unicode codepoint. Aka char in Rust.

pub fn dy(&self) -> &[f32]

A relative Y axis offsets.

One offset for each Unicode codepoint. Aka char in Rust.

pub fn rotate(&self) -> &[f32]

A list of rotation angles.

One angle for each Unicode codepoint. Aka char in Rust.

pub fn writing_mode(&self) -> WritingMode

A writing mode.

pub fn chunks(&self) -> &[TextChunk]

A list of text chunks.

pub fn abs_transform(&self) -> Transform

Element’s absolute transform.

Contains all ancestors transforms including elements’s transform.

Note that this is not the relative transform present in SVG. The SVG one would be set only on groups.

pub fn bounding_box(&self) -> Rect

Element’s text bounding box.

Text bounding box is special in SVG and doesn’t represent tight bounds of the element’s content. You can find more about it here.

objectBoundingBox in SVG terms. Meaning it doesn’t affected by parent transforms.

Returns None when the text build feature was disabled. This is because we have to perform a text layout before calculating a bounding box.

pub fn abs_bounding_box(&self) -> Rect

Element’s text bounding box in canvas coordinates.

userSpaceOnUse in SVG terms.

pub fn stroke_bounding_box(&self) -> Rect

Element’s object bounding box including stroke.

Similar to bounding_box, but includes stroke.

Will have the same value as bounding_box when path has no stroke.

pub fn abs_stroke_bounding_box(&self) -> Rect

Element’s bounding box including stroke in canvas coordinates.

pub fn flattened(&self) -> &Group

Text converted into paths, ready to render.

Note that this is only a “best-effort” attempt: The text will be converted into group/paths/image primitives, so that they can be rendered with the existing infrastructure. This process is in general lossless and should lead to correct output, with two notable exceptions:

1. For glyphs based on the SVG table, only glyphs that are pure SVG 1.1/2.0 are supported. Glyphs that make use of features in the OpenType specification that are not part of the original SVG specification are not supported.
2. For glyphs based on the COLR table, there are a certain number of features that are not (correctly) supported, such as conical gradients, certain gradient transforms and some blend modes. But this shouldn’t cause any issues in 95% of the cases, as most of those are edge cases. If the two above are not acceptable, then you will need to implement your own glyph rendering logic based on the layouted glyphs (see the layouted method).

pub fn layouted(&self) -> &[Span]

The positioned glyphs and decoration spans of the text.

This should only be used if you need more low-level access to the glyphs that make up the text. If you just need the outlines of the text, you should use flattened instead.

Trait Implementations

impl Clone for Text

fn clone(&self) -> Text

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Text

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

Formats the value using the given formatter.