#include <CgFx.h>
Inheritance diagram for nvsg::CgFx:
Public Methods | |
virtual NVSG_API const CgFx * | clone (void) const |
Get a clone of this CgFx attribute. More... | |
NVSG_API bool | createEffectFromFile (const std::string &file) |
Create effect from file. More... | |
NVSG_API bool | isEffectValid (void) const |
Detect whether the embedded effect is valid. More... | |
NVSG_API const std::string & | getEffectFile (void) const |
Get effect file. More... | |
NVSG_API size_t | getNumberOfTransforms (void) const |
Get the number of transforms. More... | |
NVSG_API const CgFxTransform & | getTransform (size_t index) const |
Get transform by index. More... | |
NVSG_API size_t | getNumberOfTweakables (void) const |
Get the number of tweakables. More... | |
NVSG_API CgFxParameterHandle | getTweakable (size_t index) const |
Get tweakable by index. More... | |
NVSG_API CgFxParameterHandle | getTweakable (const std::string &name) const |
Get tweakable by name. More... | |
NVSG_API size_t | getNumberOfAnnotations (CgFxEntityHandle hdl) const |
Get the number of Annotations. More... | |
NVSG_API CgFxAnnotationHandle | getAnnotation (CgFxEntityHandle hdl, size_t index) const |
Get annotation by index. More... | |
NVSG_API CgFxAnnotationHandle | getAnnotation (CgFxEntityHandle hdl, const std::string &name) const |
Get annotation by name. More... | |
template<typename ValueType> void | getValue (CgFxParameterHandle hdl, ValueType &value) const |
Get a CgFxParameter's value. More... | |
template<typename ValueType> void | getValue (CgFxParameterHandle hdl, ValueType *value) const |
getValue specialization for general pointer types. More... | |
NVSG_API void | getValue (CgFxParameterHandle hdl, const char **value) const |
getValue specialization for 'pointer to char pointer' types. More... | |
NVSG_API void | getValue (CgFxParameterHandle hdl, std::string &value) const |
getValue specialization for string types. More... | |
template<typename ValueType> void | setValue (CgFxParameterHandle hdl, const ValueType &value) |
Set a CgFxParameter's value. More... | |
template<typename ValueType> void | setValue (CgFxParameterHandle hdl, const ValueType &value) const |
template<typename ValueType> void | setValue (CgFxParameterHandle hdl, const ValueType *value) |
setValue specialization for general pointer types. More... | |
template<typename ValueType> void | setValue (CgFxParameterHandle hdl, const ValueType *value) const |
NVSG_API void | setValue (CgFxParameterHandle hdl, const char *value) |
setValue specialization for 'pointer to char' types. More... | |
NVSG_API void | setValue (CgFxParameterHandle hdl, const char *value) const |
NVSG_API void | setValue (CgFxParameterHandle hdl, const std::string &value) |
setValue specialization for string types. More... | |
NVSG_API void | setValue (CgFxParameterHandle hdl, const std::string &value) const |
NVSG_API size_t | getNumberOfTechniques (void) const |
Get the number of techniques. More... | |
NVSG_API CgFxTechniqueHandle | getTechnique (size_t index) const |
Get the technique by index. More... | |
NVSG_API size_t | getCurrentTechnique (void) const |
NVSG_API void | setCurrentTechnique (size_t index) |
NVSG_API bool | validateCurrentTechnique (void) const |
Validate the current technique. More... | |
NVSG_API bool | isCurrentTechniqueValid (void) const |
Determine if the current technique is valid. More... | |
NVSG_API bool | isCurrentTechniqueValidationPending (void) const |
Detect whether validation of the current technique is pending. More... | |
NVSG_API size_t | getNumberOfPasses (CgFxTechniqueHandle hdl) const |
Get the number of render passes. More... | |
NVSG_API CgFxPassHandle | getPass (CgFxTechniqueHandle hdl, size_t index) const |
Get the render pass by index. More... | |
NVSG_API bool | passFirstPass (void) const |
Initiate the first rendering pass. More... | |
NVSG_API bool | passNextPass (void) const |
Introduce subsequent rendering passes. More... | |
virtual NVSG_API DataID | getDataID (void) const |
Shared data identifier. More... | |
virtual NVSG_API bool | isDataShared (void) const |
Data sharing. More... | |
Static Public Methods | |
NVSG_API const CgFx * | create (void) |
Create a CgFx. More... | |
NVSG_API const CgFx * | createFromBase (const StateAttribute &rhs) |
Create a CgFx by copying from a StateAttribute. More... | |
Protected Methods | |
NVSG_API | CgFx (void) |
Default Constructor. More... | |
NVSG_API | CgFx (const StateAttribute &rhs) |
Partial Constructor. More... | |
NVSG_API | CgFx (const CgFx &rhs) |
Copy Constructor. More... | |
virtual NVSG_API | ~CgFx (void) |
A special state attribute describing a CgFX effect.
|
Default Constructor.
|
|
Partial Constructor.
|
|
Copy Constructor.
|
|
Create a CgFx.
|
|
Create a CgFx by copying from a StateAttribute.
|
|
Get a clone of this CgFx attribute.
Implements nvsg::StateAttribute. |
|
Create effect from file. This function creates an effect from an effect file given by file.
|
|
Detect whether the embedded effect is valid.
|
|
Get effect file.
|
|
Get the number of transforms.
|
|
Get transform by index.
|
|
Get the number of tweakables.
|
|
Get tweakable by index.
|
|
Get tweakable by name.
|
|
Get the number of Annotations.
|
|
Get annotation by index.
|
|
Get annotation by name.
|
|
Get a CgFxParameter's value. A function of this function family obtains the current value for a CgFxParameter identified by by hdl.
|
|
|
|
|
|
|
|
Set a CgFxParameter's value. A function of this family updates the current value for a CgFxParameter identified by hdl.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Get the number of techniques.
|
|
Get the technique by index.
|
|
|
|
Makes the technique at index index the current one for subsequent rendering.
|
|
Validate the current technique. Validates the current technique for subsequent rendering.
|
|
Determine if the current technique is valid.
|
|
Detect whether validation of the current technique is pending.
|
|
Get the number of render passes.
|
|
Get the render pass by index.
|
|
Initiate the first rendering pass. Initiates the first render pass for the current technique. Before the client code sends vertex data to the hardware for rendering, this call is needed to a.) set up the current technique for subsequent application on a per-pass basis, and b.) to apply the state for the first rendering pass.
|
|
Introduce subsequent rendering passes. Applies the state for the very next rendering pass if available. If no subsequent rendering pass is available, this function properly ends the application of the current technique.
|
|
Shared data identifier. Data that is shared between different CgFx attributes will be unambiguously identified by its data ID.
Reimplemented from nvsg::StateAttribute. |
|
Data sharing. A CgFX attribute can share its data with annother CgFx attribute to save memory.
Reimplemented from nvsg::StateAttribute. |