gnash::Renderer_cairo Class Reference

#include <Renderer_cairo.h>

Inheritance diagram for gnash::Renderer_cairo:

List of all members.

Public Member Functions
	Renderer_cairo ()
	Implementation of Renderer_cairo class.
	~Renderer_cairo ()
std::string	description () const
	Return a description of this renderer.
CachedBitmap *	createCachedBitmap (std::auto_ptr< image::GnashImage > im)
	Given an image, returns a pointer to a CachedBitmap class that can later be passed to FillStyleX_bitmap(), to set a bitmap fill style.
void	drawVideoFrame (image::GnashImage *baseframe, const Transform &xform, const SWFRect *bounds, bool smooth)
	Draws a video frame.
virtual geometry::Range2d< int >	world_to_pixel (const SWFRect &worldbounds) const
	Converts world coordinates to pixel coordinates.
virtual point	pixel_to_world (int x, int y) const
	Converts pixel coordinates to world coordinates (TWIPS)
void	set_color (const rgba &c)
void	set_invalidated_regions (const InvalidatedRanges &ranges)
	Sets the update region (called prior to begin_display).
virtual Renderer *	startInternalRender (image::GnashImage &)
	Setup the renderer to draw to an internal buffer.
virtual void	endInternalRender ()
	Finish internal rendering.
virtual void	begin_display (const rgba &bg_color, int viewport_width, int viewport_height, float x0, float x1, float y0, float y1)
	Bracket the displaying of a frame from a movie.
virtual void	end_display ()
void	set_scale (float xscale, float yscale)
	Sets the x/y scale for the movie.
void	set_translation (float xoff, float yoff)
void	drawLine (const std::vector< point > &coords, const rgba &color, const SWFMatrix &mat)
	Draw a line-strip directly, using a thin, solid line.
void	draw_poly (const std::vector< point > &corners, const rgba &fill, const rgba &outline, const SWFMatrix &mat, bool masked)
	Draw a simple, solid filled polygon with a thin (~1 pixel) outline.
void	set_antialiased (bool enable)
void	begin_submit_mask ()
void	end_submit_mask ()
void	disable_mask ()
void	add_path (cairo_t *cr, const Path &cur_path)
void	apply_line_style (const LineStyle &style, const SWFCxForm &cx, const SWFMatrix &mat)
void	draw_outlines (const PathVec &path_vec, const std::vector< LineStyle > &line_styles, const SWFCxForm &cx, const SWFMatrix &mat)
std::vector < PathVec::const_iterator >	find_subshapes (const PathVec &path_vec)
void	draw_subshape (const PathVec &path_vec, const SWFMatrix &mat, const SWFCxForm &cx, const std::vector< FillStyle > &FillStyles, const std::vector< LineStyle > &line_styles)
void	draw_mask (const PathVec &path_vec)
void	add_paths (const PathVec &path_vec)
void	apply_matrix_to_paths (std::vector< Path > &paths, const SWFMatrix &mat)
	Takes a path and translates it using the given SWFMatrix.
void	drawShape (const SWF::ShapeRecord &shape, const Transform &xform)
void	drawGlyph (const SWF::ShapeRecord &rec, const rgba &color, const SWFMatrix &mat)
	Draws a glyph (font character).
void	set_context (cairo_t *context)
unsigned int	getBitsPerPixel () const
bool	getPixel (rgba &color_return, int x, int y) const
bool	initTestBuffer (unsigned width, unsigned height)

---

Constructor & Destructor Documentation

gnash::Renderer_cairo::Renderer_cairo

(

)

Implementation of Renderer_cairo class.

gnash::Renderer_cairo::~Renderer_cairo

(

)

---

Member Function Documentation

void gnash::Renderer_cairo::add_path	(	cairo_t *	cr,
		const Path &	cur_path
	)

References x, gnash::Path::ap, gnash::geometry::Point2d::x, y, gnash::geometry::Point2d::y, gnash::Path::m_edges, gnash::image::end(), gnash::Edge::straight(), gnash::Edge::ap, and gnash::Edge::cp.

Referenced by draw_outlines(), and add_paths().

void gnash::Renderer_cairo::add_paths

(

const PathVec &

path_vec

)

References gnash::image::end(), and add_path().

