Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

nvsg Namespace Reference

Scenegrah classes - core NVSG. More...


Compounds

class  AnimatedQuads
 GeoSet for animated Quads. More...

class  AnimatedTransform
 Class representing an animated transformation. More...

class  AnimatedTriangles
 GeoSet for animated Triangles. More...

class  Animation
 Class defining the common interface of an animation. More...

class  Camera
 Base class for all camera types. More...

class  CgFx
 Effect attribute. More...

class  CullData
 Class holding culling information for an object and it's children. More...

class  DALHost
 Device Abstraction Link (DAL) Host. More...

class  DALDataCreator
 Creating DALData to be exchanged via a Device Abstraction Link requires this particular interface. More...

class  DALData
 Device Abstraction Link Data. More...

class  DALServer
 Device Abstraction Link Server. More...

class  DirectedLight
 Class representing a directed light. More...

class  Drawable
 Base class of all drawable objects. More...

class  NVSGException
struct  Face
 Helper class for Quads and Triangles. More...

class  FaceAttributeData
 Data of a FaceAttribute that is worth sharing. More...

class  FaceAttribute
 StateAttribute that determines the render modes to use for the following geometries. More...

class  FramedAnimation
 An Animation that holds a complete data set for each frame. More...

class  GeoNode
 Node to hold a set of geometry. More...

class  GeoSet
 Base class for Geometries. More...

class  Group
 Group node. More...

class  HighlightBox
 Base class for Highlighting objects that can be attached to Geosets. More...

class  HighlightEdges
 Base class for Highlighting objects that can be attached to Geosets. More...

class  HighlightObject
 Base class for Highlighting objects that can be attached to Geosets. More...

class  InterpolatedAnimation
 Base class for an interpolating Animation. More...

class  JitterCamera
 A jittering camera. More...

class  LightSource
 Base class for representing all light sources. More...

class  LinearInterpolatedAnimation
 An InterpolatedAnimation that performs linear interpolations between the key frames. More...

class  LOD
 Level Of Detail class. More...

class  Material
 StateAttribute that determines the material properties to use for the following geometries. More...

class  MonoCamera
 A monoscopic camera. More...

class  Node
 Base class for all nodes of the scene graph. More...

class  Object
 Base class for all objects. More...

class  ParallelCamera
 A parallel camera. More...

class  Path
 Path representation in the tree. More...

class  PerspectiveCamera
 A perspective camera. More...

class  SceneLoader
 Pure virtual base class for NVSG scene loader plug-ins. More...

class  SceneSaver
 Pure virtual base class for NVSG scene saver plug-ins. More...

class  PointLight
 Class representing a point light. More...

class  Quads
 GeoSet for Quads. More...

class  QuadStrips
 GeoSet defining quad strips. More...

class  Scene
 Shrink wrap class to subsume all scene related information. More...

class  SimpleCamera
 A simple camera. More...

class  Bone
 Internal helper class for SkinnedTriangles. More...

struct  Skin
 Internal helper class for SkinnedTriangles. More...

class  SkinnedTriangles
 GeoSet for animated Triangles. More...

class  SpotLight
 Class representing a spot light. More...

class  StateAttribute
 Pure virtual base class of all state attribute objects. More...

class  StateSet
 Class to hold a list of StateAttributes. More...

class  StereoCamera
 A stereoscopic camera. More...

class  Switch
 Switch node. More...

class  Texture
 Class to hold a texture. More...

class  TextureAttributeItemData
 Data of a texture attribute item that is worth sharing. More...

class  TextureAttributeItem
 Texture attribute item. More...

class  TextureAttribute
 Texture attribute. More...

class  Transform
 Transformation node. More...

class  Triangles
 GeoSet for Triangles. More...

class  TriStrips
 GeoSet defining triangle strips. More...

class  ViewState
 Class to encapsulate the view specific states. More...

class  VNVector
 Helper class for use in Animation. More...


Typedefs

typedef const CgFxEntity * CgFxEntityHandle
 Handle to a CgFxEntity. More...

typedef const CgFxAnnotation * CgFxAnnotationHandle
 Handle to a CgFxAnnotation. More...

typedef const CgFxParameter * CgFxParameterHandle
 Handle to a CgFxParameter. More...

typedef const CgFxTechnique * CgFxTechniqueHandle
 Handle to a CgFxTechnique. More...

