2019-01-14 17:20:36 -05:00
|
|
|
// pathfinder/renderer/src/scene.rs
|
|
|
|
//
|
|
|
|
// Copyright © 2019 The Pathfinder Project Developers.
|
|
|
|
//
|
|
|
|
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
|
|
|
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
|
|
|
// option. This file may not be copied, modified, or distributed
|
|
|
|
// except according to those terms.
|
|
|
|
|
|
|
|
//! A set of paths to be rendered.
|
|
|
|
|
2019-04-30 22:13:28 -04:00
|
|
|
use crate::builder::SceneBuilder;
|
|
|
|
use crate::concurrent::executor::Executor;
|
2019-06-05 17:35:46 -04:00
|
|
|
use crate::options::{BuildOptions, PreparedBuildOptions};
|
|
|
|
use crate::options::{PreparedRenderTransform, RenderCommandListener};
|
2020-02-05 22:59:40 -05:00
|
|
|
use crate::paint::{Paint, PaintId, PaintInfo, Palette};
|
2020-02-20 18:52:40 -05:00
|
|
|
use pathfinder_content::effects::{BlendMode, Effects};
|
2020-02-17 17:44:48 -05:00
|
|
|
use pathfinder_content::fill::FillRule;
|
2020-02-22 00:42:15 -05:00
|
|
|
use pathfinder_content::outline::Outline;
|
|
|
|
use pathfinder_content::pattern::RenderTargetId;
|
|
|
|
use pathfinder_geometry::vector::{Vector2F, Vector2I};
|
2019-06-21 13:06:19 -04:00
|
|
|
use pathfinder_geometry::rect::RectF;
|
2019-07-11 17:35:06 -04:00
|
|
|
use pathfinder_geometry::transform2d::Transform2F;
|
2019-01-14 17:20:36 -05:00
|
|
|
|
2019-01-29 17:50:15 -05:00
|
|
|
#[derive(Clone)]
|
2019-01-14 17:20:36 -05:00
|
|
|
pub struct Scene {
|
2020-02-19 20:44:41 -05:00
|
|
|
pub(crate) display_list: Vec<DisplayItem>,
|
2020-02-15 15:39:15 -05:00
|
|
|
pub(crate) paths: Vec<DrawPath>,
|
2020-02-15 16:21:12 -05:00
|
|
|
pub(crate) clip_paths: Vec<ClipPath>,
|
2020-02-05 22:59:40 -05:00
|
|
|
palette: Palette,
|
2019-05-29 22:13:42 -04:00
|
|
|
bounds: RectF,
|
|
|
|
view_box: RectF,
|
2019-01-14 17:20:36 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
impl Scene {
|
|
|
|
#[inline]
|
|
|
|
pub fn new() -> Scene {
|
|
|
|
Scene {
|
2020-02-19 20:44:41 -05:00
|
|
|
display_list: vec![],
|
2019-05-10 15:03:38 -04:00
|
|
|
paths: vec![],
|
2020-02-15 16:21:12 -05:00
|
|
|
clip_paths: vec![],
|
2020-02-05 22:59:40 -05:00
|
|
|
palette: Palette::new(),
|
2019-05-29 22:13:42 -04:00
|
|
|
bounds: RectF::default(),
|
|
|
|
view_box: RectF::default(),
|
2019-01-14 17:20:36 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-02-15 15:39:15 -05:00
|
|
|
pub fn push_path(&mut self, path: DrawPath) {
|
2019-05-10 15:03:38 -04:00
|
|
|
self.bounds = self.bounds.union_rect(path.outline.bounds());
|
|
|
|
self.paths.push(path);
|
2020-02-19 20:44:41 -05:00
|
|
|
|
|
|
|
let new_path_count = self.paths.len() as u32;
|
|
|
|
if let Some(DisplayItem::DrawPaths {
|
|
|
|
start_index: _,
|
|
|
|
ref mut end_index
|
|
|
|
}) = self.display_list.last_mut() {
|
|
|
|
*end_index = new_path_count;
|
|
|
|
} else {
|
|
|
|
self.display_list.push(DisplayItem::DrawPaths {
|
|
|
|
start_index: new_path_count - 1,
|
|
|
|
end_index: new_path_count,
|
|
|
|
});
|
|
|
|
}
|
2019-04-30 22:13:28 -04:00
|
|
|
}
|
|
|
|
|
2020-02-15 16:21:12 -05:00
|
|
|
pub fn push_clip_path(&mut self, clip_path: ClipPath) -> ClipPathId {
|
|
|
|
self.bounds = self.bounds.union_rect(clip_path.outline.bounds());
|
|
|
|
let clip_path_id = ClipPathId(self.clip_paths.len() as u32);
|
|
|
|
self.clip_paths.push(clip_path);
|
|
|
|
clip_path_id
|
|
|
|
}
|
|
|
|
|
2020-02-22 00:42:15 -05:00
|
|
|
pub fn push_render_target(&mut self, render_target: RenderTarget) -> RenderTargetId {
|
|
|
|
let render_target_id = self.palette.push_render_target(render_target);
|
|
|
|
self.display_list.push(DisplayItem::PushRenderTarget(render_target_id));
|
|
|
|
render_target_id
|
2020-02-19 20:44:41 -05:00
|
|
|
}
|
|
|
|
|
2020-02-22 00:42:15 -05:00
|
|
|
pub fn pop_render_target(&mut self) {
|
|
|
|
self.display_list.push(DisplayItem::PopRenderTarget);
|
|
|
|
}
|
|
|
|
|
|
|
|
pub fn draw_render_target(&mut self, render_target: RenderTargetId, effects: Effects) {
|
|
|
|
self.display_list.push(DisplayItem::DrawRenderTarget { render_target, effects });
|
2020-02-19 20:44:41 -05:00
|
|
|
}
|
|
|
|
|
2020-02-05 22:59:40 -05:00
|
|
|
#[inline]
|
|
|
|
pub fn build_paint_info(&self) -> PaintInfo {
|
2020-02-07 14:46:20 -05:00
|
|
|
self.palette.build_paint_info(self.view_box.size().to_i32())
|
2020-02-05 22:59:40 -05:00
|
|
|
}
|
|
|
|
|
2019-01-14 17:20:36 -05:00
|
|
|
#[allow(clippy::trivially_copy_pass_by_ref)]
|
|
|
|
pub fn push_paint(&mut self, paint: &Paint) -> PaintId {
|
2020-02-05 22:59:40 -05:00
|
|
|
self.palette.push_paint(paint)
|
2019-01-14 17:20:36 -05:00
|
|
|
}
|
|
|
|
|
2019-04-30 22:13:28 -04:00
|
|
|
#[inline]
|
2019-05-10 15:03:38 -04:00
|
|
|
pub fn path_count(&self) -> usize {
|
|
|
|
self.paths.len()
|
2019-04-30 22:13:28 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
#[inline]
|
2019-05-29 22:13:42 -04:00
|
|
|
pub fn bounds(&self) -> RectF {
|
2019-04-30 22:13:28 -04:00
|
|
|
self.bounds
|
|
|
|
}
|
|
|
|
|
|
|
|
#[inline]
|
2019-05-29 22:13:42 -04:00
|
|
|
pub fn set_bounds(&mut self, new_bounds: RectF) {
|
2019-04-30 22:13:28 -04:00
|
|
|
self.bounds = new_bounds;
|
|
|
|
}
|
|
|
|
|
|
|
|
#[inline]
|
2019-05-29 22:13:42 -04:00
|
|
|
pub fn view_box(&self) -> RectF {
|
2019-04-30 22:13:28 -04:00
|
|
|
self.view_box
|
|
|
|
}
|
|
|
|
|
|
|
|
#[inline]
|
2019-05-29 22:13:42 -04:00
|
|
|
pub fn set_view_box(&mut self, new_view_box: RectF) {
|
2019-04-30 22:13:28 -04:00
|
|
|
self.view_box = new_view_box;
|
2019-04-18 18:09:37 -04:00
|
|
|
}
|
|
|
|
|
2019-04-29 19:45:29 -04:00
|
|
|
pub(crate) fn apply_render_options(
|
|
|
|
&self,
|
|
|
|
original_outline: &Outline,
|
2019-06-05 17:35:46 -04:00
|
|
|
options: &PreparedBuildOptions,
|
2019-04-29 19:45:29 -04:00
|
|
|
) -> Outline {
|
2019-03-25 19:13:56 -04:00
|
|
|
let effective_view_box = self.effective_view_box(options);
|
|
|
|
|
2019-02-09 22:24:30 -05:00
|
|
|
let mut outline;
|
2019-02-06 21:09:37 -05:00
|
|
|
match options.transform {
|
2019-04-29 19:45:29 -04:00
|
|
|
PreparedRenderTransform::Perspective {
|
|
|
|
ref perspective,
|
|
|
|
ref clip_polygon,
|
|
|
|
..
|
|
|
|
} => {
|
2019-02-09 22:24:30 -05:00
|
|
|
if original_outline.is_outside_polygon(clip_polygon) {
|
|
|
|
outline = Outline::new();
|
|
|
|
} else {
|
|
|
|
outline = (*original_outline).clone();
|
|
|
|
outline.clip_against_polygon(clip_polygon);
|
|
|
|
outline.apply_perspective(perspective);
|
2019-03-20 16:40:48 -04:00
|
|
|
|
2019-03-25 19:13:56 -04:00
|
|
|
// TODO(pcwalton): Support subpixel AA in 3D.
|
2019-02-09 22:24:30 -05:00
|
|
|
}
|
2019-01-30 17:42:06 -05:00
|
|
|
}
|
2019-03-25 19:13:56 -04:00
|
|
|
_ => {
|
2019-02-09 22:24:30 -05:00
|
|
|
// TODO(pcwalton): Short circuit.
|
|
|
|
outline = (*original_outline).clone();
|
2019-03-25 19:13:56 -04:00
|
|
|
if options.transform.is_2d() || options.subpixel_aa_enabled {
|
|
|
|
let mut transform = match options.transform {
|
|
|
|
PreparedRenderTransform::Transform2D(transform) => transform,
|
2019-07-11 17:35:06 -04:00
|
|
|
PreparedRenderTransform::None => Transform2F::default(),
|
2019-03-25 19:13:56 -04:00
|
|
|
PreparedRenderTransform::Perspective { .. } => unreachable!(),
|
|
|
|
};
|
|
|
|
if options.subpixel_aa_enabled {
|
2019-07-12 14:26:09 -04:00
|
|
|
transform *= Transform2F::from_scale(Vector2F::new(3.0, 1.0))
|
2019-03-25 19:13:56 -04:00
|
|
|
}
|
|
|
|
outline.transform(&transform);
|
|
|
|
}
|
|
|
|
outline.clip_against_rect(effective_view_box);
|
2019-02-02 14:36:42 -05:00
|
|
|
}
|
2019-01-30 17:42:06 -05:00
|
|
|
}
|
2019-02-06 21:09:37 -05:00
|
|
|
|
|
|
|
if !options.dilation.is_zero() {
|
|
|
|
outline.dilate(options.dilation);
|
|
|
|
}
|
|
|
|
|
2019-02-12 11:57:49 -05:00
|
|
|
// TODO(pcwalton): Fold this into previous passes to avoid unnecessary clones during
|
|
|
|
// monotonic conversion.
|
2019-03-25 19:13:56 -04:00
|
|
|
outline.prepare_for_tiling(self.effective_view_box(options));
|
2019-02-02 14:36:42 -05:00
|
|
|
outline
|
2019-01-16 19:53:10 -05:00
|
|
|
}
|
2019-03-06 22:35:57 -05:00
|
|
|
|
2019-03-25 19:13:56 -04:00
|
|
|
#[inline]
|
2019-06-05 17:35:46 -04:00
|
|
|
pub(crate) fn effective_view_box(&self, render_options: &PreparedBuildOptions) -> RectF {
|
2019-03-25 19:13:56 -04:00
|
|
|
if render_options.subpixel_aa_enabled {
|
2019-06-03 15:39:29 -04:00
|
|
|
self.view_box.scale_xy(Vector2F::new(3.0, 1.0))
|
2019-03-25 19:13:56 -04:00
|
|
|
} else {
|
|
|
|
self.view_box
|
|
|
|
}
|
|
|
|
}
|
2019-04-30 22:13:28 -04:00
|
|
|
|
|
|
|
#[inline]
|
|
|
|
pub fn build<E>(&self,
|
2019-06-05 17:35:46 -04:00
|
|
|
options: BuildOptions,
|
2019-04-30 22:13:28 -04:00
|
|
|
listener: Box<dyn RenderCommandListener>,
|
|
|
|
executor: &E)
|
|
|
|
where E: Executor {
|
2019-05-03 15:35:19 -04:00
|
|
|
let prepared_options = options.prepare(self.bounds);
|
|
|
|
SceneBuilder::new(self, &prepared_options, listener).build(executor)
|
2019-04-30 22:13:28 -04:00
|
|
|
}
|
2020-02-27 11:13:14 -05:00
|
|
|
|
2019-06-15 10:50:25 -04:00
|
|
|
pub fn paths<'a>(&'a self) -> PathIter {
|
|
|
|
PathIter {
|
|
|
|
scene: self,
|
|
|
|
pos: 0
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2020-01-31 03:16:34 -05:00
|
|
|
|
2019-06-15 10:50:25 -04:00
|
|
|
pub struct PathIter<'a> {
|
|
|
|
scene: &'a Scene,
|
|
|
|
pos: usize
|
|
|
|
}
|
2020-01-31 03:16:34 -05:00
|
|
|
|
2019-06-15 10:50:25 -04:00
|
|
|
impl<'a> Iterator for PathIter<'a> {
|
2019-06-25 04:26:37 -04:00
|
|
|
type Item = (&'a Paint, &'a Outline, &'a str);
|
2019-06-15 10:50:25 -04:00
|
|
|
fn next(&mut self) -> Option<Self::Item> {
|
|
|
|
let item = self.scene.paths.get(self.pos).map(|path_object| {
|
2019-06-25 04:26:37 -04:00
|
|
|
(
|
2020-02-05 22:59:40 -05:00
|
|
|
self.scene.palette.paints.get(path_object.paint.0 as usize).unwrap(),
|
2019-06-25 04:26:37 -04:00
|
|
|
&path_object.outline,
|
|
|
|
&*path_object.name
|
|
|
|
)
|
2019-06-15 10:50:25 -04:00
|
|
|
});
|
|
|
|
self.pos += 1;
|
|
|
|
item
|
|
|
|
}
|
2019-01-29 17:50:15 -05:00
|
|
|
}
|
2020-01-31 03:16:34 -05:00
|
|
|
|
2019-01-15 14:42:25 -05:00
|
|
|
#[derive(Clone, Debug)]
|
2020-02-15 15:39:15 -05:00
|
|
|
pub struct DrawPath {
|
2019-01-14 17:20:36 -05:00
|
|
|
outline: Outline,
|
|
|
|
paint: PaintId,
|
2020-03-03 14:17:09 -05:00
|
|
|
transform: Transform2F,
|
2020-02-15 16:21:12 -05:00
|
|
|
clip_path: Option<ClipPathId>,
|
2020-02-17 17:44:48 -05:00
|
|
|
fill_rule: FillRule,
|
2020-02-20 18:52:40 -05:00
|
|
|
blend_mode: BlendMode,
|
2020-02-26 15:43:07 -05:00
|
|
|
opacity: u8,
|
2020-02-15 16:21:12 -05:00
|
|
|
name: String,
|
|
|
|
}
|
|
|
|
|
|
|
|
#[derive(Clone, Debug)]
|
|
|
|
pub struct ClipPath {
|
|
|
|
outline: Outline,
|
2020-02-17 17:44:48 -05:00
|
|
|
fill_rule: FillRule,
|
2019-01-14 17:20:36 -05:00
|
|
|
name: String,
|
|
|
|
}
|
|
|
|
|
2020-02-15 16:21:12 -05:00
|
|
|
#[derive(Clone, Copy, Debug)]
|
|
|
|
pub struct ClipPathId(pub u32);
|
|
|
|
|
2020-02-22 00:42:15 -05:00
|
|
|
#[derive(Clone, Debug)]
|
|
|
|
pub struct RenderTarget {
|
|
|
|
size: Vector2I,
|
|
|
|
name: String,
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Drawing commands.
|
2020-02-19 20:44:41 -05:00
|
|
|
#[derive(Clone, Debug)]
|
|
|
|
pub enum DisplayItem {
|
2020-02-22 00:42:15 -05:00
|
|
|
/// Draws paths to the render target on top of the stack.
|
2020-02-19 20:44:41 -05:00
|
|
|
DrawPaths { start_index: u32, end_index: u32 },
|
2020-02-22 00:42:15 -05:00
|
|
|
|
|
|
|
/// Draws an entire render target to the render target on top of the stack.
|
|
|
|
///
|
|
|
|
/// FIXME(pcwalton): This draws the entire render target, so it's inefficient. We should get
|
|
|
|
/// rid of this command and transition all uses to `DrawPaths`. The reason it exists is that we
|
|
|
|
/// don't have logic to create tiles for blur bounding regions yet.
|
|
|
|
DrawRenderTarget { render_target: RenderTargetId, effects: Effects },
|
|
|
|
|
|
|
|
/// Pushes a render target onto the top of the stack.
|
|
|
|
PushRenderTarget(RenderTargetId),
|
|
|
|
|
|
|
|
/// Pops a render target from the stack.
|
|
|
|
PopRenderTarget,
|
2020-02-19 20:44:41 -05:00
|
|
|
}
|
|
|
|
|
2020-02-15 15:39:15 -05:00
|
|
|
impl DrawPath {
|
2019-01-14 17:20:36 -05:00
|
|
|
#[inline]
|
2020-02-26 15:43:07 -05:00
|
|
|
pub fn new(outline: Outline, paint: PaintId) -> DrawPath {
|
|
|
|
DrawPath {
|
|
|
|
outline,
|
|
|
|
paint,
|
2020-03-03 14:17:09 -05:00
|
|
|
transform: Transform2F::default(),
|
2020-02-26 15:43:07 -05:00
|
|
|
clip_path: None,
|
|
|
|
fill_rule: FillRule::Winding,
|
|
|
|
blend_mode: BlendMode::SrcOver,
|
|
|
|
opacity: !0,
|
|
|
|
name: String::new(),
|
|
|
|
}
|
2019-01-14 17:20:36 -05:00
|
|
|
}
|
2019-01-29 17:50:15 -05:00
|
|
|
|
|
|
|
#[inline]
|
|
|
|
pub fn outline(&self) -> &Outline {
|
|
|
|
&self.outline
|
|
|
|
}
|
2019-05-14 17:28:21 -04:00
|
|
|
|
2020-03-03 14:17:09 -05:00
|
|
|
#[inline]
|
|
|
|
pub(crate) fn transform(&self) -> Transform2F {
|
|
|
|
self.transform
|
|
|
|
}
|
|
|
|
|
|
|
|
#[inline]
|
|
|
|
pub fn set_transform(&mut self, new_transform: Transform2F) {
|
|
|
|
self.transform = new_transform
|
|
|
|
}
|
|
|
|
|
2020-02-15 16:21:12 -05:00
|
|
|
#[inline]
|
|
|
|
pub(crate) fn clip_path(&self) -> Option<ClipPathId> {
|
|
|
|
self.clip_path
|
|
|
|
}
|
|
|
|
|
2020-02-26 15:43:07 -05:00
|
|
|
#[inline]
|
|
|
|
pub fn set_clip_path(&mut self, new_clip_path: Option<ClipPathId>) {
|
|
|
|
self.clip_path = new_clip_path
|
|
|
|
}
|
|
|
|
|
2019-05-14 17:28:21 -04:00
|
|
|
#[inline]
|
|
|
|
pub(crate) fn paint(&self) -> PaintId {
|
|
|
|
self.paint
|
|
|
|
}
|
2020-02-17 17:44:48 -05:00
|
|
|
|
|
|
|
#[inline]
|
|
|
|
pub(crate) fn fill_rule(&self) -> FillRule {
|
|
|
|
self.fill_rule
|
|
|
|
}
|
2020-02-20 18:52:40 -05:00
|
|
|
|
2020-02-26 15:43:07 -05:00
|
|
|
#[inline]
|
|
|
|
pub fn set_fill_rule(&mut self, new_fill_rule: FillRule) {
|
|
|
|
self.fill_rule = new_fill_rule
|
|
|
|
}
|
|
|
|
|
2020-02-20 18:52:40 -05:00
|
|
|
#[inline]
|
|
|
|
pub(crate) fn blend_mode(&self) -> BlendMode {
|
|
|
|
self.blend_mode
|
|
|
|
}
|
2020-02-26 15:43:07 -05:00
|
|
|
|
|
|
|
#[inline]
|
|
|
|
pub fn set_blend_mode(&mut self, new_blend_mode: BlendMode) {
|
|
|
|
self.blend_mode = new_blend_mode
|
|
|
|
}
|
|
|
|
|
|
|
|
#[inline]
|
|
|
|
pub(crate) fn opacity(&self) -> u8 {
|
|
|
|
self.opacity
|
|
|
|
}
|
|
|
|
|
|
|
|
#[inline]
|
|
|
|
pub fn set_opacity(&mut self, new_opacity: u8) {
|
|
|
|
self.opacity = new_opacity
|
|
|
|
}
|
|
|
|
|
|
|
|
#[inline]
|
|
|
|
pub fn set_name(&mut self, new_name: String) {
|
|
|
|
self.name = new_name
|
|
|
|
}
|
2019-01-14 17:20:36 -05:00
|
|
|
}
|
2020-02-15 16:21:12 -05:00
|
|
|
|
|
|
|
impl ClipPath {
|
|
|
|
#[inline]
|
2020-02-26 15:43:07 -05:00
|
|
|
pub fn new(outline: Outline) -> ClipPath {
|
|
|
|
ClipPath { outline, fill_rule: FillRule::Winding, name: String::new() }
|
2020-02-15 16:21:12 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
#[inline]
|
|
|
|
pub fn outline(&self) -> &Outline {
|
|
|
|
&self.outline
|
|
|
|
}
|
2020-02-17 17:44:48 -05:00
|
|
|
|
|
|
|
#[inline]
|
|
|
|
pub(crate) fn fill_rule(&self) -> FillRule {
|
|
|
|
self.fill_rule
|
|
|
|
}
|
2020-02-26 15:43:07 -05:00
|
|
|
|
|
|
|
#[inline]
|
|
|
|
pub fn set_fill_rule(&mut self, new_fill_rule: FillRule) {
|
|
|
|
self.fill_rule = new_fill_rule
|
|
|
|
}
|
|
|
|
|
|
|
|
#[inline]
|
|
|
|
pub fn set_name(&mut self, new_name: String) {
|
|
|
|
self.name = new_name
|
|
|
|
}
|
2020-02-15 16:21:12 -05:00
|
|
|
}
|
2020-02-22 00:42:15 -05:00
|
|
|
|
|
|
|
impl RenderTarget {
|
|
|
|
#[inline]
|
|
|
|
pub fn new(size: Vector2I, name: String) -> RenderTarget {
|
|
|
|
RenderTarget { size, name }
|
|
|
|
}
|
|
|
|
|
|
|
|
#[inline]
|
|
|
|
pub fn size(&self) -> Vector2I {
|
|
|
|
self.size
|
|
|
|
}
|
|
|
|
}
|