version 3.3

VRS::GIFVideo Class Reference

container for a set of images, useable as video texture or image More...

#include <vrs/image/gifvideo.h>

Inheritance diagram for VRS::GIFVideo:

VRS::Video VRS::Image VRS::SharedObj VRS::Visitable

List of all members.

Public Member Functions

 GIFVideo (const std::string &fileName, bool scaleToPow2=false)
 GIFVideo (DataResource *data, bool scaleToPow2=false)
 c'tors for creation from a file or dataresource
double frameRate () const
 returns frame rate in fps
bool advanceFrame (int n=1, bool loop=true)
 advances internal image by n frames
void reset ()
 resets internal image to first image
void * pixelComponents (int x, int y, int component=0) const
 returns direct access to image data
int width () const
int height () const
 size of image
int frames () const
 frame count
ImagegetFrame (int n) const
 returns a reference to the frame with number n
 VRS_TYPEINFO (GIFVideo, Video)
 VRS_SERIALIZABLE (GIFVideo)

Protected Member Functions

 GIFVideo ()


Detailed Description

container for a set of images, useable as video texture or image

Constructor & Destructor Documentation

VRS::GIFVideo::GIFVideo ( const std::string &  fileName,
bool  scaleToPow2 = false 
)

VRS::GIFVideo::GIFVideo ( DataResource data,
bool  scaleToPow2 = false 
)

c'tors for creation from a file or dataresource

A GIFVideo contains 0, 1 or more frames. Scaling contigently necessary for use as video texture on some graphics hardware resulting images are RGBA-images reproducing color key transparency of gif images.

VRS::GIFVideo::GIFVideo (  )  [protected]


Member Function Documentation

double VRS::GIFVideo::frameRate (  )  const [virtual]

returns frame rate in fps

Implements VRS::Video.

bool VRS::GIFVideo::advanceFrame ( int  n = 1,
bool  loop = true 
) [virtual]

advances internal image by n frames

Implements VRS::Video.

void VRS::GIFVideo::reset (  )  [virtual]

resets internal image to first image

Implements VRS::Video.

void* VRS::GIFVideo::pixelComponents ( int  x,
int  y,
int  component = 0 
) const [virtual]

returns direct access to image data

Implements VRS::Video.

int VRS::GIFVideo::width (  )  const [virtual]

Implements VRS::Image.

int VRS::GIFVideo::height (  )  const [virtual]

size of image

Implements VRS::Image.

int VRS::GIFVideo::frames (  )  const

frame count

Image* VRS::GIFVideo::getFrame ( int  n  )  const

returns a reference to the frame with number n

VRS::GIFVideo::VRS_TYPEINFO ( GIFVideo  ,
Video   
)

VRS::GIFVideo::VRS_SERIALIZABLE ( GIFVideo   ) 


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

Generated on Mon May 21 06:00:18 2012 by Doxygen 1.5.6
© 2001-2010 Hasso-Plattner-Institut | Impressum | Contact