CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Classes | Enumerations
GsOverlayDefs.h File Reference
#include "OdArray.h"
#include "TD_PackPush.h"
#include "TD_PackPop.h"

Go to the source code of this file.

Classes

struct  OdGsOverlayMapping
 
class  OdGsOverlayDataPlaceholder
 
class  OdGsOverlayDataContainer< OverlayDataType >
 
struct  OdGsOverlayDataContainer< OverlayDataType >::Allocator
 
struct  OdGsOverlayDataContainer< OverlayDataType >::OverlayData
 
struct  OdGsOverlayDataContainer< OverlayDataType >::ForEach
 
class  OdGsOverlayDataContainer< OverlayDataType >::Iterator
 

Enumerations

enum  OdGsOverlayId {
  kGsMainOverlay = 0 , kGsDirectOverlay , kGsUserFg3Overlay , kGsUserBg1Overlay ,
  kGsUserBg3Overlay , kGsUserFg1Overlay , kGsHighlightOverlay , kGsHighlightSelectionOverlay ,
  kGsDirectTopmostOverlay , kGsSpriteOverlay , kGsContrastOverlay , kGsUserFg2Overlay ,
  kGsUserBg2Overlay , kNumGsOverlays , kGsAllOverlays = 0x1FFF , kGsNoOverlays = 0 ,
  kGsUndefinedOverlay = -1
}
 

Enumeration Type Documentation

◆ OdGsOverlayId

This enumeration contains similar definitions as inside OdGsModel::RenderType, but fundamental difference is that values inside OdGsOverlayId is given in priority order instead of rendering order. Priority order is more flexible for type definitions, arrays, flags and internal structures. We can use mapping tables to provide conversions between priority and rendering orders.

<group OdGs_Classes>

See also
<link tv_graphSysOverlays, Work with Graphic System Overlays>
Enumerator
kGsMainOverlay 
kGsDirectOverlay 
kGsUserFg3Overlay 
kGsUserBg1Overlay 
kGsUserBg3Overlay 
kGsUserFg1Overlay 
kGsHighlightOverlay 
kGsHighlightSelectionOverlay 
kGsDirectTopmostOverlay 
kGsSpriteOverlay 
kGsContrastOverlay 
kGsUserFg2Overlay 
kGsUserBg2Overlay 
kNumGsOverlays 
kGsAllOverlays 
kGsNoOverlays 
kGsUndefinedOverlay 

Definition at line 41 of file GsOverlayDefs.h.