Main Page   Modules   Alphabetical List   Data Structures   Data Fields  

RtSlctPipe
[PowerPipe]


Data Structures
struct   RtSlctPipeLights
struct   RtSlctPipeList

Typedefs
typedef RtSlctPipeList  RtSlctPipeList
typedef RtSlctPipeLights  RtSlctPipeLights

Enumerations
enum   RtSlctPipeFlags {
  rtSLCTPIPEFLAGFACECULL = 0x00000001, rtSLCTPIPEFLAGTRUECLIP = 0x00000002, rtSLCTPIPEFLAGFOG = 0x00000004, rtSLCTPIPEFLAGCLONE = 0x00000008,
  rtSLCTPIPEFLAGSPECULAR = 0x00000010, rtSLCTPIPEFLAGDOT3 = 0x00000020, rtSLCTPIPEFLAGADC = 0x00000040, rtSLCTPIPEFLAGFORCEENUMSIZEINT = RWFORCEENUMSIZEINT
}

Functions
void  RtSlctPipeOpen (void)
void  RtSlctPipeClose (void)
RwBool  RtSlctPipeAtomicSelectPipes (RpAtomic *atomic, RtSlctPipeLights *lights, RtSlctPipeList *list, RwUInt32 flags)
RwBool  RtSlctPipeWorldSelectPipes (RpWorld *world, RtSlctPipeLights *lights, RtSlctPipeList *list, RwUInt32 flags)
void  RtSlctPipeWorldGetLighting (RpWorld *world, RtSlctPipeLights *lights)
RwBool  RtSlctPipeAtomic (RpAtomic *atomic, RpWorld *world, RtSlctPipeList *list, RwUInt32 flags)
RwBool  RtSlctPipeWorld (RpWorld *world, RtSlctPipeList *list, RwUInt32 flags)

Detailed Description

Pipeline Selection Toolkit for RenderWare.

RtSlctPipe Toolkit Overview

Requirements

Overview

This toolkit provides functionality for selecting the best pipeline to render an atomic or world with.

Typedef Documentation

typedef struct RtSlctPipeLights RtSlctPipeLights
 

RtSlctPipeLights typedef for struct RtSlctPipeLights
typedef struct RtSlctPipeList RtSlctPipeList
 

RtSlctPipeList typedef for struct RtSlctPipeList

Enumeration Type Documentation

enum RtSlctPipeFlags
 

RtSlctPipeFlags

Enumeration values:
rtSLCTPIPEFLAGFACECULL  The selected pipes must support face culling.
rtSLCTPIPEFLAGTRUECLIP  The selected pipes must support true clipping
rtSLCTPIPEFLAGFOG  The selected pipes must support vertex fog.
rtSLCTPIPEFLAGCLONE  The selected pipes must be cloning pipes.
rtSLCTPIPEFLAGSPECULAR  The selected pipes must support specular lighting.
rtSLCTPIPEFLAGDOT3  The selected pipes must support dot3 bump mapping.
rtSLCTPIPEFLAGADC  The selected pipes must support adc flagged tri-strips.

Function Documentation

RwBool RtSlctPipeAtomic (  RpAtomic *    atomic,
RpWorld *    world,
RtSlctPipeList *    list,
RwUInt32    flags
) 
 

RtSlctPipeAtomic sets the best atomic and material pipelines to render the atomic with. The world provided is used to determine the lighting. Some optimized pipelines require the lighting information to be manually uploaded to VU1 memory; if one of these pipelines is selected then an atomic render callback will be set to upload this data before the atomic is rendered. This call will not set the pipelines if the atomic or one of its materials has a pipeline attached which is not known to this toolkit.

Parameters:
atomic  atomic to render.
world  world contains lights which affect the atomic.
list  list to add used pipeline IDs to (may be NULL).
flags  flags to specify features the selected pipelines must support.
Returns:
TRUE if successful
See also:
RtSlctPipeAtomicSelectPipes , RtSlctPipeClose , RtSlctPipeOpen , RtSlctPipeWorld , RtSlctPipeWorldGetLighting , RtSlctPipeWorldSelectPipes
RwBool RtSlctPipeAtomicSelectPipes (  RpAtomic *    atomic,
RtSlctPipeLights *    lights,
RtSlctPipeList *    list,
RwUInt32    flags
) 
 

