Where every function and class of the synfig library can be found. More...

Namespaces
namespace	BITMAP
namespace	types_namespace
namespace	Exception
namespace	FileContainerZip_InternalStructs

Classes
class	BooleanCurve
class	Layer_Clamp
class	Layer_SphereDistort
class	Layer_Stretch
class	Layer_ColorCorrect
class	ValueNode_Random
struct	matrix_t
struct	stop_t
struct	linear_g
struct	radial_g
struct	url_t
struct	Vertex_t
struct	bline_t
class	Svg_parser
struct	Activepoint
class	BLinePoint
class	Bone
class	BoneWeightPair
class	CairoImporter
	Used for importing bitmaps of various formats, including animations. More...
class	CairoListImporter
class	Canvas
	Canvas is a double ended queue of Layers. It is the base class for a Synfig document. More...
class	CairoColor
class	CairoColorAccumulator
class	Color
class	ColorAccumulator
class	IndependentContext
	IndependentContext is a class to warp the iterator for a double queue of layers (that is the CanvasBase). More...
class	ContextParams
	ContextParams is a class to store rendering parameters significant for Context. More...
class	Context
	Context is a class to warp the iterator for a double queue of layers (that is the CanvasBase) with additional information about rendering parameters. More...
struct	Ray
struct	BezHull
class	CIntersect
struct	CurvePoint
class	CurveSet
class	DashItem
class	Distance
class	FileContainer
class	FileContainerTemporary
class	FileContainerZip
class	FileSystem
class	FileSystemGroup
class	FileSystemNative
class	Gamma
	This class performs color correction on Color classes. More...
class	ChangeLocale
class	ProgressCallback
class	SuperCallback
struct	GradientCPoint
class	Gradient
	Color Gradient Class. More...
class	GUID
class	GUIDHash
class	GUIDSet
class	Importer
	Used for importing bitmaps of various formats, including animations. More...
class	Keyframe
	Keyframe is used to record the state of the animation at that point (time_) More...
class	KeyframeList
class	Layer
class	Layer_Bitmap
class	Layer_NoDeform
class	Layer_Composite
	Base class for layers that put stuff on top of lower layers. More...
class	Layer_Duplicate
class	Layer_Group
	Class of the Group layer. More...
class	Layer_MeshTransform
class	Layer_Mime
class	Layer_MotionBlur
class	Layer_PasteCanvas
	Class of the Pasted Canvas layer. More...
class	Layer_Polygon
	writeme More...
class	Layer_Shape
	writeme More...
class	Layer_Skeleton
class	Layer_SkeletonDeformation
	Class of the SkeletonDeformation layer. More...
class	Layer_SolidColor
class	Layer_Sound
class	Layer_Switch
	Class of the Switch layer. More...
class	ListImporter
class	CanvasParser
	Class that handles xmlpp elements from a sif file and converts them into Synfig objects. More...
class	Main
class	Matrix
class	Mesh
class	Module
class	Mutex
class	RecMutex
class	RWLock
class	TimePoint
	TimePoint class: holds the time and the before and after interpolation mode. More...
class	TimePointSet
class	Node
struct	PaletteItem
class	Palette
class	ParamDesc
	Parameter Description Class. More...
class	ParamVocab
class	Polygon
class	Protocol
class	Rect
class	RendDesc
class	Renderer
class	RendererSoftware
struct	Segment
struct	_FILE_deleter
class	SoundProcessor
class	ColorPrep
class	CairoColorPrep
class	Surface
	Bitmap Surface. More...
class	CairoSurface
	Generic Cairo backed surface. It allows to create a image surface equivalent to the current backend for custom modifications purposes. More...
class	Target
	Used to produce rendered animations of the documents. More...
class	Target_Cairo
	This is a Target class that implements the render fucntion for a CairoSurface. More...
class	Target_Cairo_Tile
	This is a Target class that implements the render fucntion for a CairoSurface using tile mode. More...
class	Target_Multi
	Render-target. More...
class	Target_Null
	A target which renders to nothing. Useful for benchmarks and other tests. More...
class	Target_Null_Tile
	A target which renders to nothing using tiles. Useful for benchmarks and other tests. More...
class	Target_Scanline
	This is a Target class that implements the render fucntion for a line by line render procedure. More...
class	Target_Tile
	Render-target. More...
struct	TargetParam
class	Time
class	Transform
class	TransformStack
class	Transformation
class	TypeAlias
class	Operation
	Provides methods to create operation with Values. More...
class	Type
	Class for the Type of Values of Synfig. More...
class	UniqueID
class	UniqueIDLessThan
	A function class used for sorting based on UniqueIDs. More...
class	ValueBase
	Base class for the Values of Synfig. More...
class	Value
	Template for all the valid Value Types. More...
class	ValueNode
	Base class for all Value Nodes. More...
class	PlaceholderValueNode
class	LinkableValueNode
	Specialized Class of Value Nodes that has links to other Value Nodes. More...
class	ValueNodeList
	A searchable value_node list container. More...
struct	ValueNode_Add
class	ValueNode_And
class	ValueNode_AngleString
class	ValueNode_Animated
	Virtual class for the derived ValueNode Animated implementations. More...
class	ValueNode_Atan2
class	ValueNode_Average
class	ValueNode_BLine
class	ValueNode_BLineCalcTangent
class	ValueNode_BLineCalcVertex
class	ValueNode_BLineCalcWidth
class	ValueNode_BLineRevTangent
class	ValueNode_Bone
class	ValueNode_Bone_Root
class	ValueNode_BoneInfluence
class	ValueNode_BoneLink
class	ValueNode_BoneWeightPair
class	ValueNode_Compare
class	ValueNode_Composite
class	ValueNode_Const
class	ValueNode_Cos
class	ValueNode_Derivative
class	ValueNode_DIList
	Converts a ValueNode_DIList into a DashItem list. More...
class	ValueNode_DotProduct
class	ValueNode_Duplicate
class	ValueNode_Dynamic
class	Oscillator
class	ValueNode_DynamicList
	Animated List ValueNode. More...
class	ValueNode_Exp
class	ValueNode_GradientColor
struct	ValueNode_GradientRotate
class	ValueNode_Greyed
class	ValueNode_Integer
class	ValueNode_IntString
class	ValueNode_Join
class	ValueNode_Linear
class	ValueNode_Logarithm
class	ValueNode_Not
class	ValueNode_Or
class	ValueNode_Pow
class	ValueNode_RadialComposite
class	ValueNode_Range
class	ValueNode_Real
class	ValueNode_RealString
class	ValueNode_Reciprocal
class	ValueNode_Reference
struct	ValueNode_Repeat_Gradient
class	ValueNode_Reverse
struct	ValueNode_Scale
class	ValueNode_SegCalcTangent
class	ValueNode_SegCalcVertex
class	ValueNode_Sine
class	ValueNode_StaticList
	StaticList ValueNode. More...
class	ValueNode_Step
struct	ValueNode_Stripes
struct	ValueNode_Subtract
class	ValueNode_Switch
struct	ValueNode_TimedSwap
class	ValueNode_TimeLoop
class	ValueNode_TimeString
class	ValueNode_TwoTone
class	ValueNode_VectorAngle
class	ValueNode_VectorLength
class	ValueNode_VectorX
class	ValueNode_VectorY
class	ValueNode_WeightedAverage
class	ValueNode_WPList
	This class implements a list of Width Points It will provide methods to calculate the width at any intermediate position and the insertion and remove of width points. It shouldn't allow to remove all the width points to still allowing to the user to add new ones. More...
class	ValueVector
class	ValueTransformation
class	ValueAverage
class	Vector
class	Waypoint
	Waypoint is used to handle variations along the time of the ValueNodes. More...
class	WeightedValue
class	WidthPoint
class	zstreambuf
class	ZReadStream
class	ZWriteStream

Typedefs
typedef struct synfig::matrix_t	SVGMatrix
typedef struct synfig::stop_t	ColorStop
typedef struct synfig::linear_g	LinearGradient
typedef struct synfig::radial_g	RadialGradient
typedef struct synfig::url_t	URL
typedef struct synfig::Vertex_t	Vertex
typedef struct synfig::bline_t	BLine
typedef etl::angle	Angle
typedef etl::handle< Canvas >	CanvasHandle
typedef std::deque < etl::handle< Layer > >	CanvasBase
typedef CairoColor(*	cairoblendfunc )(CairoColor &, CairoColor &, float)
typedef Color(*	blendfunc )(Color &, Color &, float)
typedef float	ColorReal
typedef Color	ColorAccumulator
typedef Vector	Point
typedef ProgressCallback	ProgressManager
typedef etl::handle< Node >	NodeHandle
typedef double	Real
typedef bool(*	save_canvas_external_file_callback_t )(void *user_data, Layer::ConstHandle layer, const std::string &param_name, std::string &filename)
typedef etl::smart_ptr< FILE, _FILE_deleter >	SmartFILE
typedef std::string	String
typedef unsigned int	TypeId
typedef ValueNode_BLine::ListEntry::ActivepointList	ActivepointList
typedef ValueNode_DynamicList::ListEntry::Activepoint	Activepoint
typedef std::vector< Waypoint >	WaypointList

Enumerations
enum	PixelFormat { PF_RGB = 0, PF_GRAY = (1<<0), PF_A = (1<<1), PF_Z = (1<<2), PF_BGR = (1<<3), PF_A_START = (1<<4), PF_Z_START = (1<<5), PF_ZA = (1<<6), PF_A_INV = (1<<7), PF_Z_INV = (1<<8), PF_RAW_COLOR = (1<<9)+(1<<1) }
enum	Interpolation { INTERPOLATION_TCB, INTERPOLATION_CONSTANT, INTERPOLATION_LINEAR, INTERPOLATION_HALT, INTERPOLATION_MANUAL, INTERPOLATION_UNDEFINED, INTERPOLATION_NIL, INTERPOLATION_CLAMPED }
enum	ReleaseVersion { RELEASE_VERSION_0_61_06, RELEASE_VERSION_0_61_07, RELEASE_VERSION_0_61_08, RELEASE_VERSION_0_61_09, RELEASE_VERSION_0_62_00, RELEASE_VERSION_0_62_01, RELEASE_VERSION_0_62_02, RELEASE_VERSION_0_63_00, RELEASE_VERSION_0_63_01, RELEASE_VERSION_0_63_02, RELEASE_VERSION_0_63_03, RELEASE_VERSION_0_63_04, RELEASE_VERSION_0_63_05, RELEASE_VERSION_0_64_0, RELEASE_VERSION_0_64_1, RELEASE_VERSION_0_64_2, RELEASE_VERSION_0_64_3, RELEASE_VERSION_1_0, RELEASE_VERSION_1_0_2, RELEASE_VERSION_END }
enum	RenderMethod { SOFTWARE = 0x100, OPENGL, CAIRO }
	Available rendering methods. More...
enum	TargetAlphaMode { TARGET_ALPHA_MODE_KEEP, TARGET_ALPHA_MODE_FILL, TARGET_ALPHA_MODE_REDUCE, TARGET_ALPHA_MODE_EXTRACT }

Functions
Canvas::Handle	open_svg (std::string _filepath, String &errors, String &warnings)
Canvas::Handle	open_canvas_as (const FileSystem::Identifier &identifier, const String &as, String &errors, String &warnings)
	Loads a canvas from filename and its absolute path.
void	optimize_layers (Time, Context, CanvasHandle, bool seen_motion_blur=false)
template<>
CairoColor	blendfunc_COMPOSITE (CairoColor &a, CairoColor &b, float amount)
template<>
CairoColor	blendfunc_STRAIGHT (CairoColor &a, CairoColor &b, float amount)
template<>
CairoColor	blendfunc_ONTO (CairoColor &a, CairoColor &b, float amount)
template<>
CairoColor	blendfunc_STRAIGHT_ONTO (CairoColor &a, CairoColor &b, float amount)
template<>
CairoColor	blendfunc_BRIGHTEN (CairoColor &a, CairoColor &b, float amount)
template<>
CairoColor	blendfunc_DARKEN (CairoColor &a, CairoColor &b, float amount)
template<>
CairoColor	blendfunc_ADD (CairoColor &a, CairoColor &b, float amount)
template<>
CairoColor	blendfunc_SUBTRACT (CairoColor &a, CairoColor &b, float amount)
template<>
CairoColor	blendfunc_DIFFERENCE (CairoColor &a, CairoColor &b, float amount)
template<>
CairoColor	blendfunc_MULTIPLY (CairoColor &a, CairoColor &b, float amount)
template<>
CairoColor	blendfunc_DIVIDE (CairoColor &a, CairoColor &b, float amount)
template<>
CairoColor	blendfunc_COLOR (CairoColor &a, CairoColor &b, float amount)
template<>
CairoColor	blendfunc_HUE (CairoColor &a, CairoColor &b, float amount)
template<>
CairoColor	blendfunc_SATURATION (CairoColor &a, CairoColor &b, float amount)
template<>
CairoColor	blendfunc_LUMINANCE (CairoColor &a, CairoColor &b, float amount)
template<>
CairoColor	blendfunc_BEHIND (CairoColor &a, CairoColor &b, float amount)
template<>
CairoColor	blendfunc_ALPHA_BRIGHTEN (CairoColor &a, CairoColor &b, float amount)
template<>
CairoColor	blendfunc_ALPHA_DARKEN (CairoColor &a, CairoColor &b, float amount)
template<>
CairoColor	blendfunc_SCREEN (CairoColor &a, CairoColor &b, float amount)
template<>
CairoColor	blendfunc_OVERLAY< CairoColor > (CairoColor &a, CairoColor &b, float amount)
template<>
CairoColor	blendfunc_HARD_LIGHT (CairoColor &a, CairoColor &b, float amount)
template<>
CairoColor	blendfunc_ALPHA_OVER (CairoColor &a, CairoColor &b, float amount)
template<class C >
C	blendfunc_COMPOSITE (C &src, C &dest, float amount)
template<class C >
C	blendfunc_STRAIGHT (C &src, C &bg, float amount)
template<class C >
C	blendfunc_ONTO (C &a, C &b, float amount)
template<class C >
C	blendfunc_STRAIGHT_ONTO (C &a, C &b, float amount)
template<class C >
C	blendfunc_BRIGHTEN (C &a, C &b, float amount)
template<class C >
C	blendfunc_DARKEN (C &a, C &b, float amount)
template<class C >
C	blendfunc_ADD (C &a, C &b, float amount)
template<class C >
C	blendfunc_SUBTRACT (C &a, C &b, float amount)
template<class C >
C	blendfunc_DIFFERENCE (C &a, C &b, float amount)
template<class C >
C	blendfunc_MULTIPLY (C &a, C &b, float amount)
template<class C >
C	blendfunc_DIVIDE (C &a, C &b, float amount)
template<class C >
C	blendfunc_COLOR (C &a, C &b, float amount)
template<class C >
C	blendfunc_HUE (C &a, C &b, float amount)
template<class C >
C	blendfunc_SATURATION (C &a, C &b, float amount)
template<class C >
C	blendfunc_LUMINANCE (C &a, C &b, float amount)
template<class C >
C	blendfunc_BEHIND (C &a, C &b, float amount)
template<class C >
C	blendfunc_ALPHA_BRIGHTEN (C &a, C &b, float amount)
template<class C >
C	blendfunc_ALPHA_DARKEN (C &a, C &b, float amount)
template<class C >
C	blendfunc_SCREEN (C &a, C &b, float amount)
template<class C >
C	blendfunc_OVERLAY (C &a, C &b, float amount)
template<class C >
C	blendfunc_HARD_LIGHT (C &a, C &b, float amount)
template<class C >
C	blendfunc_ALPHA_OVER (C &a, C &b, float amount)
PixelFormat	operator\| (PixelFormat lhs, PixelFormat rhs)
PixelFormat	operator& (PixelFormat lhs, PixelFormat rhs)
int	channels (const PixelFormat x)
	Returns the number of channels that the given PixelFormat calls for.
unsigned char *	Color2PixelFormat (const Color &color, const PixelFormat &pf, unsigned char *out, const Gamma &gamma)
void	convert_color_format (unsigned char dest, const Color src, int w, PixelFormat pf, const Gamma &gamma)
const unsigned char *	PixelFormat2Color (Color &color, const PixelFormat &pf, const unsigned char *out)
Real	line_point_distsq (const Point &p1, const Point &p2, const Point &p, float &t)
int	intersect (const Point &p1, const Vector &v1, float &t1, const Point &p2, const Vector &v2, float &t2)
bool	intersect_line_segments (const Point &a, const Point &b, float &tout, const Point &c, const Point &d, float &sout)
Real	find_closest (const etl::bezier< Point > &curve, const Point &point, float step, Real closest, float t)
template<typename T >
void	Bound (etl::rect< T > &r, const etl::bezier< Point > &b)
int	intersect (const Rect &r1, const Point &p, const Vector &v)
int	intersect (const Rect &r1, const Point &p)
int	intersect (const BezHull &bh, const Point &p, const Vector &v)
int	intersect (const etl::bezier< Point > &b, const Point &p)
void	shutdown ()
	Shutdown the synfig environment.
void	error (const char *format,...)
	Reports an error.
void	error (const String &str)
void	warning (const char *format,...)
	Reports a warning.
void	warning (const String &str)
void	info (const char *format,...)
	Reports some information.
void	info (const String &str)
String	get_binary_path (const String &fallback_path)
	Returns absolute path to the binary.
Canvas::Handle	open_canvas (xmlpp::Element *node, String &errors, String &warnings)
	Loads a canvas from current xmlpp Element.
