Struct rsvg::drawing_ctx::DrawingCtx

pub struct DrawingCtx {
    session: Session,
    initial_viewport: Viewport,
    cr_stack: Rc<RefCell<Vec<Context>>>,
    cr: Context,
    drawsub_stack: Vec<Node<NodeData>>,
    config: RenderingConfiguration,
    recursion_depth: u16,
}

Fields

session: Session

initial_viewport: Viewport

cr_stack: Rc<RefCell<Vec<Context>>>

cr: Context

drawsub_stack: Vec<Node<NodeData>>

config: RenderingConfiguration

recursion_depth: u16

Depth of nested layers while drawing.

We use this to set a hard limit on how many nested layers there can be, to avoid malicious SVGs that would cause unbounded stack consumption.

Implementations

impl DrawingCtx

fn new( session: Session, cr: &Context, initial_viewport: &Viewport, config: RenderingConfiguration, drawsub_stack: Vec<Node<NodeData>>, ) -> DrawingCtx

fn nested(&self, cr: Context) -> Box<DrawingCtx>

Copies a DrawingCtx for temporary use on a Cairo surface.

DrawingCtx maintains state using during the drawing process, and sometimes we would like to use that same state but on a different Cairo surface and context than the ones being used on self. This function copies the self state into a new DrawingCtx, and ties the copied one to the supplied cr.

Note that if this function is called, it means that a temporary surface is being used. That surface needs a viewport which starts with a special transform; see Viewport::with_explicit_transform and how it is used elsewhere.

pub fn session(&self) -> &Session

pub fn rendering_options(&self, svg_nesting: SvgNesting) -> RenderingOptions

Returns the RenderingOptions being used for rendering.

pub fn user_language(&self) -> &UserLanguage

pub fn toplevel_viewport(&self) -> Rect

fn get_transform_for_stacking_ctx( &self, viewport: &Viewport, stacking_ctx: &StackingContext, clipping: bool, ) -> Result<ValidTransform, InternalRenderingError>

Gets the transform that will be used on the target surface, whether using an isolated stacking context or not.

pub fn svg_nesting(&self) -> SvgNesting

pub fn is_measuring(&self) -> bool

pub fn is_testing(&self) -> bool

fn size_for_temporary_surface(&self) -> (i32, i32)

pub fn create_surface_for_toplevel_viewport( &self, ) -> Result<ImageSurface, InternalRenderingError>

fn create_similar_surface_for_toplevel_viewport( &self, surface: &Surface, ) -> Result<Surface, InternalRenderingError>

fn push_new_viewport( &self, current_viewport: &Viewport, layout_viewport: &LayoutViewport, ) -> Option<Viewport>

Creates a new coordinate space inside a viewport and sets a clipping rectangle.

Returns the new viewport with the new coordinate space, or None if the transform inside the new viewport turned out to be invalid. In this case, the caller can simply not render the object in question.

fn clip_to_node( &mut self, clip_node: &Option<Node<NodeData>>, acquired_nodes: &mut AcquiredNodes<'_>, viewport: &Viewport, bbox: &BoundingBox, ) -> Result<(), InternalRenderingError>

fn generate_cairo_mask( &mut self, mask_node: &Node<NodeData>, viewport: &Viewport, transform: Transform, bbox: &BoundingBox, acquired_nodes: &mut AcquiredNodes<'_>, ) -> Result<Option<ImageSurface>, InternalRenderingError>

fn is_rendering_cancelled(&self) -> bool

fn check_cancellation(&self) -> Result<(), InternalRenderingError>

Checks whether the rendering has been cancelled in the middle.

If so, returns an Err. This is used from DrawingCtx::with_discrete_layer to exit early instead of proceeding with rendering.

fn check_layer_nesting_depth(&self) -> Result<(), InternalRenderingError>

fn filter_current_surface( &mut self, acquired_nodes: &mut AcquiredNodes<'_>, filter: &Filter, viewport: &Viewport, element_name: &str, bbox: &BoundingBox, ) -> Result<Surface, InternalRenderingError>

fn draw_in_optional_new_viewport( &mut self, acquired_nodes: &mut AcquiredNodes<'_>, viewport: &Viewport, layout_viewport: &Option<LayoutViewport>, draw_fn: &mut dyn FnMut(&mut AcquiredNodes<'_>, &mut DrawingCtx, &Viewport) -> Result<BoundingBox, InternalRenderingError>, ) -> Result<BoundingBox, InternalRenderingError>

fn draw_layer_internal( &mut self, stacking_ctx: &StackingContext, acquired_nodes: &mut AcquiredNodes<'_>, viewport: &Viewport, layout_viewport: Option<LayoutViewport>, clipping: bool, draw_fn: &mut dyn FnMut(&mut AcquiredNodes<'_>, &mut DrawingCtx, &Viewport) -> Result<BoundingBox, InternalRenderingError>, ) -> Result<BoundingBox, InternalRenderingError>

pub fn with_discrete_layer( &mut self, stacking_ctx: &StackingContext, acquired_nodes: &mut AcquiredNodes<'_>, viewport: &Viewport, layout_viewport: Option<LayoutViewport>, clipping: bool, draw_fn: &mut dyn FnMut(&mut AcquiredNodes<'_>, &mut DrawingCtx, &Viewport) -> Result<BoundingBox, InternalRenderingError>, ) -> Result<BoundingBox, InternalRenderingError>