typedef const CgFxPass * CgFxPassHandle
 Handle to a CgFxPass. More...

typedef std::pair< eCgFxSemantic,
CgFxParameterHandle
CgFxTransform
 A pair of a eCgFxSemantic and a CgFxParameterHandle. More...

typedef unsigned long HDAL
typedef void NVSGERRORHANDLER (const NVSGException &)
typedef Face< 3 > Face3
 Shortcut for a 3-element face. More...

typedef Face< 4 > Face4
 Shortcut for a 4-element face. More...

typedef std::vector< unsigned
int > 
IndexSet
 Shortcut for a vector of indices as used in TriStrips and QuadStrips. More...

typedef unsigned long long DataID
 64-bit save DataID. More...


Enumerations

enum  eCgFxSemantic {
  CGFX_SEMANTIC_UNKNOWN = 0, CGFX_SEMANTIC_WORLD, CGFX_SEMANTIC_FIRST_TRANSFORM = CGFX_SEMANTIC_WORLD, CGFX_SEMANTIC_VIEW,
  CGFX_SEMANTIC_PROJECTION, CGFX_SEMANTIC_WORLDT, CGFX_SEMANTIC_VIEWT, CGFX_SEMANTIC_PROJECTIONT,
  CGFX_SEMANTIC_WORLDI, CGFX_SEMANTIC_VIEWI, CGFX_SEMANTIC_PROJECTIONI, CGFX_SEMANTIC_WORLDIT,
  CGFX_SEMANTIC_VIEWIT, CGFX_SEMANTIC_PROJECTIONIT, CGFX_SEMANTIC_WORLDVIEW, CGFX_SEMANTIC_WORLDVIEWPROJECTION,
  CGFX_SEMANTIC_WORLDVIEWT, CGFX_SEMANTIC_WORLDVIEWPROJECTIONT, CGFX_SEMANTIC_WORLDVIEWI, CGFX_SEMANTIC_WORLDVIEWPROJECTIONI,
  CGFX_SEMANTIC_WORLDVIEWIT, CGFX_SEMANTIC_WORLDVIEWPROJECTIONIT, CGFX_SEMANTIC_LAST_TRANSFORM = CGFX_SEMANTIC_WORLDVIEWPROJECTIONIT
}
enum  CullCode { CC_OUT, CC_IN, CC_PART }
 ID to describe the cull code for an object. More...

enum  TextureCoordType { TCT_CYLINDRICAL, TCT_PLANAR, TCT_SPHERICAL }
 Type to specify the type of texture coordinate to generate. More...

enum  {
  OC_INVALID = 0xFFFFFFFF, OC_OBJECT = 0, OC_NODE = OC_OBJECT, OC_GEONODE,
  OC_GROUP, OC_LOD, OC_SWITCH, OC_TRANSFORM,
  OC_ANIMATEDTRANSFORM, OC_DIRECTEDLIGHT, OC_POINTLIGHT, OC_SPOTLIGHT,
  OC_DRAWABLES = 0x20, OC_GEOSET, OC_QUADS, OC_ANIMATEDQUADS,
  OC_QUADSTRIPS, OC_TRIANGLES, OC_ANIMATEDTRIANGLES, OC_SKINNEDTRIANGLES,
  OC_TRISTRIPS, OC_STATESET = 0x40, OC_STATEATTRIBUTE, OC_CGFX,
  OC_FACEATTRIBUTE, OC_MATERIAL, OC_TEXTUREATTRIBUTE, OC_TEXTUREATTRIBUTEITEM,
  OC_ANIMATION = 0x60, OC_FRAMEDTRAFOANIMATION, OC_FRAMEDVNVECTORANIMATION, OC_LINEARINTERPOLATEDTRAFOANIMATION,
  OC_LINEARINTERPOLATEDVNVECTORANIMATION, OC_CAMERA = 0x80, OC_JITTERCAMERA, OC_PARALLELCAMERA,
  OC_PERSPECTIVECAMERA, OC_STEREOCAMERA, OC_HIGHLIGHTOBJECT = 0xA0, OC_HIGHLIGHTBOX,
  OC_HIGHLIGHTEDGES, OC_CUSTOMOBJECT = 0xC0
}
 Object Codes for NVCSG Object Type Identification. More...

