#include <renddesc.h>

Public Types
enum	Lock { PX_ASPECT = (1<<0), PX_AREA = (1<<1), PX_W = (1<<2), PX_H = (1<<3), IM_ASPECT = (1<<4), IM_SPAN = (1<<5), IM_W = (1<<6), IM_H = (1<<7), IM_ZOOMIN = (1<<8), IM_ZOOMOUT = (1<<9), LINK_PX_ASPECT = (1<<10), LINK_PX_AREA = (1<<11), LINK_IM_ASPECT = (1<<12), LINK_IM_SPAN = (1<<13), LINK_IM_CENTER = (1<<14), LINK_RES = (1<<15) }
enum	{ ANTIALIAS_UNIFORM, ANTIALIAS_MONTE_CARLO, ANTIALIAS_JITTERED, ANTIALIAS_ADAPTIVE, ANTIALIAS_QUINTCUNX }
	Anti alias filers types. Seems never implemented. More...

Public Member Functions
	RendDesc ()
	Default Constructor.
RendDesc &	apply (const RendDesc &x)
	Applies the given Render Description to the current one.
const Color &	get_bg_color () const
	Gets the background color.
RendDesc &	set_bg_color (const Color &bg)
	Sets the background color.
int	get_w () const
	Return the width of the composition in pixels.
RendDesc &	set_w (int x)
	Set the width of the composition in pixels.
int	get_h () const
	Return the height of the composition in pixels.
RendDesc &	set_h (int y)
	Set the height of the composition in pixels.
RendDesc &	set_wh (int x, int y)
	Sets the width and height of the composition in pixels.
Real	get_x_res () const
	Returns the horizontal resolution (in dots per meter)
RendDesc &	set_x_res (Real x)
	Sets the horizontal resolution (in dots per meter)
Real	get_y_res () const
	Returns the vertical resolution (in dots per meter)
RendDesc &	set_y_res (Real y)
	Sets the vertical resolution (in dots per meter)
Real	get_physical_w () const
	Return the physical width of the composition in meters.
Real	get_physical_h () const
	Return the physical height of the composition in meters.
RendDesc &	set_physical_w (Real w)
	Set the physical width of the composition in meters.
RendDesc &	set_physical_h (Real h)
	Set the physical height of the composition in meters.
int	get_frame_start () const
	Return the index of the first frame.
RendDesc &	set_frame_start (int x)
	Set the index of the first frame.
int	get_frame_end () const
	Return the index of the last frame.
RendDesc &	set_frame_end (int x)
	Set the index of the last frame.
const Time	get_time_start () const
	Return the starting time of the animation.
RendDesc &	set_time_start (Time x)
	Set the time that the animation will start.
const Time	get_time_end () const
	Return the end time of the animation.
RendDesc &	set_time_end (Time x)
	Set the time that the animation will end.
RendDesc &	set_time (Time x)
	Setup for one frame at the given time.
RendDesc &	set_frame (int x)
	Setup for one frame.
const float &	get_frame_rate () const
	Return the frame rate (frames-per-second)
RendDesc &	set_frame_rate (float x)
	Set the frame rate (frames-per-second)
const bool &	get_interlaced () const
	Return the status of the interlaced flag.
RendDesc &	set_interlaced (bool x)
	Set the interlace flag.
const bool &	get_clamp () const
	Return the status of the clamp flag.
RendDesc &	set_clamp (bool x)
	Set the clamp flag.
const bool &	get_render_excluded_contexts () const
	Return the status of the render_excluded_contexts flag.
RendDesc &	set_render_excluded_contexts (bool x)
	Set the render_excluded_contexts flag.
RendDesc &	set_flags (const int &x)
	Set constraint flags.
RendDesc &	clear_flags ()
	Clear constraint flags.
int	get_flags () const
	Get constraint flags.
Point::value_type	get_pixel_aspect () const
	Return the aspect ratio of a single pixel.
Point::value_type	get_image_aspect () const
	Return the aspect ratio of the entire image.
void	set_pixel_ratio (const int &x, const int &y)
	Set the pixel ratio for LINK_IM_ASPECT flag.
void	get_pixel_ratio_reduced (int &w_ratio_reduced, int &h_ratio_reduced)
	Get the reduced pixel ratio (based on euclide reduction)
