API reference

scene_serializer.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/scene_serializer.h
SceneSerializer::~SceneSerializer
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.

scene_serializer.h
~SceneSerializer() = 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/scene_serializer.h:73

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

scene_serializer.h
bool deserialize(World& world, SceneGraph& sceneGraph, const SerializedScene& 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/scene_serializer.h:97

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

scene_serializer.h
static SerializedScene fromJSON(const std::string& json);

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/scene_serializer.h:93

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

scene_serializer.h
bool loadFromFile(World& world, SceneGraph& sceneGraph, const std::string& filePath) 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/scene_serializer.h:101

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

scene_serializer.h
bool merge(World& world, SceneGraph& sceneGraph, const SerializedScene& 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/scene_serializer.h:105

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

scene_serializer.h
void registerComponent(const std::string& typeName, SerializeFn serializeFn, DeserializeFn deserializeFn);

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/scene_serializer.h:75

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

scene_serializer.h
bool saveToFile(const World& world, const SceneGraph& sceneGraph, const std::string& filePath, const std::string& sceneName = "") 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/scene_serializer.h:88

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

scene_serializer.h
SceneSerializer();

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/scene_serializer.h:72

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

scene_serializer.h
SerializedScene serialize(const World& world, const SceneGraph& sceneGraph, const std::string& sceneName = "") 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/scene_serializer.h:80

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

scene_serializer.h
static std::string toJSON(const SerializedScene& scene);

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/scene_serializer.h:85

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

scene_serializer.h
using SerializeFn = std::function<SerializedComponent(const World& world, Entity entity)>;

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/scene_serializer.h:55

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.

scene_serializer.h
using DeserializeFn = std::function<void(World& world, Entity entity, const SerializedComponent& data)>;

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/scene_serializer.h:59

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