Main Page Modules Alphabetical List Data Structures Data Fields

PlayStation 2
[RpPDS]


Modules
Example Pipeline Definition
Pipelines
Data Structures
struct	RpPDSMatTemplate
struct	RpPDSObjTemplate
struct	RpPDSSkyMatCluster
struct	RpPDSSkyMatPrimitive
struct	RpPDSSkyMatTemplate
struct	RpPDSSkyObjTemplate
struct	RpPDSSkyVU1CodeTemplate
Defines
#define	RpWorldPipesAttach()
#define	RpWorldNumPipes (7)
#define	RpMatfxPipesAttach()
#define	RpMatfxNumPipes (6)
#define	RpSkinPipesAttach()
#define	RpSkinNumPipes (2)
#define	RpSkinfxPipesAttach()
#define	RpSkinfxNumPipes (6)
#define	RpPatchPipesAttach()
#define	RpPatchNumPipes (2)
#define	RpPatchfxPipesAttach()
#define	RpPatchfxNumPipes (6)
#define	RpPatchSkinPipesAttach()
#define	RpPatchSkinNumPipes (4)
#define	RpPatchSkinfxPipesAttach()
#define	RpPatchSkinfxNumPipes (12)
#define	RpLtMapPipesAttach()
#define	RpLtMapNumPipes (3)
#define	RpToonPipesAttach()
#define	RpToonNumPipes (3)
#define	RpSkinToonPipesAttach()
#define	RpSkinToonNumPipes (5)
#define	Rt2DPipesAttach()
#define	Rt2DNumPipes (6)
#define	RpPTankPipesAttach()
#define	RpPTankNumPipes (0)
Functions
RxPipeline *	RpPDSSkyMatPipeCreate (RpPDSSkyMatTemplate *definition)
RxPipeline *	RpPDSSkyObjPipeCreate (RpPDSSkyObjTemplate *definition)

Detailed Description

Platform specific documentation detailing the pipelines currently supported on the PlayStation 2.

RpPDS Terminology

The RpPDS plugin pipelines use the following terminology when describing the pipelines:

   TERM         DESCRIPTION

   G2           Generation 2 generic lighting rendering technology
   G3           Generation 3 generic lighting rendering technology
   G3x          Generation 3 custom lighting rendering technology
   G3xd         Generation 3 custom lighting degeneration rendering technology

   A4D          Ambient and 4 Direction lights
   ADL          Ambient and Direction Lights
   APL          Ambient and Point Lights
   OPL          Per Object pre-light value

   Gem          Gloss Environment Map effect rendering
   Emb          EMBoss bump mapping effect rendering
   Bem          Bump mapping and Environment Mapping effect rendering
   Dup          Dual pass
   Uva          Single pass texture coordinate transform rendering
   DupUva       Dual pass texture coordinate transform rendering

   Dot3         Dot3 bump mapping effect rendering
   Specular     Specular effect rendering

   Im3D         3D Immediate Mode pipeline

   Generic      Generic pipeline normally supporting:
                  Perspective & Isometric projection
                  Triangle strip and list
                  Back face and front face culling
                  Triangle clipping and culling
                  Fog and non fog rendering
                (althought individual pipelines will vary)

   Skin         Skinning pipeline normally supporting:
                  Same features of the Generic pipelines
                  64 bone 4 weight vertex position and normal skinning

   SkSpt        Skin Split
                  Same features of the Skin pipelines
                  256 bone 4 weight vertex position and normal skinning

   BPatch       Bézier Patch rendering pipeline normally supporting:
                  Perspective & Isometric projection
                  Quad patch and triangle patch rendering
                  Back face and front face culling
                  Refinded triangle culling
                  Fog and non fog rendering

   Clone        Clone rendering pipeline supporting:
                  48 local transforms per atomic

   Matfx        Material effects rendering pipeline supporting:
                  Same features of the Generic pipelines
                  Generic, Gem, Emb, Bem, Dup, Uva, DupUva effect rendering

   Team         Custom rendering pipeline supporting:
                  Base pass, Gem or Dup effect pass
                  Up to 4 plane projected shadow rendering

   Atm          Atomic object pipeline
   Sct          World Sector pipeline
   Mat          Material pipeline

   Obj          Immediate mode object pipeline
   Tri          Triangle immmediate mode pipeline
   Seg          Line segment immediate mode pipeline

Define Documentation

#define RpLtMapNumPipes (3)