enum  TextureType { TT_INVALID = 0, TT_TRANSPARENT = 1, TT_DIFFUSE = 3 }
 Texture types. More...

enum  TexCoordAxis { TCA_S = 0, TCA_T, TCA_R, TCA_Q }
 Texture coordinate axis. More...

enum  TextureEnvMode {
  TEM_REPLACE = 0, TEM_MODULATE, TEM_DECAL, TEM_BLEND,
  TEM_ADD
}
 Texture environment mode. More...

enum  TexGenLinearMode { TGML_OBJECT = 0, TGML_EYE }
 Texture coordinate generation linear mode. More...

enum  TexGenMode { TGM_OFF = -1, TGM_OBJECT_LINEAR = TGML_OBJECT, TGM_EYE_LINEAR = TGML_EYE, TGM_SPHERE_MAP }
 Texture coordinate generation mode. More...

enum  TextureWrapMode { TWM_REPEAT = 0, TWM_CLAMP, TWM_MIRROR }
 Texture wrap mode. More...

enum  TextureMinFilterMode { TFM_MIN_NEAREST = 0, TFM_MIN_BILINEAR, TFM_MIN_TRILINEAR }
 Texture minification mode. More...

enum  TextureMagFilterMode { TFM_MAG_NEAREST = 0, TFM_MAG_BILINEAR }
 Texture magnification mode. More...


Functions

NVSG_API bool CgFx_getTextureFileName (const CgFx *cgfx, CgFxParameterHandle hdl, std::string &file)
 Get texture file name. More...

NVSG_API void CgFx_setTextureFileName (CgFx *cgfx, CgFxParameterHandle hdl, const std::string &file)
 Set texture file name. More...

const char * getParameterName (CgFxParameterHandle hdl)
 Get the name for a certain parameter. More...

const char * getPassName (CgFxPassHandle hdl)
 Get the name for a certain render pass. More...

const char * getTechniqueName (CgFxTechniqueHandle hdl)
 Get the name for a certain render technique. More...

const char * getParameterSemantic (CgFxParameterHandle hdl)
 Get the semantic for a certain parameter. More...

CgFXPARAMETERTYPE getParameterType (CgFxParameterHandle hdl)
 Get the type of a certain parameter. More...

bool isParameterScalarType (CgFxParameterHandle hdl)
 Detect if the parameter identified by hdl is a scalar type. More...

bool isParameterVector2Type (CgFxParameterHandle hdl)
 Detect if the parameter identified by hdl is a two-dimensional vector type. More...

bool isParameterVector3Type (CgFxParameterHandle hdl)
 Detect if the parameter identified by hdl is a three-dimensional vector type. More...

bool isParameterVector4Type (CgFxParameterHandle hdl)
 Detect if the parameter identified by hdl is a four-dimensional vector type. More...

bool isParameterMatrix33Type (CgFxParameterHandle hdl)
 Detect if the parameter identified by hdl is a 3x3 matrix type. More...

bool isParameterMatrix34Type (CgFxParameterHandle hdl)
 Detect if the parameter identified by hdl is a 3x4 matrix type. More...

bool isParameterMatrix43Type (CgFxParameterHandle hdl)
 Detect if the parameter identified by hdl is a 4x3 matrix type. More...

bool isParameterMatrix44Type (CgFxParameterHandle hdl)
 Detect if the parameter identified by hdl is a 4x4 matrix type. More...

bool isParameterTextureType (CgFxParameterHandle hdl)
 Detect if the parameter identified by hdl is a texture type. More...

bool isParameterSamplerType (CgFxParameterHandle hdl)
 Detect if the parameter identified by hdl is a sampler type. More...

bool isTechniqueValid (CgFxTechniqueHandle hdl)
 Detect whether the technique identified by hdl is valid. More...

NVSGERRORHANDLERnvsgSetErrorHandler (NVSGERRORHANDLER *newErrorHandler)
NVSG_API void nvsgInitialize (bool runInMultithreadedEnvironment=false)
 Per-application initialization of NVSG global data. More...

NVSG_API void nvsgTerminate ()
 Per-application termination of nvsg global data. More...

NVSG_API void getVersionString (std::string &string)
 Get the version string of the NVSGSDK. More...

NVSG_API void getSDKName (std::string &string)
 Get the NVSGSDK name string. More...

