SuperSample Class Reference

#include <supersample.h>

Inheritance diagram for SuperSample:

synfig::Layer synfig::Node

List of all members.

Public Member Functions

 SuperSample ()
virtual bool set_param (const String &param, const synfig::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 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.
virtual synfig::Rect get_bounding_rect (Context context) const
virtual Vocab get_param_vocab () const
 Gets the parameter vocabulary.


Constructor & Destructor Documentation

SuperSample::SuperSample (  ) 


Member Function Documentation

bool SuperSample::set_param ( const String &  param,
const synfig::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.

References IMPORT.

ValueBase SuperSample::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.

References EXPORT, EXPORT_NAME, and EXPORT_VERSION.

bool SuperSample::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 referring to next Layer.
surface Pointer to Surface to render to.
quality The requested quality-level to render at.
renddesc The associated RendDesc.
cb 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.

References _, synfig::Context::accelerated_render(), synfig::SuperCallback::amount_complete(), synfig::ProgressCallback::amount_complete(), synfig::RendDesc::clear_flags(), synfig::ProgressCallback::error(), synfig::Color::get_a(), synfig::RendDesc::get_h(), synfig::RendDesc::get_w(), synfig::render(), synfig::Color::set_a(), synfig::RendDesc::set_wh(), and synfig::surface_target().

Rect SuperSample::get_bounding_rect ( Context  context  )  const [virtual]

Layer::Vocab SuperSample::get_param_vocab ( void   )  const [virtual]

Gets the parameter vocabulary.

Reimplemented from synfig::Layer.

References _, and synfig::Layer::set_description().


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

Generated on Fri Jul 31 00:01:57 2009 for synfig-core by  doxygen 1.5.6