osgPPU::UnitOutCapture Class Reference

Capture the content of the input texture to a file. More...

Inheritance diagram for osgPPU::UnitOutCapture:

Public Member Functions
	META_Node (osgPPU, UnitOutCapture)
	UnitOutCapture ()
	Create default ppfx.
	UnitOutCapture (const UnitOutCapture &, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
virtual	~UnitOutCapture ()
	Release it and used memory.
void	setPath (const std::string &path)
	Set path were to store the screenshots.
void	setFileExtension (const std::string &ext)
	set extension
const std::string &	getPath () const
	get currently used path
const std::string &	getFileExtension () const
	get currently used extension
void	setShotOnce (bool b)
bool	getShotOnce ()
	Check if the unit will shot once on the next traversion.
virtual void	captureInput (osg::State *state)
	Direct function, which can be used to take a screenshot.
virtual void	init ()
	Initialze the default Processoring unit.
void	setUseInputTextureInternalFormat (bool use)
bool	getUseInputTextureInternalFormat () const
	Check whenever internal format of input texture is used as pixel format for storing.
Protected Attributes
std::string	mPath
	path were to store the files
std::map< int, int >	mCaptureNumber
	Current number of the capture file.
std::string	mExtension
	file extensions
bool	mShotOnce
	Do only one screenshot.
bool	mUseInputTextureInternalFormat
	Store with the same pixel format as used by the input textures.

---

Detailed Description

Capture the content of the input texture to a file.

Screen capturing ppu. The input texture is captured into a file. This ppu allows to render out in higher resolution than your monitor supports. This can be only achieved if your rendering is going completely through ppu pipeline, so renderer in offscreen mode.

---

Member Function Documentation

void osgPPU::UnitOutCapture::setShotOnce

(

bool

b

)

Set if the output should be generated only once. The unit will be activated only for one frame. You will need to reactivate the unit, if you would like to have continous frame capturing after one frame shot.

void osgPPU::UnitOutCapture::setUseInputTextureInternalFormat

(

bool

use

)

Specify whenever the pixel format of the image to store should be the same as the internal format of input texture. This might be helpful if you want to store directly as it is, without converting. However if you want for example store a float texture to JPG files, you might need to disable this feature allowing the plugin to handle the texture data.

Per default this feature is disabled.

---

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

• UnitOutCapture.h