number of pipelines registered by RpLtMapPipesAttach

#define RpLtMapPipesAttach	(
	)

Value:

MACRO_START                                                     \
{                                                               \
    rwPDS_G2_DarkMaps_GrpMatPipeRegister();                     \
    rwPDS_G2_DarkMaps_GrpAtmPipeRegister();                     \
    rwPDS_G2_DarkMaps_GrpSctPipeRegister();                     \
}                                                               \
MACRO_STOP

Registers the RpLtMap plugin's pipelines. This macro is provided to restore the light map pipelines prior to the introduction of the PDS plugin. RpLtMapNumPipes pipelines are registered.

#define RpMatfxNumPipes (6)

number of pipelines registered by RpMatfxPipesAttach

#define RpMatfxPipesAttach	(
	)

Value:

MACRO_START                                                     \
{                                                               \
    rwPDS_G3_MatfxUV1_GrpMatPipeRegister();                     \
    rwPDS_G3_MatfxUV2_GrpMatPipeRegister();                     \
    rwPDS_G3_MatfxUV1_GrpAtmPipeRegister();                     \
    rwPDS_G3_MatfxUV2_GrpAtmPipeRegister();                     \
    rwPDS_G3_MatfxUV1_GrpSctPipeRegister();                     \
    rwPDS_G3_MatfxUV2_GrpSctPipeRegister();                     \
}                                                               \
MACRO_STOP

Registers the RpMatFX plugin's pipelines. This macro is provided to restore the material effects pipelines prior to the introduction of the PDS plugin. RpMatfxNumPipes pipelines are registered.

#define RpPatchfxNumPipes (6)

number of pipelines registered by RpPatchfxPipesAttach

#define RpPatchfxPipesAttach	(
	)

Value:

MACRO_START                                                     \
{                                                               \
    rwPDS_G2_BPatch_GrpMatPipeRegister();                       \
    rwPDS_G2_BPatch_GrpAtmPipeRegister();                       \
    rwPDS_G2_MatfxUV1BPatch_GrpMatPipeRegister();               \
    rwPDS_G2_MatfxUV2BPatch_GrpMatPipeRegister();               \
    rwPDS_G2_MatfxUV1BPatch_GrpAtmPipeRegister();               \
    rwPDS_G2_MatfxUV2BPatch_GrpAtmPipeRegister();               \
}                                                               \
MACRO_STOP

Registers the RpPatch plugin's pipelines. This macro is provided to restore the patch and patch material effects pipelines prior to the introduction of the PDS plugin. RpPatchfxNumPipes pipelines are registered. The generic and material effects patch pipelines are registered.

#define RpPatchNumPipes (2)

number of pipelines registered by RpPatchPipesAttach

#define RpPatchPipesAttach	(
	)

Value:

MACRO_START                                                     \
{                                                               \
    rwPDS_G2_BPatch_GrpMatPipeRegister();                       \
    rwPDS_G2_BPatch_GrpAtmPipeRegister();                       \
}                                                               \
MACRO_STOP

Registers the RpPatch plugin's pipelines. This macro is provided to restore the patch pipelines prior to the introduction of the PDS plugin. RpPatchNumPipes pipelines are registered. Only the generic patch pipelines are registered.

#define RpPatchSkinfxNumPipes (12)

number of pipelines registered by RpPatchSkinfxPipesAttach

#define RpPatchSkinfxPipesAttach	(
	)

Value:

MACRO_START                                                     \
{                                                               \
    rwPDS_G2_BPatch_GrpMatPipeRegister();                       \
    rwPDS_G2_BPatch_GrpAtmPipeRegister();                       \
    rwPDS_G2_MatfxUV1BPatch_GrpMatPipeRegister();               \
    rwPDS_G2_MatfxUV2BPatch_GrpMatPipeRegister();               \
    rwPDS_G2_MatfxUV1BPatch_GrpAtmPipeRegister();               \
    rwPDS_G2_MatfxUV2BPatch_GrpAtmPipeRegister();               \
    rwPDS_G2_SkinBPatch_GrpMatPipeRegister();                   \
    rwPDS_G2_SkinBPatch_GrpAtmPipeRegister();                   \
    rwPDS_G2_SkinfxUV1BPatch_GrpMatPipeRegister();              \
    rwPDS_G2_SkinfxUV2BPatch_GrpMatPipeRegister();              \
    rwPDS_G2_SkinfxUV1BPatch_GrpAtmPipeRegister();              \
    rwPDS_G2_SkinfxUV2BPatch_GrpAtmPipeRegister();              \
}                                                               \
MACRO_STOP

