OdGsOverlayMapping Struct Reference

#include <GsOverlayDefs.h>

Public Types
enum	OverlayTypeDefs {   kMainDepth = 0 , kNoDepth = 1 , kOwnDepth = 2 , kNoFrameBuf = 4 ,   kHltStyle = 8 , kContrastStyle = 16 }

Static Public Member Functions
static OdUInt32	overlayFlags (OdGsOverlayId id)
static OdUInt32	overlayIndexToRenderingOrder (OdGsOverlayId id)
static OdGsOverlayId	overlayRenderingOrderToIndex (OdUInt32 renderOrder)
static bool	validateDefinitions (OdUInt32 gsModelDef)
static bool	validateOverlayIndex (OdGsOverlayId id)
static bool	validateRenderingOrder (OdUInt32 renderOrder)

Protected Types
enum	OverlayRenderOrder {   kUserBg1 = 0 , kUserBg2 , kUserBg3 , kMain ,   kSprite , kDirect , kHighlight , kHighlightSelection ,   kDirectTopmost , kContrast , kUserFg1 , kUserFg2 ,   kUserFg3 , kNumOverlays }

Detailed Description

Provides mapping between overlays priority order and rendering order representations.

<group OdGs_Classes>

Definition at line 67 of file GsOverlayDefs.h.

Member Enumeration Documentation

OverlayRenderOrder

enum OdGsOverlayMapping::OverlayRenderOrder

protected

Enumerator
kUserBg1
kUserBg2
kUserBg3
kMain
kSprite
kDirect
kHighlight
kHighlightSelection
kDirectTopmost
kContrast
kUserFg1
kUserFg2
kUserFg3
kNumOverlays

Definition at line 70 of file GsOverlayDefs.h.

OverlayTypeDefs

enum OdGsOverlayMapping::OverlayTypeDefs

Overlays classification flags.

Enumerator
kMainDepth
kNoDepth
kOwnDepth
kNoFrameBuf
kHltStyle
kContrastStyle

Definition at line 81 of file GsOverlayDefs.h.

Member Function Documentation

overlayFlags()

static OdUInt32 OdGsOverlayMapping::overlayFlags ( OdGsOverlayId  id )

inlinestatic

Returns overlay classification flags for specified overlay.

Parameters

id	[in] Overlay index.

Definition at line 94 of file GsOverlayDefs.h.

overlayIndexToRenderingOrder()

static OdUInt32 OdGsOverlayMapping::overlayIndexToRenderingOrder ( OdGsOverlayId  id )

inlinestatic

Converts overlay index into overlay rendering order.

Parameters

id	[in] Overlay index.

Definition at line 120 of file GsOverlayDefs.h.

overlayRenderingOrderToIndex()

static OdGsOverlayId OdGsOverlayMapping::overlayRenderingOrderToIndex ( OdUInt32  renderOrder )

inlinestatic

Converts overlay rendering order into overlay index.

Parameters

renderOrder

[in] Overlay rendering order.

Definition at line 145 of file GsOverlayDefs.h.

validateDefinitions()

static bool OdGsOverlayMapping::validateDefinitions ( OdUInt32  gsModelDef )

inlinestatic

Validate overlay definitions.

Parameters

gsModelDef

[in] Number of overlay buffers defined in OdGsModel class.

Remarks

For debug purposes.

Definition at line 171 of file GsOverlayDefs.h.

validateOverlayIndex()

static bool OdGsOverlayMapping::validateOverlayIndex ( OdGsOverlayId  id )

inlinestatic

Validate overlay index.

Parameters

id	[in] Overlay index.

Definition at line 180 of file GsOverlayDefs.h.

validateRenderingOrder()

static bool OdGsOverlayMapping::validateRenderingOrder ( OdUInt32  renderOrder )

inlinestatic

Validate rendering order.

Parameters

renderOrder

[in] Overlay rendering order.

Definition at line 188 of file GsOverlayDefs.h.

---

The documentation for this struct was generated from the following file:

• GsOverlayDefs.h