Skip to content
Flecs v4.1
Topics
Here is a list of all topics with brief descriptions:
 C API
  CoreCore ECS functionality (entities, storage, queries)
   API definesDefines for customizing compile-time features
   Core API TypesTypes for core API objects
   API typesPublic API types
    Function types.Function callback types
    Query descriptor types.Types used to describe queries
    Miscellaneous typesTypes used to create entities, observers, queries, and more
    Built-in component types.Types that represent built-in components
   API ConstantsPublic API constants
    Component ID flags.ID flags are bits that can be set on an ID (ecs_id_t)
    Built-in component IDs.
   WorldFunctions for working with ecs_world_t
    Creation & Deletion
    Commands
    Misc
   EntitiesFunctions for working with ecs_entity_t
    Creating & DeletingFunctions for creating and deleting entities
    Adding & RemovingFunctions for adding and removing components
    Enabling & DisablingFunctions for enabling/disabling entities and components
    Getting and SettingFunctions for getting and setting components
    Entity LivelinessFunctions for testing and modifying entity liveliness
    Entity Information.Get information from an entity
    Entity NamesFunctions for working with entity names and paths
   ComponentsFunctions for registering and working with components
   IDsFunctions for working with ecs_id_t
   QueriesFunctions for working with ecs_term_t and ecs_query_t
   Each iteratorFind all entities that have a single (component) ID
   ObserversFunctions for working with events and observers
   IteratorsFunctions for working with ecs_iter_t
   TablesFunctions for working with ecs_table_t
  AddonsC APIs for addons
   AlertsCreate alerts from monitoring queries
   AppOptional addon for running the main application loop
   Constraint TraitsTraits that enforce constraints on entities, components and relationships
   DocUtilities for documenting entities, components, and systems
   Entity RangesEntity id range management
   FrameFrame management
   HttpSimple HTTP server used for serving up the REST API
   JsonFunctions for serializing to and from JSON
   LogLogging functions
   MetaFlecs reflection framework
   Meta UtilitiesMacro utilities to automatically insert reflection data
   MetricsCollect user-defined metrics from ECS data
   ModuleModules organize components, systems, and more in reusable units of code
   OS API ImplementationDefault implementation for OS API interface
   PipelinePipelines order and schedule systems for execution
   RestREST API for querying and mutating entities
   Flecs scriptDSL for loading scenes, assets, and configuration
   StatsCollection of statistics for world, queries, systems, and pipelines
   SystemSystems are a query + function that can be run manually or by a pipeline
   TimerRun systems at a time interval
   Units.Common unit annotations for reflection framework
    PrefixesPrefixes to indicate unit count (e.g., Kilo, Mega)
    Duration
    Time
    Mass
    Electric Current
    Amount
    Luminous Intensity
    Force
    Length
    Pressure
    Speed
    Temperature
    Data
    Data Rate
    Angle
    Frequency
    Uri
    Color
  OS APIInterface for providing OS-specific functionality
  Macro APIConvenience macros for C API
   Creation macrosConvenience macros for creating entities, components, and observers
   Type-Safe APIMacros that wrap around core functions to provide a "type-safe" API in C
    Entity API
     Creation & Deletion
     Adding & Removing
     Getting & Setting
     Singletons
     Has, Owns, Shares
     Enabling & Disabling
     Entity Names
    Component API
    ID API
    Iterator API
    Table API
    Value API
   Table sortingConvenience macros for sorting tables
   MiscMisc convenience macros
 C++ API
  CoreCore ECS functionality (entities, storage, queries)
   API Types and GlobalsTypes and constants bridged from C API
   ComponentsRegistering and working with components
   EntitiesEntity operations
   FieldsField helper types
   IteratorsIterator operations
   IDsClass for working with entity, component, tag, and pair IDs
   ObserversObservers let applications register callbacks for ECS events
   Queries
   Sparse queriesDirect iteration of sparse component storages
   Pair typeCompile-time utilities for working with relationship pairs
   RefsRefs are a fast mechanism for referring to a specific entity/component
   TablesTable operations
   TypesType operations
   WorldWorld operations
  AddonsC++ APIs for addons
   LoggingLogging functions
   AlertsAlert implementation
   AppOptional addon for running the main application loop
   DocUtilities for documenting entities, components, and systems
   Entity RangesEntity id range management
   EventsAPI for emitting events
   FrameFrame management
   JsonFunctions for serializing to/from JSON
   MetaFlecs reflection framework
   MetricsThe metrics module extracts metrics from components and makes them available through a unified component interface
   ModulesModules organize components, systems, and more in reusable units of code
   PipelinesPipelines order and schedule systems for execution
   RestREST API for querying and mutating entities
   ScriptData definition format for loading entity data
   StatsThe stats addon tracks statistics for the world and systems
   SystemsSystems are a query and a function that can be run manually or by a pipeline
   TimerRun systems at a time interval
   UnitsCommon unit annotations for reflection framework
    PrefixesPrefixes to indicate unit count (e.g., Kilo, Mega)
    QuantitiesQuantities that group units (e.g., Length)
    Duration
    Angle
    Time
    Mass
    Electric Current
    Amount
    Luminous Intensity
    Force
    Length
    Pressure
    Speed
    Temperature
    Data
    Data Rate
    Frequency
    Uri
    Color