Main Page   Modules   Alphabetical List   Data Structures   Data Fields  

RwEngine
[Initialization & Resource Management]


Modules

D3D9

Data Structures

struct  RwEngineOpenParams
struct  RwMetrics
struct  RwSubSystemInfo
struct  RwVideoMode

Defines

#define rwID_SPLINEPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x02)
#define rwID_MORPHPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x05)
#define rwID_LOGOPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x0a)
#define rwID_RANDOMPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x0c)
#define rwID_PNGIMAGEPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x0d)
#define rwID_SKYMIPMAPVAL   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x10)
#define rwID_LODATMPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x12)
#define rwID_LTMAPPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x14)
#define rwID_SKINPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x16)
#define rwID_COLLISPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x1d)
#define rwID_HANIMPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x1e)
#define rwID_USERDATAPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x1f)
#define rwID_MATERIALEFFECTSPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x20)
#define rwID_DMORPHPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x22)
#define rwID_PATCHPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x23)
#define rwID_TEAMPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x24)
#define rwID_CROWDPPPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x25)
#define rwID_ANISOTPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x27)
#define rwID_GPVSPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x2a)
#define rwID_TOONPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x2e)
#define rwID_PTANKPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x2f)
#define rwID_PRTSTDPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x30)
#define rwID_PRTADVPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x32)
#define rwID_ADCPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x34)
#define rwID_UVANIMPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x35)
#define rwID_ENVIRONMENTPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x36)
#define rwID_CHARSEPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x80)
#define rwID_NOHSWORLDPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x81)
#define rwID_SLERPPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x83)
#define rwID_TLWORLDPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x85)
#define rwID_RAYPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x88)
#define rwID_2DPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x90)
#define rwID_TILERENDPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x91)
#define rwID_JPEGIMAGEPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x92)
#define rwID_QUATPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x95)
#define rwID_SPLINEPVSPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x96)
#define rwID_MIPMAPKPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x98)
#define rwID_INTSECPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x9a)
#define rwID_TIFFIMAGEPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x9b)
#define rwID_PICKPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x9c)
#define rwID_BMPIMAGEPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x9d)
#define rwID_RASIMAGEPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x9e)
#define rwID_VCATPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0xa0)
#define rwID_2DANIM   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0xa9)
#define rwID_BARYCENTRIC   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0xb2)
#define rwID_PITEXDICTIONARYTK   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0xb3)
#define rwID_TOCTOOLKIT   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0xb4)
#define rwID_ANIMTOOLKIT   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0xb7)
#define rwID_SKINSPLITTOOKIT   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0xb8)
#define rwID_CMPKEYTOOLKIT   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0xb9)
#define rwID_GEOMCONDPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0xba)
#define rwID_WINGPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0xbb)
#define rwID_GENCPIPETOOLKIT   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0xbc)
#define rwID_LTMAPCNVTOOLKIT   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0xbd)
#define rwID_FILESYSTEMPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0xbe)
#define rwID_DICTTOOLKIT   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0xbf)

Enumerations

