Engine.cpp 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949
  1. //
  2. // Copyright (c) 2008-2016 the Urho3D project.
  3. //
  4. // Permission is hereby granted, free of charge, to any person obtaining a copy
  5. // of this software and associated documentation files (the "Software"), to deal
  6. // in the Software without restriction, including without limitation the rights
  7. // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  8. // copies of the Software, and to permit persons to whom the Software is
  9. // furnished to do so, subject to the following conditions:
  10. //
  11. // The above copyright notice and this permission notice shall be included in
  12. // all copies or substantial portions of the Software.
  13. //
  14. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  20. // THE SOFTWARE.
  21. //
  22. #include "../Precompiled.h"
  23. #include "../Audio/Audio.h"
  24. #include "../Core/Context.h"
  25. #include "../Core/CoreEvents.h"
  26. #include "../Core/ProcessUtils.h"
  27. #include "../Core/Profiler.h"
  28. #include "../Core/EventProfiler.h"
  29. #include "../Core/WorkQueue.h"
  30. #include "../Engine/Console.h"
  31. #include "../Engine/DebugHud.h"
  32. #include "../Engine/Engine.h"
  33. #include "../Graphics/Graphics.h"
  34. #include "../Graphics/Renderer.h"
  35. #include "../IO/FileSystem.h"
  36. #include "../Input/Input.h"
  37. #include "../IO/Log.h"
  38. #include "../IO/PackageFile.h"
  39. #ifdef URHO3D_NAVIGATION
  40. #include "../Navigation/NavigationMesh.h"
  41. #endif
  42. #ifdef URHO3D_NETWORK
  43. #include "../Network/Network.h"
  44. #endif
  45. #ifdef URHO3D_DATABASE
  46. #include "../Database/Database.h"
  47. #endif
  48. #ifdef URHO3D_PHYSICS
  49. #include "../Physics/PhysicsWorld.h"
  50. #endif
  51. #include "../Resource/ResourceCache.h"
  52. #include "../Resource/Localization.h"
  53. #include "../Scene/Scene.h"
  54. #include "../Scene/SceneEvents.h"
  55. #include "../UI/UI.h"
  56. #ifdef URHO3D_URHO2D
  57. #include "../Urho2D/Urho2D.h"
  58. #endif
  59. #if defined(__EMSCRIPTEN__) && defined(URHO3D_TESTING)
  60. #include <emscripten/emscripten.h>
  61. #endif
  62. #include "../DebugNew.h"
  63. #if defined(_MSC_VER) && defined(_DEBUG)
  64. // From dbgint.h
  65. #define nNoMansLandSize 4
  66. typedef struct _CrtMemBlockHeader
  67. {
  68. struct _CrtMemBlockHeader* pBlockHeaderNext;
  69. struct _CrtMemBlockHeader* pBlockHeaderPrev;
  70. char* szFileName;
  71. int nLine;
  72. size_t nDataSize;
  73. int nBlockUse;
  74. long lRequest;
  75. unsigned char gap[nNoMansLandSize];
  76. } _CrtMemBlockHeader;
  77. #endif
  78. namespace Urho3D
  79. {
  80. extern const char* logLevelPrefixes[];
  81. Engine::Engine(Context* context) :
  82. Object(context),
  83. timeStep_(0.0f),
  84. timeStepSmoothing_(2),
  85. minFps_(10),
  86. #if defined(ANDROID) || defined(IOS) || defined(RPI)
  87. maxFps_(60),
  88. maxInactiveFps_(10),
  89. pauseMinimized_(true),
  90. #else
  91. maxFps_(200),
  92. maxInactiveFps_(60),
  93. pauseMinimized_(false),
  94. #endif
  95. #ifdef URHO3D_TESTING
  96. timeOut_(0),
  97. #endif
  98. autoExit_(true),
  99. initialized_(false),
  100. exiting_(false),
  101. headless_(false),
  102. audioPaused_(false)
  103. {
  104. // Register self as a subsystem
  105. context_->RegisterSubsystem(this);
  106. // Create subsystems which do not depend on engine initialization or startup parameters
  107. context_->RegisterSubsystem(new Time(context_));
  108. context_->RegisterSubsystem(new WorkQueue(context_));
  109. #ifdef URHO3D_PROFILING
  110. context_->RegisterSubsystem(new Profiler(context_));
  111. #endif
  112. context_->RegisterSubsystem(new FileSystem(context_));
  113. #ifdef URHO3D_LOGGING
  114. context_->RegisterSubsystem(new Log(context_));
  115. #endif
  116. context_->RegisterSubsystem(new ResourceCache(context_));
  117. context_->RegisterSubsystem(new Localization(context_));
  118. #ifdef URHO3D_NETWORK
  119. context_->RegisterSubsystem(new Network(context_));
  120. #endif
  121. #ifdef URHO3D_DATABASE
  122. context_->RegisterSubsystem(new Database(context_));
  123. #endif
  124. context_->RegisterSubsystem(new Input(context_));
  125. context_->RegisterSubsystem(new Audio(context_));
  126. context_->RegisterSubsystem(new UI(context_));
  127. // Register object factories for libraries which are not automatically registered along with subsystem creation
  128. RegisterSceneLibrary(context_);
  129. #ifdef URHO3D_PHYSICS
  130. RegisterPhysicsLibrary(context_);
  131. #endif
  132. #ifdef URHO3D_NAVIGATION
  133. RegisterNavigationLibrary(context_);
  134. #endif
  135. SubscribeToEvent(E_EXITREQUESTED, URHO3D_HANDLER(Engine, HandleExitRequested));
  136. }
  137. Engine::~Engine()
  138. {
  139. }
  140. bool Engine::Initialize(const VariantMap& parameters)
  141. {
  142. if (initialized_)
  143. return true;
  144. URHO3D_PROFILE(InitEngine);
  145. // Set headless mode
  146. headless_ = GetParameter(parameters, "Headless", false).GetBool();
  147. // Register the rest of the subsystems
  148. if (!headless_)
  149. {
  150. context_->RegisterSubsystem(new Graphics(context_));
  151. context_->RegisterSubsystem(new Renderer(context_));
  152. }
  153. else
  154. {
  155. // Register graphics library objects explicitly in headless mode to allow them to work without using actual GPU resources
  156. RegisterGraphicsLibrary(context_);
  157. }
  158. #ifdef URHO3D_URHO2D
  159. // 2D graphics library is dependent on 3D graphics library
  160. RegisterUrho2DLibrary(context_);
  161. #endif
  162. // Start logging
  163. Log* log = GetSubsystem<Log>();
  164. if (log)
  165. {
  166. if (HasParameter(parameters, "LogLevel"))
  167. log->SetLevel(GetParameter(parameters, "LogLevel").GetInt());
  168. log->SetQuiet(GetParameter(parameters, "LogQuiet", false).GetBool());
  169. log->Open(GetParameter(parameters, "LogName", "Urho3D.log").GetString());
  170. }
  171. // Set maximally accurate low res timer
  172. GetSubsystem<Time>()->SetTimerPeriod(1);
  173. // Configure max FPS
  174. if (GetParameter(parameters, "FrameLimiter", true) == false)
  175. SetMaxFps(0);
  176. // Set amount of worker threads according to the available physical CPU cores. Using also hyperthreaded cores results in
  177. // unpredictable extra synchronization overhead. Also reserve one core for the main thread
  178. #ifdef URHO3D_THREADING
  179. unsigned numThreads = GetParameter(parameters, "WorkerThreads", true).GetBool() ? GetNumPhysicalCPUs() - 1 : 0;
  180. if (numThreads)
  181. {
  182. GetSubsystem<WorkQueue>()->CreateThreads(numThreads);
  183. URHO3D_LOGINFOF("Created %u worker thread%s", numThreads, numThreads > 1 ? "s" : "");
  184. }
  185. #endif
  186. // Add resource paths
  187. ResourceCache* cache = GetSubsystem<ResourceCache>();
  188. FileSystem* fileSystem = GetSubsystem<FileSystem>();
  189. Vector<String> resourcePrefixPaths = GetParameter(parameters, "ResourcePrefixPaths", String::EMPTY).GetString().Split(';', true);
  190. for (unsigned i = 0; i < resourcePrefixPaths.Size(); ++i)
  191. resourcePrefixPaths[i] = AddTrailingSlash(
  192. IsAbsolutePath(resourcePrefixPaths[i]) ? resourcePrefixPaths[i] : fileSystem->GetProgramDir() + resourcePrefixPaths[i]);
  193. Vector<String> resourcePaths = GetParameter(parameters, "ResourcePaths", "Data;CoreData").GetString().Split(';');
  194. Vector<String> resourcePackages = GetParameter(parameters, "ResourcePackages").GetString().Split(';');
  195. Vector<String> autoLoadPaths = GetParameter(parameters, "AutoloadPaths", "Autoload").GetString().Split(';');
  196. for (unsigned i = 0; i < resourcePaths.Size(); ++i)
  197. {
  198. // If path is not absolute, prefer to add it as a package if possible
  199. if (!IsAbsolutePath(resourcePaths[i]))
  200. {
  201. unsigned j = 0;
  202. for (; j < resourcePrefixPaths.Size(); ++j)
  203. {
  204. String packageName = resourcePrefixPaths[j] + resourcePaths[i] + ".pak";
  205. if (fileSystem->FileExists(packageName))
  206. {
  207. if (cache->AddPackageFile(packageName))
  208. break;
  209. else
  210. return false; // The root cause of the error should have already been logged
  211. }
  212. String pathName = resourcePrefixPaths[j] + resourcePaths[i];
  213. if (fileSystem->DirExists(pathName))
  214. {
  215. if (cache->AddResourceDir(pathName))
  216. break;
  217. else
  218. return false;
  219. }
  220. }
  221. if (j == resourcePrefixPaths.Size())
  222. {
  223. URHO3D_LOGERRORF(
  224. "Failed to add resource path '%s', check the documentation on how to set the 'resource prefix path'",
  225. resourcePaths[i].CString());
  226. return false;
  227. }
  228. }
  229. else
  230. {
  231. String pathName = resourcePaths[i];
  232. if (fileSystem->DirExists(pathName))
  233. if (!cache->AddResourceDir(pathName))
  234. return false;
  235. }
  236. }
  237. // Then add specified packages
  238. for (unsigned i = 0; i < resourcePackages.Size(); ++i)
  239. {
  240. unsigned j = 0;
  241. for (; j < resourcePrefixPaths.Size(); ++j)
  242. {
  243. String packageName = resourcePrefixPaths[j] + resourcePackages[i];
  244. if (fileSystem->FileExists(packageName))
  245. {
  246. if (cache->AddPackageFile(packageName))
  247. break;
  248. else
  249. return false;
  250. }
  251. }
  252. if (j == resourcePrefixPaths.Size())
  253. {
  254. URHO3D_LOGERRORF(
  255. "Failed to add resource package '%s', check the documentation on how to set the 'resource prefix path'",
  256. resourcePackages[i].CString());
  257. return false;
  258. }
  259. }
  260. // Add auto load folders. Prioritize these (if exist) before the default folders
  261. for (unsigned i = 0; i < autoLoadPaths.Size(); ++i)
  262. {
  263. bool autoLoadPathExist = false;
  264. for (unsigned j = 0; j < resourcePrefixPaths.Size(); ++j)
  265. {
  266. String autoLoadPath(autoLoadPaths[i]);
  267. if (!IsAbsolutePath(autoLoadPath))
  268. autoLoadPath = resourcePrefixPaths[j] + autoLoadPath;
  269. if (fileSystem->DirExists(autoLoadPath))
  270. {
  271. autoLoadPathExist = true;
  272. // Add all the subdirs (non-recursive) as resource directory
  273. Vector<String> subdirs;
  274. fileSystem->ScanDir(subdirs, autoLoadPath, "*", SCAN_DIRS, false);
  275. for (unsigned y = 0; y < subdirs.Size(); ++y)
  276. {
  277. String dir = subdirs[y];
  278. if (dir.StartsWith("."))
  279. continue;
  280. String autoResourceDir = autoLoadPath + "/" + dir;
  281. if (!cache->AddResourceDir(autoResourceDir, 0))
  282. return false;
  283. }
  284. // Add all the found package files (non-recursive)
  285. Vector<String> paks;
  286. fileSystem->ScanDir(paks, autoLoadPath, "*.pak", SCAN_FILES, false);
  287. for (unsigned y = 0; y < paks.Size(); ++y)
  288. {
  289. String pak = paks[y];
  290. if (pak.StartsWith("."))
  291. continue;
  292. String autoPackageName = autoLoadPath + "/" + pak;
  293. if (!cache->AddPackageFile(autoPackageName, 0))
  294. return false;
  295. }
  296. }
  297. }
  298. // The following debug message is confusing when user is not aware of the autoload feature
  299. // Especially because the autoload feature is enabled by default without user intervention
  300. // The following extra conditional check below is to suppress unnecessary debug log entry under such default situation
  301. // The cleaner approach is to not enable the autoload by default, i.e. do not use 'Autoload' as default value for 'AutoloadPaths' engine parameter
  302. // However, doing so will break the existing applications that rely on this
  303. if (!autoLoadPathExist && (autoLoadPaths.Size() > 1 || autoLoadPaths[0] != "Autoload"))
  304. URHO3D_LOGDEBUGF(
  305. "Skipped autoload path '%s' as it does not exist, check the documentation on how to set the 'resource prefix path'",
  306. autoLoadPaths[i].CString());
  307. }
  308. // Initialize graphics & audio output
  309. if (!headless_)
  310. {
  311. Graphics* graphics = GetSubsystem<Graphics>();
  312. Renderer* renderer = GetSubsystem<Renderer>();
  313. if (HasParameter(parameters, "ExternalWindow"))
  314. graphics->SetExternalWindow(GetParameter(parameters, "ExternalWindow").GetVoidPtr());
  315. graphics->SetWindowTitle(GetParameter(parameters, "WindowTitle", "Urho3D").GetString());
  316. graphics->SetWindowIcon(cache->GetResource<Image>(GetParameter(parameters, "WindowIcon", String::EMPTY).GetString()));
  317. graphics->SetFlushGPU(GetParameter(parameters, "FlushGPU", false).GetBool());
  318. graphics->SetOrientations(GetParameter(parameters, "Orientations", "LandscapeLeft LandscapeRight").GetString());
  319. if (HasParameter(parameters, "WindowPositionX") && HasParameter(parameters, "WindowPositionY"))
  320. graphics->SetWindowPosition(GetParameter(parameters, "WindowPositionX").GetInt(),
  321. GetParameter(parameters, "WindowPositionY").GetInt());
  322. #ifdef URHO3D_OPENGL
  323. if (HasParameter(parameters, "ForceGL2"))
  324. graphics->SetForceGL2(GetParameter(parameters, "ForceGL2").GetBool());
  325. #endif
  326. if (!graphics->SetMode(
  327. GetParameter(parameters, "WindowWidth", 0).GetInt(),
  328. GetParameter(parameters, "WindowHeight", 0).GetInt(),
  329. GetParameter(parameters, "FullScreen", true).GetBool(),
  330. GetParameter(parameters, "Borderless", false).GetBool(),
  331. GetParameter(parameters, "WindowResizable", false).GetBool(),
  332. GetParameter(parameters, "HighDPI", false).GetBool(),
  333. GetParameter(parameters, "VSync", false).GetBool(),
  334. GetParameter(parameters, "TripleBuffer", false).GetBool(),
  335. GetParameter(parameters, "MultiSample", 1).GetInt()
  336. ))
  337. return false;
  338. if (HasParameter(parameters, "DumpShaders"))
  339. graphics->BeginDumpShaders(GetParameter(parameters, "DumpShaders", String::EMPTY).GetString());
  340. if (HasParameter(parameters, "RenderPath"))
  341. renderer->SetDefaultRenderPath(cache->GetResource<XMLFile>(GetParameter(parameters, "RenderPath").GetString()));
  342. renderer->SetDrawShadows(GetParameter(parameters, "Shadows", true).GetBool());
  343. if (renderer->GetDrawShadows() && GetParameter(parameters, "LowQualityShadows", false).GetBool())
  344. renderer->SetShadowQuality(SHADOWQUALITY_SIMPLE_16BIT);
  345. renderer->SetMaterialQuality(GetParameter(parameters, "MaterialQuality", QUALITY_HIGH).GetInt());
  346. renderer->SetTextureQuality(GetParameter(parameters, "TextureQuality", QUALITY_HIGH).GetInt());
  347. renderer->SetTextureFilterMode((TextureFilterMode)GetParameter(parameters, "TextureFilterMode", FILTER_TRILINEAR).GetInt());
  348. renderer->SetTextureAnisotropy(GetParameter(parameters, "TextureAnisotropy", 4).GetInt());
  349. if (GetParameter(parameters, "Sound", true).GetBool())
  350. {
  351. GetSubsystem<Audio>()->SetMode(
  352. GetParameter(parameters, "SoundBuffer", 100).GetInt(),
  353. GetParameter(parameters, "SoundMixRate", 44100).GetInt(),
  354. GetParameter(parameters, "SoundStereo", true).GetBool(),
  355. GetParameter(parameters, "SoundInterpolation", true).GetBool()
  356. );
  357. }
  358. }
  359. // Init FPU state of main thread
  360. InitFPU();
  361. // Initialize input
  362. if (HasParameter(parameters, "TouchEmulation"))
  363. GetSubsystem<Input>()->SetTouchEmulation(GetParameter(parameters, "TouchEmulation").GetBool());
  364. #ifdef URHO3D_TESTING
  365. if (HasParameter(parameters, "TimeOut"))
  366. timeOut_ = GetParameter(parameters, "TimeOut", 0).GetInt() * 1000000LL;
  367. #endif
  368. // In debug mode, check now that all factory created objects can be created without crashing
  369. #ifdef _DEBUG
  370. if (!resourcePaths.Empty())
  371. {
  372. const HashMap<StringHash, SharedPtr<ObjectFactory> >& factories = context_->GetObjectFactories();
  373. for (HashMap<StringHash, SharedPtr<ObjectFactory> >::ConstIterator i = factories.Begin(); i != factories.End(); ++i)
  374. SharedPtr<Object> object = i->second_->CreateObject();
  375. }
  376. #endif
  377. #ifdef URHO3D_PROFILING
  378. if (GetParameter(parameters, "EventProfiler", true).GetBool())
  379. {
  380. context_->RegisterSubsystem(new EventProfiler(context_));
  381. EventProfiler::SetActive(true);
  382. }
  383. #endif
  384. frameTimer_.Reset();
  385. URHO3D_LOGINFO("Initialized engine");
  386. initialized_ = true;
  387. return true;
  388. }
  389. void Engine::RunFrame()
  390. {
  391. assert(initialized_);
  392. // If not headless, and the graphics subsystem no longer has a window open, assume we should exit
  393. if (!headless_ && !GetSubsystem<Graphics>()->IsInitialized())
  394. exiting_ = true;
  395. if (exiting_)
  396. return;
  397. // Note: there is a minimal performance cost to looking up subsystems (uses a hashmap); if they would be looked up several
  398. // times per frame it would be better to cache the pointers
  399. Time* time = GetSubsystem<Time>();
  400. Input* input = GetSubsystem<Input>();
  401. Audio* audio = GetSubsystem<Audio>();
  402. #ifdef URHO3D_PROFILING
  403. if (EventProfiler::IsActive())
  404. {
  405. EventProfiler* eventProfiler = GetSubsystem<EventProfiler>();
  406. if (eventProfiler)
  407. eventProfiler->BeginFrame();
  408. }
  409. #endif
  410. time->BeginFrame(timeStep_);
  411. // If pause when minimized -mode is in use, stop updates and audio as necessary
  412. if (pauseMinimized_ && input->IsMinimized())
  413. {
  414. if (audio->IsPlaying())
  415. {
  416. audio->Stop();
  417. audioPaused_ = true;
  418. }
  419. }
  420. else
  421. {
  422. // Only unpause when it was paused by the engine
  423. if (audioPaused_)
  424. {
  425. audio->Play();
  426. audioPaused_ = false;
  427. }
  428. Update();
  429. }
  430. Render();
  431. ApplyFrameLimit();
  432. time->EndFrame();
  433. }
  434. Console* Engine::CreateConsole()
  435. {
  436. if (headless_ || !initialized_)
  437. return 0;
  438. // Return existing console if possible
  439. Console* console = GetSubsystem<Console>();
  440. if (!console)
  441. {
  442. console = new Console(context_);
  443. context_->RegisterSubsystem(console);
  444. }
  445. return console;
  446. }
  447. DebugHud* Engine::CreateDebugHud()
  448. {
  449. if (headless_ || !initialized_)
  450. return 0;
  451. // Return existing debug HUD if possible
  452. DebugHud* debugHud = GetSubsystem<DebugHud>();
  453. if (!debugHud)
  454. {
  455. debugHud = new DebugHud(context_);
  456. context_->RegisterSubsystem(debugHud);
  457. }
  458. return debugHud;
  459. }
  460. void Engine::SetTimeStepSmoothing(int frames)
  461. {
  462. timeStepSmoothing_ = (unsigned)Clamp(frames, 1, 20);
  463. }
  464. void Engine::SetMinFps(int fps)
  465. {
  466. minFps_ = (unsigned)Max(fps, 0);
  467. }
  468. void Engine::SetMaxFps(int fps)
  469. {
  470. maxFps_ = (unsigned)Max(fps, 0);
  471. }
  472. void Engine::SetMaxInactiveFps(int fps)
  473. {
  474. maxInactiveFps_ = (unsigned)Max(fps, 0);
  475. }
  476. void Engine::SetPauseMinimized(bool enable)
  477. {
  478. pauseMinimized_ = enable;
  479. }
  480. void Engine::SetAutoExit(bool enable)
  481. {
  482. // On mobile platforms exit is mandatory if requested by the platform itself and should not be attempted to be disabled
  483. #if defined(ANDROID) || defined(IOS)
  484. enable = true;
  485. #endif
  486. autoExit_ = enable;
  487. }
  488. void Engine::SetNextTimeStep(float seconds)
  489. {
  490. timeStep_ = Max(seconds, 0.0f);
  491. }
  492. void Engine::Exit()
  493. {
  494. #if defined(IOS)
  495. // On iOS it's not legal for the application to exit on its own, instead it will be minimized with the home key
  496. #else
  497. DoExit();
  498. #endif
  499. }
  500. void Engine::DumpProfiler()
  501. {
  502. Profiler* profiler = GetSubsystem<Profiler>();
  503. if (profiler)
  504. URHO3D_LOGRAW(profiler->PrintData(true, true) + "\n");
  505. }
  506. void Engine::DumpResources(bool dumpFileName)
  507. {
  508. #ifdef URHO3D_LOGGING
  509. ResourceCache* cache = GetSubsystem<ResourceCache>();
  510. const HashMap<StringHash, ResourceGroup>& resourceGroups = cache->GetAllResources();
  511. URHO3D_LOGRAW("\n");
  512. if (dumpFileName)
  513. {
  514. URHO3D_LOGRAW("Used resources:\n");
  515. for (HashMap<StringHash, ResourceGroup>::ConstIterator i = resourceGroups.Begin();
  516. i != resourceGroups.End(); ++i)
  517. {
  518. const HashMap<StringHash, SharedPtr<Resource> >& resources = i->second_.resources_;
  519. if (dumpFileName)
  520. {
  521. for (HashMap<StringHash, SharedPtr<Resource> >::ConstIterator j = resources.Begin();
  522. j != resources.End(); ++j)
  523. URHO3D_LOGRAW(j->second_->GetName() + "\n");
  524. }
  525. }
  526. }
  527. else
  528. URHO3D_LOGRAW(cache->PrintMemoryUsage());
  529. #endif
  530. }
  531. void Engine::DumpMemory()
  532. {
  533. #ifdef URHO3D_LOGGING
  534. #if defined(_MSC_VER) && defined(_DEBUG)
  535. _CrtMemState state;
  536. _CrtMemCheckpoint(&state);
  537. _CrtMemBlockHeader* block = state.pBlockHeader;
  538. unsigned total = 0;
  539. unsigned blocks = 0;
  540. for (;;)
  541. {
  542. if (block && block->pBlockHeaderNext)
  543. block = block->pBlockHeaderNext;
  544. else
  545. break;
  546. }
  547. while (block)
  548. {
  549. if (block->nBlockUse > 0)
  550. {
  551. if (block->szFileName)
  552. URHO3D_LOGRAW("Block " + String((int)block->lRequest) + ": " + String(block->nDataSize) + " bytes, file " + String(block->szFileName) + " line " + String(block->nLine) + "\n");
  553. else
  554. URHO3D_LOGRAW("Block " + String((int)block->lRequest) + ": " + String(block->nDataSize) + " bytes\n");
  555. total += block->nDataSize;
  556. ++blocks;
  557. }
  558. block = block->pBlockHeaderPrev;
  559. }
  560. URHO3D_LOGRAW("Total allocated memory " + String(total) + " bytes in " + String(blocks) + " blocks\n\n");
  561. #else
  562. URHO3D_LOGRAW("DumpMemory() supported on MSVC debug mode only\n\n");
  563. #endif
  564. #endif
  565. }
  566. void Engine::Update()
  567. {
  568. URHO3D_PROFILE(Update);
  569. // Logic update event
  570. using namespace Update;
  571. VariantMap& eventData = GetEventDataMap();
  572. eventData[P_TIMESTEP] = timeStep_;
  573. SendEvent(E_UPDATE, eventData);
  574. // Logic post-update event
  575. SendEvent(E_POSTUPDATE, eventData);
  576. // Rendering update event
  577. SendEvent(E_RENDERUPDATE, eventData);
  578. // Post-render update event
  579. SendEvent(E_POSTRENDERUPDATE, eventData);
  580. }
  581. void Engine::Render()
  582. {
  583. if (headless_)
  584. return;
  585. URHO3D_PROFILE(Render);
  586. // If device is lost, BeginFrame will fail and we skip rendering
  587. Graphics* graphics = GetSubsystem<Graphics>();
  588. if (!graphics->BeginFrame())
  589. return;
  590. GetSubsystem<Renderer>()->Render();
  591. GetSubsystem<UI>()->Render();
  592. graphics->EndFrame();
  593. }
  594. void Engine::ApplyFrameLimit()
  595. {
  596. if (!initialized_)
  597. return;
  598. unsigned maxFps = maxFps_;
  599. Input* input = GetSubsystem<Input>();
  600. if (input && !input->HasFocus())
  601. maxFps = Min(maxInactiveFps_, maxFps);
  602. long long elapsed = 0;
  603. #ifndef __EMSCRIPTEN__
  604. // Perform waiting loop if maximum FPS set
  605. if (maxFps)
  606. {
  607. URHO3D_PROFILE(ApplyFrameLimit);
  608. long long targetMax = 1000000LL / maxFps;
  609. for (;;)
  610. {
  611. elapsed = frameTimer_.GetUSec(false);
  612. if (elapsed >= targetMax)
  613. break;
  614. // Sleep if 1 ms or more off the frame limiting goal
  615. if (targetMax - elapsed >= 1000LL)
  616. {
  617. unsigned sleepTime = (unsigned)((targetMax - elapsed) / 1000LL);
  618. Time::Sleep(sleepTime);
  619. }
  620. }
  621. }
  622. #endif
  623. elapsed = frameTimer_.GetUSec(true);
  624. #ifdef URHO3D_TESTING
  625. if (timeOut_ > 0)
  626. {
  627. timeOut_ -= elapsed;
  628. if (timeOut_ <= 0)
  629. Exit();
  630. }
  631. #endif
  632. // If FPS lower than minimum, clamp elapsed time
  633. if (minFps_)
  634. {
  635. long long targetMin = 1000000LL / minFps_;
  636. if (elapsed > targetMin)
  637. elapsed = targetMin;
  638. }
  639. // Perform timestep smoothing
  640. timeStep_ = 0.0f;
  641. lastTimeSteps_.Push(elapsed / 1000000.0f);
  642. if (lastTimeSteps_.Size() > timeStepSmoothing_)
  643. {
  644. // If the smoothing configuration was changed, ensure correct amount of samples
  645. lastTimeSteps_.Erase(0, lastTimeSteps_.Size() - timeStepSmoothing_);
  646. for (unsigned i = 0; i < lastTimeSteps_.Size(); ++i)
  647. timeStep_ += lastTimeSteps_[i];
  648. timeStep_ /= lastTimeSteps_.Size();
  649. }
  650. else
  651. timeStep_ = lastTimeSteps_.Back();
  652. }
  653. VariantMap Engine::ParseParameters(const Vector<String>& arguments)
  654. {
  655. VariantMap ret;
  656. // Pre-initialize the parameters with environment variable values when they are set
  657. if (const char* paths = getenv("URHO3D_PREFIX_PATH"))
  658. ret["ResourcePrefixPaths"] = paths;
  659. for (unsigned i = 0; i < arguments.Size(); ++i)
  660. {
  661. if (arguments[i].Length() > 1 && arguments[i][0] == '-')
  662. {
  663. String argument = arguments[i].Substring(1).ToLower();
  664. String value = i + 1 < arguments.Size() ? arguments[i + 1] : String::EMPTY;
  665. if (argument == "headless")
  666. ret["Headless"] = true;
  667. else if (argument == "nolimit")
  668. ret["FrameLimiter"] = false;
  669. else if (argument == "flushgpu")
  670. ret["FlushGPU"] = true;
  671. else if (argument == "gl2")
  672. ret["ForceGL2"] = true;
  673. else if (argument == "landscape")
  674. ret["Orientations"] = "LandscapeLeft LandscapeRight " + ret["Orientations"].GetString();
  675. else if (argument == "portrait")
  676. ret["Orientations"] = "Portrait PortraitUpsideDown " + ret["Orientations"].GetString();
  677. else if (argument == "nosound")
  678. ret["Sound"] = false;
  679. else if (argument == "noip")
  680. ret["SoundInterpolation"] = false;
  681. else if (argument == "mono")
  682. ret["SoundStereo"] = false;
  683. else if (argument == "prepass")
  684. ret["RenderPath"] = "RenderPaths/Prepass.xml";
  685. else if (argument == "deferred")
  686. ret["RenderPath"] = "RenderPaths/Deferred.xml";
  687. else if (argument == "renderpath" && !value.Empty())
  688. {
  689. ret["RenderPath"] = value;
  690. ++i;
  691. }
  692. else if (argument == "noshadows")
  693. ret["Shadows"] = false;
  694. else if (argument == "lqshadows")
  695. ret["LowQualityShadows"] = true;
  696. else if (argument == "nothreads")
  697. ret["WorkerThreads"] = false;
  698. else if (argument == "v")
  699. ret["VSync"] = true;
  700. else if (argument == "t")
  701. ret["TripleBuffer"] = true;
  702. else if (argument == "w")
  703. ret["FullScreen"] = false;
  704. else if (argument == "borderless")
  705. ret["Borderless"] = true;
  706. else if (argument == "s")
  707. ret["WindowResizable"] = true;
  708. else if (argument == "hd")
  709. ret["HighDPI"] = true;
  710. else if (argument == "q")
  711. ret["LogQuiet"] = true;
  712. else if (argument == "log" && !value.Empty())
  713. {
  714. unsigned logLevel = GetStringListIndex(value.CString(), logLevelPrefixes, M_MAX_UNSIGNED);
  715. if (logLevel != M_MAX_UNSIGNED)
  716. {
  717. ret["LogLevel"] = logLevel;
  718. ++i;
  719. }
  720. }
  721. else if (argument == "x" && !value.Empty())
  722. {
  723. ret["WindowWidth"] = ToInt(value);
  724. ++i;
  725. }
  726. else if (argument == "y" && !value.Empty())
  727. {
  728. ret["WindowHeight"] = ToInt(value);
  729. ++i;
  730. }
  731. else if (argument == "m" && !value.Empty())
  732. {
  733. ret["MultiSample"] = ToInt(value);
  734. ++i;
  735. }
  736. else if (argument == "b" && !value.Empty())
  737. {
  738. ret["SoundBuffer"] = ToInt(value);
  739. ++i;
  740. }
  741. else if (argument == "r" && !value.Empty())
  742. {
  743. ret["SoundMixRate"] = ToInt(value);
  744. ++i;
  745. }
  746. else if (argument == "pp" && !value.Empty())
  747. {
  748. ret["ResourcePrefixPaths"] = value;
  749. ++i;
  750. }
  751. else if (argument == "p" && !value.Empty())
  752. {
  753. ret["ResourcePaths"] = value;
  754. ++i;
  755. }
  756. else if (argument == "pf" && !value.Empty())
  757. {
  758. ret["ResourcePackages"] = value;
  759. ++i;
  760. }
  761. else if (argument == "ap" && !value.Empty())
  762. {
  763. ret["AutoloadPaths"] = value;
  764. ++i;
  765. }
  766. else if (argument == "ds" && !value.Empty())
  767. {
  768. ret["DumpShaders"] = value;
  769. ++i;
  770. }
  771. else if (argument == "mq" && !value.Empty())
  772. {
  773. ret["MaterialQuality"] = ToInt(value);
  774. ++i;
  775. }
  776. else if (argument == "tq" && !value.Empty())
  777. {
  778. ret["TextureQuality"] = ToInt(value);
  779. ++i;
  780. }
  781. else if (argument == "tf" && !value.Empty())
  782. {
  783. ret["TextureFilterMode"] = ToInt(value);
  784. ++i;
  785. }
  786. else if (argument == "af" && !value.Empty())
  787. {
  788. ret["TextureFilterMode"] = FILTER_ANISOTROPIC;
  789. ret["TextureAnisotropy"] = ToInt(value);
  790. ++i;
  791. }
  792. else if (argument == "touch")
  793. ret["TouchEmulation"] = true;
  794. #ifdef URHO3D_TESTING
  795. else if (argument == "timeout" && !value.Empty())
  796. {
  797. ret["TimeOut"] = ToInt(value);
  798. ++i;
  799. }
  800. #endif
  801. }
  802. }
  803. return ret;
  804. }
  805. bool Engine::HasParameter(const VariantMap& parameters, const String& parameter)
  806. {
  807. StringHash nameHash(parameter);
  808. return parameters.Find(nameHash) != parameters.End();
  809. }
  810. const Variant& Engine::GetParameter(const VariantMap& parameters, const String& parameter, const Variant& defaultValue)
  811. {
  812. StringHash nameHash(parameter);
  813. VariantMap::ConstIterator i = parameters.Find(nameHash);
  814. return i != parameters.End() ? i->second_ : defaultValue;
  815. }
  816. void Engine::HandleExitRequested(StringHash eventType, VariantMap& eventData)
  817. {
  818. if (autoExit_)
  819. {
  820. // Do not call Exit() here, as it contains mobile platform -specific tests to not exit.
  821. // If we do receive an exit request from the system on those platforms, we must comply
  822. DoExit();
  823. }
  824. }
  825. void Engine::DoExit()
  826. {
  827. Graphics* graphics = GetSubsystem<Graphics>();
  828. if (graphics)
  829. graphics->Close();
  830. exiting_ = true;
  831. #if defined(__EMSCRIPTEN__) && defined(URHO3D_TESTING)
  832. emscripten_force_exit(EXIT_SUCCESS); // Some how this is required to signal emrun to stop
  833. #endif
  834. }
  835. }