RtSlctPipeAtomicSelectPipes sets the best atomic and material pipelines to render the atomic with. Some optimized pipelines require the lighting information to be manually uploaded to VU1 memory; if one of these pipelines is selected then an atomic render callback will be set to upload this data before the atomic is rendered. This call will not set the pipelines if the atomic or one of its materials has a pipeline attached which is not known to this toolkit.

Parameters:
atomic  atomic to render.
lights  the number and type of lights the pipelines must support. If this is NULL the pipelines must support all lighting.
list  list to add used pipeline IDs to (may be NULL).
flags  flags to specify features the selected pipelines must support.
Returns:
TRUE if successful
See also:
RtSlctPipeAtomic , RtSlctPipeClose , RtSlctPipeOpen , RtSlctPipeWorld , RtSlctPipeWorldGetLighting , RtSlctPipeWorldSelectPipes
void RtSlctPipeClose (  void    ) 
 

RtSlctPipeClose is used to perform various clean up operations that are required to close down the pipeline selection toolkit.

See also:
RtSlctPipeAtomic , RtSlctPipeAtomicSelectPipes , RtSlctPipeOpen , RtSlctPipeWorld , RtSlctPipeWorldGetLighting , RtSlctPipeWorldSelectPipes
void RtSlctPipeOpen (  void    ) 
 

RtSlctPipeOpen is used to perform various initializations that are required before the pipeline selection toolkit can be used.

See also:
RtSlctPipeAtomic , RtSlctPipeAtomicSelectPipes , RtSlctPipeClose , RtSlctPipeWorld , RtSlctPipeWorldGetLighting , RtSlctPipeWorldSelectPipes
RwBool RtSlctPipeWorld (  RpWorld *    world,
RtSlctPipeList *    list,
RwUInt32    flags
) 
 

RtSlctPipeWorld sets the best world sector and material pipelines to render the world with. Some optimized pipelines require the lighting information to be manually uploaded to VU1 memory; if one of these pipelines is selected then a world sector render callback will be set to upload this data before the world sector is rendered. This call will not set the pipelines if a world sector or material has a pipeline attached which is not known to this toolkit.

Parameters:
world  world to render.
list  list to add used pipeline IDs to (may be NULL).
flags  flags to specify features the selected pipelines must support.
Returns:
TRUE if successful
See also:
RtSlctPipeAtomic , RtSlctPipeAtomicSelectPipes , RtSlctPipeClose , RtSlctPipeOpen , RtSlctPipeWorldGetLighting , RtSlctPipeWorldSelectPipes
void RtSlctPipeWorldGetLighting (  RpWorld *    world,
RtSlctPipeLights *    lights
) 
 

RtSlctPipeWorldGetLighting counts the number of each type of light the world containds.

Parameters:
world  world to find lights in.
lights  light count structure to return results in.
See also:
RtSlctPipeAtomic , RtSlctPipeAtomicSelectPipes , RtSlctPipeClose , RtSlctPipeOpen , RtSlctPipeWorld , RtSlctPipeWorldSelectPipes
RwBool RtSlctPipeWorldSelectPipes (  RpWorld *    world,
RtSlctPipeLights *    lights,
RtSlctPipeList *    list,
RwUInt32    flags
) 
 

RtSlctPipeWorldSelectPipes sets the best world sector and material pipelines to render the world with. Some optimized pipelines require the lighting information to be manually uploaded to VU1 memory; if one of these pipelines is selected then a world sector render callback will be set to upload this data before the world sector is rendered. This call will not set the pipelines if a world sector or material has a pipeline attached which is not known to this toolkit.

Parameters:
world  world to render.
lights  the number and type of lights the pipelines must support. If this is NULL the pipelines must support all lighting.
list  list to add used pipeline IDs to (may be NULL).
flags  flags to specify features the selected pipelines must support.
Returns:
TRUE if successful
See also:
RtSlctPipeAtomic , RtSlctPipeAtomicSelectPipes , RtSlctPipeClose , RtSlctPipeOpen , RtSlctPipeWorld , RtSlctPipeWorldGetLighting
Criterion Software © 1993-2003 Criterion Software Limited. All rights reserved. Built Tue Apr 22 12:47:00 2003. Send Feedback
Converted from CHM to HTML with chm2web Pro 2.85 (unicode)