libikarus/include/ikarus/scopes/entity_scope.h
Folling 67711a8d39
finalise interface & documentation
Signed-off-by: Folling <mail@folling.io>
2025-04-15 12:07:58 +02:00

29 lines
730 B
C

#pragma once
/// \file entity_scope.h
/// \author Folling <folling@ikarus.world>
#include <ikarus/macros.h>
/// \addtogroup object_scopes ObjectScopes
/// @{
IKARUS_BEGIN_HEADER
/// \brief The global scope of all entities.
struct IkarusEntityScope;
/// \brief Creates an entity scope.
/// \return The created entity scope.
/// \remark Must be freed with #ikarus_free.
IKA_API IkarusEntityScope * ikarus_entity_scope_create();
/// Converts an entity scope to an object scope.
/// \param scope The scope to convert.
/// \return The converted scope.
/// \remark Must be freed with #ikarus_free.
IKA_API struct IkarusObjectScope * ikarus_entity_scope_to_object_scope(IkarusEntityScope const * scope);
IKARUS_END_HEADER
// @}