enum  RwCriterionCoreID {
  rwID_NACOREID = MAKECHUNKID(rwVENDORID_CRITERIONINT, 0x00), rwID_VECTORMODULE = MAKECHUNKID(rwVENDORID_CRITERIONINT, 0x01), rwID_MATRIXMODULE = MAKECHUNKID(rwVENDORID_CRITERIONINT, 0x02), rwID_FRAMEMODULE = MAKECHUNKID(rwVENDORID_CRITERIONINT, 0x03),
  rwID_STREAMMODULE = MAKECHUNKID(rwVENDORID_CRITERIONINT, 0x04), rwID_CAMERAMODULE = MAKECHUNKID(rwVENDORID_CRITERIONINT, 0x05), rwID_IMAGEMODULE = MAKECHUNKID(rwVENDORID_CRITERIONINT, 0x06), rwID_RASTERMODULE = MAKECHUNKID(rwVENDORID_CRITERIONINT, 0x07),
  rwID_TEXTUREMODULE = MAKECHUNKID(rwVENDORID_CRITERIONINT, 0x08), rwID_PIPEMODULE = MAKECHUNKID(rwVENDORID_CRITERIONINT, 0x09), rwID_IMMEDIATEMODULE = MAKECHUNKID(rwVENDORID_CRITERIONINT, 0x0A), rwID_RESOURCESMODULE = MAKECHUNKID(rwVENDORID_CRITERIONINT, 0x0B),
  rwID_DEVICEMODULE = MAKECHUNKID(rwVENDORID_CRITERIONINT, 0x0C), rwID_COLORMODULE = MAKECHUNKID(rwVENDORID_CRITERIONINT, 0x0D), rwID_POLYPIPEMODULE = MAKECHUNKID(rwVENDORID_CRITERIONINT, 0x0E), rwID_ERRORMODULE = MAKECHUNKID(rwVENDORID_CRITERIONINT, 0x0F),
  rwID_METRICSMODULE = MAKECHUNKID(rwVENDORID_CRITERIONINT, 0x10), rwID_DRIVERMODULE = MAKECHUNKID(rwVENDORID_CRITERIONINT, 0x11), rwID_CHUNKGROUPMODULE = MAKECHUNKID(rwVENDORID_CRITERIONINT, 0x12), rwCRITERIONCOREIDFORCEENUMSIZEINT = RWFORCEENUMSIZEINT
}
enum  RwVideoModeFlag {
  rwVIDEOMODEEXCLUSIVE = 0x0001, rwVIDEOMODEINTERLACE = 0x0002, rwVIDEOMODEFFINTERLACE = 0x0004, rwVIDEOMODE_PS2_FSAASHRINKBLIT = 0x0100,
  rwVIDEOMODE_PS2_FSAAREADCIRCUIT = 0x0200, rwVIDEOMODE_XBOX_WIDESCREEN = 0x0100, rwVIDEOMODE_XBOX_PROGRESSIVE = 0x0200, rwVIDEOMODE_XBOX_FIELD = 0x0400,
  rwVIDEOMODE_XBOX_10X11PIXELASPECT = 0x0800, rwVIDEOMODEFLAGFORCEENUMSIZEINT = RWFORCEENUMSIZEINT
}
enum  RwEngineInitFlag { rwENGINEINITFREELISTS = 0, rwENGINEINITNOFREELISTS = 0x1, rwENGINEINITFLAGFORCEENUMSIZEINT = RWFORCEENUMSIZEINT }

Functions

RwUInt32 RwEngineGetVersion (void)
RwInt32 RwEngineRegisterPlugin (RwInt32 size, RwUInt32 pluginID, RwPluginObjectConstructor initCB, RwPluginObjectDestructor termCB)
RwInt32 RwEngineGetPluginOffset (RwUInt32 pluginID)
RwInt32 RwEngineGetNumSubSystems (void)
RwSubSystemInfo * RwEngineGetSubSystemInfo (RwSubSystemInfo *subSystemInfo, RwInt32 subSystemIndex)
RwInt32 RwEngineGetCurrentSubSystem (void)
RwBool RwEngineSetSubSystem (RwInt32 subSystemIndex)
RwInt32 RwEngineGetNumVideoModes (void)
RwVideoMode * RwEngineGetVideoModeInfo (RwVideoMode *modeinfo, RwInt32 modeIndex)
RwInt32 RwEngineGetCurrentVideoMode (void)
RwBool RwEngineSetVideoMode (RwInt32 modeIndex)
RwInt32 RwEngineGetTextureMemorySize (void)
RwInt32 RwEngineGetMaxTextureSize (void)
RwBool RwEngineSetFocus (RwBool enable)
RwMetrics * RwEngineGetMetrics (void)
RwBool RwEngineStop (void)
RwBool RwEngineStart (void)
RwBool RwEngineClose (void)
RwBool RwEngineOpen (RwEngineOpenParams *initParams)
RwBool RwEngineTerm (void)
RwBool RwEngineInit (const RwMemoryFunctions *memFuncs, RwUInt32 openFlags, RwUInt32 resArenaSize)

Detailed Description

Device handling.

RwEngine Overview

Requirements

Overview

This object exposes RenderWare Graphics engine. The engine manages:

All RenderWare Graphics applications must Initialize, Open, then Start the RenderWare Graphics Engine before entering their main loop.

All plugins must be registered - by calling their respective "PluginAttach()" functions - prior to calling RwEngineStart.

Define Documentation

#define rwID_2DANIM   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0xa9)
 

defines the pluginID for the Rt2dAnim (inc. Maestro) toolkit. See RwEngineRegisterPlugin

#define rwID_2DPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x90)
 

defines the pluginID for the Rt2d toolkit. See RwEngineRegisterPlugin

#define rwID_ADCPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x34)
 

defines the pluginID for the RpADC plugin. See RwEngineRegisterPlugin

