synfig-core  1.0.3
Public Types | Public Member Functions | List of all members
synfig::Target_Tile Class Reference

Render-target. More...

#include <target_tile.h>

Inheritance diagram for synfig::Target_Tile:
synfig::Target synfig::Target_Null_Tile

Public Types

typedef etl::handle< Target_TileHandle
typedef etl::loose_handle
< Target_Tile
typedef etl::handle< const
- Public Types inherited from synfig::Target
typedef etl::handle< TargetHandle
typedef etl::loose_handle< TargetLooseHandle
typedef etl::handle< const TargetConstHandle
typedef Target *(* Factory )(const char *filename, TargetParam p)
 Type that represents a pointer to a Target's constructor.
typedef std::map< String,
 Book of types of targets indexed by the name of the Target.
typedef std::map< String, StringExtBook
 Book of types of targets indexed by the file extension.

Public Member Functions

 Target_Tile ()
virtual bool render (ProgressCallback *cb=NULL)
 Renders the canvas to the target.
virtual int next_tile (int &x, int &y)
 Determines which tile needs to be rendered next.
virtual int next_frame (Time &time)
virtual bool add_tile (const synfig::Surface &surface, int x, int y)=0
 Adds the tile at x , y contained in surface.
virtual int total_tiles () const
 Returns the total tiles of the imaged rounded to integer number of tiles.
virtual bool start_frame (ProgressCallback *cb=NULL)=0
 Marks the start of a frame.
virtual void end_frame ()=0
 Marks the end of a frame.
void set_threads (int x)
 Sets the number of threads.
int get_threads () const
 Gets the number of threads.
void set_tile_w (int w)
 Sets the tile widht.
int get_tile_w () const
 Gets the tile widht.
void set_tile_h (int h)
 Sets the tile height.
int get_tile_h () const
 Gets the tile height.
bool get_clipping () const
 Gets clipping.
void set_clipping (bool x)
 Sets clipping.
- 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.
Gammagamma ()
const Gammagamma () 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.
RendDescrend_desc ()
 Gets the target particular render description.
const RendDescrend_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.

Additional Inherited Members

- Static Public Member Functions inherited from synfig::Target
static Bookbook ()
static ExtBookext_book ()
static bool subsys_init ()
static bool subsys_stop ()
 Stops the Target module by deleting the book and the extension book.
static Handle create (const String &type, const String &filename, synfig::TargetParam params)
 Creates a new Target described by type, outputting to a file described by filename.
- Public Attributes inherited from synfig::Target
RendDesc desc
 Adjusted Render description set by set_rend_desc()
etl::handle< Canvascanvas
 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 Bookbook_
 Target Book, indexed by the target's name.
static ExtBookext_book_
 Map of target names indexed by associated file extension.
- Protected Member Functions inherited from synfig::Target
 Target ()
 Default constructor.

Detailed Description



Member Typedef Documentation

typedef etl::loose_handle<Target_Tile> synfig::Target_Tile::LooseHandle
typedef etl::handle<const Target_Tile> synfig::Target_Tile::ConstHandle

Constructor & Destructor Documentation

Target_Tile::Target_Tile ( )

Member Function Documentation

bool synfig::Target_Tile::render ( ProgressCallback cb = NULL)
int Target_Tile::next_tile ( int &  x,
int &  y 

Determines which tile needs to be rendered next.

Most cases will not have to redefine this function. The default should be adequate in nearly all situations.

The number of tiles left to go plus one. This means that whenever this function returns zero, there are no more tiles to render and that any value in x or y should be disregarded.

References synfig::Target::rend_desc().

int Target_Tile::next_frame ( Time time)

Returns the number of peniding frames to render. If it is zero it stops rendering frames.

Reimplemented from synfig::Target.

virtual bool synfig::Target_Tile::add_tile ( const synfig::Surface surface,
int  x,
int  y 
pure virtual

Adds the tile at x , y contained in surface.

Implemented in synfig::Target_Null_Tile.

virtual int synfig::Target_Tile::total_tiles ( ) const

Returns the total tiles of the imaged rounded to integer number of tiles.

References synfig::Target::rend_desc().

virtual bool synfig::Target_Tile::start_frame ( ProgressCallback cb = NULL)
pure virtual

Marks the start of a frame.

true on success, false upon an error.
See Also
end_frame(), start_scanline()

Implemented in synfig::Target_Null_Tile.

virtual void synfig::Target_Tile::end_frame ( )
pure virtual

Marks the end of a frame.

See Also

Implemented in synfig::Target_Null_Tile.

void synfig::Target_Tile::set_threads ( int  x)

Sets the number of threads.

int synfig::Target_Tile::get_threads ( ) const

Gets the number of threads.

void synfig::Target_Tile::set_tile_w ( int  w)

Sets the tile widht.

int synfig::Target_Tile::get_tile_w ( ) const

Gets the tile widht.

void synfig::Target_Tile::set_tile_h ( int  h)

Sets the tile height.

int synfig::Target_Tile::get_tile_h ( ) const

Gets the tile height.

bool synfig::Target_Tile::get_clipping ( ) const

Gets clipping.

void synfig::Target_Tile::set_clipping ( bool  x)

Sets clipping.

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