Enum Generator 

pub enum Generator {
    Fill {
        paint: Paint,
    },
    Shapes {
        items: Vec<ShapeItem>,
    },
    Text {
        text: TextContent,
        style: TextStyle,
    },
    Layout {
        root: Box<LayoutNode>,
    },
}

The picture of a generated source.

A generated picture has the canvas’s size and aspect. Positions are normalized, (0, 0) top-left to (1, 1) bottom-right, and lengths are fractions of the shorter side, so the picture is the same at any render resolution. A fill never changes over time; text changes only through its style’s animators; shapes and layouts may change.

Variants

Fill

Paint over the whole picture.

Fields

paint: Paint

What covers the picture.

Shapes

Shapes drawn from an ordered content tree, as an After Effects or Lottie shape layer draws them. Every value in the tree may be keyframed in picture time.

Fields

items: Vec<ShapeItem>

The content tree, front first. See ShapeItem.

Text

Text on a transparent picture, laid out and placed by its style as caption cues are, and drawn with the host’s registered fonts.

Fields

text: TextContent

The text, a string or runs; \n starts a line. Non-empty, at most MAX_TEXT_CONTENT_BYTES bytes. Run times are picture time.

style: TextStyle

How it looks and where it lies. The font size is at most MAX_TEXT_GENERATOR_FONT_SIZE.

Layout

Boxes laid out by CSS flexbox around their text and shapes, with the engine’s fonts. Any value in the tree may be keyframed in picture time. See LayoutNode.

Fields

root: Box<LayoutNode>

The root box: the whole picture.

Implementations

impl Generator

pub fn is_valid(&self) -> bool

Whether every field is in range, as a project needs it to be.

pub fn validate(&self) -> Result<(), GeneratorIssue>

Checks every field. A shapes or layout generator’s problem names where in its tree it lies. A layout’s pixel font sizes are checked only by Self::validate_on, which knows the canvas.

Errors

Returns the first problem, if any.

pub fn validate_on(&self, width: u32, height: u32) -> Result<(), GeneratorIssue>

Self::validate for a generator drawn on a width by height canvas, which a layout’s pixel lengths refer to.

Errors

Returns the first problem, if any.

Trait Implementations

impl Clone for Generator

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Generator

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Generator

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Generator

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Generator

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Generator