optix::ProgramObj Class Reference

Detailed Description

Program object wraps the OptiX C API RTprogram opaque type and its associated function set.

Inheritance diagram for optix::ProgramObj:

Public Member Functions
void	destroy ()
void	validate ()
Context	getContext () const
Variable	declareVariable (const std::string &name)
Variable	queryVariable (const std::string &name) const
void	removeVariable (Variable v)
unsigned int	getVariableCount () const
Variable	getVariable (unsigned int index) const
RTprogram	get ()
int	getId () const
Public Member Functions inherited from optix::APIObj
void	addReference ()
int	removeReference ()
virtual void	checkError (RTresult code) const
virtual void	checkError (RTresult code, Context context) const
void	checkErrorNoGetContext (RTresult code) const

Friends
class	Handle< ProgramObj >

Additional Inherited Members
Static Public Member Functions inherited from optix::APIObj
static Exception	makeException (RTresult code, RTcontext context)

Member Function Documentation

Variable optix::ProgramObj::declareVariable ( const std::string &  name )

inlinevirtual

Declare a variable associated with this object. See rt[ObjectType]DeclareVariable. Note that this function is wrapped by the convenience function Handle::operator[].

Implements optix::ScopedObj.

int optix::ProgramObj::getId ( ) const

inline

Returns the device-side ID of this program object. See rtProgramGetId

unsigned int optix::ProgramObj::getVariableCount ( ) const

inlinevirtual

Query the number of variables associated with this object. Used along with ScopedObj::getVariable to iterate over variables in an object. See rt[ObjectType]GetVariableCount

Implements optix::ScopedObj.

Variable optix::ProgramObj::queryVariable ( const std::string &  name ) const

inlinevirtual

Query a variable associated with this object by name. See rt[ObjectType]QueryVariable. Note that this function is wrapped by the convenience function Handle::operator[].

Implements optix::ScopedObj.