NVSG_API void getCopyrightString (std::string &string)
 Get the NVSGSDK copyright string. More...

NVSG_API void getVendorName (std::string &string)
 Get the NVSGSDK vendor name. More...

template<typename T> const T * endEdit (const T *&obj)
template<typename T> bool isTypeOf (const Object *p)
 Detect if the Object pointed to by p is a pointer to a specified (templated) type. More...

bool areOfSameType (const Object &p0, const Object &p1)
 Detect if the two Objects p0 and p1 are of the same type. More...

VNVector lerp (float alpha, const VNVector &v0, const VNVector &v1)
 Linear interpolation between two VNVector. More...


Variables

const HDAL HDAL_INVALID
NVSGERRORHANDLERnvsgErrorHandler


Detailed Description

Scenegrah classes - core NVSG.

This namespace contains all core NVSG classes. Put all the scenegraph and node related classes in here.


Typedef Documentation

typedef const CgFxEntity* nvsg::CgFxEntityHandle
 

Handle to a CgFxEntity.

typedef const CgFxAnnotation* nvsg::CgFxAnnotationHandle
 

Handle to a CgFxAnnotation.

typedef const CgFxParameter* nvsg::CgFxParameterHandle
 

Handle to a CgFxParameter.

typedef const CgFxTechnique* nvsg::CgFxTechniqueHandle
 

Handle to a CgFxTechnique.

typedef const CgFxPass* nvsg::CgFxPassHandle
 

Handle to a CgFxPass.

typedef std::pair<eCgFxSemantic, CgFxParameterHandle> nvsg::CgFxTransform
 

A pair of a eCgFxSemantic and a CgFxParameterHandle.

typedef void nvsg::NVSGERRORHANDLER(const NVSGException&)
 

A NVSG error handler routine is of this type

typedef Face<3> nvsg::Face3
 

Shortcut for a 3-element face.

typedef Face<4> nvsg::Face4
 

Shortcut for a 4-element face.

typedef std::vector<unsigned int> nvsg::IndexSet
 

Shortcut for a vector of indices as used in TriStrips and QuadStrips.

typedef unsigned long long nvsg::DataID
 

64-bit save DataID.

The DataID is used to identify an instance of an Object.


Enumeration Type Documentation

enum nvsg::eCgFxSemantic
 

Enumeration values:
CGFX_SEMANTIC_WORLD  Object to world transform.
CGFX_SEMANTIC_VIEW  World to eyespace transform.
CGFX_SEMANTIC_PROJECTION  Projection matrix.
CGFX_SEMANTIC_WORLDT  Transposed world transform.
CGFX_SEMANTIC_VIEWT  Transposed view transform.
CGFX_SEMANTIC_PROJECTIONT  Transposed projection matrix.
CGFX_SEMANTIC_WORLDI  World to object transform.
CGFX_SEMANTIC_VIEWI  Eyespace to world transform.
CGFX_SEMANTIC_PROJECTIONI  Inverse projection matrix.
CGFX_SEMANTIC_WORLDIT  Inverse transposed world transform.
CGFX_SEMANTIC_VIEWIT  Inverse transposed view transform.
CGFX_SEMANTIC_PROJECTIONIT  Inverse transposed projection matrix.
CGFX_SEMANTIC_WORLDVIEW  Concatenated modelview matrix.
CGFX_SEMANTIC_WORLDVIEWPROJECTION  Concatenated modelview projection matrix.
CGFX_SEMANTIC_WORLDVIEWT  Transposed modelview matrix.
CGFX_SEMANTIC_WORLDVIEWPROJECTIONT  Transposed modelview projection matrix.
CGFX_SEMANTIC_WORLDVIEWI  Inverse modelview matrix.
CGFX_SEMANTIC_WORLDVIEWPROJECTIONI  Inverse modelview projection matrix.
CGFX_SEMANTIC_WORLDVIEWIT  Inverse transposed modelview matrix.
CGFX_SEMANTIC_WORLDVIEWPROJECTIONIT  Inverse transposed modelview projection matrix.

enum nvsg::CullCode
 

ID to describe the cull code for an object.

Enumeration values:
CC_OUT  an object is completely outside.
CC_IN  an object is completely inside.
CC_PART  an object is partially in and partially out.

enum nvsg::TextureCoordType
 

