omegalib  13.1
omega::CameraOutput Class Reference

The Camera output class is used to simplify and optimize reading back 

rendered frames to main memory. More...

#include <CameraOutput.h>

Public Member Functions

 CameraOutput ()
 
void reset (RenderTarget::Type type)
 
void beginDraw (const DrawContext &context)
 
void endDraw (const DrawContext &context)
 
void startFrame (const FrameInfo &frame)
 
void finishFrame (const FrameInfo &frame)
 
bool isEnabled ()
 
void setEnabled (bool value)
 
void setReadbackTarget (PixelData *color, PixelData *depth=NULL)
 
void setReadbackTargetAndViewport (PixelData *color, PixelData *depth, const Rect &readbackViewport)
 
void setTextureTarget (Texture *color, Texture *depth=NULL)
 
void setTextureTargetAndViewport (Texture *color, Texture *depth, const Rect &readbackViewport)
 
const Rect & getReadbackViewport ()
 
RenderTarget * getRenderTarget ()
 
RenderTarget::Type getType ()
 
- Public Member Functions inherited from omicron::ReferenceType
 ReferenceType ()
 
virtual ~ReferenceType ()
 
void ref ()
 
void unref ()
 
long refCount ()
 

Additional Inherited Members

- Static Public Member Functions inherited from omicron::ReferenceType
static void printObjCounts ()
 
- Static Protected Attributes inherited from omicron::ReferenceType
static List< ReferenceType * > mysObjList
 

Detailed Description

The Camera output class is used to simplify and optimize reading back 

rendered frames to main memory.

Each camera has multiple output available, one for each GPU device active in the current configuration. The general workflow is as follows:

  1. Create a PixelData object to store the output frame
  2. Attach the PixelData object to one of the outputs of a camera
  3. enable the camera output - the pixel data will now be updated at the end of each frame
+ Inheritance diagram for omega::CameraOutput:

Constructor & Destructor Documentation

omega::CameraOutput::CameraOutput ( )

Member Function Documentation

void omega::CameraOutput::beginDraw ( const DrawContext &  context)
void omega::CameraOutput::endDraw ( const DrawContext &  context)
void omega::CameraOutput::finishFrame ( const FrameInfo &  frame)
const Rect& omega::CameraOutput::getReadbackViewport ( )
inline
RenderTarget* omega::CameraOutput::getRenderTarget ( )
inline
RenderTarget::Type omega::CameraOutput::getType ( )
inline
bool omega::CameraOutput::isEnabled ( )
inline
void omega::CameraOutput::reset ( RenderTarget::Type  type)
void omega::CameraOutput::setEnabled ( bool  value)
inline
void omega::CameraOutput::setReadbackTarget ( PixelData *  color,
PixelData *  depth = NULL 
)
void omega::CameraOutput::setReadbackTargetAndViewport ( PixelData *  color,
PixelData *  depth,
const Rect &  readbackViewport 
)
void omega::CameraOutput::setTextureTarget ( Texture *  color,
Texture *  depth = NULL 
)
void omega::CameraOutput::setTextureTargetAndViewport ( Texture *  color,
Texture *  depth,
const Rect &  readbackViewport 
)
void omega::CameraOutput::startFrame ( const FrameInfo &  frame)

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