void	set_res_ratio (const Real &x, const Real &y)
	Set the resolution ratio for LINK_RES flag.
const int &	get_antialias () const
	Return the antialias amount.
RendDesc &	set_antialias (const int &x)
	Set the antialias amount.
Real	get_span () const
	Return the distance from the bottom-right to the top-left.
RendDesc &	set_span (const Real &x)
	Set the span distance.
const Point &	get_focus () const
	Gets the focus Point.
RendDesc &	set_focus (const Point &x)
	Sets the focus Point.
const Point &	get_tl () const
	Gets the top left point of the compostion.
RendDesc &	set_tl (const Point &x)
	Sets the top left point of the compostion.
const Point &	get_br () const
	Gets the bottom right point of the compostion.
RendDesc &	set_br (const Point &x)
	Sets the bottom right point of the compostion.
RendDesc &	set_tl_br (const Point &x, const Point &y)
	Sets the top left and the bottom right of the composition.
Rect	get_rect () const
	Returns the rectangle of the composition.
RendDesc &	set_viewport (const Point &__tl, const Point &__br)
	Sets the view port by the top left and right bottom corners.
RendDesc &	set_viewport (Vector::value_type a, Vector::value_type b, Vector::value_type c, Vector::value_type d)
	Sets the view port by the four corners values.
Real	get_pw () const
	Returns the width of one pixel.
Real	get_ph () const
	Returns the height of one pixel.
RendDesc &	set_subwindow (int x, int y, int w, int h)
	Sets viewport to represent the screen at the given pixel coordinates.
RendDesc &	set_duration (Time t)
	Sets the duration of the animation.
const Time	get_duration ()
	Gets the duration of the animation.
void	set_transformation_matrix (const Matrix &x)
	Sets the transformation matrix.
const Matrix &	get_transformation_matrix () const
	Gets the transformation matrix.
Matrix	get_world_to_pixels_matrix () const
Matrix	get_pixels_to_world_matrix () const

Public Attributes
enum synfig::RendDesc:: { ... }	AntialiasFilter
	Anti alias filers types. Seems never implemented.

Detailed Description

Todo:: writeme

Member Enumeration Documentation

enum synfig::RendDesc::Lock

Enumerator:

PX_ASPECT
PX_AREA
PX_W
PX_H
IM_ASPECT
IM_SPAN
IM_W
IM_H
IM_ZOOMIN
IM_ZOOMOUT
LINK_PX_ASPECT
LINK_PX_AREA
LINK_IM_ASPECT
LINK_IM_SPAN
LINK_IM_CENTER
LINK_RES

anonymous enum

Anti alias filers types. Seems never implemented.

Enumerator:

ANTIALIAS_UNIFORM
ANTIALIAS_MONTE_CARLO
ANTIALIAS_JITTERED
ANTIALIAS_ADAPTIVE
ANTIALIAS_QUINTCUNX

Constructor & Destructor Documentation

synfig::RendDesc::RendDesc ( )

inline

Default Constructor.

References f.

Member Function Documentation

RendDesc & RendDesc::apply ( const RendDesc & x )

Applies the given Render Description to the current one.

const Color & RendDesc::get_bg_color ( ) const

Gets the background color.

Referenced by synfig::Target_Scanline::add_frame(), and encode_canvas().

RendDesc & RendDesc::set_bg_color ( const Color & bg )

Sets the background color.

int RendDesc::get_w ( ) const

Return the width of the composition in pixels.

RendDesc & RendDesc::set_w ( int x )

Set the width of the composition in pixels.

The other parameters are adjusted according to the constraints placed on the flags. Seems to be incomplete and doesn't use all the possible flags.

Todo:: write the needed code to keep the flags usage

Todo:: This needs to be documented further.

Todo:: This needs to be documented further.

References FLAGS.

Referenced by synfig::Layer_MeshTransform::accelerated_render(), cairo_renddesc_untransform(), synfig::Layer::render_transformed(), yuv::set_rend_desc(), and ffmpeg_trgt::set_rend_desc().

int RendDesc::get_h ( ) const

Return the height of the composition in pixels.

RendDesc & RendDesc::set_h ( int y )

Set the height of the composition in pixels.

The other parameters are adjusted according to the constraints placed on the flags. Seems to be incomplete and doesn't use all the possible flags.