#define rwID_ANIMTOOLKIT   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0xb7)
 

defines the pluginID for the RtAnim toolkit. See RwEngineRegisterPlugin

#define rwID_ANISOTPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x27)
 

defines the pluginID for the RpAnisot plugin. See RwEngineRegisterPlugin

#define rwID_BARYCENTRIC   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0xb2)
 

defines the pluginID for the RtBary toolkit. See RwEngineRegisterPlugin

#define rwID_BMPIMAGEPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x9d)
 

defines the pluginID for the RtBMP toolkit. See RwEngineRegisterPlugin

#define rwID_CHARSEPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x80)
 

defines the pluginID for the RtCharset plugin. See RwEngineRegisterPlugin

#define rwID_CMPKEYTOOLKIT   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0xb9)
 

defines the pluginID for the RtCmpKey toolkit. See RwEngineRegisterPlugin

#define rwID_COLLISPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x1d)
 

defines the pluginID for the RpCollision plugin. See RwEngineRegisterPlugin

#define rwID_CROWDPPPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x25)
 

defines the pluginID for the RpCrowd plugin. See RwEngineRegisterPlugin

#define rwID_DICTTOOLKIT   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0xbf)
 

defines the pluginID for the RtDict toolkit. See RwEngineRegisterPlugin

#define rwID_DMORPHPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x22)
 

defines the pluginID for the RpDMorph plugin. See RwEngineRegisterPlugin

#define rwID_ENVIRONMENTPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x36)
 

defines the pluginID for background environment settings for a scene. For internal use.

#define rwID_FILESYSTEMPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0xbe)
 

defines the pluginID for the RtFSyst toolkit. See RwEngineRegisterPlugin

#define rwID_GENCPIPETOOLKIT   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0xbc)
 

defines the pluginID for the RtGenCPipe toolkit. See RwEngineRegisterPlugin

#define rwID_GEOMCONDPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0xba)
 

defines the pluginID for the RtGCond toolkit. See RwEngineRegisterPlugin

#define rwID_GPVSPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x2a)
 

defines the pluginID for the RpPVS plugin. See RwEngineRegisterPlugin

#define rwID_HANIMPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x1e)
 

defines the pluginID for the RpHAnim plugin. See RwEngineRegisterPlugin

#define rwID_INTSECPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x9a)
 

defines the pluginID for the RtIntersection toolkit. See RwEngineRegisterPlugin

#define rwID_JPEGIMAGEPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x92)
 

defines the pluginID for the RtJPEG toolkit. See RwEngineRegisterPlugin

#define rwID_LODATMPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x12)
 

defines the pluginID for the RpLODAtomic plugin. See RwEngineRegisterPlugin

#define rwID_LOGOPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x0a)
 

defines the pluginID for the RpLogo plugin. See RwEngineRegisterPlugin

#define rwID_LTMAPCNVTOOLKIT   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0xbd)
 

defines the pluginID for the RtLtMapCnv toolkit. See RwEngineRegisterPlugin

#define rwID_LTMAPPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x14)
 

defines the pluginID for the RpLtMap plugin. See RwEngineRegisterPlugin

#define rwID_MATERIALEFFECTSPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x20)
 

defines the pluginID for the RpMatFX plugin. See RwEngineRegisterPlugin

#define rwID_MIPMAPKPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x98)
 

defines the pluginID for the RpMipmapKL toolkit. See RwEngineRegisterPlugin

#define rwID_MORPHPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x05)
 

defines the pluginID for the RpMorph plugin. See RwEngineRegisterPlugin

#define rwID_NOHSWORLDPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x81)
 

defines the pluginID for the RtWorldImport toolkit. See RwEngineRegisterPlugin

#define rwID_PATCHPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x23)
 

defines the pluginID for the RpPatch plugin. See RwEngineRegisterPlugin

#define rwID_PICKPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x9c)
 

defines the pluginID for the RtPick toolkit. See RwEngineRegisterPlugin

#define rwID_PITEXDICTIONARYTK   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0xb3)
 

defines the pluginID for the RtPITexD toolkit. See RwEngineRegisterPlugin

#define rwID_PNGIMAGEPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x0d)
 

defines the pluginID for the RtPNG plugin. See RwEngineRegisterPlugin

#define rwID_PRTADVPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x32)
 

defines the pluginID for the RpPrtAdv plugin. See RwEngineRegisterPlugin

#define rwID_PRTSTDPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x30)
 

defines the pluginID for the RpPrtStd plugin. See RwEngineRegisterPlugin

#define rwID_PTANKPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x2f)
 

defines the pluginID for the RpPTank plugin. See RwEngineRegisterPlugin

#define rwID_QUATPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x95)
 

defines the pluginID for the RtQuat toolkit. See RwEngineRegisterPlugin

#define rwID_RANDOMPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x0c)
 

defines the pluginID for the RpRandom plugin. See RwEngineRegisterPlugin

#define rwID_RASIMAGEPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x9e)
 

defines the pluginID for the RtRAS toolkit. See RwEngineRegisterPlugin

#define rwID_RAYPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x88)
 

defines the pluginID for the RtRay toolkit. See RwEngineRegisterPlugin

#define rwID_SKINPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x16)
 

defines the pluginID for the RpSkin plugin. See RwEngineRegisterPlugin

#define rwID_SKINSPLITTOOKIT   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0xb8)
 

defines the pluginID for the RtSkinSplit toolkit. See RwEngineRegisterPlugin

#define rwID_SKYMIPMAPVAL   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x10)
 

defines the pluginID for the RtMipmapK plugin. See RwEngineRegisterPlugin

#define rwID_SLERPPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x83)
 

defines the pluginID for the RtSlerp toolkit. See RwEngineRegisterPlugin

#define rwID_SPLINEPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x02)
 

defines the pluginID for the RpSpline plugin. See RwEngineRegisterPlugin

#define rwID_SPLINEPVSPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x96)
 

defines the pluginID for the RtSplinePVS toolkit. See RwEngineRegisterPlugin

#define rwID_TEAMPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x24)
 

defines the pluginID for the RpTeam plugin. See RwEngineRegisterPlugin

#define rwID_TIFFIMAGEPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x9b)
 

defines the pluginID for the RtTIFF toolkit. See RwEngineRegisterPlugin

#define rwID_TILERENDPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x91)
 

defines the pluginID for the RtTileRender toolkit. See RwEngineRegisterPlugin

#define rwID_TLWORLDPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x85)
 

defines the pluginID for the RtWorld toolkit. See RwEngineRegisterPlugin

#define rwID_TOCTOOLKIT   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0xb4)
 

defines the pluginID for the RtTOC toolkit. See RwEngineRegisterPlugin

#define rwID_TOONPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x2e)
 

defines the pluginID for the RpToon plugin. See RwEngineRegisterPlugin

#define rwID_USERDATAPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x1f)
 

defines the pluginID for the RpUserData plugin. See RwEngineRegisterPlugin

#define rwID_UVANIMPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0x35)
 

defines the pluginID for the RpUVAnim plugin. See RwEngineRegisterPlugin

#define rwID_VCATPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0xa0)
 

defines the pluginID for the RtVCAT toolkit. See RwEngineRegisterPlugin

#define rwID_WINGPLUGIN   MAKECHUNKID(rwVENDORID_CRITERIONTK, 0xbb)
 

defines the pluginID for the RtWing toolkit. See RwEngineRegisterPlugin

Enumeration Type Documentation

enum RwCriterionCoreID
 

The Core Library is consisted from a collection of plugins that constitute it. This is a list of the pluginIDs that belong to the Core. See RwEngineRegisterPlugin

Enumeration values:
rwID_VECTORMODULE  Vector module pluginID. See RwV2d and RwV3d
rwID_MATRIXMODULE  Matrix module pluginID. See RwMatrix
rwID_FRAMEMODULE  Frame module pluginID. See RwFrame
rwID_STREAMMODULE  Stream module pluginID. See RwStream
rwID_CAMERAMODULE  Camera module pluginID. See RwCamera
rwID_IMAGEMODULE  Image module pluginID. See RwImage
rwID_RASTERMODULE  Raster module pluginID. See RwRaster
rwID_TEXTUREMODULE  Texture module pluginID. See RwTexture
rwID_PIPEMODULE  Pipeline module pluginID. See RxPipeline
rwID_IMMEDIATEMODULE  Immediate module pluginID. See RwIm3D
rwID_RESOURCESMODULE  Resource module pluginID. See RwResources
rwID_DEVICEMODULE  Device module pluginID
rwID_COLORMODULE  Color module pluginID. See RwRGBA
rwID_ERRORMODULE  Error module pluginID. See RwError
rwID_METRICSMODULE  Metrics module pluginID. See RwMetrics
rwID_DRIVERMODULE  Driver module pluginID
rwID_CHUNKGROUPMODULE  Chunk group module pluginID. See RwChunkGroup

