#include <VOP_Node.h>

Public Member Functions
	VOP_FunctionArgInfo ()

void	setTypeInfo (const VOP_TypeInfo &type_info)
	Argument type. More...

const VOP_TypeInfo &	getTypeInfo () const

void	setName (const char *name)
	Argument name. More...

const UT_StringHolder &	getName () const

void	setVarName (const char *var_name)
	Local variable name to use when calling the function. More...

const UT_StringHolder &	getVarName () const

void	setInitCodeStr (const char *init_code)

const UT_StringHolder &	getInitCodeStr () const

void	setInputIndex (int input_index)
	Node input index, if argument corresponds to an input; otherwise -1. More...

int	getInputIndex () const

void	setOutputIndex (int output_index)
	Node output index, if argument corresponds to an input; otherwise -1. More...

int	getOutputIndex () const

void	setExported (bool exported)
	True if it's an export (output) shader function parameter. More...

bool	isExported () const

Detailed Description

Abstracts information about shader function parameters/arguments. It has two use cases: when declaring and defining a shader function, and when calling a shader function. It always stores shader parameter type and name, but may not store some of the other information for some use cases.

Definition at line 182 of file VOP_Node.h.

Constructor & Destructor Documentation

VOP_FunctionArgInfo::VOP_FunctionArgInfo ( )

Member Function Documentation

const UT_StringHolder& VOP_FunctionArgInfo::getInitCodeStr ( ) const

inline

Definition at line 204 of file VOP_Node.h.

int VOP_FunctionArgInfo::getInputIndex ( ) const

inline

Definition at line 209 of file VOP_Node.h.

const UT_StringHolder& VOP_FunctionArgInfo::getName ( ) const

inline

Definition at line 194 of file VOP_Node.h.

int VOP_FunctionArgInfo::getOutputIndex ( ) const

inline

Definition at line 214 of file VOP_Node.h.

const VOP_TypeInfo& VOP_FunctionArgInfo::getTypeInfo ( ) const

inline

Definition at line 189 of file VOP_Node.h.

const UT_StringHolder& VOP_FunctionArgInfo::getVarName ( ) const

bool VOP_FunctionArgInfo::isExported ( ) const

inline

Definition at line 219 of file VOP_Node.h.

void VOP_FunctionArgInfo::setExported ( bool exported )

True if it's an export (output) shader function parameter.

void VOP_FunctionArgInfo::setInitCodeStr ( const char * init_code )

Expression (ie, RHS of the assignment) to use for initialization of the argument when calling the shader function.

void VOP_FunctionArgInfo::setInputIndex ( int input_index )

Node input index, if argument corresponds to an input; otherwise -1.

void VOP_FunctionArgInfo::setName ( const char * name )

Argument name.

void VOP_FunctionArgInfo::setOutputIndex ( int output_index )

Node output index, if argument corresponds to an input; otherwise -1.

void VOP_FunctionArgInfo::setTypeInfo ( const VOP_TypeInfo & type_info )

Argument type.

void VOP_FunctionArgInfo::setVarName ( const char * var_name )

Local variable name to use when calling the function.

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

VOP/VOP_Node.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation