synfig Namespace Reference

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


Classes

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
class  SoftwareExpired
 This class is thrown when the software timeout has been reached. More...
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 ontop of lower layers. More...
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  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  SurfaceNew
class  SurfaceChannelLockConst
class  SurfaceChannelLock
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_Animated
class  ValueNode_BLine
class  ValueNode_Composite
class  ValueNode_Const
class  ValueNode_DynamicList
 Animated List ValueNode. More...
struct  ValueNode_GradientRotate
class  ValueNode_Linear
class  ValueNode_RadialComposite
class  ValueNode_Reference
struct  ValueNode_Scale
class  ValueNode_SegCalcTangent
class  ValueNode_SegCalcVertex
class  ValueNode_Sine
struct  ValueNode_Stripes
struct  ValueNode_Subtract
struct  ValueNode_TimedSwap
struct  ValueNode_TwoTone
class  Vector
class  Waypoint

Namespaces

namespace  Exception
namespace  Proto

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 Vector Point
typedef etl::handle
< Node > 		NodeHandle
typedef double Real
typedef
etl::smart_ptr< FILE,
_FILE_deleter > 		SmartFILE
typedef std::string String
typedef std::string String
typedef
ValueNode_BLine::ListEntry::ActivepointList 		ActivepointList
typedef
ValueNode_DynamicList::ListEntry::Activepoint 		Activepoint
typedef
ValueNode_DynamicList::ListEntry::ActivepointList 		ActivepointList
typedef Vector Point
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  SurfaceColorSystem { COLORSYS_RGB, COLORSYS_YUV, COLORSYS_END }
enum  SurfaceChannel {
  CHAN_A, CHAN_R, CHAN_G, CHAN_B,
  CHAN_Y, CHAN_U, CHAN_V, CHAN_END
}

Functions

Canvas::Handle open_canvas (const String &filename)
 Loads a canvas from filename.
void optimize_layers (Context context, Canvas::Handle op_canvas)
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)
Canvas::Handle string_to_canvas (const String &data)
 Retrieves a Canvas from a string in XML format.
const char * get_version ()
const char * get_build_date ()
const char * get_build_time ()
bool check_version_ (int v, int vec_size, int color_size, int canvas_size, int layer_size)
 Version checker.
synfig::Node * find_node (const GUID &guid)
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 operator<= (RendDesc::Lock lhs, RendDesc::Lock rhs)
 This operator is for checking RendDesc::Lock flags.
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.
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 > > &activepoint_set, 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.

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

synfig::Point

Todo:
writeme

typedef ProgressCallback synfig::ProgressManager

typedef Vector synfig::Point

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

synfig::Real

Todo:
writeme

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

synfig::String

Todo:
writeme
Todo:
writeme

typedef std::string synfig::String

typedef ValueNode_BLine::ListEntry::ActivepointList synfig::ActivepointList

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

typedef ValueNode_DynamicList::ListEntry::ActivepointList synfig::ActivepointList

typedef Vector synfig::Point

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 infront 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 datastructure, 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::SurfaceColorSystem

Todo:
This needs to be documented further.
Enumerator:
COLORSYS_RGB 
COLORSYS_YUV 
COLORSYS_END 

enum synfig::SurfaceChannel

Todo:
This needs to be documented further.
Enumerator:
CHAN_A 
CHAN_R 
CHAN_G 
CHAN_B 
CHAN_Y 
CHAN_U 
CHAN_V 
CHAN_END 

Function Documentation

Canvas::Handle synfig::open_canvas ( const String &  filename  ) 

Loads a canvas from filename.

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

void synfig::optimize_layers ( Context  context,
Canvas::Handle  op_canvas 
)

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.

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

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

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

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

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

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

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

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

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

template<typename T>
void synfig::Bound ( etl::rect< T > &  r,
const etl::bezier< Point > &  b 
) [inline]

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

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

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

void synfig::error ( const String &  str  ) 

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

Reports a warning.

Call this when something questionable occurs, describing what happened

void synfig::warning ( const String &  str  ) 

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

Reports some information.

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

void synfig::info ( const String &  str  ) 

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

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

Canvas::Handle synfig::string_to_canvas ( const String &  data  ) 

Retrieves a Canvas from a string in XML format.

const char * synfig::get_version (  ) 

const char * synfig::get_build_date (  ) 

const char * synfig::get_build_time (  ) 

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

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

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

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

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

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

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

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

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

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::operator<= ( RendDesc::Lock  lhs,
RendDesc::Lock  rhs 
) [inline]

This operator is for checking RendDesc::Lock 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:
RendDesc::Lock, RendDesc

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

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!

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

bool synfig::save_canvas ( const String &  filename,
Canvas::ConstHandle  canvas 
)

Saves a canvas to filename.

Returns:
true on success, false on error.

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

Stores a Canvas in a string in XML format.

etl::handle< Target_Scanline > synfig::surface_target ( Surface *  surface  ) 

Creates a target that will render to 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 ( 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 ( set< Activepoint, std::less< UniqueID > > &  activepoint_set,
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  ) 

ValueBase synfig::convert_bline_to_segment_list ( const ValueBase &  bline  ) 

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

ValueBase synfig::convert_bline_to_width_list ( const ValueBase &  bline  ) 

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

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 }
}

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 }
}

Generated on Wed Aug 15 05:00:24 2007 for synfig by  doxygen 1.5.3