Struct HaloZone 

pub struct HaloZone {
    pub color: String,
    pub x: f32,
    pub y: f32,
    pub radius: f32,
    pub radius_x: Option<f32>,
    pub radius_y: Option<f32>,
    pub rotation: f32,
    pub opacity: f32,
}

A single glow zone for the “halo” animated-background preset.

Fields

color: String

Zone color (hex string). May itself carry an alpha channel (#rrggbbaa); see HaloZone::opacity for how the two combine.

x: f32

X position as a fraction of the surface the halo is painted on: the viewport in a slide view, the world the camera travels in a world view (WorldTimeline::world_extent). 0.0 = left, 1.0 = right.

y: f32

Y position as a fraction of that same surface. 0.0 = top, 1.0 = bottom.

radius: f32

Radius as a fraction of that surface’s max(width, height) — so the same value covers proportionally the same area whichever view it is in. This is also the fallback for radius_x/radius_y when either is omitted, which is what keeps a zone written before those fields existed a perfect, unrotated circle.

radius_x: Option<f32>

Horizontal radius, same fraction-of-surface units as HaloZone::radius. Omitted (the default) falls back to radius. Set it together with radius_y to draw an ellipse instead of a circle — a wide, thin light band wants radius_x far larger than radius_y.

radius_y: Option<f32>

Vertical radius, same fraction-of-surface units as HaloZone::radius. Omitted (the default) falls back to radius — see HaloZone::radius_x.

rotation: f32

Rotation of the ellipse in degrees, clockwise about its own center. Ignored on a circular zone (radius_x == radius_y, which includes every zone that only sets radius) — a rotated circle is a circle, so it is never worth the extra draw call.

opacity: f32

Zone opacity, multiplied with any alpha already encoded in color.

Default 1.0 is a true no-op: it leaves color’s own alpha (opaque or hex-encoded) untouched, so scenarios written before this field existed — including ones that hid alpha inside the hex string, e.g. #1E3A8A55 — keep rendering identically. Values are clamped to 0.0..=1.0.

Implementations

impl HaloZone

pub fn effective_radius_x(&self) -> f32

pub fn effective_radius_y(&self) -> f32

pub fn is_circular(&self) -> bool

Trait Implementations

impl Clone for HaloZone

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 HaloZone

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HaloZone

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for HaloZone

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for HaloZone

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

where __S: Serializer,

Serialize this value into the given Serde serializer.