enum RwEngineInitFlag
 

RwEngineInitFlag Engine initialization flags. An application can use these to control the memory manager that RenderWare uses for dynamic memory management. By default RenderWare uses FreeLists. This is the preferred way of using RenderWare. If the application does not want RenderWare to use the memory manager, then the application can pass rwENGINEINITNOFREELISTS as the argument to RwEngineInit and RenderWare will replace freelist calls to corresponding calls to RwMalloc and RwFree. This will result in more memory management related calls.

Enumeration values:
rwENGINEINITFREELISTS  Use Freelists
rwENGINEINITNOFREELISTS  Don't use Freelists

enum RwVideoModeFlag
 

RwVideoModeFlag These flags specify the type of display that RenderWare will use. The flags may be OR'd together to build composite modes. Note that not all modes are supported on all platforms.

Enumeration values:
rwVIDEOMODEEXCLUSIVE  Exclusive (i.e. full-screen)
rwVIDEOMODEINTERLACE  Interlaced
rwVIDEOMODEFFINTERLACE  Flicker Free Interlaced

Function Documentation

RwBool RwEngineClose (  void    ) 
 

RwEngineClose closes the RenderWare Graphics engine by releasing the currently selected rendering subsystem (graphics device). This function must only be called after the rendering engine has been stopped.

Note the sequence of function calls used to run-up and run-down the RenderWare Graphics engine is as follows: RwEngineInit, RwEngineOpen, RwEngineStart to run-up and RwEngineStop, RwEngineClose, RwEngineTerm to run-down.

Returns:
Returns TRUE if successful or FALSE if there is an error
See also:
RwEngineInit , RwEngineOpen , RwEngineStart , RwEngineStop , RwEngineTerm

RwInt32 RwEngineGetCurrentSubSystem (  void    ) 
 

RwEngineGetCurrentSubSystem retrieves the index of the currently selected rendering subsystem (graphics device). This function should only be called after the engine has been opened.

Returns:
Returns an RwInt32 value equal to the current rendering subsystem if successful or -1 if there is an error.
See also:
RwEngineGetNumSubSystems , RwEngineGetNumVideoModes , RwEngineGetCurrentVideoMode , RwEngineGetSubSystemInfo , RwEngineGetVideoModeInfo , RwEngineOpen

RwInt32 RwEngineGetCurrentVideoMode (  void    ) 
 

RwEngineGetCurrentVideoMode retrieves the index of the currently selected video mode. This function should only be called after the engine has been opened.

Returns:
Returns an RwInt32 value equal to the current video mode if successful or -1 if there is an error.
See also:
RwEngineGetNumSubSystems , RwEngineGetNumVideoModes , RwEngineGetCurrentSubSystem , RwEngineGetSubSystemInfo , RwEngineGetVideoModeInfo , RwEngineOpen

RwInt32 RwEngineGetMaxTextureSize (  void    ) 
 

RwEngineGetMaxTextureSize determines the maximum dimensions of textures allocatable with this device.

Returns:
Returns an RwInt32 value giving the maximum dimension (in texels) of textures that may be allocated. Returns -1 if the query failed.
See also:
RwEngineGetTextureMemorySize

RwMetrics* RwEngineGetMetrics (  void    ) 
 

RwEngineGetMetrics gets metrics from RenderWare Graphics to evaluate the performance of the system. Information such as current polygon and vertex throughput, and cache swapping occurring in the resource arena and texture cache (if applicable) is available. Metrics are only available on a metrics build.

Note: The metrics structure is an accumulated value since the last RwCameraShowRaster or RwRasterShowRaster, and is most useful when examined immediately before calls to these functions.

Returns:
Returns a pointer to the metrics data block, or NULL on failure.

RwInt32 RwEngineGetNumSubSystems (  void    ) 
 

RwEngineGetNumSubSystems determines the number of rendering subsystems (graphics devices) currently available on the platform the RenderWare Graphics engine is running. This function should only be called after the engine has been opened.

Returns:
Returns an RwInt32 value equal to the number of rendering subsystems if successful or -1 if there is an error.
See also:
RwEngineGetNumVideoModes , RwEngineGetCurrentSubSystem , RwEngineGetCurrentVideoMode , RwEngineGetSubSystemInfo , RwEngineGetVideoModeInfo , RwEngineOpen

