Inkscape: Inkscape::DrawingCache Class Reference

Searching...

No Matches

#include <drawing-surface.h>

Inheritance diagram for Inkscape::DrawingCache:

Public Member Functions
	DrawingCache (Geom::IntRect const &area, int device_scale=1)

	~DrawingCache () override

void	markDirty (Geom::IntRect const &area=Geom::IntRect::infinite())

void	markClean (Geom::IntRect const &area=Geom::IntRect::infinite())

void	scheduleTransform (Geom::IntRect const &new_area, Geom::Affine const &trans)
	Call this during the update phase to schedule a transformation of the cache.

void	prepare ()
	Transforms the cache according to the transform specified during the update phase.

void	paintFromCache (DrawingContext &dc, Geom::OptIntRect &area, bool is_filter)
	Paints the clean area from cache and modifies the area parameter to the bounds of the region that must be repainted.

Public Member Functions inherited from Inkscape::DrawingSurface
	DrawingSurface (Geom::IntRect const &area, int device_scale=1)
	Creates a surface with the given physical extents.

	DrawingSurface (Geom::Rect const &logbox, Geom::IntPoint const &pixdims, int device_scale=1)
	Creates a surface with the given logical and physical extents.

	DrawingSurface (cairo_surface_t *surface, Geom::Point const &origin)
	Wrap a cairo_surface_t.

virtual	~DrawingSurface ()

Geom::Rect	area () const
	Get the logical extents of the surface.

Geom::IntPoint	pixels () const
	Get the pixel dimensions of the surface.

Geom::Point	dimensions () const
	Get the logical width and weight of the surface as a point.

Geom::Point	origin () const

Geom::Scale	scale () const

int	device_scale () const

Geom::Affine	drawingTransform () const
	Get the transformation applied to the drawing context on construction.

void	dropContents ()
	Drop contents of the surface and release the underlying Cairo object.

cairo_surface_t *	raw ()

cairo_t *	createRawContext ()
	Create a drawing context for this surface.

Protected Attributes
cairo_region_t *	_clean_region

Geom::IntRect	_pending_area

Geom::Affine	_pending_transform

Protected Attributes inherited from Inkscape::DrawingSurface
cairo_surface_t *	_surface

Geom::Point	_origin

Geom::Scale	_scale

Geom::IntPoint	_pixels

int	_device_scale

bool	_has_context

Private Member Functions
void	_dumpCache (Geom::OptIntRect const &area)

Additional Inherited Members
Protected Member Functions inherited from Inkscape::DrawingSurface
Geom::IntRect	pixelArea () const

Detailed Description

Definition at line 63 of file drawing-surface.h.

Constructor & Destructor Documentation

◆ DrawingCache()

Inkscape::DrawingCache::DrawingCache	(	Geom::IntRect const &	area,
		int	device_scale = `1`
	)

explicit

Definition at line 137 of file drawing-surface.cpp.

◆ ~DrawingCache()

Inkscape::DrawingCache::~DrawingCache ( )

override

Definition at line 144 of file drawing-surface.cpp.

References _clean_region.

Member Function Documentation

◆ _dumpCache()

void Inkscape::DrawingCache::_dumpCache ( Geom::OptIntRect const & area )

private

Definition at line 279 of file drawing-surface.cpp.

References _clean_region, Inkscape::DrawingSurface::_origin, Inkscape::DrawingSurface::_surface, Inkscape::DrawingSurface::area(), cairo_to_geom(), Inkscape::DrawingContext::fill(), ink_cairo_surface_copy(), Inkscape::DrawingContext::rectangle(), Inkscape::DrawingContext::setSource(), and surface.

◆ markClean()

void Inkscape::DrawingCache::markClean ( Geom::IntRect const & area = Geom::IntRect::infinite() )

Definition at line 155 of file drawing-surface.cpp.

References _clean_region, Inkscape::DrawingSurface::area(), clean, geom_to_cairo(), and Inkscape::DrawingSurface::pixelArea().

◆ markDirty()

void Inkscape::DrawingCache::markDirty ( Geom::IntRect const & area = Geom::IntRect::infinite() )

Definition at line 149 of file drawing-surface.cpp.

References _clean_region, Inkscape::DrawingSurface::area(), and geom_to_cairo().

◆ paintFromCache()

void Inkscape::DrawingCache::paintFromCache	(	DrawingContext &	dc,
		Geom::OptIntRect &	area,
		bool	is_filter
	)

Paints the clean area from cache and modifies the area parameter to the bounds of the region that must be repainted.

Definition at line 233 of file drawing-surface.cpp.

References _clean_region, Inkscape::DrawingSurface::area(), cairo_to_geom(), Inkscape::DrawingContext::fill(), geom_to_cairo(), Inkscape::DrawingContext::rectangle(), and Inkscape::DrawingContext::setSource().

◆ prepare()

void Inkscape::DrawingCache::prepare ( )

Transforms the cache according to the transform specified during the update phase.

Call this during render phase, before painting.

Definition at line 172 of file drawing-surface.cpp.

References _clean_region, Inkscape::DrawingSurface::_origin, _pending_area, _pending_transform, Inkscape::DrawingSurface::_pixels, Inkscape::DrawingSurface::_surface, Geom::are_near(), Inkscape::DrawingSurface::createRawContext(), Geom::GenericRect< C >::dimensions(), geom_to_cairo(), ink_cairo_transform(), Geom::Affine::isIdentity(), Geom::Affine::isTranslation(), limit, Geom::GenericRect< C >::min(), Inkscape::DrawingSurface::pixelArea(), Geom::Point::round(), Geom::Affine::setIdentity(), Geom::Affine::translation(), Geom::IntPoint::x(), and Geom::IntPoint::y().

◆ scheduleTransform()

void Inkscape::DrawingCache::scheduleTransform	(	Geom::IntRect const &	new_area,
		Geom::Affine const &	trans
	)

Call this during the update phase to schedule a transformation of the cache.

Definition at line 164 of file drawing-surface.cpp.

References _pending_area, and _pending_transform.

Member Data Documentation

◆ _clean_region

cairo_region_t* Inkscape::DrawingCache::_clean_region

protected

Definition at line 77 of file drawing-surface.h.

Referenced by _dumpCache(), markClean(), markDirty(), paintFromCache(), prepare(), and ~DrawingCache().

◆ _pending_area

Geom::IntRect Inkscape::DrawingCache::_pending_area

protected

Definition at line 78 of file drawing-surface.h.

Referenced by prepare(), and scheduleTransform().

◆ _pending_transform

Geom::Affine Inkscape::DrawingCache::_pending_transform

protected

Definition at line 79 of file drawing-surface.h.

Referenced by prepare(), and scheduleTransform().

The documentation for this class was generated from the following files:

/builds/inkscape/inkscape/src/display/drawing-surface.h
/builds/inkscape/inkscape/src/display/drawing-surface.cpp

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DrawingCache()

◆ ~DrawingCache()

Member Function Documentation

◆ _dumpCache()

◆ markClean()

◆ markDirty()

◆ paintFromCache()

◆ prepare()

◆ scheduleTransform()

Member Data Documentation

◆ _clean_region

◆ _pending_area

◆ _pending_transform