SF_System.h

Go to the documentation of this file.

/*
 * Copyright 2016 Autodesk, Inc. All rights reserved.
 * Use of this software is subject to the terms of the Autodesk license agreement and any attachments or Appendices thereto provided at the time of installation or download,
 * or which otherwise accompanies this software in either electronic or hard copy form, or which is signed by you and accepted by Autodesk.
 */

#pragma once

#include "gwnavruntime/kernel/SF_Memory.h"

namespace Kaim
{

// ***** System Core Initialization class

// System initialization must take place before any other objects are used;
// this is done my calling System::Init(). Among other things, this is necessary to
// initialize the memory allocator. Similarly, System::Destroy must be
// called before program exist for proper cleanup. Both of these tasks can be achieved by
// simply creating System object first, allowing its constructor/destructor do the work.
class System
{
public:
    // Two default argument constructors, to allow specifying KY_SysAllocPaged with and without
    // HeapDesc for the root heap.
    System(SysAllocBase* psysAlloc = Kaim::SysAllocMalloc::InitSystemSingleton()) { Init(psysAlloc); }

    System(const MemoryHeap::HeapDesc& rootHeapDesc, SysAllocBase* sysAllocBase = Kaim::SysAllocMalloc::InitSystemSingleton()) { Init(rootHeapDesc, sysAllocBase); }

    ~System() { Destroy(); }

    // Initializes System core, setting the global heap that is needed for GFx
    // memory allocations. Users can override memory heap implementation by passing
    // a different memory heap here.
    static void Init(const MemoryHeap::HeapDesc& rootHeapDesc, SysAllocBase* sysAllocBase = Kaim::SysAllocMalloc::InitSystemSingleton());

    static void Init(SysAllocBase* sysAllocBase = Kaim::SysAllocMalloc::InitSystemSingleton()) { Init(MemoryHeap::RootHeapDesc(), sysAllocBase); }

    // De-initializes System more, finalizing the threading system and destroying
    // the global memory allocator.
    static void Destroy();
    static bool hasMemoryLeaks;
};
}