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

nvsg.h File Reference

#include "nvsgcommon.h"
#include <string>
#include <vector>

Include dependency graph for nvsg.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

namespace  nvsg

Typedefs

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

Functions

NVSG_API void nvsgInitialize (bool runInMultithreadedEnvironment=false)
 Per-application initialization of NVSG global data.
NVSG_API void nvsgTerminate ()
 Per-application termination of nvsg global data.
NVSG_API void getVersionString (std::string &string)
 Get the version string of the NVSGSDK.
NVSG_API void getSDKName (std::string &string)
 Get the NVSGSDK name string.
NVSG_API void getCopyrightString (std::string &string)
 Get the NVSGSDK copyright string.
NVSG_API void getVendorName (std::string &string)
 Get the NVSGSDK vendor name.


Detailed Description


Typedef Documentation

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

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


Function Documentation

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


Generated on Tue Mar 1 13:19:46 2005 for NVSGSDK by NVIDIA