Registers the RpPatch plugin's pipelines. This macro is provided to restore the full set of patch pipelines prior to the introduction of the PDS plugin. RpPatchSkinfxNumPipes pipelines are registered. The generic, material effects, skinning and skinning material effects pipelines are registered.

#define RpPatchSkinNumPipes (4)

number of pipelines registered by RpPatchSkinPipesAttach

#define RpPatchSkinPipesAttach	(
	)

Value:

MACRO_START                                                     \
{                                                               \
    rwPDS_G2_BPatch_GrpMatPipeRegister();                       \
    rwPDS_G2_BPatch_GrpAtmPipeRegister();                       \
    rwPDS_G2_SkinBPatch_GrpMatPipeRegister();                   \
    rwPDS_G2_SkinBPatch_GrpAtmPipeRegister();                   \
}                                                               \
MACRO_STOP

Registers the RpPatch plugin's pipelines. This macro is provided to restore the patch and patch skinning pipelines prior to the introduction of the PDS plugin. RpPatchSkinNumPipes pipelines are registered. The generic and skinning patch pipelines are registered.

#define RpPTankNumPipes (0)

number of pipelines registered by RpPTankPipesAttach

#define RpPTankPipesAttach	(
	)

Registers the RpPTank plugin's pipelines. This macro is provided to restore the particle pipelines prior to the introduction of the PDS plugin. RpPTankNumPipes pipelines are registered.

#define RpSkinfxNumPipes (6)

number of pipelines registered by RpSkinfxPipesAttach

#define RpSkinfxPipesAttach	(
	)

Value:

MACRO_START                                                     \
{                                                               \
    rwPDS_G3_Skin_GrpMatPipeRegister();                         \
    rwPDS_G3_Skin_GrpAtmPipeRegister();                         \
    rwPDS_G3_SkinfxUV1_GrpMatPipeRegister();                    \
    rwPDS_G3_SkinfxUV2_GrpMatPipeRegister();                    \
    rwPDS_G3_SkinfxUV1_GrpAtmPipeRegister();                    \
    rwPDS_G3_SkinfxUV2_GrpAtmPipeRegister();                    \
}                                                               \
MACRO_STOP

Registers the RpSkin plugin's pipelines. This macro is provided to restore the skinning and skinning material effects pipelines prior to the introduction of the PDS plugin. RpSkinfxNumPipes pipelines are registered. The generic skinning and material effects skinning pipelines are registered.

#define RpSkinNumPipes (2)

number of pipelines registered by RpSkinPipesAttach

#define RpSkinPipesAttach	(
	)

Value:

MACRO_START                                                     \
{                                                               \
    rwPDS_G3_Skin_GrpMatPipeRegister();                         \
    rwPDS_G3_Skin_GrpAtmPipeRegister();                         \
}                                                               \
MACRO_STOP

Registers the RpSkin plugin's pipelines. This macro is provided to restore the skinning pipelines prior to the introduction of the PDS plugin. RpSkinNumPipes pipelines are registered. Only the generic skinning pipelines are registered.

#define RpSkinToonNumPipes (5)

number of pipelines registered by RpSkinToonPipesAttach

#define RpSkinToonPipesAttach	(
	)

Value:

MACRO_START                                                     \
{                                                               \
    rwPDS_G3_Toon_GrpMatPipeRegister();                         \
    rwPDS_G3_Toon_GrpAtmPipeRegister();                         \
    rwPDS_G3_Toon_GrpSctPipeRegister();                         \
    rwPDS_G3_SkinToon_GrpMatPipeRegister();                     \
    rwPDS_G3_SkinToon_GrpAtmPipeRegister();                     \
}                                                               \
MACRO_STOP

Registers the RpToon plugin's pipelines. This macro is provided to restore the skinning toon pipelines prior to the introduction of the PDS plugin. RpSkinToonNumPipes pipelines are registered. The generic and skinning toon pipelines are registered.

#define RpToonNumPipes (3)

number of pipelines registered by RpToonPipesAttach

#define RpToonPipesAttach	(
	)

Value:

MACRO_START                                                     \
{                                                               \
    rwPDS_G3_Toon_GrpMatPipeRegister();                         \
    rwPDS_G3_Toon_GrpAtmPipeRegister();                         \
    rwPDS_G3_Toon_GrpSctPipeRegister();                         \
}                                                               \
MACRO_STOP

