HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
BRAY::OutputFile Class Reference

A render product represents an output file. More...

#include <BRAY_Interface.h>

Classes

struct  AOV
 

Public Member Functions

 OutputFile (BRAY::ScenePtr &scene, const UT_StringHolder &filename, const UT_StringHolder &type)
 
 ~OutputFile ()
 
bool setOptions (const UT_Options &options)
 Copy over options from those passed in. More...
 
AOVappendAOV (const UT_StringHolder &name)
 Add an AOV to this output file. More...
 
bool commit ()
 Commit and add this output file to the render. More...
 
void cancel ()
 Cancel this output file for some reason. More...
 
template<typename T >
bool setOption (const UT_StringHolder &name, const T *value, exint size)
 
template<typename T >
bool setOption (const UT_StringHolder &name, const T &value)
 

Static Public Member Functions

static bool isKnownType (const UT_StringRef &type)
 
static void clearFiles (BRAY::ScenePtr &scene)
 

Detailed Description

A render product represents an output file.

Definition at line 808 of file BRAY_Interface.h.

Constructor & Destructor Documentation

BRAY::OutputFile::OutputFile ( BRAY::ScenePtr scene,
const UT_StringHolder filename,
const UT_StringHolder type 
)
inline

Definition at line 846 of file BRAY_Interface.h.

BRAY::OutputFile::~OutputFile ( )
inline

Definition at line 855 of file BRAY_Interface.h.

Member Function Documentation

AOV& BRAY::OutputFile::appendAOV ( const UT_StringHolder name)
inline

Add an AOV to this output file.

Definition at line 880 of file BRAY_Interface.h.

void BRAY::OutputFile::cancel ( )
inline

Cancel this output file for some reason.

Definition at line 894 of file BRAY_Interface.h.

static void BRAY::OutputFile::clearFiles ( BRAY::ScenePtr scene)
static
bool BRAY::OutputFile::commit ( )
inline

Commit and add this output file to the render.

Definition at line 887 of file BRAY_Interface.h.

static bool BRAY::OutputFile::isKnownType ( const UT_StringRef type)
static
template<typename T >
bool BRAY::OutputFile::setOption ( const UT_StringHolder name,
const T *  value,
exint  size 
)

Method is specialized for T in:

template<typename T >
bool BRAY::OutputFile::setOption ( const UT_StringHolder name,
const T &  value 
)
inline

Method is specialized for T in:

Definition at line 872 of file BRAY_Interface.h.

bool BRAY::OutputFile::setOptions ( const UT_Options options)

Copy over options from those passed in.


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