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

A class that compiles a shader and saves it into an existing shader HDA. More...

#include <VOP_HDACodeCompiler.h>

+ Inheritance diagram for VOP_ShaderHDACompilerHDA:

Public Member Functions

 VOP_ShaderHDACompilerHDA ()
 Constructor. More...
 
virtual bool compileVexCodeToSections (OP_Node *srcnode, FS_IndexFile *hda, const char *context_mask)
 
- Public Member Functions inherited from VOP_ShaderHDACompiler
 VOP_ShaderHDACompiler ()
 Constructor. More...
 
void setRManPath (const char *path)
 
const UT_StringgetRManPath () const
 
- Public Member Functions inherited from VOP_HDACodeCompiler
 VOP_HDACodeCompiler ()
 
virtual ~VOP_HDACodeCompiler ()
 
virtual bool compileNewOperatorType (OP_Node *srcnode, const char *name, const char *label, const char *path, const char *metasrc, const VOP_ContextTypeList *types=NULL)
 
const UT_StringMap
< UT_StringHolder > & 
getFunctionsSectionsMap () const
 
void setShaderName (const char *shader_name)
 Main shader name used in compilation. More...
 
const UT_StringHoldergetShaderName () const
 Main shader name used in compilation. More...
 
UT_ErrorSeverity getStatus (UT_String &message, UT_String *details=0)
 
void setForceCompilationOnOpNameConflict (bool flag)
 
bool getForceCompilationOnOpNameConflict ()
 

Protected Member Functions

virtual void getContextTypesForCompilation (VOP_ContextTypeList &contexts) const
 Obtains the context types for which to compile the code. More...
 
virtual void doCompile (FS_IndexFile *hda, VOP_CodeGenerator *code_generator, VOP_ContextType context_type, const char *section_name, OP_Node *output_node)
 Compiles the given context type of the source node to the HDA in OTL. More...
 
- Protected Member Functions inherited from VOP_ShaderHDACompiler
bool initForShaderCompilation (OP_Node *srcnode)
 Sets up member variables to be ready for compilation. More...
 
bool compilePrimaryOutputNodes (FS_IndexFile *hda, opui_ScriptMaterialCodeMapper &mapper)
 
void compileMappedNodes (FS_IndexFile *hda, opui_ScriptMaterialCodeMapper &mapper)
 
OP_NodegetNode () const
 
VOP_CodeGeneratorgetCodeGenerator () const
 
OP_OperatorTablegetTable () const
 
- Protected Member Functions inherited from VOP_HDACodeCompiler
void saveVflCodeToSection (FS_IndexFile *hda, OP_Node *shader_node, VOP_CodeGenerator *code_generator, VOP_ContextType context_type, const char *section_name, OP_Node *output_node)
 Saves the code to section. More...
 
bool isOK () const
 Checks if there was an error during compilation up till now. More...
 
void setStatus (UT_ErrorSeverity sev, const char *msg, const char *details=0)
 
void clearStatus ()
 

Additional Inherited Members

- Static Public Member Functions inherited from VOP_ShaderHDACompiler
static void removeShaderCodeSections (FS_IndexFile *file)
 Utility function for cleaning up HDA of any compiled sections. More...
 
- Static Public Member Functions inherited from VOP_HDACodeCompiler
static bool canCompileNode (OP_Node *srcnode)
 
static void removeCodeSections (OP_Node *node, FS_IndexFile *file)
 
static bool updateCodeSections (OP_Node *node, FS_IndexFile *file, UT_String *message)
 

Detailed Description

A class that compiles a shader and saves it into an existing shader HDA.

Definition at line 359 of file VOP_HDACodeCompiler.h.

Constructor & Destructor Documentation

VOP_ShaderHDACompilerHDA::VOP_ShaderHDACompilerHDA ( )

Constructor.

Member Function Documentation

virtual bool VOP_ShaderHDACompilerHDA::compileVexCodeToSections ( OP_Node srcnode,
FS_IndexFile hda,
const char *  context_mask 
)
virtual

Compiles a given node to the sections of a given HDA (already existing). This is used for HDAs that have contents network, but also want to store cached vfl/vex code.

Parameters
srcnodeThe node from which to obtain vex code.
hdaThe HDA definition to which save the vfl and vex code.

Reimplemented from VOP_HDACodeCompiler.

virtual void VOP_ShaderHDACompilerHDA::doCompile ( FS_IndexFile hda,
VOP_CodeGenerator code_generator,
VOP_ContextType  context_type,
const char *  section_name,
OP_Node output_node 
)
protectedvirtual

Compiles the given context type of the source node to the HDA in OTL.

Implements VOP_ShaderHDACompiler.

virtual void VOP_ShaderHDACompilerHDA::getContextTypesForCompilation ( VOP_ContextTypeList contexts) const
protectedvirtual

Obtains the context types for which to compile the code.

Implements VOP_ShaderHDACompiler.


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