# synfig Namespace Reference

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

## Classes

class | BooleanCurve
class | Layer_Clamp
class | Layer_SphereDistort
class | Layer_Stretch
class | Layer_ColorCorrect
class | ValueNode_Random
struct | Activepoint
class | BLinePoint
class | Canvas
class | Color
class | Context
struct | Ray
struct | BezHull
class | CIntersect
struct | CurvePoint
class | CurveSet
class | Distance
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
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_Mime
class | Layer_MotionBlur
class | Layer_PasteCanvas
class | Layer_Polygon
| writeme More...
class | Layer_Shape
| writeme More...
class | Layer_SolidColor
class | ListImporter
class | CanvasParser
class | Main
class | Matrix
class | Module
class | Mutex
class | RecMutex
class | RWLock
class | TimePoint
class | TimePointSet
class | Node
struct | PaletteItem
class | Palette
class | ParamDesc
| Parameter Description Class. More...
class | ParamVocab
class | Protocol
class | Rect
class | RendDesc
struct | Segment
struct | _FILE_deleter
class | ColorPrep
class | Surface
| Bitmap Surface. More...
class | Target
| Render-target. 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
| Render-target. More...
class | Target_Tile
| Render-target. More...
class | Time
class | Transform
class | TransformStack
class | UniqueID
class | UniqueIDLessThan
| A function class used for sorting based on UniqueIDs. More...
class | ValueBase
class | Value
class | ValueNode
class | PlaceholderValueNode
class | LinkableValueNode
class | ValueNodeList
| A searchable value_node list container. More...
struct | ValueNode_Add
class | ValueNode_And
class | ValueNode_AngleString
struct | ValueNode_Animated
class | ValueNode_Atan2
class | ValueNode_BLine
class | ValueNode_BLineCalcTangent
class | ValueNode_BLineCalcVertex
class | ValueNode_BLineCalcWidth
class | ValueNode_BLineRevTangent
class | ValueNode_Compare
class | ValueNode_Composite
class | ValueNode_Const
class | ValueNode_Cos
class | ValueNode_DotProduct
class | ValueNode_Duplicate
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_RealString
class | ValueNode_Reciprocal
class | ValueNode_Reference
struct | ValueNode_Repeat_Gradient
struct | ValueNode_Scale
class | ValueNode_SegCalcTangent
class | ValueNode_SegCalcVertex
class | ValueNode_Sine
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 | Vector
class | Waypoint

## Namespaces

namespace | Exception

## Typedefs

typedef etl::angle | Angle
typedef std::deque < etl::handle< Layer > > | CanvasBase
typedef float | ColorReal
typedef Color | ColorAccumulator
typedef Vector | Point
typedef ProgressCallback | ProgressManager
typedef etl::handle< Node > | NodeHandle
typedef double | Real
typedef etl::smart_ptr< FILE, _FILE_deleter > | SmartFILE
typedef std::string | String
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 }
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_61_10, RELEASE_VERSION_END }

## Functions

Canvas::Handle | open_canvas (const String &filename, String &errors, String &warnings)
| Loads a canvas from filename.
void | optimize_layers (Time time, Context context, Canvas::Handle op_canvas, bool seen_motion_blur_in_parent)
PixelFormat | operator| (PixelFormat lhs, PixelFormat rhs)
PixelFormat | operator & (PixelFormat lhs, PixelFormat rhs)
int | channels (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 | find_closest (const etl::bezier< Point > &curve, const Point &point, float step, Real *dout, float *tout)
int | intersect (const Point &p1, const Vector &v1, float &t1, const Point &p2, const Vector &v2, float &t2)
int | intersect (const Rect &r, const Point &p)
int | intersect (const bezier< Point > &b, const Point &p)
Real | line_point_distsq (const Point &p1, const Point &p2, const Point &p, float &t)
bool | intersect_line_segments (const Point &a, const Point &b, float &tout, const Point &c, const Point &d, float &sout)
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 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)
std::map< synfig::String, etl::loose_handle< Canvas > > & | get_open_canvas_map ()
Canvas::Handle | open_canvas_as (const String &filename, const String &as, String &errors, String &warnings)
const char * | get_version ()
const char * | get_build_date ()
bool | check_version_ (int v, int vec_size, int color_size, int canvas_size, int layer_size)
| Version checker.
synfig::Node * | find_node (const synfig::GUID &guid)
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)
template<typename T>
etl::handle< T > | guid_cast (const synfig::GUID &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 | parametric_render (Context context, Surface &surface, const RendDesc &desc, ProgressCallback *callback)
bool | render (Context context, Target_Scanline::Handle target, const RendDesc &desc, ProgressCallback *)
| Renders starting at context to target.
bool | render_threaded (Context context, Target_Scanline::Handle target, const RendDesc &desc, ProgressCallback *callback, int threads)
bool | save_canvas (const String &filename, Canvas::ConstHandle canvas)
| Saves a canvas to filename.
String | canvas_to_string (Canvas::ConstHandle canvas)
| Stores a Canvas in a string in XML format.
void | set_file_version (ReleaseVersion version)
ReleaseVersion | get_file_version ()
Target_Scanline::Handle | surface_target (Surface *surface)
| Creates a target that will render to 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 (set< Waypoint, std::less< UniqueID > > &waypoint_set, const Time &time, const etl::handle< Node > &node)
int | activepoint_collect (set< Activepoint, std::less< UniqueID > > &, const Time &time, const etl::handle< Node > &node)
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.

## Variables

static const float | EncodeYUV [3][3]
static const float | DecodeYUV [3][3]

## Detailed Description

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

Todo:
  Writeme

## Typedef Documentation

synfig::Angle

Todo:
  writeme

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

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 etl::smart_ptr<FILE,_FILE_deleter> synfig::SmartFILE

typedef std::string synfig::String

Todo:
  writeme

Todo:
  writeme

typedef ValueNode_DynamicList::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 |

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_61_10 |
  RELEASE_VERSION_END |

## Function Documentation

Canvas::Handle synfig::open_canvas | ( | const String & | filename,
|  | String & | errors,
|  | String & | warnings |
| ) |  |  |

Loads a canvas from filename.

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

References open_canvas_as().

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

void synfig::optimize_layers | ( | Time | time,
|  | Context | context,
|  | Canvas::Handle | op_canvas,
|  | bool | seen_motion_blur_in_parent |
| ) |  |  |

References synfig::Color::BLEND_COMPOSITE, synfig::Color::BLEND_STRAIGHT, synfig::Layer::create(), synfig::Canvas::create_inline(), synfig::Layer::dynamic_param_list(), f, synfig::Layer_Composite::get_amount(), synfig::Layer_Composite::get_blend_method(), synfig::Layer_PasteCanvas::get_origin(), synfig::Layer::get_param(), synfig::Layer::get_param_list(), synfig::Layer_PasteCanvas::get_sub_canvas(), synfig::Layer_PasteCanvas::get_time_offset(), synfig::Layer_PasteCanvas::get_zoom(), info(), synfig::Color::is_straight(), synfig::Layer_Composite::set_amount(), synfig::Layer_Composite::set_blend_method(), synfig::Layer_PasteCanvas::set_sub_canvas(), synfig::Layer::set_time(), synfig::ValueBase::TYPE_INTEGER, and synfig::ValueBase::TYPE_REAL.

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

PixelFormat synfig::operator| | ( | PixelFormat | lhs,
|  | PixelFormat | rhs |
| ) |  |  | `[inline]`

PixelFormat synfig::operator & | ( | PixelFormat | lhs,
|  | PixelFormat | rhs |
| ) |  |  | `[inline]`

int synfig::channels | ( | 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 convert_surface_frame(), imagemagick_trgt::end_scanline(), imagemagick_trgt::init(), imagemagick_trgt::start_frame(), and bmp::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 convert_surface_frame(), ppm::end_scanline(), png_trgt::end_scanline(), mng_trgt::end_scanline(), magickpp_trgt::end_scanline(), jpeg_trgt::end_scanline(), imagemagick_trgt::end_scanline(), ffmpeg_trgt::end_scanline(), dv_trgt::end_scanline(), and bmp::end_scanline().

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::find_closest | ( | const etl::bezier< Point > & | curve,
|  | const Point & | point,
|  | float | step,
|  | Real * | dout,
|  | float * | tout |
| ) |  |  |

References line_point_distsq().

Referenced by find_closest_point().

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_render(), synfig::Layer_Shape::get_color(), synfig::Layer_Shape::hit_check(), synfig::CurveSet::intersect(), intersect_line_segments(), and recurse_intersect().

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

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

References intersect_scurve().

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().

bool synfig::intersect_line_segments | ( | const Point & | a,
|  | const Point & | b,
|  | float & | tout,
|  | const Point & | c,
|  | const Point & | d,
|  | float & | sout |
| ) |  |  | `[inline]`

References intersect().

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_render(), synfig::Layer_PasteCanvas::accelerated_render(), Rectangle::hit_check(), and synfig::Rect::operator &&().

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_render(), synfig::Canvas::add_value_node(), synfig::Exception::BadFrameRate::BadFrameRate(), synfig::Exception::BadLinkName::BadLinkName(), synfig::Exception::BadTime::BadTime(), synfig::Exception::BadType::BadType(), check_version_(), synfig::Canvas::clone(), synfig::LinkableValueNode::create(), encode_value(), mng_trgt::end_frame(), mng_trgt::end_scanline(), synfig::Exception::FileNotFound::FileNotFound(), exr_mptr::get_frame(), imagemagick_mptr::get_frame(), bmp_mptr::get_frame(), synfig::ListImporter::get_frame(), synfig::Exception::IDAlreadyExists::IDAlreadyExists(), mng_trgt::init(), gif::init(), ffmpeg_trgt::init(), dv_trgt::init(), jpeg_mptr::jpeg_mptr(), synfig::ListImporter::ListImporter(), mng_error_proc(), synfig::Importer::open(), synfig::ValueNode_RadialComposite::operator()(), synfig::ValueNode_Composite::operator()(), synfig::Gradient::operator()(), synfig::Distance::operator=(), synfig::CanvasParser::parse_from_file_as(), png_mptr::png_mptr(), save_canvas(), Import::set_param(), png_trgt::start_frame(), imagemagick_trgt::start_frame(), bmp::start_frame(), synfig::Module::subsys_init(), supersample_helper(), Outline::sync(), magickpp_trgt::~magickpp_trgt(), and mng_trgt::~mng_trgt().

void synfig::error | ( | const String & | str | ) |

References _, and current_time().

Referenced by encode_animated(), encode_layer(), encode_value_node(), yuv::end_frame(), gif::end_frame(), extract_arg_cluster(), freetype_constructor(), process_global_flags(), and magickpp_trgt::~magickpp_trgt().

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

Reports a warning.

Call this when something questionable occurs, describing what happened

Referenced by synfig::Layer_SphereDistort::accelerated_render(), Layer_Freetype::accelerated_render(), synfig::Layer_Shape::accelerated_render(), synfig::Layer_PasteCanvas::accelerated_render(), broken_pipe_signal(), copy_image_list(), Target_LibAVCodec::end_frame(), extract_RendDesc(), bmp_mptr::get_frame(), synfig::Distance::ident_system(), Target_LibAVCodec::init(), synfig::ValueNode_RadialComposite::link_count(), synfig::ValueNode_Composite::link_count(), open_canvas_as(), synfig::ValueNode_DynamicList::operator()(), synfig::ValueNode_BLine::operator()(), synfig::Layer_SphereDistort::set_param(), Region::set_param(), Outline::set_param(), synfig::Layer_Composite::set_param(), Import::set_param(), Region::sync(), Outline::sync(), synfig::Time::Time(), synfig::ValueBase::type_name(), synfig::Canvas::~Canvas(), magickpp_trgt::~magickpp_trgt(), and synfig::Main::~Main().

void synfig::warning | ( | const String & | str | ) |

References _, and current_time().

Referenced by copy_image_list(), encode_canvas_toplevel(), encode_linkable_value_node(), encode_subtract(), and magickpp_trgt::~magickpp_trgt().

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

Reports some information.

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

Referenced by synfig::Context::accelerated_render(), synfig::KeyframeList::dump(), gif::end_frame(), synfig::Layer_Shape::hit_check(), synfig::ListImporter::ListImporter(), synfig::Main::Main(), optimize_layers(), png_mptr::png_mptr(), synfig::Target_Scanline::render(), Import::set_param(), synfig::Canvas::set_time(), magickpp_trgt::~magickpp_trgt(), and mng_trgt::~mng_trgt().

void synfig::info | ( | const String & | str | ) |

References _, and current_time().

Referenced by main().

std::map< synfig::String, etl::loose_handle< Canvas > > & synfig::get_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().

Canvas::Handle synfig::open_canvas_as | ( | const String & | filename,
|  | const String & | as,
|  | String & | errors,
|  | String & | warnings |
| ) |  |  |

References _, synfig::Layer::create(), synfig::Canvas::create(), synfig::CanvasParser::error_count(), synfig::CanvasParser::get_errors_text(), synfig::CanvasParser::get_warnings_text(), synfig::CanvasParser::loading_, synfig::CanvasParser::parse_from_file_as(), synfig::CanvasParser::set_allow_errors(), and warning().

Referenced by open_canvas().

const char * synfig::get_version | ( |  | ) |

References VERSION.

const char * synfig::get_build_date | ( |  | ) |

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

Version checker.

For internal use only.

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.

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

References global_node_map().

Referenced by guid_cast().

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().

template<typename T>

etl::handle<T> synfig::guid_cast | ( | const synfig::GUID & | guid | ) | `[inline]`

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::parametric_render | ( | Context | context,
|  | Surface & | surface,
|  | const RendDesc & | desc,
|  | ProgressCallback * | callback |
| ) |  |  |

References synfig::Color::alpha(), 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 | ( | Context | context,
|  | Target_Scanline::Handle | target,
|  | const RendDesc & | desc,
|  | ProgressCallback * |  |
| ) |  |  |

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::Color::alpha(), 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::render_threaded | ( | Context | context,
|  | Target_Scanline::Handle | target,
|  | const RendDesc & | desc,
|  | ProgressCallback * | callback,
|  | int | threads |
| ) |  |  |

References _, synfig::Color::alpha(), 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 String & | filename,
|  | Canvas::ConstHandle | canvas |
| ) |  |  |

Saves a canvas to filename.

Returns:
  `true` on success, `false` on error.

References encode_canvas_toplevel(), and error().

Referenced by main().

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

Stores a Canvas in a string in XML format.

References encode_canvas_toplevel().

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().

etl::handle< Target_Scanline > 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().

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 | ( | set< Waypoint, std::less< UniqueID > > & | waypoint_set,
|  | const Time & | time,
|  | const etl::handle< Node > & | node |
| ) |  |  |

Todo:
  This needs to be documented further.

References synfig::ValueBase::TYPE_CANVAS.

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

Todo:
  This needs to be documented further.

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_DynamicList::clone(), synfig::ValueNode_Const::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(), 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(), synfig::ValueBase::get_loop(), and synfig::ValueBase::TYPE_LIST.

Referenced by Outline::sync().

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

Finds the closest point to pos in bline.

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

## Variable Documentation

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::Color::get_v(), and synfig::Color::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().