API reference

filament_backend.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/filament_backend.h
KUI_3D_BACKEND_API::~FilamentBackend
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.

filament_backend.h
~FilamentBackend();

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/filament_backend.h:89

Report an issue with this entry →
KUI_3D_BACKEND_API::addAssetToScene
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.

filament_backend.h
void addAssetToScene(void* asset);

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/filament_backend.h:151

Report an issue with this entry →
KUI_3D_BACKEND_API::addEntityToScene
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.

filament_backend.h
void addEntityToScene(uint32_t filamentEntity);

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/filament_backend.h:129

Report an issue with this entry →
KUI_3D_BACKEND_API::applyMaterialOverride
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.

filament_backend.h
void applyMaterialOverride(uint32_t filamentEntity, const MaterialOverride& mat);

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/filament_backend.h:250

Report an issue with this entry →
KUI_3D_BACKEND_API::applyQualityPreset
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.

filament_backend.h
void applyQualityPreset(QualityPreset preset);

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/filament_backend.h:238

Report an issue with this entry →
KUI_3D_BACKEND_API::beginFrame
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.

filament_backend.h
bool beginFrame();

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/filament_backend.h:124

Report an issue with this entry →
KUI_3D_BACKEND_API::clearSkybox
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.

filament_backend.h
void clearSkybox();

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/filament_backend.h:210

Report an issue with this entry →
KUI_3D_BACKEND_API::configureBloom
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.

filament_backend.h
void configureBloom(float strength = 0.1f, int levels = 6, float threshold = 1.0f);

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/filament_backend.h:216

Report an issue with this entry →
KUI_3D_BACKEND_API::configureFog
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.

