pub struct Galley {
pub job: Arc<LayoutJob>,
pub rows: Vec<Row>,
pub elided: bool,
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
;
Needs to be recreated if the underlying font atlas texture changes, which happens under the following conditions:
pixels_per_point
ormax_texture_size
change. These parameters are set incrate::text::Fonts::begin_frame
. When usingegui
they are set fromegui::InputState
and can change at any time.- The atlas has become full. This can happen any time a new glyph is added to the atlas, which in turn can happen any time new text is laid out.
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()
unless Self::elided
is true
.
Note that a paragraph (a piece of text separated with \n
)
can be split up into multiple rows.
elided: bool
Set to true the text was truncated due to TextWrapping::max_rows
.
rect: Rect
Bounding rect.
rect.top()
is always 0.0.
With LayoutJob::halign
:
Align::LEFT
: rect.left() == 0.0Align::Center
: rect.center() == 0.0Align::RIGHT
: rect.right() == 0.0
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
impl Galley
sourcepub fn pos_from_pcursor(&self, pcursor: PCursor) -> Rect
pub fn pos_from_pcursor(&self, pcursor: PCursor) -> Rect
Returns a 0-width Rect.
sourcepub fn pos_from_cursor(&self, cursor: &Cursor) -> Rect
pub fn pos_from_cursor(&self, cursor: &Cursor) -> Rect
Returns a 0-width Rect.
sourcepub fn cursor_from_pos(&self, pos: Vec2) -> Cursor
pub fn cursor_from_pos(&self, pos: Vec2) -> Cursor
Cursor at the given position within the galley