std::map< String, etl::loose_handle< Canvas > > &	get_open_canvas_map ()
TimePoint	operator+ (TimePoint lhs, const Time &rhs)
TimePoint	operator- (TimePoint lhs, const Time &rhs)
bool	operator< (const TimePoint &lhs, const TimePoint &rhs)
bool	operator< (const TimePoint &lhs, const Time &rhs)
bool	operator< (const Time &lhs, const TimePoint &rhs)
bool	operator== (const TimePoint &lhs, const TimePoint &rhs)
bool	operator!= (const TimePoint &lhs, const TimePoint &rhs)
synfig::Node *	find_node (const synfig::GUID &guid)
template<typename T >
etl::handle< T >	guid_cast (const synfig::GUID &guid)
	Returns a Handle to the Node by its GUID.
RendDesc::Lock	operator\| (RendDesc::Lock lhs, RendDesc::Lock rhs)
	This operator allows the combining of RendDesc::Lock flags using the '\|' operator.
RendDesc::Lock	operator& (RendDesc::Lock lhs, RendDesc::Lock rhs)
	This operator allows the masking of RendDesc::Lock flags using the '&' operator.
RendDesc::Lock	operator~ (RendDesc::Lock rhs)
	This operator allows the inverting of RendDesc::Lock flags using the '~' operator.
bool	render (Context context, Target_Scanline::Handle target, const RendDesc &desc, ProgressCallback *)
	Renders starting at context to target.
bool	cairorender (Context context, cairo_surface_t surface, const RendDesc &desc, ProgressCallback cb=NULL)
bool	cairorender (Context context, cairo_t cr, const RendDesc &desc, ProgressCallback cb=NULL)
bool	parametric_render (Context context, Surface &surface, const RendDesc &desc, ProgressCallback *)
bool	render_threaded (Context context, Target_Scanline::Handle target, const RendDesc &desc, ProgressCallback *callback, int threads)
bool	save_canvas (const FileSystem::Identifier &identifier, Canvas::ConstHandle canvas, bool safe=true)
	Saves a canvas to filename.
String	canvas_to_string (Canvas::ConstHandle canvas)
	Stores a Canvas in a string in XML format.
void	set_save_canvas_external_file_callback (save_canvas_external_file_callback_t callback, void *user_data)
void	set_file_version (ReleaseVersion version)
ReleaseVersion	get_file_version ()
etl::handle< Target_Scanline >	surface_target (Surface *surface)
	Creates a target that will render to surface.
etl::handle< Target_Cairo >	cairo_image_target (cairo_surface_t **surface)
	Creates a target that will render to a cairo_surface_t image surface.
Time::Format	operator\| (Time::Format lhs, Time::Format rhs)
	This operator allows the combining of Time::Format flags using the '\|' operator.
bool	operator<= (Time::Format lhs, Time::Format rhs)
	This operator is for checking Time::Format flags.
int	waypoint_collect (std::set< Waypoint, std::less< UniqueID > > &waypoint_set, const Time &time, const etl::handle< Node > &node)
int	activepoint_collect (std::set< Activepoint, std::less< UniqueID > > &activepoint_set, const Time &time, const etl::handle< Node > &node)
ValueNode::LooseHandle	find_value_node (const GUID &guid)
ValueBase	convert_bline_to_segment_list (const ValueBase &bline)
	Converts a list of bline points into a list of segments.
ValueBase	convert_bline_to_width_list (const ValueBase &bline)
	Converts a list of bline points into a list of widths.
Real	find_closest_point (const ValueBase &bline, const Point &pos, Real &radius, bool loop, Point *out_point=0)
	Finds the closest point to pos in bline.
Real	std_to_hom (const ValueBase &bline, Real pos, bool index_loop, bool bline_loop)
	Converts from standard to homogeneous index (considers the length)
Real	hom_to_std (const ValueBase &bline, Real pos, bool index_loop, bool bline_loop)
	Converts from homogeneous to standard index.
Real	bline_length (const ValueBase &bline, bool bline_loop, std::vector< Real > *lengths)
	Returns the length of the bline.
synfig::ValueBase	convert_bline_to_wplist (const ValueBase &bline)
	Converts a ValueNode_BLine into a WidthPoint list.
synfig::Real	widthpoint_interpolate (const WidthPoint &prev, const WidthPoint &next, const Real position, const Real smoothness=0.0)
	synfig::widthpoint_interpolate
bool	check_version_ (int v, int vec_size, int color_size, int canvas_size, int layer_size)
	Version checker.
const char *	get_version ()
const char *	get_build_date ()

Variables
Type &	type_bool = TypeBool::instance
Type &	type_integer = TypeInteger::instance
Type &	type_angle = TypeAngle::instance
Type &	type_time = TypeTime::instance
Type &	type_real = TypeReal::instance
Type &	type_vector = TypeVector::instance
Type &	type_color = TypeColor::instance
Type &	type_segment = TypeSegment::instance
Type &	type_bline_point = TypeBLinePoint::instance
Type &	type_matrix = TypeMatrix::instance
Type &	type_bone_weight_pair = TypeBoneWeightPair::instance
Type &	type_width_point = TypeWidthPoint::instance
Type &	type_dash_item = TypeDashItem::instance
Type &	type_list = TypeList::instance
Type &	type_canvas = TypeCanvas::instance
Type &	type_string = TypeString::instance
Type &	type_gradient = TypeGradient::instance
Type &	type_bone_object = TypeBoneObject::instance
Type &	type_bone_valuenode = TypeBoneValueNode::instance
Type &	type_transformation = TypeTransformation::instance
static const float	EncodeYUV [3][3]
static const float	DecodeYUV [3][3]
Type &	type_nil = types_namespace::TypeNil::instance

Detailed Description

Where every function and class of the synfig library can be found.

Todo:: Writeme

Typedef Documentation

typedef struct synfig::matrix_t synfig::SVGMatrix

typedef struct synfig::stop_t synfig::ColorStop

typedef struct synfig::linear_g synfig::LinearGradient

typedef struct synfig::radial_g synfig::RadialGradient

typedef struct synfig::url_t synfig::URL

typedef struct synfig::Vertex_t synfig::Vertex

typedef struct synfig::bline_t synfig::BLine

synfig::Angle

Todo:: writeme

typedef etl::handle<Canvas> synfig::CanvasHandle

typedef std::deque< etl::handle< Layer > > synfig::CanvasBase

typedef CairoColor(* synfig::cairoblendfunc)(CairoColor &, CairoColor &, float)

typedef Color(* synfig::blendfunc)(Color &, Color &, float)

typedef float synfig::ColorReal

typedef Color synfig::ColorAccumulator

typedef Vector synfig::Point

Todo:: writeme

typedef ProgressCallback synfig::ProgressManager

typedef etl::handle<Node> synfig::NodeHandle

synfig::Real

Todo:: writeme

typedef bool(* synfig::save_canvas_external_file_callback_t)(void *user_data, Layer::ConstHandle layer, const std::string &param_name, std::string &filename)

typedef etl::smart_ptr<FILE,_FILE_deleter> synfig::SmartFILE

typedef std::string synfig::String

Todo:: writeme

Todo:: writeme

typedef unsigned int synfig::TypeId

typedef ValueNode_WPList::ListEntry::ActivepointList synfig::ActivepointList

typedef ValueNode_DynamicList::ListEntry::Activepoint synfig::Activepoint

typedef std::vector< Waypoint > synfig::WaypointList

Enumeration Type Documentation

enum synfig::PixelFormat

Enumerator:

PF_RGB
PF_GRAY	If set, use one grayscale channel. If clear, use three channels for RGB.
PF_A	If set, include alpha channel.
PF_Z	If set, include ZDepth channel.
PF_BGR	If set, reverse the order of the RGB channels.
PF_A_START	If set, alpha channel is before the color data. If clear, it is after.
PF_Z_START	If set, ZDepth channel is before the color data. If clear, it is after.
PF_ZA	If set, the ZDepth channel will be in front of the alpha channel. If clear, they are reversed.
PF_A_INV	If set, the alpha channel is stored as 1.0-a.
PF_Z_INV	If set, the ZDepth channel is stored as 1.0-z.
PF_RAW_COLOR	If set, the data represents a raw Color data structure, and all other bits are ignored.

enum synfig::Interpolation

Enumerator:

INTERPOLATION_TCB
INTERPOLATION_CONSTANT
INTERPOLATION_LINEAR
INTERPOLATION_HALT
INTERPOLATION_MANUAL
INTERPOLATION_UNDEFINED
INTERPOLATION_NIL
INTERPOLATION_CLAMPED

enum synfig::ReleaseVersion

Enumerator:

RELEASE_VERSION_0_61_06
RELEASE_VERSION_0_61_07
RELEASE_VERSION_0_61_08
RELEASE_VERSION_0_61_09
RELEASE_VERSION_0_62_00
RELEASE_VERSION_0_62_01
RELEASE_VERSION_0_62_02
RELEASE_VERSION_0_63_00
RELEASE_VERSION_0_63_01
RELEASE_VERSION_0_63_02
RELEASE_VERSION_0_63_03
RELEASE_VERSION_0_63_04
RELEASE_VERSION_0_63_05
RELEASE_VERSION_0_64_0
RELEASE_VERSION_0_64_1
RELEASE_VERSION_0_64_2
RELEASE_VERSION_0_64_3
RELEASE_VERSION_1_0
RELEASE_VERSION_1_0_2
RELEASE_VERSION_END

