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...
AOV &	appendAOV (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...
const UT_StringHolder &	filename () const
	Access member data. More...
const UT_StringHolder &	type () const
const UT_Array< AOV > &	aovs () const
const UT_Options &	options () const
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)
void	dump () const
void	dump (UT_JSONWriter &w) const

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 1152 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 1193 of file BRAY_Interface.h.

BRAY::OutputFile::~OutputFile ( )

inline

Definition at line 1202 of file BRAY_Interface.h.

Member Function Documentation

const UT_Array<AOV>& BRAY::OutputFile::aovs ( ) const

inline

Definition at line 1246 of file BRAY_Interface.h.

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

inline

Add an AOV to this output file.

Definition at line 1227 of file BRAY_Interface.h.

void BRAY::OutputFile::cancel ( )

inline

Cancel this output file for some reason.

Definition at line 1241 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 1234 of file BRAY_Interface.h.

void BRAY::OutputFile::dump

(

)

const

Dump information (used by karma:debug)

void BRAY::OutputFile::dump

(

UT_JSONWriter &

w

)

const

Dump information (used by karma:debug)

const UT_StringHolder& BRAY::OutputFile::filename ( ) const

inline

Access member data.

Definition at line 1244 of file BRAY_Interface.h.

static bool BRAY::OutputFile::isKnownType ( const UT_StringRef &  type )

static

const UT_Options& BRAY::OutputFile::options ( ) const

inline

Definition at line 1247 of file BRAY_Interface.h.

template<typename T >

bool BRAY::OutputFile::setOption	(	const UT_StringHolder &	name,
		const T *	value,
		exint	size
	)

Method is specialized for T in:

• bool
• int32/int64
• fpreal32/fpreal64
• UT_StringHolder

template<typename T >

bool BRAY::OutputFile::setOption ( const UT_StringHolder &  name, const T &  value  )

inline

Method is specialized for T in:

• bool
• int32/int64
• fpreal32/fpreal64
• UT_StringHolder

Definition at line 1219 of file BRAY_Interface.h.

bool BRAY::OutputFile::setOptions

(

const UT_Options &

options

)

Copy over options from those passed in.

const UT_StringHolder& BRAY::OutputFile::type ( ) const

inline

Definition at line 1245 of file BRAY_Interface.h.

---

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

• BRAY/BRAY_Interface.h