filament_backend.h
void configureFog(float density, float startDistance, float maxOpacity, float r, float g, float b, float height = 0.0f, int type = 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/filament_backend.h:222

Report an issue with this entry →
KUI_3D_BACKEND_API::configureShadows
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.

filament_backend.h
void configureShadows(uint32_t lightEntity, const ShadowConfig& config);

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/filament_backend.h:168

Report an issue with this entry →
KUI_3D_BACKEND_API::configureSSAO
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.

filament_backend.h
void configureSSAO(const SSAOConfig& config);

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/filament_backend.h:246

Report an issue with this entry →
KUI_3D_BACKEND_API::createBoxRenderable
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.

filament_backend.h
uint32_t createBoxRenderable(const Vec3& color, float alpha = 1.0f);

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/filament_backend.h:189

Report an issue with this entry →
KUI_3D_BACKEND_API::createCameraEntity
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.

filament_backend.h
uint32_t createCameraEntity();

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/filament_backend.h:136

Report an issue with this entry →
KUI_3D_BACKEND_API::createCylinderRenderable
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.

filament_backend.h
uint32_t createCylinderRenderable(const Vec3& color, float alpha = 1.0f, int sectors = 32);

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/filament_backend.h:198

Report an issue with this entry →
KUI_3D_BACKEND_API::createDefaultMaterialInstance
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.

filament_backend.h
filament::MaterialInstance* createDefaultMaterialInstance();

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/filament_backend.h:157

Report an issue with this entry →
KUI_3D_BACKEND_API::createLightEntity
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.

filament_backend.h
uint32_t createLightEntity(const LightComponent& light);

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/filament_backend.h:135

Report an issue with this entry →
KUI_3D_BACKEND_API::createPlaneRenderable
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.

filament_backend.h
uint32_t createPlaneRenderable(const Vec3& color, float alpha = 1.0f);

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/filament_backend.h:201

Report an issue with this entry →
KUI_3D_BACKEND_API::createRenderableEntity
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.

filament_backend.h
uint32_t createRenderableEntity();

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/filament_backend.h:133

Report an issue with this entry →
KUI_3D_BACKEND_API::createSphereRenderable
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.

filament_backend.h
uint32_t createSphereRenderable(const Vec3& color, float alpha = 1.0f, int stacks = 16, int sectors = 32);

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/filament_backend.h:194

Report an issue with this entry →
KUI_3D_BACKEND_API::currentQualityPreset
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.

filament_backend.h
QualityPreset currentQualityPreset() 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/filament_backend.h:240

Report an issue with this entry →
KUI_3D_BACKEND_API::currentSSAOConfig
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.

filament_backend.h
SSAOConfig currentSSAOConfig() 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/filament_backend.h:248

Report an issue with this entry →
KUI_3D_BACKEND_API::destroyAsset
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.

filament_backend.h
void destroyAsset(void* asset);

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/filament_backend.h:153

Report an issue with this entry →
KUI_3D_BACKEND_API::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.

filament_backend.h
void destroyEntity(uint32_t filamentEntity);

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/filament_backend.h:137

Report an issue with this entry →
KUI_3D_BACKEND_API::endFrame
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.

filament_backend.h
void endFrame();

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/filament_backend.h:127

Report an issue with this entry →
KUI_3D_BACKEND_API::engine
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.

filament_backend.h
filament::Engine* engine() 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/filament_backend.h:256

Report an issue with this entry →
KUI_3D_BACKEND_API::FilamentBackend
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.

filament_backend.h
FilamentBackend();

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/filament_backend.h:88

Report an issue with this entry →
KUI_3D_BACKEND_API::FilamentBackend
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.

filament_backend.h
FilamentBackend(const FilamentBackend&) = 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/filament_backend.h:91

Report an issue with this entry →
KUI_3D_BACKEND_API::getAnimationCount
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.

filament_backend.h
size_t getAnimationCount(void* animator) 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/filament_backend.h:175

Report an issue with this entry →
KUI_3D_BACKEND_API::getAnimationDuration
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.

filament_backend.h
float getAnimationDuration(void* animator, size_t index) 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/filament_backend.h:176

Report an issue with this entry →
KUI_3D_BACKEND_API::getAnimationName
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.

filament_backend.h
const char* getAnimationName(void* animator, size_t index) 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/filament_backend.h:177

Report an issue with this entry →
KUI_3D_BACKEND_API::getAssetAnimator
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.

filament_backend.h
void* getAssetAnimator(void* asset) 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/filament_backend.h:179

Report an issue with this entry →
KUI_3D_BACKEND_API::getAssetBoundingBox
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.

filament_backend.h
void getAssetBoundingBox(void* asset, Vec3& center, Vec3& halfExtent) 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/filament_backend.h:181

Report an issue with this entry →
KUI_3D_BACKEND_API::getAssetRootEntity
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.

filament_backend.h
uint32_t getAssetRootEntity(void* asset) 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/filament_backend.h:154

Report an issue with this entry →
KUI_3D_BACKEND_API::height
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.

filament_backend.h
int height() 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/filament_backend.h:261

Report an issue with this entry →
KUI_3D_BACKEND_API::initialize
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.

filament_backend.h
bool initialize(void* nativeWindow, int width, int height, void* sharedGLContext = nullptr);

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/filament_backend.h:95

Report an issue with this entry →
KUI_3D_BACKEND_API::initializeWithPlatform
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.

filament_backend.h
bool initializeWithPlatform(void* platform, int width, int height);

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/filament_backend.h:103

Report an issue with this entry →
KUI_3D_BACKEND_API::isHeadless
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.

filament_backend.h
bool isHeadless() 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/filament_backend.h:187

Report an issue with this entry →
KUI_3D_BACKEND_API::isInitialized
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.

filament_backend.h
bool isInitialized() 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/filament_backend.h:108

Report an issue with this entry →
KUI_3D_BACKEND_API::isShadowingEnabled
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.

filament_backend.h
bool isShadowingEnabled() 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/filament_backend.h:167

Report an issue with this entry →
KUI_3D_BACKEND_API::isZeroCopy
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.

filament_backend.h
bool isZeroCopy() 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/filament_backend.h:118

Report an issue with this entry →
KUI_3D_BACKEND_API::loadGltfAsset
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.

filament_backend.h
void* loadGltfAsset(const std::string& path);

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/filament_backend.h:149

Report an issue with this entry →
KUI_3D_BACKEND_API::loadSkybox
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.

filament_backend.h
bool loadSkybox(const std::string& path);

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/filament_backend.h:204

Report an issue with this entry →
KUI_3D_BACKEND_API::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.

filament_backend.h
FilamentBackend& operator=(const FilamentBackend&) = 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/filament_backend.h:93

Report an issue with this entry →
KUI_3D_BACKEND_API::readPixelsToBuffer
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.

filament_backend.h
bool readPixelsToBuffer(uint8_t* outRGBA, int w, int h);

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/filament_backend.h:183

Report an issue with this entry →
KUI_3D_BACKEND_API::removeAssetFromScene
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.

filament_backend.h
void removeAssetFromScene(void* asset);

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/filament_backend.h:152

Report an issue with this entry →
KUI_3D_BACKEND_API::removeEntityFromScene
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.

filament_backend.h
void removeEntityFromScene(uint32_t filamentEntity);

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/filament_backend.h:131

Report an issue with this entry →
KUI_3D_BACKEND_API::render
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.

filament_backend.h
void render();

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/filament_backend.h:126

Report an issue with this entry →
KUI_3D_BACKEND_API::resize
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.

filament_backend.h
void resize(int width, int height);

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/filament_backend.h:121

Report an issue with this entry →
KUI_3D_BACKEND_API::scene
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.

filament_backend.h
filament::Scene* scene() 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/filament_backend.h:258

Report an issue with this entry →
KUI_3D_BACKEND_API::screenToWorldRay
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.

filament_backend.h
void screenToWorldRay(int px, int py, Vec3& outOrigin, Vec3& outDirection) 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/filament_backend.h:224

Report an issue with this entry →
KUI_3D_BACKEND_API::setActiveCamera
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.

filament_backend.h
void setActiveCamera(uint32_t cameraEntity, const CameraComponent& cam);

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/filament_backend.h:139

Report an issue with this entry →
KUI_3D_BACKEND_API::setAssetTransform
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.

filament_backend.h
void setAssetTransform(void* asset, const Mat4& worldMatrix);

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/filament_backend.h:155

Report an issue with this entry →
KUI_3D_BACKEND_API::setBloomEnabled
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.

filament_backend.h
void setBloomEnabled(bool enabled);

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/filament_backend.h:213

Report an issue with this entry →
KUI_3D_BACKEND_API::setCameraTransform
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.

filament_backend.h
void setCameraTransform(uint32_t cameraEntity, const Mat4& worldMatrix);

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/filament_backend.h:141

Report an issue with this entry →
KUI_3D_BACKEND_API::setDefaultEnvironment
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.

filament_backend.h
void setDefaultEnvironment();

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/filament_backend.h:160

Report an issue with this entry →
KUI_3D_BACKEND_API::setDynamicResolution
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.

filament_backend.h
void setDynamicResolution(bool enabled, float minScale = 0.5f, float maxScale = 1.0f, int quality = 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/filament_backend.h:234

Report an issue with this entry →
KUI_3D_BACKEND_API::setEntityCastShadows
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.

filament_backend.h
void setEntityCastShadows(uint32_t filamentEntity, bool cast);

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/filament_backend.h:242

Report an issue with this entry →
KUI_3D_BACKEND_API::setEntityLOD
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.

filament_backend.h
void setEntityLOD(uint32_t filamentEntity, uint8_t level);

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/filament_backend.h:253

Report an issue with this entry →
KUI_3D_BACKEND_API::setEntityReceiveShadows
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.

filament_backend.h
void setEntityReceiveShadows(uint32_t filamentEntity, bool receive);

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/filament_backend.h:244

Report an issue with this entry →
KUI_3D_BACKEND_API::setEntityTransform
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.

filament_backend.h
void setEntityTransform(uint32_t entity, const Mat4& worldMatrix);

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/filament_backend.h:146

Report an issue with this entry →
KUI_3D_BACKEND_API::setFogEnabled
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.

filament_backend.h
void setFogEnabled(bool enabled);

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/filament_backend.h:220

Report an issue with this entry →
KUI_3D_BACKEND_API::setMorphWeights
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.

filament_backend.h
void setMorphWeights(uint32_t filamentEntity, const float* weights, size_t count);

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/filament_backend.h:231

Report an issue with this entry →
KUI_3D_BACKEND_API::setShadowingEnabled
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.

filament_backend.h
void setShadowingEnabled(bool enabled);

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/filament_backend.h:163

Report an issue with this entry →
KUI_3D_BACKEND_API::setShadowType
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.

filament_backend.h
void setShadowType(int type);

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/filament_backend.h:169

Report an issue with this entry →
KUI_3D_BACKEND_API::setSolidColorSkybox
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.

filament_backend.h
void setSolidColorSkybox(float r, float g, float b);

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/filament_backend.h:208

Report an issue with this entry →
KUI_3D_BACKEND_API::setToneMapping
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.

filament_backend.h
void setToneMapping(int type);

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/filament_backend.h:217

Report an issue with this entry →
KUI_3D_BACKEND_API::setupZeroCopyRenderTarget
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.

filament_backend.h
uint32_t setupZeroCopyRenderTarget(int width, int height);

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/filament_backend.h:110

Report an issue with this entry →
KUI_3D_BACKEND_API::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.

filament_backend.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/filament_backend.h:107

Report an issue with this entry →
KUI_3D_BACKEND_API::updateAnimator
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.

filament_backend.h
void updateAnimator(void* animator, int animIndex, float time);

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/filament_backend.h:169

Report an issue with this entry →
KUI_3D_BACKEND_API::updateAnimatorCrossFade
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.

filament_backend.h
void updateAnimatorCrossFade(void* animator, int prevAnim, float prevTime, float alpha);

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/filament_backend.h:173

Report an issue with this entry →
KUI_3D_BACKEND_API::updateBoneMatrices
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.

filament_backend.h
void updateBoneMatrices(void* animator);

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/filament_backend.h:174

Report an issue with this entry →
KUI_3D_BACKEND_API::updateLight
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.

filament_backend.h
void updateLight(uint32_t lightEntity, const LightComponent& light, const Mat4& worldMatrix);

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/filament_backend.h:143

Report an issue with this entry →
KUI_3D_BACKEND_API::view
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.

filament_backend.h
filament::View* view() 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/filament_backend.h:259

Report an issue with this entry →
KUI_3D_BACKEND_API::width
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.

filament_backend.h
int width() 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/filament_backend.h:260

Report an issue with this entry →
KUI_3D_BACKEND_API::zeroCopyTextureId
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.

filament_backend.h
uint32_t zeroCopyTextureId() 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/filament_backend.h:115

Report an issue with this entry →
LightComponent::Vec3
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.

filament_backend.h
Vec3 color = Vec3(1, 1, 1);

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/filament_backend.h:65

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