Struct webrender_api::display_item::StickyFrameDescriptor

pub struct StickyFrameDescriptor {
    pub id: SpatialId,
    pub parent_spatial_id: SpatialId,
    pub bounds: LayoutRect,
    pub margins: SideOffsets2D<Option<f32>, LayoutPixel>,
    pub vertical_offset_bounds: StickyOffsetBounds,
    pub horizontal_offset_bounds: StickyOffsetBounds,
    pub previously_applied_offset: LayoutVector2D,
    pub key: SpatialTreeItemKey,
    pub transform: Option<PropertyBinding<LayoutTransform>>,
}

Fields

id: SpatialId

parent_spatial_id: SpatialId

bounds: LayoutRect

margins: SideOffsets2D<Option<f32>, LayoutPixel>

The margins that should be maintained between the edge of the parent viewport and this sticky frame. A margin of None indicates that the sticky frame should not stick at all to that particular edge of the viewport.

vertical_offset_bounds: StickyOffsetBounds

The minimum and maximum vertical offsets for this sticky frame. Ignoring these constraints, the sticky frame will continue to stick to the edge of the viewport as its original position is scrolled out of view. Constraints specify a maximum and minimum offset from the original position relative to non-sticky content within the same scrolling frame.

horizontal_offset_bounds: StickyOffsetBounds

The minimum and maximum horizontal offsets for this sticky frame. Ignoring these constraints, the sticky frame will continue to stick to the edge of the viewport as its original position is scrolled out of view. Constraints specify a maximum and minimum offset from the original position relative to non-sticky content within the same scrolling frame.

previously_applied_offset: LayoutVector2D

The amount of offset that has already been applied to the sticky frame. A positive y component this field means that a top-sticky item was in a scrollframe that has been scrolled down, such that the sticky item’s position needed to be offset downwards by previously_applied_offset.y. A negative y component corresponds to the upward offset applied due to bottom-stickiness. The x-axis works analogously.

key: SpatialTreeItemKey

A unique (per-pipeline) key for this spatial that is stable across display lists.

transform: Option<PropertyBinding<LayoutTransform>>

A property binding that we use to store an animation ID for APZ

Trait Implementations

impl Clone for StickyFrameDescriptor

fn clone(&self) -> StickyFrameDescriptor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StickyFrameDescriptor

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

Formats the value using the given formatter.

impl Default for StickyFrameDescriptor

fn default() -> StickyFrameDescriptor

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StickyFrameDescriptor

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StickyFrameDescriptor

fn eq(&self, other: &StickyFrameDescriptor) -> 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 Peek for StickyFrameDescriptor

unsafe fn peek_from(bytes: *const u8, output: *mut Self) -> *const u8

Deserialize from the buffer pointed to by bytes.

impl Poke for StickyFrameDescriptor

fn max_size() -> usize

Return the maximum number of bytes that the serialized version of Self will occupy.

unsafe fn poke_into(&self, bytes: *mut u8) -> *mut u8

Serialize into the buffer pointed to by bytes.

impl Serialize for StickyFrameDescriptor

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for StickyFrameDescriptor

impl StructuralPartialEq for StickyFrameDescriptor