Todo:: write the needed code to keep the flags usage

Todo:: This needs to be documented further.

Todo:: This needs to be documented further.

References FLAGS.

Referenced by synfig::Layer_MeshTransform::accelerated_render(), cairo_renddesc_untransform(), synfig::Layer::render_transformed(), yuv::set_rend_desc(), and ffmpeg_trgt::set_rend_desc().

RendDesc & RendDesc::set_wh	(	int	x,
		int	y
	)

Sets the width and height of the composition in pixels.

Real RendDesc::get_x_res ( ) const

Returns the horizontal resolution (in dots per meter)

Referenced by encode_canvas(), synfig::Distance::get(), mng_trgt::init(), synfig::Distance::meters(), imagemagick_trgt::start_frame(), png_trgt::start_frame(), synfig::Distance::units(), and png_trgt_spritesheet::write_png_file().

RendDesc & RendDesc::set_x_res ( Real x )

Sets the horizontal resolution (in dots per meter)

References FLAGS.

Referenced by OptionsProcessor::extract_renddesc().

Real RendDesc::get_y_res ( ) const

Returns the vertical resolution (in dots per meter)

Referenced by encode_canvas(), mng_trgt::init(), imagemagick_trgt::start_frame(), png_trgt::start_frame(), and png_trgt_spritesheet::write_png_file().

RendDesc & RendDesc::set_y_res ( Real y )

Sets the vertical resolution (in dots per meter)

References FLAGS.

Referenced by OptionsProcessor::extract_renddesc().

Real RendDesc::get_physical_w ( ) const

Return the physical width of the composition in meters.

Real RendDesc::get_physical_h ( ) const

Return the physical height of the composition in meters.

RendDesc & RendDesc::set_physical_w ( Real w )

Set the physical width of the composition in meters.

RendDesc & RendDesc::set_physical_h ( Real h )

Set the physical height of the composition in meters.

int RendDesc::get_frame_start ( ) const

Return the index of the first frame.

Referenced by dv_trgt::init(), imagemagick_trgt::init(), ffmpeg_trgt::init(), mng_trgt::init(), synfig::Target::next_frame(), bmp::set_rend_desc(), ppm::set_rend_desc(), cairo_png_trgt::set_rend_desc(), png_trgt::set_rend_desc(), exr_trgt::set_rend_desc(), jpeg_trgt::set_rend_desc(), mng_trgt::set_rend_desc(), png_trgt_spritesheet::set_rend_desc(), and gif::set_rend_desc().

RendDesc & RendDesc::set_frame_start ( int x )

Set the index of the first frame.

int RendDesc::get_frame_end ( ) const

Return the index of the last frame.

Referenced by gif::end_frame(), imagemagick_trgt::init(), ffmpeg_trgt::init(), mng_trgt::init(), synfig::Target::next_frame(), bmp::set_rend_desc(), ppm::set_rend_desc(), cairo_png_trgt::set_rend_desc(), png_trgt::set_rend_desc(), exr_trgt::set_rend_desc(), jpeg_trgt::set_rend_desc(), mng_trgt::set_rend_desc(), png_trgt_spritesheet::set_rend_desc(), and gif::set_rend_desc().

RendDesc & RendDesc::set_frame_end ( int x )

Set the index of the last frame.

const Time RendDesc::get_time_start ( ) const

Return the starting time of the animation.

Referenced by encode_canvas(), OptionsProcessor::extract_renddesc(), and synfig::Target::next_frame().

RendDesc & RendDesc::set_time_start ( Time x )

Set the time that the animation will start.

Referenced by OptionsProcessor::extract_renddesc().

const Time RendDesc::get_time_end ( ) const

Return the end time of the animation.

Referenced by encode_canvas(), and synfig::Target::next_frame().

RendDesc & RendDesc::set_time_end ( Time x )

Set the time that the animation will end.

Referenced by OptionsProcessor::extract_renddesc().

RendDesc & RendDesc::set_time ( Time x )

Setup for one frame at the given time.

Referenced by OptionsProcessor::extract_renddesc().

RendDesc & RendDesc::set_frame ( int x )

Setup for one frame.

const float & RendDesc::get_frame_rate ( ) const

Return the frame rate (frames-per-second)

