Public Types | Public Member Functions

gnash::ScreenShotter Class Reference

Handles screen dumps. More...

#include <gui.h>

List of all members.

Public Types

typedef std::vector< size_t > FrameList

Public Member Functions

 ScreenShotter (boost::shared_ptr< Renderer > r, const std::string &fileName)
 Create a ScreenShotter with renderer and output name.
void now ()
 Take a screenshot at the next possible moment.
void lastFrame ()
 Take a screenshot when the last frame is reached.
void last () const
 Called on the last frame before exit.
void screenShot (size_t frameAdvance)
 Takes a screenshot if required.
void setFrames (const FrameList &frames)
 Request a list of frames to be rendered to image files.

Detailed Description

Handles screen dumps.


Member Typedef Documentation

typedef std::vector<size_t> gnash::ScreenShotter::FrameList

Constructor & Destructor Documentation

gnash::ScreenShotter::ScreenShotter ( boost::shared_ptr< Renderer r,
const std::string &  fileName 
) [inline]

Create a ScreenShotter with renderer and output name.


Member Function Documentation

void gnash::ScreenShotter::last (  )  const

Called on the last frame before exit.

Which frame is last depends on the execution path of the SWF, whether the SWF loops, whether a timeout was requested or a maximum number of advances set. Those conditions are not knowable in advance, so the last frame is a special case.

void gnash::ScreenShotter::lastFrame (  )  [inline]

Take a screenshot when the last frame is reached.

void gnash::ScreenShotter::now (  )  [inline]

Take a screenshot at the next possible moment.

void gnash::ScreenShotter::screenShot ( size_t  frameAdvance  ) 

Takes a screenshot if required.

Called on each advance.

Parameters:
frameAdvance used to check whether a screenshot is required as well as to construct the filename.
void gnash::ScreenShotter::setFrames ( const FrameList frames  ) 

Request a list of frames to be rendered to image files.


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