synfig::Target_Null Class Reference

A target which renders to nothing. Useful for benchmarks and other tests. More...

#include <target_null.h>

Inheritance diagram for synfig::Target_Null:

Public Member Functions
	~Target_Null ()
virtual bool	start_frame (ProgressCallback *=NULL)
	Marks the start of a frame.
virtual void	end_frame ()
	Marks the end of a frame.
virtual Color *	start_scanline (int)
	Marks the start of a scanline.
virtual bool	end_scanline ()
	Marks the end of a scanline.
Public Member Functions inherited from synfig::Target_Scanline
	Target_Scanline ()
	Default constructor (threads = 2 current frame = 0)
virtual bool	render (ProgressCallback *cb=NULL)
	Renders the canvas to the target.
virtual int	next_frame (Time &time)
void	set_threads (int x)
	Sets the number of threads.
int	get_threads () const
	Gets the number of threads.
bool	add_frame (const synfig::Surface *surface)
	Puts the rendered surface onto the target.
Public Member Functions inherited from synfig::Target
sigc::signal< void > &	signal_progress ()
virtual	~Target ()
int	get_quality () const
	Gets the target quality.
void	set_quality (int q)
	Sets the target quality.
void	set_avoid_time_sync (bool x=true)
	Sets the target avoid time synchronization.
bool	get_avoid_time_sync () const
	Gets the target avoid time synchronization.
TargetAlphaMode	get_alpha_mode () const
	Tells how to handle alpha.
void	set_alpha_mode (TargetAlphaMode x=TARGET_ALPHA_MODE_KEEP)
	Sets how to handle alpha.
Gamma &	gamma ()
const Gamma &	gamma () const
	Sets the target gamma.
virtual void	set_canvas (etl::handle< Canvas > c)
	Sets the target canvas. Must be defined by derived targets.
const etl::handle< Canvas > &	get_canvas () const
	Gets the target canvas.
RendDesc &	rend_desc ()
	Gets the target particular render description.
const RendDesc &	rend_desc () const
	Gets the target particular render description.
virtual bool	set_rend_desc (RendDesc *d)
	Sets the RendDesc for the Target to desc.
virtual bool	init (ProgressCallback *cb=NULL)
	Initialization tasks of the derived target.

Static Public Member Functions
static Target *	create (const char *=0)

Additional Inherited Members
Public Types inherited from synfig::Target_Scanline
typedef etl::handle < Target_Scanline >	Handle
typedef etl::loose_handle < Target_Scanline >	LooseHandle
typedef etl::handle< const Target_Scanline >	ConstHandle
Public Attributes inherited from synfig::Target
RendDesc	desc
	Adjusted Render description set by set_rend_desc()
etl::handle< Canvas >	canvas
	Canvas being rendered in this target module.
int	quality_
	Render quality used for the render process of the target.
Gamma	gamma_
	Gamma value used for the render process of the target.
TargetAlphaMode	alpha_mode
	Tells how to handle alpha. Used by non alpha supported targets to decide if the background must be filled or not.
bool	avoid_time_sync_
	When set to true, the target doesn't sync to canvas time.
int	curr_frame_
	The current frame being rendered.
Static Public Attributes inherited from synfig::Target
static Book *	book_
	Target Book, indexed by the target's name.
static ExtBook *	ext_book_
	Map of target names indexed by associated file extension.
Protected Member Functions inherited from synfig::Target
	Target ()
	Default constructor.

Detailed Description

A target which renders to nothing. Useful for benchmarks and other tests.

Todo:

writeme

Constructor & Destructor Documentation

synfig::Target_Null::~Target_Null ( )

inline

Member Function Documentation

virtual bool synfig::Target_Null::start_frame ( ProgressCallback *  cb = NULL )

inlinevirtual

Marks the start of a frame.

Returns

true on success, false upon an error.

See Also

end_frame(), start_scanline()

Implements synfig::Target_Scanline.

References synfig::Target::desc, and synfig::RendDesc::get_w().

virtual void synfig::Target_Null::end_frame ( )

inlinevirtual

Marks the end of a frame.

See Also

start_frame()

Implements synfig::Target_Scanline.

virtual Color* synfig::Target_Null::start_scanline ( int  scanline )

inlinevirtual

Marks the start of a scanline.

Parameters

scanline

Which scanline is going to be rendered.

Returns

The address where the target wants the scanline to be written.

Warning

Must be called after start_frame()

See Also

end_scanline(), start_frame()

Implements synfig::Target_Scanline.

virtual bool synfig::Target_Null::end_scanline ( )

inlinevirtual

Marks the end of a scanline.

Takes the data that was put at the address returned to by start_scanline() and does whatever it is supposed to do with it.

Returns

true on success, false on failure.

See Also

start_scanline()

Implements synfig::Target_Scanline.

static Target* synfig::Target_Null::create ( const char *  = 0 )

inlinestatic

Referenced by synfig::Target::subsys_init().

---

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

• target_null.h