synfig::Layer_Composite Class Reference

Base class for layers that put stuff ontop of lower layers. More...

#include <layer_composite.h>

Inheritance diagram for synfig::Layer_Composite:

List of all members.

Public Member Functions
float	get_amount () const
Layer_Composite &	set_amount (float x)
Color::BlendMethod	get_blend_method () const
Layer_Composite &	set_blend_method (Color::BlendMethod x)
bool	is_solid_color () const
bool	is_disabled () const
virtual Vocab	get_param_vocab () const
	Gets the paramater vocabulary.
virtual bool	set_param (const String &param, const ValueBase &value)
	Sets the parameter described by param to value.
virtual ValueBase	get_param (const String &param) const
	Get the value of the specified parameter.
virtual Rect	get_full_bounding_rect (Context context) const
virtual bool	accelerated_render (Context context, Surface *surface, int quality, const RendDesc &renddesc, ProgressCallback *cb) const
	Renders the Canvas to the given Surface in an accelerated manner.
Protected Member Functions
	Layer_Composite (float amount=1.0, Color::BlendMethod blend_method=Color::BLEND_COMPOSITE)

---

Detailed Description

Base class for layers that put stuff ontop of lower layers.

---

Constructor & Destructor Documentation

synfig::Layer_Composite::Layer_Composite (  float  amount = 1.0, Color::BlendMethod  blend_method = Color::BLEND_COMPOSITE )  [inline, protected]

---

Member Function Documentation

float synfig::Layer_Composite::get_amount (   )  const [inline]

Layer_Composite& synfig::Layer_Composite::set_amount (  float  x  )  [inline]

Color::BlendMethod synfig::Layer_Composite::get_blend_method (   )  const [inline]

Layer_Composite& synfig::Layer_Composite::set_blend_method (  Color::BlendMethod  x  )  [inline]

bool synfig::Layer_Composite::is_solid_color (   )  const [inline]

bool synfig::Layer_Composite::is_disabled (   )  const [inline]

Layer::Vocab Layer_Composite::get_param_vocab (   )  const [virtual]

Gets the paramater vocabulary. Reimplemented from synfig::Layer. Reimplemented in synfig::Layer_Bitmap, synfig::Layer_MotionBlur, synfig::Layer_PasteCanvas, synfig::Layer_Polygon, synfig::Layer_Shape, and synfig::Layer_SolidColor.

bool Layer_Composite::set_param (  const String &  param, const ValueBase &  value )  [virtual]

Sets the parameter described by param to value. Parameters: param  The name of the parameter to set value  What the parameter is to be set to. Returns: true on success, false upon rejection or failure. If it returns false, then the Layer is assumed to remain unchanged. See also: get_param() Todo: param should be of the type const String &param Reimplemented from synfig::Layer. Reimplemented in synfig::Layer_MotionBlur, synfig::Layer_PasteCanvas, synfig::Layer_Polygon, synfig::Layer_Shape, and synfig::Layer_SolidColor.

ValueBase Layer_Composite::get_param (  const String &  param  )  const [virtual]

Get the value of the specified parameter. Returns: The requested parameter value, or (upon failure) a NIL ValueBase. See also: set_param() Todo: param should be of the type const String & Reimplemented from synfig::Layer. Reimplemented in synfig::Layer_Bitmap, synfig::Layer_MotionBlur, synfig::Layer_PasteCanvas, synfig::Layer_Polygon, synfig::Layer_Shape, and synfig::Layer_SolidColor.

Rect Layer_Composite::get_full_bounding_rect (  Context  context  )  const [virtual]

Reimplemented from synfig::Layer.

bool Layer_Composite::accelerated_render (  Context  context, Surface *  surface, int  quality, const RendDesc &  renddesc, ProgressCallback *  cb )  const [virtual]

Renders the Canvas to the given Surface in an accelerated manner. Parameters: context  Context iterator refering to next Layer. surface  Pointer to Surface to render to. quality  The requested quality-level to render at. rend_desc  The associated RendDesc. callback  Pointer to callback object. May be NULL if there is no callback. Returns: true on success, false on failure See also: Handle::accelerated_render() Reimplemented from synfig::Layer. Reimplemented in synfig::Layer_Bitmap, synfig::Layer_MotionBlur, synfig::Layer_PasteCanvas, synfig::Layer_Shape, and synfig::Layer_SolidColor.

---

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

• layer_composite.h
• layer_composite.cpp

---