Referenced by end_submit_mask().

void gnash::Renderer_cairo::apply_line_style	(	const LineStyle &	style,
		const SWFCxForm &	cx,
		const SWFMatrix &	mat
	)

References gnash::LineStyle::joinStyle(), gnash::JOIN_ROUND, gnash::JOIN_BEVEL, gnash::JOIN_MITER, LOG_ONCE, _, gnash::LineStyle::startCapStyle(), gnash::LineStyle::endCapStyle(), gnash::CAP_ROUND, gnash::CAP_NONE, gnash::CAP_SQUARE, gnash::LineStyle::miterLimitFactor(), gnash::LineStyle::getThickness(), gnash::LineStyle::scaleThicknessVertically(), gnash::LineStyle::scaleThicknessHorizontally(), color, gnash::SWFCxForm::transform(), gnash::LineStyle::get_color(), and set_color().

Referenced by draw_outlines().

void gnash::Renderer_cairo::apply_matrix_to_paths	(	std::vector< Path > &	paths,
		const SWFMatrix &	mat
	)

Takes a path and translates it using the given SWFMatrix.

References gnash::renderer::opengl::for_each(), gnash::Path::transform(), and gnash::key::_1.

Referenced by drawShape().

void gnash::Renderer_cairo::begin_display	(	const rgba &	background_color,
		int	viewport_width,
		int	viewport_height,
		float	x0,
		float	x1,
		float	y0,
		float	y1
	)		[virtual]

Bracket the displaying of a frame from a movie.

Set up to render a full frame from a movie and fills the background. Sets up necessary transforms, to scale the movie to fit within the given dimensions. Call end_display() when you're done. Most of the arguments are only for the ogl renderer. See documentation in that class. Do not use these arguments for new renderers!

Implements gnash::Renderer.

References gnash::rgba::m_a, set_color(), gnash::geometry::SnappingRanges2d::size(), gnash::geometry::SnappingRanges2d::getRange(), gnash::geometry::Range2d::isNull(), gnash::geometry::Range2d::isWorld(), x, gnash::geometry::Range2d::getMinX(), y, gnash::geometry::Range2d::getMinY(), gnash::geometry::Range2d::getMaxX(), and gnash::geometry::Range2d::getMaxY().

void gnash::Renderer_cairo::begin_submit_mask

(

)

[virtual]

Masks

Masks are defined by drawing calls enclosed by begin_submit_mask() and end_submit_mask(). Between these two calls, no drawing is to occur. The shapes rendered between the two calls define the visible region of the mask. Graphics that are irrelevant in the context of a mask (lines and fill styles, for example) should be ignored. After use, disable_mask() is called to remove the mask.

Masks may be nested. That is, end_submit_mask() may be followed by a call to begin_submit_mask(). The resulting mask shall be an intersection of the previously created mask. disable_mask() shall result in the disabling or destruction of the last created mask.

Implements gnash::Renderer.

CachedBitmap * gnash::Renderer_cairo::createCachedBitmap

(

std::auto_ptr< image::GnashImage >

im

)

[virtual]

Given an image, returns a pointer to a CachedBitmap class that can later be passed to FillStyleX_bitmap(), to set a bitmap fill style.

================================================================== Caching utitilies for core. ==================================================================

Implements gnash::Renderer.

References gnash::image::TYPE_RGB, and gnash::image::TYPE_RGBA.

std::string gnash::Renderer_cairo::description

(

)

const [inline, virtual]

Return a description of this renderer.

Implements gnash::Renderer.

void gnash::Renderer_cairo::disable_mask

(

)

[virtual]

Implements gnash::Renderer.

void gnash::Renderer_cairo::draw_mask

(

const PathVec &

path_vec

)

References gnash::image::end(), gnash::Path::m_fill0, and gnash::Path::m_fill1.

Referenced by drawShape().

void gnash::Renderer_cairo::draw_outlines	(	const PathVec &	path_vec,
		const std::vector< LineStyle > &	line_styles,
		const SWFCxForm &	cx,
		const SWFMatrix &	mat
	)

References gnash::image::end(), gnash::Path::m_line, apply_line_style(), and add_path().

Referenced by draw_subshape().