RwInt32 RwEngineGetNumVideoModes (  void    ) 
 

RwEngineGetNumVideoModes determines the number of video modes available in the currently selected rendering subsystem (graphics device). This function should only be called after the engine has been opened.

Returns:
Returns an RwInt32 value equal to the number of video modes if successful or -1 if there is an error.
See also:
RwEngineGetNumSubSystems , RwEngineGetCurrentSubSystem , RwEngineGetCurrentVideoMode , RwEngineGetSubSystemInfo , RwEngineOpen

RwInt32 RwEngineGetPluginOffset (  RwUInt32    pluginID ) 
 

RwEngineGetPluginOffset gets the offset of a previously registered RenderWare Graphics engine plugin.

Parameters:
pluginID  An RwUInt32 value equal to the plugin ID.
Returns:
Returns an RwInt32 value equal to the data block offset if successful or -1 if the plugin is not registered.
See also:
RwEngineRegisterPlugin

RwSubSystemInfo* RwEngineGetSubSystemInfo (  RwSubSystemInfo *    subSystemInfo,
RwInt32    subSystemIndex
) 
 

RwEngineGetSubSystemInfo retrieves information about the rendering subsystem (graphics device) corresponding to the specified index. This function should only be called after the engine has been opened.

Parameters:
subSystemInfo  Pointer to an RwSubSystemInfo value that will receive the information.
subSystemIndex  An RwInt32 value equal to the index of the subsystem.
Returns:
Returns pointer to the RwSubSystemInfo value if successful or NULL if there is an error.
See also:
RwEngineGetNumSubSystems , RwEngineGetNumVideoModes , RwEngineGetCurrentSubSystem , RwEngineGetCurrentVideoMode , RwEngineGetVideoModeInfo , RwEngineOpen
   The sequence to print out the identifying names of all graphics devices
   on a particular platform is as follows:

   RwInt32 numSubSystems, i;
   RwSubSystemInfo ssInfo;

   numSubSystems = RwEngineGetNumSubSystems();

   for(i=0; i<numSubSystems; i++)
   {
       RwSubSystemInfo ssInfo;

       if( RwEngineGetSubSystemInfo(&ssInfo, i) )
       {
           printf("SubSystem %d: %s\n", i, ssInfo.name );
       }
   }

RwInt32 RwEngineGetTextureMemorySize (  void    ) 
 

RwEngineGetTextureMemorySize determines the amount of available texture memory.

Returns:
Returns an RwInt32 value giving the number of bytes available for allocation to textures. Returns -1 if the query failed.
See also:
RwEngineGetMaxTextureSize

RwUInt32 RwEngineGetVersion (  void    ) 
 

RwEngineGetVersion returns the version of the RenderWare engine. This should be treated as a 5 digit hex number where the first three digits correspond to the RenderWare SDK release number, and the last two are a binary stream format revision number. For example, the version 0x31001 corresponds to 3.1.0.1 (SDK 3.1.0, binary revision 1).

Note that the engine must be initialized before using this function.

Returns:
Returns a value containing the version number.
See also:
RwEngineGetNumSubSystems , RwEngineGetNumVideoModes , RwEngineGetCurrentSubSystem , RwEngineGetCurrentVideoMode , RwEngineGetSubSystemInfo , RwEngineGetVideoModeInfo , RwEngineInit

RwVideoMode* RwEngineGetVideoModeInfo (  RwVideoMode *    modeinfo,
RwInt32    modeIndex
) 
 

RwEngineGetVideoModeInfo retrieves information about the video mode in the current rendering subsystem (graphics device) corresponding to the specified index. This function should only be called after the engine has been opened.

Parameters:
modeinfo  Pointer to an RwVideoMode value that will receive the information.
modeIndex  An RwInt32 value equal to the index of the video mode.
Returns:
Returns a pointer to the RwVideoMode value if successful or NULL if there is an error.
See also:
RwEngineGetNumSubSystems , RwEngineGetNumVideoModes , RwEngineGetCurrentSubSystem , RwEngineGetCurrentVideoMode , RwEngineGetSubSystemInfo , RwEngineOpen
   The sequence to print out all the video modes for the current graphics
   device is as follows:

   RwInt32 numVideoModes, j;
   RwVideoMode vmodeInfo;

   numVideoModes = RwEngineGetNumVideoModes();

   for(j=0; j<numVideoModes; j++)
   {
       if( RwEngineGetVideoModeInfo(&vmodeInfo, j) )
       {
           printf("Video Mode %d: %dx%dx%d %s\n", j,
               vmodeInfo.width, vmodeInfo.height, vmodeInfo.depth,
              (vmodeInfo.flags & rwVIDEOMODEEXCLUSIVE ? "(EXCLUSIVE)" : "") );
       }
   }