Type to specify the type of texture coordinate to generate.

There are three different types of texture coordinate generation available: cylindrical, planar, and spherical.

Enumeration values:
TCT_CYLINDRICAL  Puts a cylinder around the BoundingSphere with the z-axis as it's axis and projects the vertices of the GeoSet on it to get the texture coordinates.
TCT_PLANAR  Puts a plane in the x-y-plane and vertically projects the vertices of the GeoSet on that plane to the the texture coordinates.
TCT_SPHERICAL  Projects the vertices of the GeoSet radially on the BoundingSphere to get the texture coordinates.

anonymous enum
 

Object Codes for NVCSG Object Type Identification.

For a custom traverser it is essential to identify all actual scenegraph components while traversing the scenegraph, and to call the corresponding handler routine for a particular object. For this reason, all concrete NVSG object types must be assigned to a unique object code. Secure object codes for custom defined NVSG objects start at OC_CUSTOMOBJECT.\n\n See also: How to Derive a Traverser and How to Derive an NVSG Object for further information.

Note:
Choosing an object code lower than OC_CUSTOMOBJECT for a custom-defined NVSG object results in undefined runtime behavior!
Enumeration values:
OC_INVALID  invalid object code.
OC_OBJECT  Object.
OC_NODE  Node = 0x00.
OC_GEONODE  GeoNode.
OC_GROUP  Group.
OC_LOD  LOD.
OC_SWITCH  Switch.
OC_TRANSFORM  Transform.
OC_ANIMATEDTRANSFORM  AnimatedTransform.
OC_DIRECTEDLIGHT  DirectedLight.
OC_POINTLIGHT  PointLight.
OC_SPOTLIGHT  SpotLight.
OC_DRAWABLES  Drawable = 0x20.
OC_GEOSET  GeoSet.
OC_QUADS  Quads.
OC_ANIMATEDQUADS  AnimatedQuads.
OC_QUADSTRIPS  QuadStrips.
OC_TRIANGLES  Triangles.
OC_ANIMATEDTRIANGLES  AnimatedTriangles.
OC_SKINNEDTRIANGLES  SkinnedTriangles.
OC_TRISTRIPS  TriStrips.
OC_STATESET  StateSet = 0x40.
OC_STATEATTRIBUTE  StateAttribute.
OC_CGFX  CgFX.
OC_FACEATTRIBUTE  FaceAttribute.
OC_MATERIAL  Material.
OC_TEXTUREATTRIBUTE  TextureAttribute.
OC_TEXTUREATTRIBUTEITEM  TextureAttributeItem.
OC_ANIMATION  Animation = 0x60.
OC_FRAMEDTRAFOANIMATION  FramedTrafoAnimation.
OC_FRAMEDVNVECTORANIMATION  FramedVectorAnimation.
OC_LINEARINTERPOLATEDTRAFOANIMATION  LinearAnimatedTrafoAnimation.
OC_LINEARINTERPOLATEDVNVECTORANIMATION  LinearInterpolatedVNVectorAnimation.
OC_CAMERA  Camera = 0x80.
OC_JITTERCAMERA  JitterCamera.
OC_PARALLELCAMERA  ParallelCamera.
OC_PERSPECTIVECAMERA  PerspectiveCamera.
OC_STEREOCAMERA  StereoCamera.
OC_HIGHLIGHTOBJECT  HighlightObject = 0xA0.
OC_HIGHLIGHTBOX  HighlightBox.
OC_HIGHLIGHTEDGES  HighlightEdges.
OC_CUSTOMOBJECT  CustomObjects = 0xC0.

enum nvsg::TextureType
 

Texture types.

Enumeration values:
TT_INVALID  invalid texture type.
TT_TRANSPARENT  transparent texture type - blending on.
TT_DIFFUSE  diffuse texture.

enum nvsg::TexCoordAxis
 

Texture coordinate axis.

enum nvsg::TextureEnvMode
 

Texture environment mode.

Enumeration values:
TEM_REPLACE  C = C_t; A = A_t.
TEM_MODULATE  C = C_f*C_t; A = A_f*A_t.
TEM_DECAL  C = C_f*(1-A_t)+C_t*A_t; A = A_f.
TEM_BLEND  C = C_f*(1-C_t)+C_c*C_t; A = A_f*A_t.
TEM_ADD  C = min(1,C_f+C_t); A = A_f*A_t.

