synfig-core  1.0.3
Classes | Public Member Functions | List of all members
synfig::CairoListImporter Class Reference

#include <cairolistimporter.h>

Inheritance diagram for synfig::CairoListImporter:
synfig::CairoImporter

Classes

class  CacheElement

Public Member Functions

 CairoListImporter (const FileSystem::Identifier &identifier)
 ~CairoListImporter ()
virtual bool get_frame (cairo_surface_t *&csurface, const RendDesc &renddesc, Time time, ProgressCallback *callback=NULL)
 Gets a frame and puts it into cairo_surface_t.
virtual bool is_animated ()
 Returns true if the importer pays attention to the time parameter of get_frame()
- Public Member Functions inherited from synfig::CairoImporter
Gammagamma ()
const Gammagamma () const
virtual ~CairoImporter ()
virtual bool get_frame (cairo_surface_t *&csurface, const RendDesc &renddesc, Time time, bool &trimmed __attribute__((unused)), unsigned int &width __attribute__((unused)), unsigned int &height __attribute__((unused)), unsigned int &top __attribute__((unused)), unsigned int &left __attribute__((unused)), ProgressCallback *callback=NULL)

Additional Inherited Members

- Public Types inherited from synfig::CairoImporter
typedef CairoImporter *(* Factory )(const FileSystem::Identifier &identifier)
typedef std::map< std::string,
BookEntry
Book
typedef etl::handle
< CairoImporter
Handle
typedef etl::loose_handle
< CairoImporter
LooseHandle
typedef etl::handle< const
CairoImporter
ConstHandle
- Static Public Member Functions inherited from synfig::CairoImporter
static Bookbook ()
static bool subsys_init ()
static bool subsys_stop ()
static Handle open (const FileSystem::Identifier &identifier)
 Attempts to open filename, and returns a handle to the associated CairoImporter.
- Public Attributes inherited from synfig::CairoImporter
const FileSystem::Identifier identifier
- Static Public Attributes inherited from synfig::CairoImporter
static Bookbook_
- Protected Member Functions inherited from synfig::CairoImporter
 CairoImporter (const FileSystem::Identifier &identifier)

Detailed Description

Todo:
Write more detailed description

Constructor & Destructor Documentation

CairoListImporter::CairoListImporter ( const FileSystem::Identifier identifier)

! read first line and check whether it is a Papagayo lip sync file

! it is a Papagayo lipsync file

References synfig::error(), f, synfig::FileSystem::Identifier::filename, synfig::info(), and synfig::FileSystem::safeGetline().

CairoListImporter::~CairoListImporter ( )

Member Function Documentation

bool CairoListImporter::get_frame ( cairo_surface_t *&  csurface,
const RendDesc renddesc,
Time  time,
ProgressCallback callback = NULL 
)
virtual

Gets a frame and puts it into cairo_surface_t.

Parameters
surfaceReference to surface to put frame into
timeFor animated importers, determines which frame to get. For static importers, this parameter is unused.
callbackPointer to callback class for progress, errors, etc.
Returns
true on success, false on error
See Also
ProgressCallback, Surface

Implements synfig::CairoImporter.

References _, synfig::ProgressCallback::error(), synfig::error(), synfig::CairoListImporter::CacheElement::frame_name, synfig::RendDesc::get_frame_rate(), synfig::FileSystemNative::instance(), LIST_CAIROIMPORTER_CACHE_SIZE, synfig::CairoImporter::open(), and synfig::CairoListImporter::CacheElement::surface.

bool CairoListImporter::is_animated ( )
virtual

Returns true if the importer pays attention to the time parameter of get_frame()

Reimplemented from synfig::CairoImporter.


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