API reference

lua_engine3d_api.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/lua_engine3d_api.h
defined
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.

lua_engine3d_api.h
#endif #if defined(KUI_HAS_3D_PHYSICS) class BulletPhysicsBackend;

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/lua_engine3d_api.h:25

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

lua_engine3d_api.h
#if defined(KUI_HAS_3D_RENDER) struct SSAOConfig;

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/lua_engine3d_api.h:20

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

lua_engine3d_api.h
#pragma once #if defined(KUI_HAS_3D_ENGINE) && defined(KUI_HAS_SCRIPTING) #include <kui/core/types.h> #include <string> struct lua_State;

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/lua_engine3d_api.h:1

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

lua_engine3d_api.h
KUI_API void engine3dClearInputState();

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/lua_engine3d_api.h:47

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

lua_engine3d_api.h
KUI_API void engine3dSetKeyDown(const std::string& key);

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/lua_engine3d_api.h:42

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

lua_engine3d_api.h
KUI_API void engine3dSetKeyUp(const std::string& key);

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/lua_engine3d_api.h:44

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

lua_engine3d_api.h
KUI_API void engine3dSetMouseButton(int button, bool down);

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/lua_engine3d_api.h:46

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

lua_engine3d_api.h
KUI_API void engine3dSetMousePosition(float x, float y);

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/lua_engine3d_api.h:45

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

lua_engine3d_api.h
#endif KUI_API void registerEngine3DAPI(lua_State* L, EngineApp* app #if defined(KUI_HAS_3D_RENDER) , ConfigureSSAOFn ssaoFn = nullptr , ApplyQualityFn qualityFn = nullptr #endif #if defined(KUI_HAS_3D_PHYSICS) , BulletPhysicsBackend* physics = nullptr #endif );

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/lua_engine3d_api.h:29

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

lua_engine3d_api.h
using ApplyQualityFn = void(*)(int 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/lua_engine3d_api.h:24

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

lua_engine3d_api.h
using ConfigureSSAOFn = void(*)(const SSAOConfig&);

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/lua_engine3d_api.h:22

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