RwBool RwEngineInit (  const RwMemoryFunctions *    memFuncs,
RwUInt32    openFlags,
RwUInt32    resArenaSize
) 
 

RwEngineInit initializes the core of the RenderWare Graphics rendering engine.

This function must be called before any other RenderWare function except functions listed in RwFreeList Overview.

This function may also be used to specify an alternative interface that RenderWare Graphics will use for memory management. If specified, RenderWare Graphics will use the supplied memory allocation routines rather than the default standard library ones. Specifying NULL for this parameter forces the default ones to be used.

Similarly, a default file system interface is initialized by RwEngineInit.

Note the sequence of function calls used to run-up and run-down the RenderWare Graphics engine is as follows: RwEngineInit, RwEngineOpen, RwEngineStart to run-up and RwEngineStop, RwEngineClose, RwEngineTerm to run-down.

Note that the purpose of FreeLists is to improve memory management performance. It is recommended that developers benchmark their applications with and without the use of FreeLists. FreeLists should be used if possible.

Note too that ultimately RenderWare Graphics FreeLists make use of the memory functions supplied as the first parameter. Most customers will want to use FreeLists as they increase performance.

Running RenderWare Graphics without Freelists is allowed purely to help developers observe memory usage since calls to RwMalloc are easily hooked.

Parameters:
memFuncs  Pointer to an RwMemoryFunctions value specifying the memory management interface (specify NULL to use the default interface).
openFlags  Additional parameters for the Initialization of RenderWare Graphics. Currently the only flag is whether to use Freelists or not. A value of rwENGINEINITNOFREELISTS can be used to tell RenderWare Graphics to use RwMalloc and RwFree in place of RwFreeListAlloc and RwFreeListFree.
resArenaSize  An RwUInt32 specifying the size of the memory block (in bytes) reserved for the resources instancing arena. Can be set to zero if no instance data will be used
Returns:
Returns TRUE if successful or FALSE if there is an error
See also:
RwEngineOpen , RwEngineStart , RwEngineStop , RwEngineClose , RwEngineTerm , RwOsGetMemoryInterface

RwBool RwEngineOpen (  RwEngineOpenParams *    initParams ) 
 

RwEngineOpen initializes the default rendering subsystem (graphics device) and video mode. The device is opened on the specified display. Once the device has been opened use the API functions RwEngineSetSubSystem and RwEngineSetVideoMode to set the display device, as appropriate.

This function must only be called after the rendering engine has been initialized.

Note the sequence of function calls used to run-up and run-down the RenderWare Graphics engine is as follows: RwEngineInit, RwEngineOpen, RwEngineStart to run-up and RwEngineStop, RwEngineClose, RwEngineTerm to run-down.

Parameters:
initParams  A pointer to the RwEngineOpenParams value describing a device-dependent parameter (see example below)
Returns:
Returns TRUE if successful or FALSE if there is an error
See also:
RwEngineInit , RwEngineStart , RwEngineStop , RwEngineClose , RwEngineTerm , RwEngineSetSubSystem , RwEngineSetVideoMode
   To open the RenderWare Graphics engine from a Windows application. The variable
   hwnd is a Windows device handle returned from CreateWindow (type HWND).
   Assume the engine has been initialized:

   RwEngineOpenParams openParams;

   openParams.displayID = hwnd;
   if( !RwEngineOpen(&openParams) )
   {
       RwEngineTerm();
       fprintf(stderr, "RwEngineOpen failed\n");
       ...
  }

RwInt32 RwEngineRegisterPlugin (  RwInt32    size,
RwUInt32    pluginID,
RwPluginObjectConstructor    initCB,
RwPluginObjectDestructor    termCB
) 
 

The functionRwEngineRegisterPlugin registers a plugin and reserves some space within the global engine space. This must happen after the engine has been initialized but before the engine is opened and is the mechanism for adding plugins to RenderWare Graphics. The global data is initialized using the specified object constructor when RwEngineStart is called. Note that a NULL return value from the constructor will cause RwEngineStart to fail.