enum synfig::RenderMethod

Available rendering methods.

Enumerator:

SOFTWARE	Software rendering.
OPENGL	OpenGL rendering (not supported)
CAIRO	Cairo rendering.

enum synfig::TargetAlphaMode

Enumerator:

TARGET_ALPHA_MODE_KEEP
TARGET_ALPHA_MODE_FILL
TARGET_ALPHA_MODE_REDUCE
TARGET_ALPHA_MODE_EXTRACT

Function Documentation

Canvas::Handle synfig::open_svg	(	std::string	_filepath,
		String &	errors,
		String &	warnings
	)

References synfig::Svg_parser::load_svg_canvas().

Referenced by svg_layer::set_param().

Canvas::Handle synfig::open_canvas_as	(	const FileSystem::Identifier &	identifier,
		const String &	as,
		String &	errors,
		String &	warnings
	)

Loads a canvas from filename and its absolute path.

Returns: The Canvas's handle on success, an empty handle on failure

References _, synfig::CanvasParser::error_count(), synfig::FileSystem::Identifier::filename, synfig::CanvasParser::get_errors_text(), synfig::CanvasParser::get_warnings_text(), synfig::CanvasParser::parse_from_file_as(), synfig::CanvasParser::set_allow_errors(), and warning().

Referenced by OptionsProcessor::extract_job(), synfig::Canvas::find_canvas(), and synfig::Canvas::surefind_canvas().

void synfig::optimize_layers	(	Time	time,
		Context	context,
		CanvasHandle	op_canvas,
		bool	seen_motion_blur = `false`
	)

Optimize layers based on its calculated Z depth to perform a quick render of the layers to the output.

References synfig::Context::active(), synfig::Layer_PasteCanvas::apply_z_range_to_params(), synfig::Color::BLEND_COMPOSITE, synfig::ValueNode_Const::create(), synfig::LinkableValueNode::create(), synfig::Layer::create(), synfig::Canvas::create_inline(), synfig::Layer::dynamic_param_list(), synfig::ValueBase::get(), synfig::Layer_Composite::get_amount(), synfig::Layer_Composite::get_blend_method(), synfig::Layer::get_name(), synfig::Layer_PasteCanvas::get_origin(), synfig::Layer_PasteCanvas::get_param(), synfig::Layer::get_param(), synfig::Layer::get_param_list(), synfig::Context::get_params(), synfig::Layer::get_parent_canvas_grow_value(), synfig::Layer_PasteCanvas::get_sub_canvas(), synfig::Layer_PasteCanvas::get_time_offset(), info(), type_integer, type_real, and synfig::Context::z_depth_visibility().

Referenced by synfig::Target_Scanline::render(), synfig::Target_Cairo::render(), synfig::Target_Tile::render(), and synfig::Target_Cairo_Tile::render().

template<>

CairoColor synfig::blendfunc_COMPOSITE	(	CairoColor &	a,
		CairoColor &	b,
		float	amount
	)

References synfig::CairoColor::alpha(), COLOR_EPSILON, synfig::CairoColor::get_a(), synfig::CairoColor::get_b(), synfig::CairoColor::get_g(), and synfig::CairoColor::get_r().

Referenced by blendfunc_BEHIND(), and blendfunc_ONTO().

template<>

CairoColor synfig::blendfunc_STRAIGHT	(	CairoColor &	a,
		CairoColor &	b,
		float	amount
	)

References synfig::CairoColor::alpha(), COLOR_EPSILON, synfig::CairoColor::get_a(), synfig::CairoColor::get_b(), synfig::CairoColor::get_g(), and synfig::CairoColor::get_r().

Referenced by blendfunc_ALPHA_OVER(), and blendfunc_STRAIGHT_ONTO().

template<>

CairoColor synfig::blendfunc_ONTO	(	CairoColor &	a,
		CairoColor &	b,
		float	amount
	)

References blendfunc_COMPOSITE(), synfig::CairoColor::get_a(), and synfig::CairoColor::set_a().

Referenced by blendfunc_HARD_LIGHT(), blendfunc_OVERLAY(), and blendfunc_SCREEN().

template<>

CairoColor synfig::blendfunc_STRAIGHT_ONTO	(	CairoColor &	a,
		CairoColor &	b,
		float	amount
	)

References synfig::CairoColor::blend(), synfig::Color::BLEND_STRAIGHT, synfig::CairoColor::get_a(), and synfig::CairoColor::set_a().

template<>

CairoColor synfig::blendfunc_BRIGHTEN	(	CairoColor &	a,
		CairoColor &	b,
		float	amount
	)

References synfig::CairoColor::get_a(), synfig::CairoColor::get_b(), synfig::CairoColor::get_g(), and synfig::CairoColor::get_r().

template<>

CairoColor synfig::blendfunc_DARKEN	(	CairoColor &	a,
		CairoColor &	b,
		float	amount
	)

References synfig::CairoColor::get_a(), synfig::CairoColor::get_b(), synfig::CairoColor::get_g(), and synfig::CairoColor::get_r().

template<>

CairoColor synfig::blendfunc_ADD	(	CairoColor &	a,
		CairoColor &	b,
		float	amount
	)

References synfig::CairoColor::get_a(), synfig::CairoColor::get_b(), synfig::CairoColor::get_g(), and synfig::CairoColor::get_r().

template<>

CairoColor synfig::blendfunc_SUBTRACT	(	CairoColor &	a,
		CairoColor &	b,
		float	amount
	)

References synfig::CairoColor::get_a(), synfig::CairoColor::get_b(), synfig::CairoColor::get_g(), and synfig::CairoColor::get_r().

template<>

CairoColor synfig::blendfunc_DIFFERENCE	(	CairoColor &	a,
		CairoColor &	b,
		float	amount
	)

References std::abs(), synfig::CairoColor::get_a(), synfig::CairoColor::get_b(), synfig::CairoColor::get_g(), and synfig::CairoColor::get_r().

template<>

CairoColor synfig::blendfunc_MULTIPLY	(	CairoColor &	a,
		CairoColor &	b,
		float	amount
	)

References synfig::CairoColor::get_a(), synfig::CairoColor::get_b(), synfig::CairoColor::get_g(), synfig::CairoColor::get_r(), synfig::CairoColor::set_b(), synfig::CairoColor::set_g(), and synfig::CairoColor::set_r().

template<>

CairoColor synfig::blendfunc_DIVIDE	(	CairoColor &	a,
		CairoColor &	b,
		float	amount
	)

References COLOR_EPSILON, synfig::CairoColor::get_a(), synfig::CairoColor::get_b(), synfig::CairoColor::get_g(), and synfig::CairoColor::get_r().

template<>

CairoColor synfig::blendfunc_COLOR	(	CairoColor &	a,
		CairoColor &	b,
		float	amount
	)

References synfig::Color::blend(), and synfig::Color::BLEND_COLOR.

template<>

CairoColor synfig::blendfunc_HUE	(	CairoColor &	a,
		CairoColor &	b,
		float	amount
	)

References synfig::Color::blend(), and synfig::Color::BLEND_HUE.

template<>

CairoColor synfig::blendfunc_SATURATION	(	CairoColor &	a,
		CairoColor &	b,
		float	amount
	)

References synfig::Color::blend(), and synfig::Color::BLEND_SATURATION.

template<>

CairoColor synfig::blendfunc_LUMINANCE	(	CairoColor &	a,
		CairoColor &	b,
		float	amount
	)

References synfig::Color::blend(), and synfig::Color::BLEND_LUMINANCE.

template<>

CairoColor synfig::blendfunc_BEHIND	(	CairoColor &	a,
		CairoColor &	b,
		float	amount
	)

References synfig::CairoColor::blend(), synfig::Color::BLEND_COMPOSITE, synfig::CairoColor::get_a(), and synfig::CairoColor::set_a().

template<>

CairoColor synfig::blendfunc_ALPHA_BRIGHTEN	(	CairoColor &	a,
		CairoColor &	b,
		float	amount
	)

References synfig::CairoColor::get_a(), synfig::CairoColor::get_b(), synfig::CairoColor::get_g(), and synfig::CairoColor::get_r().

template<>

CairoColor synfig::blendfunc_ALPHA_DARKEN	(	CairoColor &	a,
		CairoColor &	b,
		float	amount
	)

References synfig::CairoColor::get_a(), synfig::CairoColor::get_b(), synfig::CairoColor::get_g(), and synfig::CairoColor::get_r().

template<>

CairoColor synfig::blendfunc_SCREEN	(	CairoColor &	a,
		CairoColor &	b,
		float	amount
	)

References blendfunc_ONTO(), synfig::CairoColor::get_b(), synfig::CairoColor::get_g(), synfig::CairoColor::get_r(), synfig::CairoColor::set_b(), synfig::CairoColor::set_g(), and synfig::CairoColor::set_r().

