Cogs.Foundation
Loading...
Searching...
No Matches
Public Types | List of all members
Cogs::ComponentModel::ComponentFlags Struct Reference

Contains component flags. More...

#include <Component.h>

Public Types

enum  EComponentFlags : uint32_t {
  None = 0x00 , Active = 0x01 , Changed = 0x02 , DisableTracking = 0x04 ,
  CarryChanged = 0x08 , OverflowFieldChange = 0x10 , FieldChange = 0x100 , AllFieldChanged = ~(FieldChange-1u) | OverflowFieldChange
}
 Component flags describing the state of a component instance. More...
 

Detailed Description

Contains component flags.

Member Enumeration Documentation

◆ EComponentFlags

Component flags describing the state of a component instance.

Enumerator
None 

The component has not been initialized.

Active 

The component has been initialized and is currently allocated.

Changed 

The components data has changed.

DisableTracking 

No change tracking should be performed on the component.

CarryChanged 

Set when fields are marked changed by setChanged or setFieldChanged.. Field prevents the Changed flag to reset when calling resetChanged(). Typical loop: Client updates Components calling SetXXXChanged() setting CarryChanged. System redraw starts. All CarryChanged cleared. Components are drawn. Any changes while redrawing will set CarryChanged causing requiring a new redraw to clear. When redraw ends resetChanged() is called.

OverflowFieldChange 

Field change bit for fields outside range of individual change tracking bit. Field 24++.

FieldChange 

Flags above reserved for field change storage. Field0=FieldChange, Field 1 = FieldChange<<1.

AllFieldChanged 

Mark all fields changed. Sets FieldChange + all bits above + OverflowFieldChange.


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