fn with_alpha( &mut self, opacity: UnitInterval, draw_fn: &mut dyn FnMut(&mut DrawingCtx) -> Result<BoundingBox, InternalRenderingError>, ) -> Result<BoundingBox, InternalRenderingError>

Run the drawing function with the specified opacity

fn link_tag_begin(&mut self, link_target: &str)

Start a Cairo tag for PDF links

fn link_tag_end(&mut self)

End a Cairo tag for PDF links

fn make_filter_plan( &mut self, acquired_nodes: &mut AcquiredNodes<'_>, specs: &[FilterSpec], source_image_width: i32, source_image_height: i32, stroke_paint_source: Rc<UserSpacePaintSource>, fill_paint_source: Rc<UserSpacePaintSource>, viewport: &Viewport, ) -> Result<Rc<FilterPlan>, InternalRenderingError>

fn run_filters( &mut self, viewport: &Viewport, surface_to_filter: SharedImageSurface, filter: &Filter, acquired_nodes: &mut AcquiredNodes<'_>, node_name: &str, user_space_params: &NormalizeParams, stroke_paint_source: Rc<UserSpacePaintSource>, fill_paint_source: Rc<UserSpacePaintSource>, node_bbox: &BoundingBox, ) -> Result<SharedImageSurface, InternalRenderingError>

fn set_pattern( &mut self, pattern: &UserSpacePattern, acquired_nodes: &mut AcquiredNodes<'_>, viewport: &Viewport, ) -> Result<bool, InternalRenderingError>

fn set_paint_source( &mut self, paint_source: &UserSpacePaintSource, acquired_nodes: &mut AcquiredNodes<'_>, viewport: &Viewport, ) -> Result<bool, InternalRenderingError>

pub fn get_paint_source_surface( &mut self, width: i32, height: i32, acquired_nodes: &mut AcquiredNodes<'_>, paint_source: &UserSpacePaintSource, viewport: &Viewport, ) -> Result<SharedImageSurface, InternalRenderingError>

Computes and returns a surface corresponding to the given paint server.

pub fn draw_layer( &mut self, layer: &Layer, acquired_nodes: &mut AcquiredNodes<'_>, clipping: bool, viewport: &Viewport, ) -> Result<BoundingBox, InternalRenderingError>

fn draw_shape( &mut self, shape: &Shape, stacking_ctx: &StackingContext, acquired_nodes: &mut AcquiredNodes<'_>, clipping: bool, viewport: &Viewport, ) -> Result<BoundingBox, InternalRenderingError>

fn paint_surface( &mut self, surface: &SharedImageSurface, width: f64, height: f64, image_rendering: ImageRendering, viewport: &Viewport, ) -> Result<(), Error>

fn draw_image( &mut self, image: &Image, stacking_ctx: &StackingContext, acquired_nodes: &mut AcquiredNodes<'_>, clipping: bool, viewport: &Viewport, ) -> Result<BoundingBox, InternalRenderingError>

fn draw_group( &mut self, _group: &Group, _stacking_ctx: &StackingContext, _acquired_nodes: &mut AcquiredNodes<'_>, _clipping: bool, _viewport: &Viewport, ) -> Result<BoundingBox, InternalRenderingError>

fn draw_text_span( &mut self, span: &TextSpan, acquired_nodes: &mut AcquiredNodes<'_>, clipping: bool, viewport: &Viewport, ) -> Result<BoundingBox, InternalRenderingError>

fn draw_text( &mut self, text: &Text, stacking_ctx: &StackingContext, acquired_nodes: &mut AcquiredNodes<'_>, clipping: bool, viewport: &Viewport, ) -> Result<BoundingBox, InternalRenderingError>

pub fn get_snapshot( &self, width: i32, height: i32, ) -> Result<SharedImageSurface, InternalRenderingError>

pub fn draw_node_to_surface( &mut self, node: &Node<NodeData>, acquired_nodes: &mut AcquiredNodes<'_>, cascaded: &CascadedValues<'_>, transform: ValidTransform, width: i32, height: i32, ) -> Result<SharedImageSurface, InternalRenderingError>

pub fn draw_node_from_stack( &mut self, node: &Node<NodeData>, acquired_nodes: &mut AcquiredNodes<'_>, cascaded: &CascadedValues<'_>, viewport: &Viewport, clipping: bool, ) -> Result<BoundingBox, InternalRenderingError>

pub fn draw_from_use_node( &mut self, node: &Node<NodeData>, acquired_nodes: &mut AcquiredNodes<'_>, values: &ComputedValues, use_rect: Rect, link: &NodeId, clipping: bool, viewport: &Viewport, fill_paint: Rc<PaintSource>, stroke_paint: Rc<PaintSource>, ) -> Result<BoundingBox, InternalRenderingError>

pub fn get_font_options(&self) -> FontOptions

Extracts the font options for the current state of the DrawingCtx.

You can use the font options later with create_pango_context().

Trait Implementations

impl Drop for DrawingCtx

fn drop(&mut self)

Executes the destructor for this type.