enum nvsg::TexGenLinearMode
 

Texture coordinate generation linear mode.

enum nvsg::TexGenMode
 

Texture coordinate generation mode.

enum nvsg::TextureWrapMode
 

Texture wrap mode.

Enumeration values:
TWM_REPEAT  Corresponds to GL_REPEAT in OpenGL.
TWM_CLAMP  Corresponds to GL_CLAMP in OpenGL.
TWM_MIRROR  Corresponds to GL_MIRRORED_REPEAT_ARB in OpenGL.

enum nvsg::TextureMinFilterMode
 

Texture minification mode.

Enumeration values:
TFM_MIN_NEAREST  Corresponds to GL_NEAREST in OpenGL.
TFM_MIN_BILINEAR  Corresponds to GL_LINEAR in OpenGL.
TFM_MIN_TRILINEAR  Corresponds to GL_LINEAR_MIPMAP_LINEAR in OpenGL.

enum nvsg::TextureMagFilterMode
 

Texture magnification mode.

Enumeration values:
TFM_MAG_NEAREST  Corresponds to GL_NEAREST in OpenGL.
TFM_MAG_BILINEAR  Corresponds to GL_LINEAR in OpenGL.


Function Documentation

NVSG_API bool CgFx_getTextureFileName const CgFx   cgfx,
CgFxParameterHandle    hdl,
std::string &    file
 

Get texture file name.

If a texture filename is available for a texture type parameter identified by hdl, this function obtains the texture file name in fname.

Returns:
true if a texture file name could be found, false otherwise.
Note:
It doesn't make sense to call this function for non-texture type parameters. It will not crash, though.

NVSG_API void CgFx_setTextureFileName CgFx   cgfx,
CgFxParameterHandle    hdl,
const std::string &    file
 

Set texture file name.

For a texture type parameter identified by hdl, this function sets the texture file name to file.

Note:
Calling this function for non-texture type parameters yields undefind behaviour!

const char* getParameterName CgFxParameterHandle    hdl [inline]
 

Get the name for a certain parameter.

Returns:
The name of the parameter identified by hdl.

const char* getPassName CgFxPassHandle    hdl [inline]
 

Get the name for a certain render pass.

Returns:
The name of the pass identified by hdl.

const char* getTechniqueName CgFxTechniqueHandle    hdl [inline]
 

Get the name for a certain render technique.

Returns:
The name of the technique identified by hdl.

const char* getParameterSemantic CgFxParameterHandle    hdl [inline]
 

Get the semantic for a certain parameter.

Returns:
The semantic string for the parameter identified by hdl.

CgFXPARAMETERTYPE getParameterType CgFxParameterHandle    hdl [inline]
 

Get the type of a certain parameter.

Returns:
The enum type for the parameter identified by hdl.

bool isParameterScalarType CgFxParameterHandle    hdl [inline]
 

Detect if the parameter identified by hdl is a scalar type.

Returns:
true if the parameter is a scalar type, false otherwise.

bool isParameterVector2Type CgFxParameterHandle    hdl [inline]
 

Detect if the parameter identified by hdl is a two-dimensional vector type.

Returns:
true if the parameter is a two-dimensional vector type, false otherwise.

bool isParameterVector3Type CgFxParameterHandle    hdl [inline]
 

Detect if the parameter identified by hdl is a three-dimensional vector type.

Returns:
true if the parameter is a three-dimensional vector type, false otherwise.

bool isParameterVector4Type CgFxParameterHandle    hdl [inline]
 

Detect if the parameter identified by hdl is a four-dimensional vector type.

Returns:
true if the parameter is a four-dimensional vector type, false otherwise.

bool isParameterMatrix33Type CgFxParameterHandle    hdl [inline]
 

Detect if the parameter identified by hdl is a 3x3 matrix type.

Returns:
true if the parameter is a 3x3 matrix type, false otherwise.

bool isParameterMatrix34Type CgFxParameterHandle    hdl [inline]
 

Detect if the parameter identified by hdl is a 3x4 matrix type.

Returns:
true if the parameter is a 3x4 matrix type, false otherwise.

bool isParameterMatrix43Type CgFxParameterHandle    hdl [inline]
 

Detect if the parameter identified by hdl is a 4x3 matrix type.

