atlas::serializer Class Reference

serializer is responsible for saving/loading scenes More...

#include <serializer.hpp>

Public Member Functions
	serializer (const ref< scene > &p_scene_ctx)
	constructs a new serializer with a requirement to specify a scene to serialize
void	save (const std::filesystem::path &p_filepath)
bool	load (const std::filesystem::path &p_filepath, const flecs::world &p_registry)

Detailed Description

serializer is responsible for saving/loading scenes

This class excepts a scene context with the purpose of serializing with the entities that reside within that specific scene context

Which also provide an API for loading in a scene from disk for deserialization.

Constructor & Destructor Documentation

serializer()

atlas::serializer::serializer

(

const ref< scene > &

p_scene_ctx

)

constructs a new serializer with a requirement to specify a scene to serialize

Parameters

p_scene_ctx

is the current scene to perform serialization/deserialization to

Member Function Documentation

load()

bool atlas::serializer::load	(	const std::filesystem::path &	p_filepath,
		const flecs::world &	p_registry
	)

Parameters

p_filepath	is the specified path to loading in the saved file from
p_registry	is the current scene registry to load/create the entities through that registry

Returns

true if loading was successful, otherwise will return false

save()

void atlas::serializer::save

(

const std::filesystem::path &

p_filepath

)

Parameters

p_filepath

is the specified path to save the file

---

The documentation for this class was generated from the following file:

• TheAtlasEngine/atlas/core/serialize/serializer.hpp