API reference

ecs.h · C++ API

Browse entries grouped by interface file. Expand an entry for declarations, usage and version boundaries.

Read the related guide →

Entries retain declarations and sources. Runtime verification is recorded per entry; internal source candidates are not a promise of SDK delivery.

include/kui/engine/ecs.h
ComponentPool::add
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
T& add(uint32_t entityIndex, const T& component)

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:82

Report an issue with this entry →
ComponentPool::add
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
T& add(uint32_t entityIndex, T&& component)

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:99

Report an issue with this entry →
ComponentPool::compact
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
void compact()

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:143

Report an issue with this entry →
ComponentPool::components
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
const std::vector<T>& components() const

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:153

Report an issue with this entry →
ComponentPool::components
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
std::vector<T>& components()

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:152

Report an issue with this entry →
ComponentPool::each
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
template <typename Fn> void each(Fn&& fn)

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:155

Report an issue with this entry →
ComponentPool::entities
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
const std::vector<uint32_t>& entities() const

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:150

Report an issue with this entry →
ComponentPool::get
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
const T* get(uint32_t entityIndex) const

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:136

Report an issue with this entry →
ComponentPool::get
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
T* get(uint32_t entityIndex)

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:131

Report an issue with this entry →
ComponentPool::has
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
bool has(uint32_t entityIndex) const override

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:78

Report an issue with this entry →
ComponentPool::remove
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
void remove(uint32_t entityIndex) override

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:115

Report an issue with this entry →
ComponentPool::size
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
size_t size() const override

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:141

Report an issue with this entry →
ComponentPoolBase::~ComponentPoolBase
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
virtual ~ComponentPoolBase() = default;

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:58

Report an issue with this entry →
ComponentPoolBase::has
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
virtual bool has(uint32_t entityIndex) const = 0;

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:59

Report an issue with this entry →
ComponentPoolBase::remove
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
virtual void remove(uint32_t entityIndex) = 0;

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:60

Report an issue with this entry →
ComponentPoolBase::size
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
virtual size_t size() const = 0;

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:61

Report an issue with this entry →
Entity::isValid
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
bool isValid() const

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:42

Report an issue with this entry →
Entity::null
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
static Entity null()

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:44

Report an issue with this entry →
Entity::operator!=
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
bool operator!=(const Entity& e) const

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:41

Report an issue with this entry →
Entity::operator==
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
bool operator==(const Entity& e) const

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:40

Report an issue with this entry →
EntityHash::operator
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
size_t operator()(const Entity& e) const

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:48

Report an issue with this entry →
System::~System
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
virtual ~System() = default;

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:197

Report an issue with this entry →
System::fixedUpdate
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
virtual void fixedUpdate(World& world, float fixedDt)

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:202

Report an issue with this entry →
System::init
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
virtual void init(World& world)

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:198

Report an issue with this entry →
System::isEnabled
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
bool isEnabled() const

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:216

Report an issue with this entry →
System::isFixedTimestep
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
bool isFixedTimestep() const

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:208

Report an issue with this entry →
System::name
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
const std::string& name() const

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:214

Report an issue with this entry →
System::priority
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
int priority() const

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:212

Report an issue with this entry →
System::setEnabled
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
void setEnabled(bool e)

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:217

Report an issue with this entry →
System::setFixedTimestep
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
void setFixedTimestep(bool f)

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:210

Report an issue with this entry →
System::setName
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
void setName(const std::string& n)

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:215

Report an issue with this entry →
System::setPriority
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
void setPriority(int p)

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:213

Report an issue with this entry →
System::shutdown
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
virtual void shutdown(World& world)

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:200

Report an issue with this entry →
System::update
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
virtual void update(World& world, float dt) = 0;

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:199

Report an issue with this entry →
TransformComponent::one
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
Vec3 scale = Vec3::one();

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:174

Report an issue with this entry →
World::~World
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
~World()

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:232

Report an issue with this entry →
World::addComponent
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
template <typename T> T& addComponent(Entity e, const T& component)

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:291

Report an issue with this entry →
World::addComponent
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
template <typename T> T& addComponent(Entity e, T&& component)

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:299

Report an issue with this entry →
World::addSystem
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
template <typename T, typename... Args> T& addSystem(Args&&... args)

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:357

Report an issue with this entry →
World::aliveEntities
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
const std::unordered_set<uint32_t>& aliveEntities() const

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:282

Report an issue with this entry →
World::createEntity
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
Entity createEntity(const std::string& name)

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:254

Report an issue with this entry →
World::createEntity
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
Entity createEntity()

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:238

Report an issue with this entry →
World::destroyEntity
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
void destroyEntity(Entity e)

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:260

Report an issue with this entry →
World::each
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
template <typename T, typename Fn> void each(Fn&& fn)

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:347

Report an issue with this entry →
World::entityCount
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
size_t entityCount() const

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:280

Report an issue with this entry →
World::entityFromIndex
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
Entity entityFromIndex(uint32_t idx) const

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:285

Report an issue with this entry →
World::fixedUpdateSystems
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
void fixedUpdateSystems(float fixedDt)

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:380

Report an issue with this entry →
World::getComponent
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
template <typename T> const T* getComponent(Entity e) const

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:326

Report an issue with this entry →
World::getComponent
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
template <typename T> T* getComponent(Entity e)

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:319

Report an issue with this entry →
World::getPool
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
template <typename T> ComponentPool<T>* getPool()

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:333

Report an issue with this entry →
World::getPool
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
template <typename T> const ComponentPool<T>* getPool() const

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:340

Report an issue with this entry →
World::hasComponent
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
template <typename T> bool hasComponent(Entity e) const

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:312

Report an issue with this entry →
World::initSystems
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
void initSystems()

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:368

Report an issue with this entry →
World::isAlive
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
bool isAlive(Entity e) const

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:276

Report an issue with this entry →
World::operator=
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
World& operator=(const World&) = delete;

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:236

Report an issue with this entry →
World::removeComponent
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
template <typename T> void removeComponent(Entity e)

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:305

Report an issue with this entry →
World::shutdown
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
void shutdown()

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:387

Report an issue with this entry →
World::updateSystems
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
void updateSystems(float dt)

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:373

Report an issue with this entry →
World::World
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
World(const World&) = delete;

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:234

Report an issue with this entry →
World::World
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

ecs.h
World() = default;

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/ecs.h:231

Report an issue with this entry →
Browse this reference type →