template<>

CairoColor synfig::blendfunc_OVERLAY< CairoColor >	(	CairoColor &	a,
		CairoColor &	b,
		float	amount
	)

References synfig::CairoColor::blend(), synfig::Color::BLEND_ONTO, and synfig::CairoColor::get_r().

Referenced by synfig::CairoColor::blend().

template<>

CairoColor synfig::blendfunc_HARD_LIGHT	(	CairoColor &	a,
		CairoColor &	b,
		float	amount
	)

References synfig::CairoColor::blend(), synfig::Color::BLEND_ONTO, synfig::CairoColor::get_a(), synfig::CairoColor::get_b(), synfig::CairoColor::get_g(), and synfig::CairoColor::get_r().

template<>

CairoColor synfig::blendfunc_ALPHA_OVER	(	CairoColor &	a,
		CairoColor &	b,
		float	amount
	)

References synfig::CairoColor::blend(), synfig::Color::BLEND_STRAIGHT, synfig::CairoColor::get_a(), and synfig::CairoColor::set_a().

template<class C >

C synfig::blendfunc_COMPOSITE	(	C &	src,
		C &	dest,
		float	amount
	)

References COLOR_EPSILON, and synfig::CairoColor::get_a().

template<class C >

C synfig::blendfunc_STRAIGHT	(	C &	src,
		C &	bg,
		float	amount
	)

References COLOR_EPSILON, and synfig::CairoColor::set_a().

template<class C >

C synfig::blendfunc_ONTO	(	C &	a,
		C &	b,
		float	amount
	)

References blendfunc_COMPOSITE().

template<class C >

C synfig::blendfunc_STRAIGHT_ONTO	(	C &	a,
		C &	b,
		float	amount
	)

References blendfunc_STRAIGHT(), and synfig::CairoColor::set_a().

template<class C >

C synfig::blendfunc_BRIGHTEN	(	C &	a,
		C &	b,
		float	amount
	)

References synfig::CairoColor::set_b(), synfig::CairoColor::set_g(), and synfig::CairoColor::set_r().

template<class C >

C synfig::blendfunc_DARKEN	(	C &	a,
		C &	b,
		float	amount
	)

template<class C >

C synfig::blendfunc_ADD	(	C &	a,
		C &	b,
		float	amount
	)

References synfig::CairoColor::set_b(), synfig::CairoColor::set_g(), and synfig::CairoColor::set_r().

template<class C >

C synfig::blendfunc_SUBTRACT	(	C &	a,
		C &	b,
		float	amount
	)

References synfig::CairoColor::set_b(), synfig::CairoColor::set_g(), and synfig::CairoColor::set_r().

template<class C >

C synfig::blendfunc_DIFFERENCE	(	C &	a,
		C &	b,
		float	amount
	)

References std::abs(), synfig::CairoColor::set_b(), synfig::CairoColor::set_g(), and synfig::CairoColor::set_r().

template<class C >

C synfig::blendfunc_MULTIPLY	(	C &	a,
		C &	b,
		float	amount
	)

References synfig::CairoColor::get_a().

template<class C >

C synfig::blendfunc_DIVIDE	(	C &	a,
		C &	b,
		float	amount
	)

References COLOR_EPSILON, and synfig::CairoColor::get_a().

template<class C >

C synfig::blendfunc_COLOR	(	C &	a,
		C &	b,
		float	amount
	)

template<class C >

C synfig::blendfunc_HUE	(	C &	a,
		C &	b,
		float	amount
	)

template<class C >

C synfig::blendfunc_SATURATION	(	C &	a,
		C &	b,
		float	amount
	)

template<class C >

C synfig::blendfunc_LUMINANCE	(	C &	a,
		C &	b,
		float	amount
	)

template<class C >

C synfig::blendfunc_BEHIND	(	C &	a,
		C &	b,
		float	amount
	)

<

Todo:: this is a hack

References blendfunc_COMPOSITE(), COLOR_EPSILON, and synfig::CairoColor::set_a().

template<class C >

C synfig::blendfunc_ALPHA_BRIGHTEN	(	C &	a,
		C &	b,
		float	amount
	)

References synfig::CairoColor::set_a().

template<class C >

C synfig::blendfunc_ALPHA_DARKEN	(	C &	a,
		C &	b,
		float	amount
	)

References synfig::CairoColor::set_a().

template<class C >

C synfig::blendfunc_SCREEN	(	C &	a,
		C &	b,
		float	amount
	)

References blendfunc_ONTO().

template<class C >

C synfig::blendfunc_OVERLAY	(	C &	a,
		C &	b,
		float	amount
	)

References blendfunc_ONTO().

template<class C >

C synfig::blendfunc_HARD_LIGHT	(	C &	a,
		C &	b,
		float	amount
	)

References blendfunc_ONTO().

template<class C >

C synfig::blendfunc_ALPHA_OVER	(	C &	a,
		C &	b,
		float	amount
	)

References blendfunc_STRAIGHT().

PixelFormat synfig::operator\|	(	PixelFormat	lhs,
		PixelFormat	rhs
	)

inline

PixelFormat synfig::operator&	(	PixelFormat	lhs,
		PixelFormat	rhs
	)

inline

int synfig::channels ( const PixelFormat x )

inline

Returns the number of channels that the given PixelFormat calls for.

References FLAGS, PF_A, PF_GRAY, PF_RAW_COLOR, and PF_Z.

Referenced by imagemagick_trgt::end_scanline(), imagemagick_trgt::init(), bmp::start_frame(), and imagemagick_trgt::start_frame().

unsigned char* synfig::Color2PixelFormat	(	const Color &	color,
		const PixelFormat &	pf,
		unsigned char *	out,
		const Gamma &	gamma
	)

inline

References synfig::Gamma::b_F32_to_U8(), FLAGS, synfig::Gamma::g_F32_to_U8(), synfig::Color::get_a(), synfig::Color::get_b(), synfig::Color::get_g(), synfig::Color::get_r(), synfig::Color::get_y(), PF_A, PF_A_INV, PF_A_START, PF_BGR, PF_GRAY, PF_RAW_COLOR, PF_Z, PF_Z_START, PF_ZA, and synfig::Gamma::r_F32_to_U8().

Referenced by convert_color_format().

void synfig::convert_color_format	(	unsigned char *	dest,
		const Color *	src,
		int	w,
		PixelFormat	pf,
		const Gamma &	gamma
	)

inline

References Color2PixelFormat().

Referenced by bmp::end_scanline(), ppm::end_scanline(), dv_trgt::end_scanline(), imagemagick_trgt::end_scanline(), png_trgt::end_scanline(), ffmpeg_trgt::end_scanline(), jpeg_trgt::end_scanline(), magickpp_trgt::end_scanline(), mng_trgt::end_scanline(), and png_trgt_spritesheet::write_png_file().

const unsigned char* synfig::PixelFormat2Color	(	Color &	color,
		const PixelFormat &	pf,
		const unsigned char *	out
	)

inline

References FLAGS, PF_A, PF_A_START, PF_BGR, PF_GRAY, PF_Z, PF_Z_START, PF_ZA, synfig::Color::set_a(), synfig::Color::set_b(), synfig::Color::set_g(), synfig::Color::set_r(), and synfig::Color::set_yuv().

Real synfig::line_point_distsq	(	const Point &	p1,
		const Point &	p2,
		const Point &	p,
		float &	t
	)

inline

References synfig::Vector::mag_squared().

Referenced by synfig::BezHull::Bound(), and find_closest().

int synfig::intersect	(	const Point &	p1,
		const Vector &	v1,
		float &	t1,
		const Point &	p2,
		const Vector &	v2,
		float &	t2
	)

References ERR.

Referenced by synfig::Layer_SphereDistort::accelerated_cairorender(), synfig::Layer_SphereDistort::accelerated_render(), synfig::Layer_Shape::get_color(), synfig::Layer_Shape::hit_check(), intersect_line_segments(), synfig::Rect::operator&&(), and recurse_intersect().

bool synfig::intersect_line_segments	(	const Point &	a,
		const Point &	b,
		float &	tout,
		const Point &	c,
		const Point &	d,
		float &	sout
	)

inline

References intersect().

Real synfig::find_closest	(	const etl::bezier< Point > &	curve,
		const Point &	point,
		float	step,
		Real *	closest,
		float *	t
	)

References line_point_distsq().

template<typename T >

void synfig::Bound	(	etl::rect< T > &	r,
		const etl::bezier< Point > &	b
	)

inline

Referenced by intersect(), and synfig::CIntersect::operator()().

int synfig::intersect	(	const Rect &	r1,
		const Point &	p,
		const Vector &	v
	)

References ERR.

Referenced by Warp::accelerated_cairorender(), Warp::accelerated_render(), synfig::Layer_PasteCanvas::accelerated_render(), and Rectangle::hit_check().

int synfig::intersect	(	const Rect &	r1,
		const Point &	p
	)

int synfig::intersect	(	const BezHull &	bh,
		const Point &	p,
		const Vector &	v
	)

