tbx  0.7.3
Public Member Functions | List of all members
tbx::SpriteCapture Class Reference

Class to capture screen output to a sprite. More...

#include <sprite.h>

Public Member Functions

 SpriteCapture (UserSprite *sprite, bool start_capture=false, bool to_mask=false)
 Class to capture screen output to a sprite.
 
 ~SpriteCapture ()
 Sprite capture destructor. More...
 
bool capture ()
 Capture screen output to sprite or sprites mask. More...
 
bool release ()
 Release screen output from sprite. More...
 
bool is_capturing ()
 Check if this capture is capturing to the sprite. More...
 

Detailed Description

Class to capture screen output to a sprite.

Constructor & Destructor Documentation

SpriteCapture::~SpriteCapture ( )

Sprite capture destructor.

Automatically releases the current capture.

Member Function Documentation

bool SpriteCapture::capture ( )

Capture screen output to sprite or sprites mask.

returns true if capture successful or already captured.

bool tbx::SpriteCapture::is_capturing ( )
inline

Check if this capture is capturing to the sprite.

Returns
true if capturing
bool SpriteCapture::release ( )

Release screen output from sprite.

returns true if successful or capture already released or not started.


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