Parameters:
size  An RwInt32 value equal to the size of the memory block to reserve.
pluginID  An RwInt32 value equal to the plugin ID (must be unique - used to identify binary chunks).
initCB  A constructor for the plugin data block.
termCB  A destructor for the plugin data block.
Returns:
Returns an RwInt32 value equal to the byte offset within the engine global variables of memory reserved for this plugin or -1 if there is an error.
See also:
RwEngineGetPluginOffset , RwEngineInit

RwBool RwEngineSetFocus (  RwBool    enable ) 
 

RwEngineSetFocus changes the focus properties of the currently selected rendering subsystem (graphics device). Use this function to grab or release the current device focus. This function is especially useful for full screen applications.

Parameters:
enable  An RwBool value equal to the focus action:
  • TRUE - Grab focus.
  • FALSE - Release focus.
Returns:
Returns TRUE if successful or FALSE if there is an error
See also:
RwEngineSetVideoMode , RwEngineGetCurrentVideoMode , RwEngineGetNumVideoModes , RwEngineGetVideoModeInfo

RwBool RwEngineSetSubSystem (  RwInt32    subSystemIndex ) 
 

RwEngineSetSubSystem is used to set the current rendering subsystem (graphic device) to the subsystem with the specified index. The rendering subsystem can only be set after the RenderWare Graphics engine has been opened.

Parameters:
subSystemIndex  An RwInt32 value equal to the subsystem's index
Returns:
Returns TRUE if successful or FALSE if there is an error
See also:
RwEngineGetNumSubSystems , RwEngineGetNumVideoModes , RwEngineGetCurrentSubSystem , RwEngineGetCurrentVideoMode , RwEngineGetSubSystemInfo , RwEngineGetVideoModeInfo , RwEngineOpen

RwBool RwEngineSetVideoMode (  RwInt32    modeIndex ) 
 

RwEngineSetVideoMode sets the current video mode to the video mode with the specified index. The video mode can only be set after the RenderWare Graphics engine has been opened.

Parameters:
modeIndex  An RwInt32 value equal to the video mode's index
Returns:
Returns TRUE if successful or FALSE if there is an error
See also:
RwEngineGetNumSubSystems , RwEngineGetNumVideoModes , RwEngineGetCurrentSubSystem , RwEngineGetCurrentVideoMode , RwEngineGetSubSystemInfo , RwEngineGetVideoModeInfo , RwEngineOpen

RwBool RwEngineStart (  void    ) 
 

RwEngineStart starts the RenderWare Graphics engine. This function must only be called after the rendering engine has been initialized and opened (in that order). This function also initializes the memory requested by all registered plugins.

Note the sequence of function calls used to run-up and run-down the RenderWare Graphics engine is as follows: RwEngineInit, RwEngineOpen, RwEngineStart to run-up and RwEngineStop, RwEngineClose, RwEngineTerm to run-down.

A NULL return value from any of the registered plugin object constructors will cause this function to fail.

Returns:
Returns TRUE if successful or FALSE if there is an error
See also:
RwEngineInit , RwEngineOpen , RwEngineStop , RwEngineClose , RwEngineTerm

RwBool RwEngineStop (  void    ) 
 

RwEngineStop stops the RenderWare Graphics engine. This function must be called before any attempt is made to close (and then terminate, if required) the rendering engine.

Note the sequence of function calls used to run-up and run-down the RenderWare Graphics engine is as follows: RwEngineInit, RwEngineOpen, RwEngineStart to run-up and RwEngineStop, RwEngineClose, RwEngineTerm to run-down.

Returns:
Returns TRUE if successful or FALSE if there is an error
See also:
RwEngineInit , RwEngineOpen , RwEngineStart , RwEngineClose , RwEngineTerm

RwBool RwEngineTerm (  void    ) 
 

RwEngineTerm terminates the RenderWare Graphics engine. Before termination, the engine must first be stopped and then closed (in that order). This function should be called before the application closes down.

Note the sequence of function calls used to run-up and run-down the RenderWare Graphics engine is as follows: RwEngineInit, RwEngineOpen, RwEngineStart to run-up and RwEngineStop, RwEngineClose, RwEngineTerm to run-down.

Returns:
Returns TRUE if successful or FALSE if there is an error
See also:
RwEngineInit , RwEngineOpen , RwEngineStart , RwEngineStop , RwEngineClose

Criterion Software © 1993-2004 Criterion Software Limited. All rights reserved. Built Thu Feb 12 13:46:51 2004. Send Feedback