pub struct Galley {
    pub job: Arc<LayoutJob>,
    pub rows: Vec<Row>,
    pub rect: Rect,
    pub mesh_bounds: Rect,
    pub num_vertices: usize,
    pub num_indices: usize,
    pub pixels_per_point: f32,
}
Expand description

Text that has been laid out, ready for painting.

You can create a Galley using crate::Fonts::layout_job;

This needs to be recreated if pixels_per_point (dpi scale) changes.

Fields§

§job: Arc<LayoutJob>

The job that this galley is the result of. Contains the original string and style sections.

§rows: Vec<Row>

Rows of text, from top to bottom. The number of characters in all rows sum up to job.text.chars().count(). Note that each paragraph (pieces of text separated with \n) can be split up into multiple rows.

§rect: Rect

Bounding rect.

rect.top() is always 0.0.

With LayoutJob::halign:

§mesh_bounds: Rect

Tight bounding box around all the meshes in all the rows. Can be used for culling.

§num_vertices: usize

Total number of vertices in all the row meshes.

§num_indices: usize

Total number of indices in all the row meshes.

§pixels_per_point: f32

The number of physical pixels for each logical point. Since this affects the layout, we keep track of it so that we can warn if this has changed once we get to tessellation.

Implementations§

source§

impl Galley

source

pub fn is_empty(&self) -> bool

source

pub fn text(&self) -> &str

source

pub fn size(&self) -> Vec2

source§

impl Galley

source

fn end_pos(&self) -> Rect

Zero-width rect past the last character.

source

pub fn pos_from_pcursor(&self, pcursor: PCursor) -> Rect

Returns a 0-width Rect.

source

pub fn pos_from_cursor(&self, cursor: &Cursor) -> Rect

Returns a 0-width Rect.

source

pub fn cursor_from_pos(&self, pos: Vec2) -> Cursor

Cursor at the given position within the galley

source§

impl Galley

source

pub fn end(&self) -> Cursor

Cursor to one-past last character.

source

pub fn end_rcursor(&self) -> RCursor

source§

impl Galley

source

pub fn from_ccursor(&self, ccursor: CCursor) -> Cursor

source

pub fn from_rcursor(&self, rcursor: RCursor) -> Cursor

source

pub fn from_pcursor(&self, pcursor: PCursor) -> Cursor

source§

impl Galley

source

pub fn cursor_left_one_character(&self, cursor: &Cursor) -> Cursor

source

pub fn cursor_right_one_character(&self, cursor: &Cursor) -> Cursor

source

pub fn cursor_up_one_row(&self, cursor: &Cursor) -> Cursor

source

pub fn cursor_down_one_row(&self, cursor: &Cursor) -> Cursor

source

pub fn cursor_begin_of_row(&self, cursor: &Cursor) -> Cursor

source

pub fn cursor_end_of_row(&self, cursor: &Cursor) -> Cursor

Trait Implementations§

source§

impl Clone for Galley

source§

fn clone(&self) -> Galley

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Galley

source§

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

Formats the value using the given formatter. Read more
source§

impl PartialEq<Galley> for Galley

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl StructuralPartialEq for Galley

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. 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 Twhere 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> ToOwned for Twhere T: Clone,

§

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 Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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.