Struct azul_webrender_api::DisplayListBuilder [−][src]
pub struct DisplayListBuilder { pub data: Vec<u8>, pub pipeline_id: PipelineId, // some fields omitted }
Fields
data: Vec<u8>
pipeline_id: PipelineId
Implementations
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.
Discards the builder’s save (indicating the attempted operation was successful).
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.
Print the display items in the list to stdout.
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,
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_with_animation(
&mut self,
common: &CommonItemProperties,
bounds: LayoutRect,
color: PropertyBinding<ColorF>
)
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
)
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
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
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 create_conic_gradient(
&mut self,
center: LayoutPoint,
angle: f32,
stops: Vec<GradientStop>,
extend_mode: ExtendMode
) -> ConicGradient
pub fn create_conic_gradient(
&mut self,
center: LayoutPoint,
angle: f32,
stops: Vec<GradientStop>,
extend_mode: ExtendMode
) -> ConicGradient
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
)
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
)
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_conic_gradient(
&mut self,
common: &CommonItemProperties,
bounds: LayoutRect,
gradient: ConicGradient,
tile_size: LayoutSize,
tile_spacing: LayoutSize
)
pub fn push_conic_gradient(
&mut self,
common: &CommonItemProperties,
bounds: LayoutRect,
gradient: ConicGradient,
tile_size: LayoutSize,
tile_spacing: LayoutSize
)
Pushes a conic 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 push_computed_frame(
&mut self,
origin: LayoutPoint,
parent_spatial_id: SpatialId,
scale_from: Option<LayoutSize>,
vertical_flip: bool,
rotation: Rotation
) -> SpatialId
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,
flags: StackingContextFlags
)
pub fn push_simple_stacking_context(
&mut self,
origin: LayoutPoint,
spatial_id: SpatialId,
prim_flags: PrimitiveFlags
)
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]
)
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 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(
&mut self,
parent_space_and_clip: &SpaceAndClipInfo,
external_id: ExternalScrollId,
content_rect: LayoutRect,
clip_rect: LayoutRect,
scroll_sensitivity: ScrollSensitivity,
external_scroll_offset: LayoutVector2D
) -> SpaceAndClipInfo
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_image_mask(
&mut self,
parent_space_and_clip: &SpaceAndClipInfo,
image_mask: ImageMask,
points: &[LayoutPoint],
fill_rule: FillRule
) -> ClipId
pub fn define_clip_rect(
&mut self,
parent_space_and_clip: &SpaceAndClipInfo,
clip_rect: LayoutRect
) -> ClipId
pub fn define_clip_rounded_rect(
&mut self,
parent_space_and_clip: &SpaceAndClipInfo,
clip: ComplexClipRegion
) -> ClipId
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
)
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for DisplayListBuilder
impl Send for DisplayListBuilder
impl Sync for DisplayListBuilder
impl Unpin for DisplayListBuilder
impl UnwindSafe for DisplayListBuilder
Blanket Implementations
Mutably borrows from an owned value. Read more