Returns:
true if the parameter is a 4x3 matrix type, false otherwise.

bool isParameterMatrix44Type CgFxParameterHandle    hdl [inline]
 

Detect if the parameter identified by hdl is a 4x4 matrix type.

Returns:
true if the parameter is a 4x4 matrix type, false otherwise.

bool isParameterTextureType CgFxParameterHandle    hdl [inline]
 

Detect if the parameter identified by hdl is a texture type.

Returns:
true if the parameter is a texture type, false otherwise.

bool isParameterSamplerType CgFxParameterHandle    hdl [inline]
 

Detect if the parameter identified by hdl is a sampler type.

Returns:
true if the parameter is a sampler type, false otherwise.

bool isTechniqueValid CgFxTechniqueHandle    hdl [inline]
 

Detect whether the technique identified by hdl is valid.

Returns:
true if the technique is valid, false otherwise.

NVSGERRORHANDLER* nvsgSetErrorHandler NVSGERRORHANDLER   newErrorHandler
 

Replace the current NVSG error handler by newErrorHandler

Parameters

  • newErrorHandler The replacement for the currently used NVSG error handler routine.
Return Value A pointer to the formerly used error handler routine.

NVSG_API void nvsgInitialize bool    runInMultithreadedEnvironment = false
 

Per-application initialization of NVSG global data.

An application must call this routine once before any other NVSG API call. This routine properly initializes all global data required by the NVSG API.

In addition, this routine optionally configures the NVSG library to run safe in a multithreaded environment. This will be achieved by specifying true for the optional runInMultithreadedEnvironment parameter. For a singlethreaded environment, it is strongly recommended to either omit this parameter, or to specify false here. Making the NVSG library multithreaded safe requires some overhead, which might affect the runtime behavior in a singlethreaded environment.

It is recommended to call this routine inside the application's initial entry point.

Note:
The nvsg runtime behaviour is undefined if an application issues nvsg API calls without a prior call to this routine.
Parameters:
runInMultithreadedEnvironment  Specifies whether to run in a multithreaded environment, or not. Specify false when running in a singlethreaded environment, true when running in a multithreaded environment.

NVSG_API void nvsgTerminate  
 

Per-application termination of nvsg global data.

It is strongly recommended to call this routine when the application terminates. This routine properly frees all global data required by the nvsg API.

Note:
The nvsg runtime behaviour is undefined if an application issues nvsg API calls after having called this routine.

NVSG_API void getVersionString std::string &    string
 

Get the version string of the NVSGSDK.

Parameters:
string  string to hold the NVSGSDK version string

NVSG_API void getSDKName std::string &    string
 

Get the NVSGSDK name string.

Parameters:
string  string to hold the NVSGSDK name string

NVSG_API void getCopyrightString std::string &    string
 

Get the NVSGSDK copyright string.

Parameters:
string  string to hold the NVSGSDK coppyright string

NVSG_API void getVendorName std::string &    string
 

Get the NVSGSDK vendor name.

Parameters:
string  string to hold the NVSGSDK vendor name string

template<typename T>
bool isTypeOf const Object   p [inline]
 

Detect if the Object pointed to by p is a pointer to a specified (templated) type.

Returns:
true if p is a pointer to the specified type, false otherwise.

bool areOfSameType const Object   p0,
const Object   p1
[inline]
 

Detect if the two Objects p0 and p1 are of the same type.

Returns:
true if p0 and p1 are of the same type, false otherwise.

VNVector lerp float    alpha,
const VNVector   v0,
const VNVector   v1
[inline]
 

Linear interpolation between two VNVector.

Performs a linear interpolation v = v0 + alpha * ( v1 - v0 ) of each corresponding vertex and normal of the two VNVector. The interpolated normals are normalized then.

Note:
The two VNVector are assumed to be the same size.
Returns:
a VNVector with the interpolated vertices and normals.
Parameters:
alpha  interpolation parameter
v0  start value of interpolation
v1  end value of interpolation


Variable Documentation

NVSGERRORHANDLER* nvsg::nvsgErrorHandler
 

Global pointer to the currently used NVSG error handler routine. Use the nvsgSetErrorHandler function to assign a new error handler routine .


Generated on Tue Mar 1 13:20:23 2005 for NVSGSDK by NVIDIA