void gnash::Renderer_cairo::draw_poly	(	const std::vector< point > &	corners,
		const rgba &	fill,
		const rgba &	outline,
		const SWFMatrix &	mat,
		bool	masked
	)		[virtual]

Draw a simple, solid filled polygon with a thin (~1 pixel) outline.

This can't be used for Flash shapes but is intended for internal drawings like bounding boxes (editable text fields) and similar. The polygon should not contain self-intersections. If you do not wish a outline or a fill, then simply set the alpha value to zero.

The polygon need NOT be closed (ie: this function will automatically add an additional vertex to close it.

When masked==false, then any potential mask currently active will be ignored, otherwise it is respected.

Implements gnash::Renderer.

References x, y, gnash::key::i, gnash::rgba::m_a, and set_color().

void gnash::Renderer_cairo::draw_subshape	(	const PathVec &	path_vec,
		const SWFMatrix &	mat,
		const SWFCxForm &	cx,
		const std::vector< FillStyle > &	FillStyles,
		const std::vector< LineStyle > &	line_styles
	)

References draw_outlines().

Referenced by drawShape(), and drawGlyph().

void gnash::Renderer_cairo::drawGlyph	(	const SWF::ShapeRecord &	rec,
		const rgba &	color,
		const SWFMatrix &	mat
	)		[virtual]

Draws a glyph (font character).

Glyphs are defined just like shape characters with the difference that they do not have any fill or line styles. Instead, the shape must be drawn using the given color (solid fill). Please note that although the glyph paths may indicate subshapes, the renderer is to ignore that information.

Parameters:

def
mat
color

Implements gnash::Renderer.

References gnash::SWF::ShapeRecord::paths(), and draw_subshape().

void gnash::Renderer_cairo::drawLine	(	const std::vector< point > &	coords,
		const rgba &	color,
		const SWFMatrix &	mat
	)		[virtual]

Draw a line-strip directly, using a thin, solid line.

Can be used to draw empty boxes and cursors.

an array of 16-bit signed integer coordinates. Even indices (and 0) are x coordinates, while uneven ones are y coordinates.

the number of x-y coordinates (vertices).

the color to be used to draw the line strip.

the SWFMatrix to be used to transform the vertices.

Implements gnash::Renderer.

References gnash::key::i, x, y, gnash::key::e, and set_color().

void gnash::Renderer_cairo::drawShape	(	const SWF::ShapeRecord &	shape,
		const Transform &	xform
	)		[virtual]

Implements gnash::Renderer.

References gnash::SWF::ShapeRecord::paths(), apply_matrix_to_paths(), gnash::Transform::matrix, draw_mask(), find_subshapes(), gnash::SWF::ShapeRecord::fillStyles(), gnash::SWF::ShapeRecord::lineStyles(), gnash::key::i, draw_subshape(), and gnash::Transform::colorTransform.

void gnash::Renderer_cairo::drawVideoFrame	(	image::GnashImage *	frame,
		const Transform &	xform,
		const SWFRect *	bounds,
		bool	smooth
	)		[virtual]

Draws a video frame.

================================================================== Rendering Interface. ================================================================== The frame has already been decoded and is available in RGB format only.

Parameters:

frame	The RGB video buffer frame. Ownership of the buffer is left to the caller.
mat	The SWFMatrix with world coordinates used to retrieve the x and y coordinate of the video object. The scaling of the SWFMatrix only refers to the Flash instance, *not* to the video inside that instance. When a video object is placed on the stage and the loaded video is smaller, then the SWFMatrix is still an "identity matrix". However, if the video object is scaled via ActionScript, for example, then the SWFMatrix will change. This means the renderer has to find the correct scaling for the video inside the bounds.
bounds	The minX/minY fields of this SWFRect are always zero. The width and height determine the size of the Flash video instance on the stage (in TWIPS) prior to SWFMatrix transformations.

Implements gnash::Renderer.

References gnash::image::GnashImage::type(), gnash::image::TYPE_RGBA, LOG_ONCE, _, assert, test::w, gnash::image::GnashImage::width(), gnash::key::h, gnash::image::GnashImage::height(), gnash::SWFRect::width(), gnash::SWFRect::height(), gnash::SWFRect::get_x_min(), gnash::SWFRect::get_y_min(), gnash::Transform::matrix, gnash::Renderer::_quality, gnash::QUALITY_BEST, gnash::QUALITY_HIGH, gnash::QUALITY_MEDIUM, gnash::QUALITY_LOW, gnash::SWFRect::getRange(), gnash::SWFMatrix::transform(), gnash::geometry::Range2d::getMinX(), gnash::geometry::Range2d::getMinY(), gnash::geometry::Range2d::width(), and gnash::geometry::Range2d::height().

void gnash::Renderer_cairo::end_display

(

)

[virtual]

Implements gnash::Renderer.

void gnash::Renderer_cairo::end_submit_mask

(

)

[virtual]

Implements gnash::Renderer.

References add_paths().

virtual void gnash::Renderer_cairo::endInternalRender

(

)

[inline, virtual]

Finish internal rendering.

Any rendering after this function has been called must apply to the external buffer.

Implements gnash::Renderer.

std::vector< PathVec::const_iterator > gnash::Renderer_cairo::find_subshapes

(

const PathVec &

path_vec

)

References gnash::image::end(), and gnash::Path::m_new_shape.

Referenced by drawShape().

unsigned int gnash::Renderer_cairo::getBitsPerPixel

(

)

const

bool gnash::Renderer_cairo::getPixel	(	rgba &	color_return,
		int	x,
		int	y
	)		const

References assert, gnash::rgba::m_a, gnash::rgba::m_r, gnash::rgba::m_g, and gnash::rgba::m_b.

bool gnash::Renderer_cairo::initTestBuffer	(	unsigned	width,
		unsigned	height
	)

References set_context().

point gnash::Renderer_cairo::pixel_to_world	(	int	x,
		int	y
	)		const [virtual]

Converts pixel coordinates to world coordinates (TWIPS)

Implements gnash::Renderer.

References x, and y.

void gnash::Renderer_cairo::set_antialiased

(

bool

enable

)

References LOG_ONCE, and __FUNCTION__.

void gnash::Renderer_cairo::set_color

(

const rgba &

c

)

References gnash::rgba::m_r, gnash::rgba::m_g, gnash::rgba::m_b, and gnash::rgba::m_a.

Referenced by begin_display(), drawLine(), draw_poly(), and apply_line_style().

void gnash::Renderer_cairo::set_context

(

cairo_t *

context

)

Referenced by initTestBuffer(), and gnash::renderer::cairo::set_context().

void gnash::Renderer_cairo::set_invalidated_regions

(

const InvalidatedRanges &

)

[virtual]

Sets the update region (called prior to begin_display).

================================================================== Prepare drawing area and other utilities ================================================================== The renderer might do clipping and leave the region outside these bounds unchanged, but he is allowed to change them if that makes sense. After rendering a frame the area outside the invalidated region can be undefined and is not used.

It is not required for all renderers. Parameters are world coordinates (TWIPS).

For more info see page Detection of updated regions.

Reimplemented from gnash::Renderer.

void gnash::Renderer_cairo::set_scale	(	float	,
		float
	)		[virtual]

Sets the x/y scale for the movie.

================================================================== Interfaces for adjusting renderer output. ==================================================================

Reimplemented from gnash::Renderer.

void gnash::Renderer_cairo::set_translation	(	float	,
		float
	)		[virtual]

Sets the x/y offset for the movie in pixels. This applies to all graphics drawn except the background, which must be drawn for the entire canvas, regardless of the translation.

Reimplemented from gnash::Renderer.

virtual Renderer* gnash::Renderer_cairo::startInternalRender

(

image::GnashImage &

buffer

)

[inline, virtual]

Setup the renderer to draw to an internal buffer.

Implementations are free to return a new renderer if they choose.

Returns:

0 if the renderer does not support this.

Implements gnash::Renderer.

geometry::Range2d< int > gnash::Renderer_cairo::world_to_pixel

(

const SWFRect &

worldbounds

)

const [virtual]

Converts world coordinates to pixel coordinates.

================================================================== Interface for querying the renderer. ==================================================================

Implements gnash::Renderer.

References gnash::SWFRect::get_x_min(), gnash::SWFRect::get_y_min(), gnash::SWFRect::get_x_max(), and gnash::SWFRect::get_y_max().

---

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

• Renderer_cairo.h
• Renderer_cairo.cpp