Referenced by encode_canvas(), gif::end_frame(), OptionsProcessor::extract_renddesc(), synfig::ListImporter::get_frame(), synfig::CairoListImporter::get_frame(), yuv::init(), ffmpeg_trgt::init(), mng_trgt::init(), and gif::set_rend_desc().

RendDesc & RendDesc::set_frame_rate ( float x )

Set the frame rate (frames-per-second)

Referenced by OptionsProcessor::extract_renddesc(), dv_trgt::set_rend_desc(), and gif::set_rend_desc().

const bool & RendDesc::get_interlaced ( ) const

Return the status of the interlaced flag.

RendDesc & RendDesc::set_interlaced ( bool x )

Set the interlace flag.

Referenced by dv_trgt::set_rend_desc().

const bool & RendDesc::get_clamp ( ) const

Return the status of the clamp flag.

References clamp().

Referenced by synfig::parametric_render(), synfig::render(), and synfig::render_threaded().

RendDesc & RendDesc::set_clamp ( bool x )

Set the clamp flag.

References clamp().

const bool & RendDesc::get_render_excluded_contexts ( ) const

Return the status of the render_excluded_contexts flag.

RendDesc & RendDesc::set_render_excluded_contexts ( bool x )

Set the render_excluded_contexts flag.

RendDesc & RendDesc::set_flags ( const int & x )

Set constraint flags.

Referenced by CheckerBoard::accelerated_cairorender(), Rectangle::accelerated_render(), Circle::accelerated_render(), cairo_renddesc_untransform(), synfig::Layer::render_transformed(), and bmp::set_rend_desc().

RendDesc & RendDesc::clear_flags ( )

Clear constraint flags.

int RendDesc::get_flags ( ) const

Get constraint flags.

Referenced by cairo_renddesc_untransform().

Real RendDesc::get_pixel_aspect ( ) const

Return the aspect ratio of a single pixel.

Referenced by process_job(), and exr_trgt::start_frame().

Real RendDesc::get_image_aspect ( ) const

Return the aspect ratio of the entire image.

Referenced by process_job().

void RendDesc::set_pixel_ratio	(	const int &	x,
		const int &	y
	)

Set the pixel ratio for LINK_IM_ASPECT flag.

Affect the pixel ratio for LINK_IM_ASPECT flag.

void RendDesc::get_pixel_ratio_reduced	(	int &	w_ratio_reduced,
		int &	h_ratio_reduced
	)

Get the reduced pixel ratio (based on euclide reduction)

void RendDesc::set_res_ratio	(	const Real &	x,
		const Real &	y
	)

Set the resolution ratio for LINK_RES flag.

Affect the resolution ratio for LINK_RES flag.

const int & RendDesc::get_antialias ( ) const

Return the antialias amount.

Referenced by synfig::cairorender(), encode_canvas(), synfig::parametric_render(), process_job(), synfig::render(), and synfig::render_threaded().

RendDesc & RendDesc::set_antialias ( const int & x )

Set the antialias amount.

Referenced by OptionsProcessor::extract_renddesc().

Real RendDesc::get_span ( ) const

Return the distance from the bottom-right to the top-left.

Referenced by process_job().

RendDesc & RendDesc::set_span ( const Real & x )

Set the span distance.

Todo:: this looks wrong. I suspect the intention was to check

Todo:: This needs to be documented further. or fix me

Todo:: This needs to be documented further. or fix me

References FLAGS.

Referenced by OptionsProcessor::extract_renddesc().

const Point & RendDesc::get_focus ( ) const

Gets the focus Point.

Referenced by process_job().

RendDesc & RendDesc::set_focus ( const Point & x )

Sets the focus Point.

const Point & RendDesc::get_tl ( ) const

Gets the top left point of the compostion.

RendDesc & RendDesc::set_tl ( const Point & x )

Sets the top left point of the compostion.

References std::abs(), and FLAGS.

Referenced by RadialBlur::accelerated_cairorender(), CurveWarp::accelerated_cairorender(), Warp::accelerated_cairorender(), RadialBlur::accelerated_render(), synfig::Layer_MeshTransform::accelerated_render(), CurveWarp::accelerated_render(), Warp::accelerated_render(), synfig::Layer_PasteCanvas::accelerated_render(), synfig::Layer::render_transformed(), and bmp::set_rend_desc().