Registers the RpToon plugin's pipelines. This macro is provided to restore the toon pipelines prior to the introduction of the PDS plugin. RpToonNumPipes pipelines are registered. Only the generic toon pipelines are registered.

#define RpWorldNumPipes (7)

number of pipelines registered by RpWorldPipesAttach

#define RpWorldPipesAttach	(
	)

Value:

MACRO_START                                                     \
{                                                               \
    rwPDS_G3_Generic_GrpMatPipeRegister();                      \
    rwPDS_G3_Generic_GrpAtmPipeRegister();                      \
    rwPDS_G3_Generic_GrpSctPipeRegister();                      \
    rwPDS_G3_Im3D_TriPipeRegister();                            \
    rwPDS_G3_Im3D_SegPipeRegister();                            \
    rwPDS_G3_Im3D_TriObjPipeRegister();                         \
    rwPDS_G3_Im3D_SegObjPipeRegister();                         \
}                                                               \
MACRO_STOP

Registers the RpWorld plugin's pipelines. This macro is provided to restore the world's pipelines prior to the introduction of the PDS plugin. RpWorldNumPipes pipelines are registered.

#define Rt2DNumPipes (6)

number of pipelines registered by Rt2DPipesAttach

#define Rt2DPipesAttach	(
	)

Value:

MACRO_START                                                     \
{                                                               \
    rwPDS_G3_2DFill_MatPipeRegister();                          \
    rwPDS_G3_2DFill_ObjPipeRegister();                          \
    rwPDS_G3_2DFont_MatPipeRegister();                          \
    rwPDS_G3_2DFont_ObjPipeRegister();                          \
    rwPDS_G3_2DStroke_MatPipeRegister();                        \
    rwPDS_G3_2DStroke_ObjPipeRegister();                        \
}                                                               \
MACRO_STOP

Registers the Rt2D plugin's pipelines. This macro is provided to restore the 2d pipelines prior to the introduction of the PDS plugin. Rt2DNumPipes pipelines are registered.

Function Documentation

RxPipeline* RpPDSSkyMatPipeCreate

(

RpPDSSkyMatTemplate *

definition

)

Creates a material pipeline from the RpPDSSkyMatTemplate definition structure. This function is called by default when RpPDSRegisterPipe is creating material PS2All pipelines.

The function constructs a pipeline in the following way :-

RxPipelineCreate : Creates a default RxPipeline

RxPipelineLock : Lock the new pipeline.

RxNodeDefinitionGetPS2AllMat : Retrieves the PS2AllMat pipeline RxNodeDefinition.

RxLockedPipeAddFragment : Adds the PS2AllMat pipeline node definition to the locked pipeline.

RxPipelineFindNodeByName : Finds the newly added node definition in the pipeline.

RxPipelineNodePS2AllMatGenerateCluster : Add each of the requested clusters.

Setup the VU1 memory buffer sizes with either : RxPipelineNodePS2AllMatSetLineVUBufferSizes or RxPipelineNodePS2AllMatSetTriangleVUBufferSizes or RxPipelineNodePS2AllMatSetPointListVUBufferSize, depending on the primitive.

RxLockedPipeUnlock : Unlock the pipeline for post construction time setup.

RxPipelineNodePS2AllMatSetVIFOffset : Setup the VIF offset.

RxPipelineNodePS2AllMatSetVU1CodeArray : Setup the VU1 vector code array and size.

RxPipelineNodePS2AllMatSetCallBack : Finally setup the material callbacks ( rxPS2ALLMATCALLBACKMESHINSTANCETEST, rxPS2ALLMATCALLBACKRESENTRYALLOC, rxPS2ALLMATCALLBACKINSTANCE, rxPS2ALLMATCALLBACKBRIDGE and rxPS2ALLMATCALLBACKPOSTMESH ).

Parameters:

definition

Definition structure defining the material pipeline.

Returns:: Contructed pipeline on success : NULL otherwise.

See also:: RpPDSSkyObjPipeCreate , RpPDSRegisterMatPipe

RxPipeline* RpPDSSkyObjPipeCreate

(

RpPDSSkyObjTemplate *

definition

)

Creates an object pipeline from the RpPDSSkyObjTemplate definition structure. This function is called by default when RpPDSRegisterPipe is creating object PS2All pipelines.

The function constructs a pipeline in the following way :-