Struct webrender_api::DisplayListBuilder

pub struct DisplayListBuilder {
    pub data: Vec<u8>,
    pub pipeline_id: PipelineId,
    // some fields omitted
}

Fields

data: Vec<u8>

pipeline_id: PipelineId

Methods

impl DisplayListBuilder

pub fn new(pipeline_id: PipelineId, content_size: LayoutSize) -> Self

pub fn with_capacity(
    pipeline_id: PipelineId,
    content_size: LayoutSize,
    capacity: usize
) -> Self

pub fn content_size(&self) -> LayoutSize

Return the content size for this display list

pub fn save(&mut self)

Saves the current display list state, so it may be restore()'d.

Conditions:

• Doesn't support popping clips that were pushed before the save.
• Doesn't support nested saves.
• Must call clear_save() if the restore becomes unnecessary.

pub fn restore(&mut self)

Restores the state of the builder to when save() was last called.

pub fn clear_save(&mut self)

Discards the builder's save (indicating the attempted operation was successful).

pub fn print_display_list(&mut self)

Print the display items in the list to stdout.

pub fn emit_display_list<W>(
    &mut self,
    indent: usize,
    range: Range<Option<usize>>,
    sink: W
) -> usize where
    W: Write, 

Emits a debug representation of display items in the list, for debugging purposes. If the range's start parameter is specified, only display items starting at that index (inclusive) will be printed. If the range's end parameter is specified, only display items before that index (exclusive) will be printed. Calling this function with end <= start is allowed but is just a waste of CPU cycles. The function emits the debug representation of the selected display items, one per line, with the given indent, to the provided sink object. The return value is the total number of items in the display list, which allows the caller to subsequently invoke this function to only dump the newly-added items.

pub fn push_item(&mut self, item: &DisplayItem)

Add an item to the display list.

NOTE: It is usually preferable to use the specialized methods to push display items. Pushing unexpected or invalid items here may result in WebRender panicking or behaving in unexpected ways.

pub fn push_iter<I>(&mut self, iter: I) where
    I: IntoIterator,
    I::IntoIter: ExactSizeIterator,
    I::Item: Poke, 

Push items from an iterator to the display list.

NOTE: Pushing unexpected or invalid items to the display list may result in panic and confusion.

pub fn push_rect(&mut self, common: &CommonItemProperties, color: ColorF)

pub fn push_clear_rect(&mut self, common: &CommonItemProperties)

pub fn push_hit_test(&mut self, common: &CommonItemProperties)

pub fn push_line(
    &mut self,
    common: &CommonItemProperties,
    area: &LayoutRect,
    wavy_line_thickness: f32,
    orientation: LineOrientation,
    color: &ColorF,
    style: LineStyle
)

pub fn push_image(
    &mut self,
    common: &CommonItemProperties,
    bounds: LayoutRect,
    image_rendering: ImageRendering,
    alpha_type: AlphaType,
    key: ImageKey,
    color: ColorF
)

pub fn push_repeating_image(
    &mut self,
    common: &CommonItemProperties,
    bounds: LayoutRect,
    stretch_size: LayoutSize,
    tile_spacing: LayoutSize,
    image_rendering: ImageRendering,
    alpha_type: AlphaType,
    key: ImageKey,
    color: ColorF
)

pub fn push_yuv_image(
    &mut self,
    common: &CommonItemProperties,
    bounds: LayoutRect,
    yuv_data: YuvData,
    color_depth: ColorDepth,
    color_space: YuvColorSpace,
    color_range: ColorRange,
    image_rendering: ImageRendering
)

Push a yuv image. All planar data in yuv image should use the same buffer type.

pub fn push_text(
    &mut self,
    common: &CommonItemProperties,
    bounds: LayoutRect,
    glyphs: &[GlyphInstance],
    font_key: FontInstanceKey,
    color: ColorF,
    glyph_options: Option<GlyphOptions>
)

pub fn create_gradient(
    &mut self,
    start_point: LayoutPoint,
    end_point: LayoutPoint,
    stops: Vec<GradientStop>,
    extend_mode: ExtendMode
) -> Gradient

NOTE: gradients must be pushed in the order they're created because create_gradient stores the stops in anticipation.

pub fn create_radial_gradient(
    &mut self,
    center: LayoutPoint,
    radius: LayoutSize,
    stops: Vec<GradientStop>,
    extend_mode: ExtendMode
) -> RadialGradient

NOTE: gradients must be pushed in the order they're created because create_gradient stores the stops in anticipation.

pub fn push_border(
    &mut self,
    common: &CommonItemProperties,
    bounds: LayoutRect,
    widths: LayoutSideOffsets,
    details: BorderDetails
)

pub fn push_box_shadow(
    &mut self,
    common: &CommonItemProperties,
    box_bounds: LayoutRect,
    offset: LayoutVector2D,
    color: ColorF,
    blur_radius: f32,
    spread_radius: f32,
    border_radius: BorderRadius,
    clip_mode: BoxShadowClipMode
)