const Point & RendDesc::get_br ( ) const

Gets the bottom right point of the compostion.

RendDesc & RendDesc::set_br ( const Point & x )

Sets the bottom right point of the compostion.

References std::abs(), and FLAGS.

Referenced by RadialBlur::accelerated_cairorender(), CurveWarp::accelerated_cairorender(), Warp::accelerated_cairorender(), RadialBlur::accelerated_render(), synfig::Layer_MeshTransform::accelerated_render(), CurveWarp::accelerated_render(), Warp::accelerated_render(), synfig::Layer_PasteCanvas::accelerated_render(), synfig::Layer::render_transformed(), and bmp::set_rend_desc().

RendDesc & RendDesc::set_tl_br	(	const Point &	x,
		const Point &	y
	)

Sets the top left and the bottom right of the composition.

References std::abs(), and FLAGS.

Referenced by CheckerBoard::accelerated_cairorender(), and cairo_renddesc_untransform().

Rect synfig::RendDesc::get_rect ( ) const

inline

Returns the rectangle of the composition.

References get_br(), and get_tl().

Referenced by synfig::Context::accelerated_render(), synfig::Layer_PasteCanvas::accelerated_render(), and synfig::Layer::render_transformed().

RendDesc & RendDesc::set_viewport	(	const Point &	__tl,
		const Point &	__br
	)

Sets the view port by the top left and right bottom corners.

RendDesc & RendDesc::set_viewport	(	Vector::value_type	a,
		Vector::value_type	b,
		Vector::value_type	c,
		Vector::value_type	d
	)

Sets the view port by the four corners values.

Real RendDesc::get_pw ( ) const

Returns the width of one pixel.

Real RendDesc::get_ph ( ) const

Returns the height of one pixel.

RendDesc & RendDesc::set_subwindow	(	int	x,
		int	y,
		int	w,
		int	h
	)

Sets viewport to represent the screen at the given pixel coordinates.

Referenced by Blur_Layer::accelerated_cairorender(), Layer_Shade::accelerated_cairorender(), synfig::Layer_SphereDistort::accelerated_cairorender(), Layer_Bevel::accelerated_cairorender(), synfig::Layer_Shape::accelerated_cairorender(), Blur_Layer::accelerated_render(), Layer_Shade::accelerated_render(), Rectangle::accelerated_render(), synfig::Layer_SphereDistort::accelerated_render(), Layer_Bevel::accelerated_render(), Circle::accelerated_render(), synfig::Layer_Shape::accelerated_render(), and synfig::Target_Scanline::render().

RendDesc & RendDesc::set_duration ( Time t )

Sets the duration of the animation.

const Time RendDesc::get_duration ( )

Gets the duration of the animation.

void synfig::RendDesc::set_transformation_matrix ( const Matrix & x )

inline

Sets the transformation matrix.

Referenced by Zoom::accelerated_render(), Translate::accelerated_render(), synfig::Layer_Stretch::accelerated_render(), Rotate::accelerated_render(), synfig::Layer_MeshTransform::accelerated_render(), synfig::Layer_PasteCanvas::accelerated_render(), and synfig::Layer::render_transformed().

const Matrix& synfig::RendDesc::get_transformation_matrix ( ) const

inline

Gets the transformation matrix.

Referenced by Zoom::accelerated_render(), Translate::accelerated_render(), synfig::Layer_Stretch::accelerated_render(), Rotate::accelerated_render(), synfig::Layer_MeshTransform::accelerated_render(), LinearGradient::accelerated_render(), synfig::Context::accelerated_render(), synfig::Layer_PasteCanvas::accelerated_render(), and synfig::Layer::render_transformed().

Matrix synfig::RendDesc::get_world_to_pixels_matrix ( ) const

inline

References epsilon, get_br(), get_h(), get_tl(), and get_w().

Referenced by synfig::Layer_MeshTransform::accelerated_render().

Matrix synfig::RendDesc::get_pixels_to_world_matrix ( ) const

inline

References get_br(), get_h(), get_tl(), and get_w().

Member Data Documentation

enum { ... } synfig::RendDesc::AntialiasFilter

Anti alias filers types. Seems never implemented.

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

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation