Struct cosmic_text::Scroll

pub struct Scroll {
    pub line: usize,
    pub vertical: f32,
    pub horizontal: f32,
}

Scroll position in [Buffer]

Fields

line: usize

Index of [BufferLine] in [Buffer::lines]. This will be adjusted as needed if layout is out of bounds

vertical: f32

Pixel offset from the start of the [BufferLine]. This will be adjusted as needed if it is negative or exceeds the height of the [BufferLine::layout] lines.

horizontal: f32

The horizontal position of scroll in fractional pixels

Implementations

impl Scroll

pub const fn new(line: usize, vertical: f32, horizontal: f32) -> Self

Create a new scroll

Trait Implementations

impl Clone for Scroll

fn clone(&self) -> Scroll

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Scroll

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

Formats the value using the given formatter.

impl Default for Scroll

fn default() -> Scroll

Returns the “default value” for a type.

impl PartialEq for Scroll

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Scroll

fn partial_cmp(&self, other: &Scroll) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Scroll

impl StructuralPartialEq for Scroll