MeVisLab Resolution Independence API
Public Member Functions | List of all members
FrameGrabber Class Reference

FrameGrabber class grabs GL frames for movie generation. More...

#include <FrameGrabber.h>

Public Member Functions

 FrameGrabber ()
 
 ~FrameGrabber ()
 
void cleanup (bool deleteFiles)
 cleanup memory, if deleteFiles is set, it also deletes all temporary files
 
void createAviWithBink (const char *filename, float framerate)
 create AVI out of stored frames (requieres binkconv.exe to be in the PATH)
 
void startRecording ()
 start recording at 0
 
void stopRecording ()
 stop recording
 
bool isRecording ()
 flag if currently a record session is running
 
void grabFrame (void *renderarea, int mode=GL_BACK)
 grab a single gl frame, (mode is GL_FRONT or GL_BACK, front contains windows and mouse also)
 
void writeToFiles ()
 write stored images to temp disk
 
void setMaximumBytes (long bytes)
 set the maximum number of bytes stored in memory for movie frames
 
long getMaximumBytes ()
 get the maximum number of bytes stored in memory for movie frames
 
int getDiskFrames ()
 get current disk frame number
 
int getMemFrames ()
 get current mem frame number
 
void setStatusField (SoSFString *field, SoNode *owner)
 set status field
 
void updateStatus (const char *string)
 update status
 
void writeCurrentFrameToDisk (const char *name, void *renderarea, int mode)
 grabs the current frame and writes to disk
 
MLuint8 * grabGLFrame (void *renderarea, int &w, int &h, int mode=GL_BACK)
 returns new buffer with content of gl framebuffer
 
std::string getFileNameTemplate ()
 

Detailed Description

FrameGrabber class grabs GL frames for movie generation.

Definition at line 41 of file FrameGrabber.h.

Constructor & Destructor Documentation

◆ FrameGrabber()

FrameGrabber::FrameGrabber ( )

◆ ~FrameGrabber()

FrameGrabber::~FrameGrabber ( )

Member Function Documentation

◆ cleanup()

void FrameGrabber::cleanup ( bool deleteFiles)

cleanup memory, if deleteFiles is set, it also deletes all temporary files

◆ createAviWithBink()

void FrameGrabber::createAviWithBink ( const char * filename,
float framerate )

create AVI out of stored frames (requieres binkconv.exe to be in the PATH)

◆ getDiskFrames()

int FrameGrabber::getDiskFrames ( )
inline

get current disk frame number

Definition at line 76 of file FrameGrabber.h.

◆ getFileNameTemplate()

std::string FrameGrabber::getFileNameTemplate ( )

◆ getMaximumBytes()

long FrameGrabber::getMaximumBytes ( )
inline

get the maximum number of bytes stored in memory for movie frames

Definition at line 73 of file FrameGrabber.h.

◆ getMemFrames()

int FrameGrabber::getMemFrames ( )
inline

get current mem frame number

Definition at line 79 of file FrameGrabber.h.

◆ grabFrame()

void FrameGrabber::grabFrame ( void * renderarea,
int mode = GL_BACK )

grab a single gl frame, (mode is GL_FRONT or GL_BACK, front contains windows and mouse also)

◆ grabGLFrame()

MLuint8 * FrameGrabber::grabGLFrame ( void * renderarea,
int & w,
int & h,
int mode = GL_BACK )

returns new buffer with content of gl framebuffer

◆ isRecording()

bool FrameGrabber::isRecording ( )
inline

flag if currently a record session is running

Definition at line 61 of file FrameGrabber.h.

◆ setMaximumBytes()

void FrameGrabber::setMaximumBytes ( long bytes)
inline

set the maximum number of bytes stored in memory for movie frames

Definition at line 70 of file FrameGrabber.h.

◆ setStatusField()

void FrameGrabber::setStatusField ( SoSFString * field,
SoNode * owner )
inline

set status field

Definition at line 82 of file FrameGrabber.h.

◆ startRecording()

void FrameGrabber::startRecording ( )

start recording at 0

◆ stopRecording()

void FrameGrabber::stopRecording ( )
inline

stop recording

Definition at line 58 of file FrameGrabber.h.

◆ updateStatus()

void FrameGrabber::updateStatus ( const char * string)

update status

◆ writeCurrentFrameToDisk()

void FrameGrabber::writeCurrentFrameToDisk ( const char * name,
void * renderarea,
int mode )

grabs the current frame and writes to disk

◆ writeToFiles()

void FrameGrabber::writeToFiles ( )

write stored images to temp disk

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