OpenSceneGraph 3.6.5
osgViewer::ScreenCaptureHandler::WriteToFile Class Reference

Concrete implementation of a CaptureOperation that writes the screen capture to a file. More...

#include <ViewerEventHandlers>

Inheritance diagram for osgViewer::ScreenCaptureHandler::WriteToFile:

Public Types

enum  SavePolicy { OVERWRITE , SEQUENTIAL_NUMBER }

Public Member Functions

 WriteToFile (const std::string &filename, const std::string &extension, SavePolicy savePolicy=SEQUENTIAL_NUMBER)
virtual void operator() (const osg::Image &image, const unsigned int context_id)
void setSavePolicy (SavePolicy savePolicy)
SavePolicy getSavePolicy () const
Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead.
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
virtual void setThreadSafeRefUnref (bool)
 Deprecated, Referenced is always theadsafe so there method now has no effect and does not need to be called.
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe.
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref().
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it.
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it.
int referenceCount () const
 Return the number of pointers currently referencing this object.
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted.
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object.

Protected Member Functions

WriteToFileoperator= (const WriteToFile &)
Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
void deleteUsingDeleteHandler () const

Protected Attributes

const std::string _filename
const std::string _extension
SavePolicy _savePolicy
std::vector< unsigned int > _contextSaveCounter
Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
OpenThreads::Atomic _refCount

Additional Inherited Members

Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex * getGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced.
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated.
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler.

Detailed Description

Concrete implementation of a CaptureOperation that writes the screen capture to a file.

Member Enumeration Documentation

◆ SavePolicy

Enumerator
OVERWRITE 
SEQUENTIAL_NUMBER 

Constructor & Destructor Documentation

◆ WriteToFile()

osgViewer::ScreenCaptureHandler::WriteToFile::WriteToFile ( const std::string & filename,
const std::string & extension,
SavePolicy savePolicy = SEQUENTIAL_NUMBER )

References SEQUENTIAL_NUMBER.

Referenced by operator=().

Member Function Documentation

◆ getSavePolicy()

SavePolicy osgViewer::ScreenCaptureHandler::WriteToFile::getSavePolicy ( ) const
inline

References _savePolicy.

◆ operator()()

virtual void osgViewer::ScreenCaptureHandler::WriteToFile::operator() ( const osg::Image & image,
const unsigned int context_id )
virtual

◆ operator=()

WriteToFile & osgViewer::ScreenCaptureHandler::WriteToFile::operator= ( const WriteToFile & )
inlineprotected

References WriteToFile().

◆ setSavePolicy()

void osgViewer::ScreenCaptureHandler::WriteToFile::setSavePolicy ( SavePolicy savePolicy)
inline

References _savePolicy.

Member Data Documentation

◆ _contextSaveCounter

std::vector<unsigned int> osgViewer::ScreenCaptureHandler::WriteToFile::_contextSaveCounter
protected

◆ _extension

const std::string osgViewer::ScreenCaptureHandler::WriteToFile::_extension
protected

◆ _filename

const std::string osgViewer::ScreenCaptureHandler::WriteToFile::_filename
protected

◆ _savePolicy

SavePolicy osgViewer::ScreenCaptureHandler::WriteToFile::_savePolicy
protected

Referenced by getSavePolicy(), and setSavePolicy().


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

osg logo
Generated at Sun Jul 20 2025 00:00:00 for the OpenSceneGraph by doxygen 1.14.0.