changeset 1428:d16964858790

add: documentation comment
author sam <sam@basx.dev>
date Sat, 11 Jan 2025 14:15:29 +0700
parents 676fc13685a9
children ab01c577d91c
files semicongine.nim
diffstat 1 files changed, 2 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/semicongine.nim	Sat Jan 11 14:04:39 2025 +0700
+++ b/semicongine.nim	Sat Jan 11 14:15:29 2025 +0700
@@ -9,9 +9,8 @@
 from ./semicongine/background_loaders import initBackgroundLoader
 import ./semicongine/loaders
 
-#### Main engine object
-
 proc initEngine*(appName: string) =
+  ## Required to be called before most features of the engine can be used
   engine_obj_internal = Engine()
   engine_obj_internal.vulkan = initVulkan(appName)
 
@@ -22,6 +21,7 @@
   engine_obj_internal.mixer[].lock.initLock()
   engine_obj_internal.audiothread.createThread(audioWorker, engine_obj_internal.mixer)
 
+  # start background resource loaders
   engine_obj_internal.rawLoader = initBackgroundLoader(loadBytes)
   engine_obj_internal.jsonLoader = initBackgroundLoader(loadJson)
   engine_obj_internal.configLoader = initBackgroundLoader(loadConfig)