References ERR, synfig::BezHull::p, and synfig::BezHull::size.

int synfig::intersect	(	const etl::bezier< Point > &	b,
		const Point &	p
	)

void synfig::shutdown ( )

Shutdown the synfig environment.

void synfig::error	(	const char *	format,
			...
	)

Reports an error.

Call this when an error occurs, describing what happened

Referenced by synfig::Context::accelerated_cairorender(), synfig::Layer_PasteCanvas::accelerated_cairorender(), synfig::Context::accelerated_render(), Layer_Freetype::accelerated_render(), synfig::Canvas::add_value_node(), synfig::Exception::BadFrameRate::BadFrameRate(), synfig::Exception::BadLinkName::BadLinkName(), synfig::Exception::BadTime::BadTime(), cairo_paint_with_alpha_operator(), cairo_renddesc_untransform(), synfig::CairoListImporter::CairoListImporter(), check_version_(), synfig::Canvas::clone(), synfig::LinkableValueNode::create(), encode_animated(), encode_interpolation(), encode_layer(), encode_value(), encode_value_node(), encode_value_node_bone(), yuv::end_frame(), mng_trgt::end_frame(), gif::end_frame(), mng_trgt::end_scanline(), synfig::FileSystemNative::file_rename(), synfig::Exception::FileNotFound::FileNotFound(), freetype_constructor(), get_binary_path(), synfig::ValueNode_Bone::get_bones_referenced_by(), exr_mptr::get_frame(), bmp_mptr::get_frame(), imagemagick_mptr::get_frame(), synfig::ListImporter::get_frame(), synfig::CairoListImporter::get_frame(), synfig::ValueNode_BoneInfluence::get_inverse_transform(), hom_to_std(), synfig::Exception::IDAlreadyExists::IDAlreadyExists(), dv_trgt::init(), ffmpeg_trgt::init(), mng_trgt::init(), gif::init(), jpeg_mptr::jpeg_mptr(), synfig::ListImporter::ListImporter(), png_trgt_spritesheet::load_png_file(), synfig::CairoSurface::map_cairo_image(), mng_error_proc(), cairo_png_trgt::obtain_surface(), synfig::Importer::open(), synfig::CairoImporter::open(), open_canvas(), synfig::ValueNode_RadialComposite::operator()(), synfig::ValueNode_Composite::operator()(), synfig::Gradient::operator()(), synfig::Distance::operator=(), synfig::CanvasParser::parse_as(), synfig::CanvasParser::parse_from_file_as(), png_mptr::png_mptr(), png_trgt_spritesheet::read_png_file(), save_canvas(), synfig::FileContainerTemporary::save_temporary(), synfig::Layer_Bitmap::set_cairo_surface(), synfig::CairoSurface::set_cairo_surface(), synfig::ValueNode_Bone::set_link_vfunc(), Import::set_param(), png_trgt_spritesheet::set_rend_desc(), setup_job(), synfig::Layer_Shape::shape_to_cairo(), bmp::start_frame(), imagemagick_trgt::start_frame(), png_trgt::start_frame(), mng_trgt::start_frame(), synfig::Module::subsys_init(), supersample_helper(), Outline::sync(), Advanced_Outline::sync(), synfig::CairoSurface::unmap_cairo_image(), png_trgt_spritesheet::write_png_file(), magickpp_trgt::~magickpp_trgt(), and mng_trgt::~mng_trgt().

void synfig::error ( const String & str )

References _, and current_time().

void synfig::warning	(	const char *	format,
			...
	)

Reports a warning.

Call this when something questionable occurs, describing what happened

Referenced by RadialBlur::accelerated_cairorender(), synfig::Layer_SphereDistort::accelerated_cairorender(), SpiralGradient::accelerated_cairorender(), FilledRect::accelerated_cairorender(), CurveGradient::accelerated_cairorender(), synfig::Layer_SphereDistort::accelerated_render(), synfig::Layer_Shape::accelerated_render(), Layer_Freetype::accelerated_render(), synfig::Layer_PasteCanvas::accelerated_render(), broken_pipe_signal(), copy_image_list(), encode_canvas_toplevel(), encode_linkable_value_node(), encode_subtract(), OptionsProcessor::extract_renddesc(), bmp_mptr::get_frame(), synfig::Layer::get_parent_paste_canvas_layer(), synfig::ValueNode_Bone::get_possible_parent_bones(), synfig::Distance::ident_system(), open_canvas_as(), synfig::ValueNode_DIList::operator()(), synfig::ValueNode_WPList::operator()(), synfig::ValueNode_BLine::operator()(), synfig::ValueNode_StaticList::operator()(), synfig::ValueNode_DynamicList::operator()(), cairo_png_trgt::put_surface(), synfig::Layer::render_transformed(), Region::set_param(), Import::set_param(), Outline::set_param(), synfig::Layer_Composite::set_param(), synfig::ValueNode_Bone::set_root_canvas(), synfig::CairoSurface::set_wh(), synfig::Layer_Shape::shape_to_cairo(), Region::sync(), Outline::sync(), Advanced_Outline::sync(), synfig::Time::Time(), synfig::Canvas::~Canvas(), magickpp_trgt::~magickpp_trgt(), and synfig::Main::~Main().

void synfig::warning ( const String & str )

References _, and current_time().

void synfig::info	(	const char *	format,
			...
	)

Reports some information.

Call this to report various information. Please be sparse...

Referenced by Layer_Shade::accelerated_cairorender(), LumaKey::accelerated_cairorender(), Layer_Bevel::accelerated_cairorender(), synfig::Context::accelerated_cairorender(), synfig::Context::accelerated_render(), synfig::CairoListImporter::CairoListImporter(), synfig::FileContainerTemporary::directory_create(), synfig::FileContainerZip::directory_create(), synfig::KeyframeList::dump(), gif::end_frame(), synfig::Layer_Shape::feather_cairo_surface(), synfig::FileContainerZip::file_open_write(), synfig::FileContainerTemporary::file_remove(), synfig::Layer_Shape::hit_check(), synfig::ListImporter::ListImporter(), synfig::Main::Main(), synfig::FileContainerZip::open_from_history(), synfig::FileContainerTemporary::open_temporary(), Blur::operator()(), optimize_layers(), synfig::CanvasParser::parse_from_file_as(), png_mptr::png_mptr(), synfig::Target_Scanline::render(), synfig::FileContainerZip::save(), Import::set_param(), synfig::Canvas::set_time(), setup_job(), synfig::Layer_Shape::shape_to_cairo(), magickpp_trgt::~magickpp_trgt(), and mng_trgt::~mng_trgt().

void synfig::info ( const String & str )

References _, and current_time().

String synfig::get_binary_path ( const String & fallback_path )

Returns absolute path to the binary.

References error(), f, and PATH_MAX.

Referenced by ffmpeg_trgt::init().

Canvas::Handle synfig::open_canvas	(	xmlpp::Element *	node,
		String &	errors,
		String &	warnings
	)

Loads a canvas from current xmlpp Element.

Returns: The Canvas's handle on success, an empty handle on failure

References error(), synfig::CanvasParser::error_count(), synfig::CanvasParser::get_errors_text(), synfig::CanvasParser::get_warnings_text(), synfig::CanvasParser::parse_as(), and synfig::CanvasParser::set_allow_errors().

Referenced by synfig::Svg_parser::load_svg_canvas().

std::map< synfig::String, etl::loose_handle< Canvas > > & synfig::get_open_canvas_map ( )

Returns the Open Canvases Map.

See Also: open_canvas_map_

References open_canvas_map_().

Referenced by _canvas_file_name_changed(), _remove_from_open_canvas_map(), synfig::CanvasParser::parse_from_file_as(), synfig::CanvasParser::register_canvas_in_map(), synfig::Canvas::set_file_name(), and synfig::Main::~Main().

TimePoint synfig::operator+	(	TimePoint	lhs,
		const Time &	rhs
	)

inline

References synfig::TimePoint::get_time(), and synfig::TimePoint::set_time().

TimePoint synfig::operator-	(	TimePoint	lhs,
		const Time &	rhs
	)

inline

References synfig::TimePoint::get_time(), and synfig::TimePoint::set_time().

bool synfig::operator<	(	const TimePoint &	lhs,
		const TimePoint &	rhs
	)

inline

References synfig::TimePoint::get_time().

bool synfig::operator<	(	const TimePoint &	lhs,
		const Time &	rhs
	)

inline

References synfig::TimePoint::get_time().

bool synfig::operator<	(	const Time &	lhs,
		const TimePoint &	rhs
	)

inline

References synfig::TimePoint::get_time().

bool synfig::operator==	(	const TimePoint &	lhs,
		const TimePoint &	rhs
	)

inline

References synfig::TimePoint::get_time().

bool synfig::operator!=	(	const TimePoint &	lhs,
		const TimePoint &	rhs
	)

inline

References synfig::TimePoint::get_time().

synfig::Node * synfig::find_node ( const synfig::GUID & guid )

