Skip to main content

TextEffect

ass_renderer::pipeline

Enum TextEffect 

Source 
pub enum TextEffect {

Show 14 variants    Bold,
    Italic,
    Underline,
    Strikethrough,
    Outline {
        color: [u8; 4],
        width_x: f32,
        width_y: f32,
    },
    Shadow {
        color: [u8; 4],
        x_offset: f32,
        y_offset: f32,
    },
    Blur {
        radius: f32,
    },
    EdgeBlur {
        radius: f32,
    },
    Karaoke {
        progress: f32,
        style: u8,
        secondary: [u8; 4],
    },
    Rotation {
        x: f32,
        y: f32,
        z: f32,
        origin: Option<(f32, f32)>,
    },
    Shear {
        x: f32,
        y: f32,
    },
    Scale {
        x: f32,
        y: f32,
    },
    Clip {
        x1: f32,
        y1: f32,
        x2: f32,
        y2: f32,
        inverse: bool,
    },
    OpaqueBox {
        color: [u8; 4],
        padding_x: f32,
        padding_y: f32,
    },

}
Expand description

Text effect enumeration

Variants§

§

Bold

Bold text

§

Italic

Italic text

§

Underline

Underline

§

Strikethrough

Strikethrough

§

Outline

Outline with color and per-axis width (\bord/\xbord/\ybord). For the common symmetric case width_x == width_y.

Fields

§color: [u8; 4]
§width_x: f32
§width_y: f32
§

Shadow

Shadow with color and offset

Fields

§color: [u8; 4]
§x_offset: f32
§y_offset: f32
§

Blur

Blur effect

Fields

§radius: f32
§

EdgeBlur

Edge blur effect (only blurs outline/edges)

Fields

§radius: f32
§

Karaoke

Karaoke effect. secondary is the not-yet-sung (secondary) colour; the sung colour is the layer’s primary color.

Fields

§progress: f32
§style: u8
§secondary: [u8; 4]
§

Rotation

3D rotation (in degrees). origin, when set, is the rotation centre in screen-space pixels (\org); otherwise the text’s own centre is used.

Fields

§x: f32
§y: f32
§z: f32
§origin: Option<(f32, f32)>
§

Shear

Shear/skew transformation

Fields

§x: f32
§y: f32
§

Scale

Scale transformation

Fields

§x: f32
§y: f32
§

Clip

Clip region

Fields

§x1: f32
§y1: f32
§x2: f32
§y2: f32
§inverse: bool
§

OpaqueBox

Opaque box behind the text (BorderStyle: 3), drawn in the outline colour with per-axis padding around the glyph bounds.

Fields

§color: [u8; 4]
§padding_x: f32
§padding_y: f32

Trait Implementations§

Source§

impl Clone for TextEffect

Source§

fn clone(&self) -> TextEffect

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TextEffect

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.