pub fn push_gradient(
    &mut self,
    common: &CommonItemProperties,
    bounds: LayoutRect,
    gradient: Gradient,
    tile_size: LayoutSize,
    tile_spacing: LayoutSize
)

Pushes a linear gradient to be displayed.

The gradient itself is described in the gradient parameter. It is drawn on a "tile" with the dimensions from tile_size. These tiles are now repeated to the right and to the bottom infinitely. If tile_spacing is not zero spacers with the given dimensions are inserted between the tiles as seams.

The origin of the tiles is given in layout.rect.origin. If the gradient should only be displayed once limit the layout.rect.size to a single tile. The gradient is only visible within the local clip.

pub fn push_radial_gradient(
    &mut self,
    common: &CommonItemProperties,
    bounds: LayoutRect,
    gradient: RadialGradient,
    tile_size: LayoutSize,
    tile_spacing: LayoutSize
)

Pushes a radial gradient to be displayed.

See push_gradient for explanation.

pub fn push_reference_frame(
    &mut self,
    origin: LayoutPoint,
    parent_spatial_id: SpatialId,
    transform_style: TransformStyle,
    transform: PropertyBinding<LayoutTransform>,
    kind: ReferenceFrameKind
) -> SpatialId

pub fn pop_reference_frame(&mut self)

pub fn push_stacking_context(
    &mut self,
    origin: LayoutPoint,
    spatial_id: SpatialId,
    prim_flags: PrimitiveFlags,
    clip_id: Option<ClipId>,
    transform_style: TransformStyle,
    mix_blend_mode: MixBlendMode,
    filters: &[FilterOp],
    filter_datas: &[FilterData],
    filter_primitives: &[FilterPrimitive],
    raster_space: RasterSpace,
    cache_tiles: bool,
    is_backdrop_root: bool
)

pub fn push_simple_stacking_context(
    &mut self,
    origin: LayoutPoint,
    spatial_id: SpatialId,
    prim_flags: PrimitiveFlags
)

Helper for examples/ code.

pub fn push_simple_stacking_context_with_filters(
    &mut self,
    origin: LayoutPoint,
    spatial_id: SpatialId,
    prim_flags: PrimitiveFlags,
    filters: &[FilterOp],
    filter_datas: &[FilterData],
    filter_primitives: &[FilterPrimitive]
)

Helper for examples/ code.

pub fn pop_stacking_context(&mut self)

pub fn push_stops(&mut self, stops: &[GradientStop])

pub fn push_backdrop_filter(
    &mut self,
    common: &CommonItemProperties,
    filters: &[FilterOp],
    filter_datas: &[FilterData],
    filter_primitives: &[FilterPrimitive]
)

pub fn push_filters(
    &mut self,
    filters: &[FilterOp],
    filter_datas: &[FilterData],
    filter_primitives: &[FilterPrimitive]
)

pub fn define_scroll_frame<I>(
    &mut self,
    parent_space_and_clip: &SpaceAndClipInfo,
    external_id: Option<ExternalScrollId>,
    content_rect: LayoutRect,
    clip_rect: LayoutRect,
    complex_clips: I,
    image_mask: Option<ImageMask>,
    scroll_sensitivity: ScrollSensitivity,
    external_scroll_offset: LayoutVector2D
) -> SpaceAndClipInfo where
    I: IntoIterator<Item = ComplexClipRegion>,
    I::IntoIter: ExactSizeIterator + Clone, 

pub fn define_clip_chain<I>(
    &mut self,
    parent: Option<ClipChainId>,
    clips: I
) -> ClipChainId where
    I: IntoIterator<Item = ClipId>,
    I::IntoIter: ExactSizeIterator + Clone, 

pub fn define_clip<I>(
    &mut self,
    parent_space_and_clip: &SpaceAndClipInfo,
    clip_rect: LayoutRect,
    complex_clips: I,
    image_mask: Option<ImageMask>
) -> ClipId where
    I: IntoIterator<Item = ComplexClipRegion>,
    I::IntoIter: ExactSizeIterator + Clone, 

pub fn define_sticky_frame(
    &mut self,
    parent_spatial_id: SpatialId,
    frame_rect: LayoutRect,
    margins: SideOffsets2D<Option<f32>, LayoutPixel>,
    vertical_offset_bounds: StickyOffsetBounds,
    horizontal_offset_bounds: StickyOffsetBounds,
    previously_applied_offset: LayoutVector2D
) -> SpatialId

pub fn push_iframe(
    &mut self,
    bounds: LayoutRect,
    clip_rect: LayoutRect,
    space_and_clip: &SpaceAndClipInfo,
    pipeline_id: PipelineId,
    ignore_missing_pipeline: bool
)

pub fn push_shadow(
    &mut self,
    space_and_clip: &SpaceAndClipInfo,
    shadow: Shadow,
    should_inflate: bool
)

pub fn pop_all_shadows(&mut self)

pub fn finalize(self) -> (PipelineId, LayoutSize, BuiltDisplayList)

Trait Implementations

impl Clone for DisplayListBuilder

fn clone(&self) -> DisplayListBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.