Kaim::DisplayListManager Class Reference

Kaim::DisplayListManager Class Reference
+ Related help topics:

#include <displaylist.h>

Class Description

Game side: Manages all DisplayListData, send them to the NavigationLab.

NavigationLab side: Manages the DisplayListBlobs to render

Public Member Functions

void SubmitToRenderer ()
 Changed for consistency, please use BuildVisualGeometry instead. More...
 

Create a DisplayList that will be displayed 1 frame

DisplayList Make (const char group[64], const char name[64])
 
DisplayList Make (KyUInt32 worldElementId, const char name[64])
 
DisplayList Make (KyUInt32 worldElementId, const char group[64], const char name[64])
 

Create a DisplayList that will be displayed multiple frames, until RemoveDisplayList() is called

DisplayList MakeMultiFrame (KyUInt32 &displayListId, const char group[64], const char name[64])
 
DisplayList MakeMultiFrame (KyUInt32 &displayListId, KyUInt32 worldElementId, const char name[64])
 Associate the displayList with a worldElementId. More...
 
DisplayList MakeMultiFrame (KyUInt32 &displayListId, KyUInt32 worldElementId, const char group[64], const char name[64])
 Associate the displayList with a worldElementId. More...
 
KyUInt32 GenerateDisplayListId ()
 Returns a unique displayListId. More...
 
void RemoveDisplayList (KyUInt32 displayListId)
 Remove a displayList thta was created with MakeMultiFrame(). More...
 
void RemoveDisplayList (const char *displayListName, const char *displayListGroupName, KyUInt32 worldElementId=0xFFFFFFFF)
 Remove a displayList thta was created with MakeMultiFrame(). More...
 
void NewFrame ()
 End the current frame and begin a new one. More...
 

For internal use only

DisplayListData * GetNewDisplayListData ()
 
void SendDisplayListData (DisplayListData *displayListData)
 
void ReleaseDisplayListData (DisplayListData *displayListData)
 
void AddDisplayListBlobToRender (const char *displayListBlob, KyUInt32 blobsize)
 
DisplayListBlob * GetNextDisplayListBlobToRender (KyUInt32 &sizeRead)
 
void ClearDisplayListBlobsToRender ()
 
void SetVisualGeometry (IVisualGeometry *visualGeometry)
 
IVisualGeometryGetVisualGeometry ()
 
bool IsVisualGeometrySupported ()
 
void BuildVisualGeometry ()
 

Member Function Documentation

KyUInt32 Kaim::DisplayListManager::GenerateDisplayListId ( )

Returns a unique displayListId.

DisplayList Kaim::DisplayListManager::MakeMultiFrame ( KyUInt32 displayListId,
const char  group[64],
const char  name[64] 
)
  • Indicates the receiver to display the displayList untill DisplayListManager::RemoveDisplayList(displayListId) is called.
  • When displayListId = KyUInt32MAXVAL, then displayListId is set to GenerateDisplayListId().
  • If a DisplayList is created with an existing displayListId then it will replace the existing one.
    m_displayListId = KyUInt32MAXVAL; // initialized somewhere, out of the function creating the displayList
    MakeMultiFrame(m_displayListId, "mygroup", "myname")
DisplayList Kaim::DisplayListManager::MakeMultiFrame ( KyUInt32 displayListId,
KyUInt32  worldElementId,
const char  name[64] 
)

Associate the displayList with a worldElementId.

DisplayList Kaim::DisplayListManager::MakeMultiFrame ( KyUInt32 displayListId,
KyUInt32  worldElementId,
const char  group[64],
const char  name[64] 
)

Associate the displayList with a worldElementId.

void Kaim::DisplayListManager::NewFrame ( )

End the current frame and begin a new one.

void Kaim::DisplayListManager::RemoveDisplayList ( KyUInt32  displayListId)

Remove a displayList thta was created with MakeMultiFrame().

+ Examples:
void Kaim::DisplayListManager::RemoveDisplayList ( const char *  displayListName,
const char *  displayListGroupName,
KyUInt32  worldElementId = 0xFFFFFFFF 
)

Remove a displayList thta was created with MakeMultiFrame().

void Kaim::DisplayListManager::SubmitToRenderer ( )
inline

Changed for consistency, please use BuildVisualGeometry instead.


The documentation for this class was generated from the following files:
  • gwnavruntime/visualsystem/displaylist.h
  • gwnavruntime/visualsystem/displaylist.cpp