Finds a node by its GUID.

See Also: global_node_map()

References global_node_map().

Referenced by guid_cast().

template<typename T >

etl::handle<T> synfig::guid_cast ( const synfig::GUID & guid )

Returns a Handle to the Node by its GUID.

References find_node().

Referenced by find_value_node().

RendDesc::Lock synfig::operator\|	(	RendDesc::Lock	lhs,
		RendDesc::Lock	rhs
	)

inline

This operator allows the combining of RendDesc::Lock flags using the '|' operator.

See Also: RendDesc::Lock, RendDesc

RendDesc::Lock synfig::operator&	(	RendDesc::Lock	lhs,
		RendDesc::Lock	rhs
	)

inline

This operator allows the masking of RendDesc::Lock flags using the '&' operator.

See Also: RendDesc::Lock, RendDesc

RendDesc::Lock synfig::operator~ ( RendDesc::Lock rhs )

inline

This operator allows the inverting of RendDesc::Lock flags using the '~' operator.

See Also: RendDesc::Lock, RendDesc

bool synfig::render	(	Context	context,
		Target_Scanline::Handle	target,
		const RendDesc &	desc,
		ProgressCallback *	callback
	)

Renders starting at context to target.

Warning: Target::set_rend_desc() must have already been called on target before you call this function!

References _, synfig::ProgressCallback::amount_complete(), synfig::Color::clamped(), synfig::ProgressCallback::error(), synfig::Color::get_a(), synfig::RendDesc::get_antialias(), synfig::RendDesc::get_br(), synfig::RendDesc::get_clamp(), synfig::Context::get_color(), synfig::RendDesc::get_h(), synfig::RendDesc::get_tl(), and synfig::RendDesc::get_w().

Referenced by SuperSample::accelerated_render(), synfig::Layer_Composite::accelerated_render(), synfig::Layer::accelerated_render(), synfig::Target_Scanline::render(), and render_threaded().

bool synfig::cairorender	(	Context	context,
		cairo_surface_t *	surface,
		const RendDesc &	desc,
		ProgressCallback *	cb = `NULL`
	)

References synfig::ProgressCallback::amount_complete(), synfig::Color::clamped(), synfig::Color::get_a(), synfig::RendDesc::get_antialias(), synfig::RendDesc::get_br(), synfig::Context::get_cairocolor(), synfig::RendDesc::get_h(), synfig::RendDesc::get_tl(), synfig::RendDesc::get_w(), synfig::CairoSurface::map_cairo_image(), synfig::CairoColor::premult_alpha(), and synfig::CairoSurface::unmap_cairo_image().

Referenced by synfig::Layer_Composite::accelerated_cairorender(), synfig::Layer::accelerated_cairorender(), and cairorender().

bool synfig::cairorender	(	Context	context,
		cairo_t *	cr,
		const RendDesc &	desc,
		ProgressCallback *	cb = `NULL`
	)

References synfig::ProgressCallback::amount_complete(), cairo_renddesc_untransform(), cairorender(), synfig::RendDesc::get_h(), synfig::RendDesc::get_ph(), synfig::RendDesc::get_pw(), synfig::RendDesc::get_tl(), and synfig::RendDesc::get_w().

bool synfig::parametric_render	(	Context	context,
		Surface &	surface,
		const RendDesc &	desc,
		ProgressCallback *	callback
	)

References synfig::ProgressCallback::amount_complete(), synfig::Color::clamped(), synfig::Color::get_a(), synfig::RendDesc::get_antialias(), synfig::RendDesc::get_br(), synfig::RendDesc::get_clamp(), synfig::Context::get_color(), synfig::RendDesc::get_h(), synfig::RendDesc::get_tl(), and synfig::RendDesc::get_w().

bool synfig::render_threaded	(	Context	context,
		Target_Scanline::Handle	target,
		const RendDesc &	desc,
		ProgressCallback *	callback,
		int	threads
	)

References _, synfig::ProgressCallback::amount_complete(), synfig::Color::clamped(), synfig::ProgressCallback::error(), synfig::Color::get_a(), synfig::RendDesc::get_antialias(), synfig::RendDesc::get_br(), synfig::RendDesc::get_clamp(), synfig::Context::get_color(), synfig::RendDesc::get_h(), synfig::RendDesc::get_tl(), synfig::RendDesc::get_w(), and render().

Referenced by synfig::Target_Scanline::render().

bool synfig::save_canvas	(	const FileSystem::Identifier &	identifier,
		Canvas::ConstHandle	canvas,
		bool	safe = `true`
	)

Saves a canvas to filename.

Returns: true on success, false on error.

References encode_canvas_toplevel(), error(), synfig::FileSystem::Identifier::file_system, and synfig::FileSystem::Identifier::filename.

Referenced by process_job().

String synfig::canvas_to_string ( Canvas::ConstHandle canvas )

Stores a Canvas in a string in XML format.

Returns: The string with the XML canvas definition

References encode_canvas_toplevel().

void synfig::set_save_canvas_external_file_callback	(	save_canvas_external_file_callback_t	callback,
		void *	user_data
	)

References save_canvas_external_file_callback, and save_canvas_external_file_user_data.

void synfig::set_file_version ( ReleaseVersion version )

References save_canvas_version.

ReleaseVersion synfig::get_file_version ( )

References save_canvas_version.

Referenced by encode_linkable_value_node(), synfig::ValueNode_RadialComposite::link_name(), and synfig::ValueNode_Composite::link_name().

Target_Scanline::Handle synfig::surface_target ( Surface * surface )

Creates a target that will render to surface.

Referenced by SuperSample::accelerated_render(), synfig::Layer_Composite::accelerated_render(), and synfig::Layer::accelerated_render().

Target_Cairo::Handle synfig::cairo_image_target ( cairo_surface_t ** surface )

Creates a target that will render to a cairo_surface_t image surface.

Time::Format synfig::operator\|	(	Time::Format	lhs,
		Time::Format	rhs
	)

inline

This operator allows the combining of Time::Format flags using the '|' operator.

See Also: Time::Format, Time::get_string()

bool synfig::operator<=	(	Time::Format	lhs,
		Time::Format	rhs
	)

inline

This operator is for checking Time::Format flags.

Don't think of it as "less then or equal to", but think of it like an arrow. Is rhs inside of lhs ?

See Also: Time::Format, Time::get_string()

int synfig::waypoint_collect	(	std::set< Waypoint, std::less< UniqueID > > &	waypoint_set,
		const Time &	time,
		const etl::handle< Node > &	node
	)

Todo:: This needs to be documented further.

int synfig::activepoint_collect	(	std::set< Activepoint, std::less< UniqueID > > &	activepoint_set,
		const Time &	time,
		const etl::handle< Node > &	node
	)

Todo:: This needs to be documented further.

ValueNode::LooseHandle synfig::find_value_node ( const GUID & guid )

References guid_cast().

Referenced by synfig::ValueNode_Const::clone(), synfig::ValueNode_StaticList::clone(), synfig::ValueNode_DynamicList::clone(), and synfig::LinkableValueNode::clone().

ValueBase synfig::convert_bline_to_segment_list ( const ValueBase & bline )

Converts a list of bline points into a list of segments.

References synfig::ValueBase::get_list_of(), synfig::ValueBase::get_loop(), synfig::BLinePoint::get_tangent1(), synfig::BLinePoint::get_tangent2(), and synfig::BLinePoint::get_vertex().

Referenced by Region::sync(), and Outline::sync().

ValueBase synfig::convert_bline_to_width_list ( const ValueBase & bline )

Converts a list of bline points into a list of widths.

References synfig::ValueBase::empty(), synfig::ValueBase::get_list_of(), synfig::ValueBase::get_loop(), and type_list.

Referenced by Outline::sync().

Real synfig::find_closest_point	(	const ValueBase &	bline,
		const Point &	pos,
		Real &	radius,
		bool	loop,
		Point *	out_point = `0`
	)

Finds the closest point to pos in bline.

References find_closest(), and synfig::ValueBase::get_list_of().

Real synfig::std_to_hom	(	const ValueBase &	bline,
		Real	pos,
		bool	index_loop,
		bool	bline_loop
	)

Converts from standard to homogeneous index (considers the length)

References bline_length(), synfig::ValueBase::get_list_of(), synfig::BLinePoint::get_tangent2(), and synfig::BLinePoint::get_vertex().

Referenced by Advanced_Outline::sync().

Real synfig::hom_to_std	(	const ValueBase &	bline,
		Real	pos,
		bool	index_loop,
		bool	bline_loop
	)

Converts from homogeneous to standard index.

References bline_length(), error(), synfig::ValueBase::get_list_of(), synfig::BLinePoint::get_tangent1(), synfig::BLinePoint::get_tangent2(), and synfig::BLinePoint::get_vertex().

Referenced by synfig::ValueNode_BLineCalcVertex::operator()(), synfig::ValueNode_BLineCalcWidth::operator()(), synfig::ValueNode_BLineCalcTangent::operator()(), and Advanced_Outline::sync().

Real synfig::bline_length	(	const ValueBase &	bline,
		bool	bline_loop,
		std::vector< Real > *	lengths
	)

Returns the length of the bline.

References synfig::ValueBase::get_list_of(), synfig::BLinePoint::get_tangent1(), synfig::BLinePoint::get_tangent2(), and synfig::BLinePoint::get_vertex().

Referenced by hom_to_std(), std_to_hom(), and Advanced_Outline::sync().

ValueBase synfig::convert_bline_to_wplist ( const ValueBase & bline )

Converts a ValueNode_BLine into a WidthPoint list.

References synfig::ValueBase::empty(), synfig::ValueBase::get_contained_type(), synfig::ValueBase::get_list_of(), synfig::ValueBase::get_loop(), type_bline_point, and type_list.

Real synfig::widthpoint_interpolate	(	const WidthPoint &	prev,
		const WidthPoint &	next,
		const Real	p,
		const Real	smoothness = `0.0`
	)

synfig::widthpoint_interpolate

Interpolated width

Parameters

prev	the previous width point to evaluate the width
next	the next width point to evaluate the width
position	the position to interpolate between prev and next
smoothness	a [0,1] value that defines how is calculated the interpolation

Returns: the interpolated width based on surrounding width points and its values

Parameters

prev	previous withpoint
next	next withpoint
p	position to calculate the new width between previous position and next position
smoothness	[0,1] how much linear (0) or smooth (1) the interpolation is

Returns: the interpolated width

References epsilon, f, synfig::WidthPoint::get_position(), synfig::WidthPoint::get_side_type_after(), synfig::WidthPoint::get_side_type_before(), and synfig::WidthPoint::get_width().

Referenced by synfig::ValueNode_WPList::interpolated_width(), and Advanced_Outline::sync().

bool synfig::check_version_	(	int	v,
		int	vec_size,
		int	color_size,
		int	canvas_size,
		int	layer_size
	)

Version checker.

Checks to make sure that the library version matches with what the program was compiled against.

See Also: SYNFIG_CHECK_VERSION()

References _, error(), and SYNFIG_LIBRARY_VERSION.

const char * synfig::get_version ( )

References VERSION.

const char * synfig::get_build_date ( )

Variable Documentation

Type & synfig::type_bool = TypeBool::instance

Type & synfig::type_integer = TypeInteger::instance

Type & synfig::type_angle = TypeAngle::instance

Type & synfig::type_time = TypeTime::instance

Type & synfig::type_real = TypeReal::instance

Type & synfig::type_vector = TypeVector::instance

Type & synfig::type_color = TypeColor::instance

Type & synfig::type_segment = TypeSegment::instance

Type & synfig::type_bline_point = TypeBLinePoint::instance

Referenced by synfig::ValueAverage::add(), synfig::ValueVector::check_type(), synfig::ValueNode_Composite::check_type(), synfig::ValueNode_BLineRevTangent::check_type(), synfig::ValueNode_Reverse::check_type(), synfig::ValueNode_BoneInfluence::check_type(), synfig::ValueTransformation::check_type(), convert_bline_to_wplist(), synfig::ValueNode_BoneInfluence::create(), synfig::ValueNode_BLine::create(), encode_bline_point(), encode_value(), synfig::ValueNode_Composite::get_children_vocab_vfunc(), synfig::ValueNode_Composite::get_link_index_from_name(), synfig::ValueVector::get_vector(), synfig::ValueAverage::multiply(), synfig::ValueNode_Composite::operator()(), synfig::ValueNode_BoneInfluence::operator()(), reverse_value(), synfig::ValueNode_Composite::set_link_vfunc(), Region::sync(), Outline::sync(), synfig::ValueTransformation::transform(), and synfig::ValueNode_Reverse::ValueNode_Reverse().

Type & synfig::type_matrix = TypeMatrix::instance

Referenced by synfig::ValueAverage::add(), synfig::ValueVector::check_type(), synfig::ValueTransformation::check_type(), synfig::ValueVector::get_vector(), synfig::ValueAverage::multiply(), and synfig::ValueTransformation::transform().

Type & synfig::type_bone_weight_pair = TypeBoneWeightPair::instance

Referenced by synfig::ValueNode_BoneWeightPair::check_type(), synfig::ValueNode_Const::create(), and synfig::ValueNode_StaticList::create_list_entry().

Type & synfig::type_width_point = TypeWidthPoint::instance

Referenced by synfig::ValueAverage::add(), synfig::ValueNode_Composite::check_type(), synfig::ValueNode_Reverse::check_type(), synfig::ValueTransformation::check_type(), synfig::ValueNode_WPList::create(), encode_value(), encode_width_point(), synfig::ValueNode_Composite::get_children_vocab_vfunc(), synfig::ValueNode_Composite::get_link_index_from_name(), synfig::ValueAverage::multiply(), synfig::ValueNode_Composite::operator()(), reverse_value(), synfig::ValueNode_Composite::set_link_vfunc(), synfig::ValueTransformation::transform(), and synfig::ValueNode_Reverse::ValueNode_Reverse().

Type & synfig::type_dash_item = TypeDashItem::instance

Referenced by synfig::ValueNode_Composite::check_type(), synfig::ValueNode_Reverse::check_type(), synfig::ValueNode_DIList::create(), encode_dash_item(), encode_value(), synfig::ValueNode_Composite::get_children_vocab_vfunc(), synfig::ValueNode_Composite::get_link_index_from_name(), synfig::ValueNode_Composite::operator()(), reverse_value(), synfig::ValueNode_Composite::set_link_vfunc(), and synfig::ValueNode_Reverse::ValueNode_Reverse().

Type & synfig::type_list = TypeList::instance

Type & synfig::type_canvas = TypeCanvas::instance

Referenced by synfig::Layer::clone(), synfig::ValueNode_Animated::create(), encode_animated(), encode_layer(), and encode_value().

Type & synfig::type_string = TypeString::instance

Type & synfig::type_gradient = TypeGradient::instance

Type & synfig::type_bone_object = TypeBoneObject::instance

Referenced by synfig::ValueNode_Bone::check_type(), synfig::LinkableValueNode::check_type(), synfig::ValueNode_Const::create(), synfig::ValueNode_Animated::create(), synfig::ValueNode_StaticList::create_from(), synfig::ValueNode_StaticList::create_list_entry(), encode_value_node_bone_id(), and synfig::ValueNode_Bone::ValueNode_Bone().

Type & synfig::type_bone_valuenode = TypeBoneValueNode::instance

Referenced by synfig::ValueNode_Animated::create(), encode_value(), synfig::ValueNode_Bone::get_bones_referenced_by(), synfig::ValueNode_BoneWeightPair::set_link_vfunc(), synfig::ValueNode_BoneLink::set_link_vfunc(), synfig::ValueNode_Bone::set_link_vfunc(), synfig::ValueNode_Const::set_value(), and synfig::ValueNode_Const::~ValueNode_Const().

Type & synfig::type_transformation = TypeTransformation::instance

Referenced by synfig::ValueAverage::add(), synfig::ValueVector::check_type(), synfig::ValueNode_Composite::check_type(), synfig::ValueTransformation::check_type(), encode_value(), synfig::ValueNode_Composite::get_children_vocab_vfunc(), synfig::ValueNode_Composite::get_link_index_from_name(), synfig::ValueVector::get_vector(), synfig::ValueAverage::multiply(), synfig::ValueNode_Composite::operator()(), synfig::ValueNode_Composite::set_link_vfunc(), and synfig::ValueTransformation::transform().

const float synfig::EncodeYUV[3][3]

static

Initial value:

{
    { 0.299f, 0.587f, 0.114f },
    { -0.168736f, -0.331264f, 0.5f },
    { 0.5f, -0.418688f, -0.081312f }
}

Referenced by synfig::Color::get_u(), synfig::CairoColor::get_u(), synfig::Color::get_v(), synfig::CairoColor::get_v(), synfig::Color::get_y(), and synfig::CairoColor::get_y().

const float synfig::DecodeYUV[3][3]

static

Initial value:

{
    { 1.0f, 0.0f, 1.402f },
    { 1.0f, -0.344136f, -0.714136f },
    { 1.0f, 1.772f, 0.0f }
}

Referenced by synfig::Color::set_yuv(), and synfig::CairoColor::set_yuv().

Type & synfig::type_nil = types_namespace::TypeNil::instance

Referenced by synfig::ValueAverage::average_generic(), synfig::ValueNode_TimeLoop::check_type(), synfig::ValueNode_Reference::check_type(), synfig::ValueNode_Switch::check_type(), synfig::ValueBase::clear(), synfig::ValueAverage::convert_to_weighted_type(), encode_value(), synfig::ValueBase::get_contained_type(), synfig::ValueBase::get_type(), synfig::ValueAverage::get_type_from_weighted(), synfig::ValueBase::ident_type(), synfig::ValueBase::is_valid(), synfig::ValueNode_StaticList::operator()(), and synfig::ValueNode_BoneLink::set_link_vfunc().

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation