File List

Here is a list of all documented files with brief descriptions:

[detail level 12345]

Engine
API
Allocatables
Allocatables.hpp	Includes engine allocatable types
File.hpp	Defines the API for files
Mutex.hpp	Defines the API for Mutexes
Path.hpp	Defines the API for Paths
Semaphore.hpp	Contains the declaration of CYB::API::Semaphore
Declarations
Assert.hpp	Defines assertion functions and macros
Declarations.hpp	Includes the headers needed before anything else in the engine
Endianess.hpp	Ensures the engine/unit is being compiled on a little endian architecture
Expressions.hpp	Helpful constexprs
OSDeclaration.hpp	Defines the TARGET_OS_XXX macro for identifying the operating system the program is being compiled for
STL.hpp	Used for including c++ headers that contain language features, not library features
SystemChecks.hpp	Checks the platform that the engine and unit is being compiled on is appropriate
ExtendedTypes
ExtendedTypes.hpp	Includes headers that define types with certain dependancies
LockGuard.hpp	Defines the LockGuard class
UniquePointer.hpp	Defines the CYB extension of std::unique_ptr
Interfaces
CommandLine.hpp	Defines the CommandLine interface
Heap.hpp	Defines the Heap interface
Interfaces.hpp	Includes headers that define non-allocatable engine objects
Logger.hpp	Defines CYB::API::Logger
Stream.hpp	Defines CYB::API::Stream Interface
Interop
Allocatable.hpp	Defines CYB::API::Allocatable
Allocator.hpp	Defines CYB::API::Allocator
Constructor.hpp	Defines CYB::API::Interop::Constructor
Context.hpp	Defines CYB::API::Interop::Context
Interop.hpp	Includes files that contain classes required for communitcation between the engine and the unit
Object.hpp	Defines CYB::API::Interop::Object
STLAllocator.hpp	Defines CYB::API::STLAllocator
Types
String
CStyleString.hpp	Contains the definitions of a basic c string
DynamicString.hpp
StaticString.hpp	Contains the definitions of a basic string
Strings.hpp	Includes various string functions
UTF8String.hpp	Defines CYB::API::String::Dynamic
Containers.hpp	Aliasings of STL containers to use the correct allocator types
EngineInformation.hpp	Defines the CYB::API::EngineInformation class
Exception.hpp	Defines the exception classes of the engine
ParameterPack.hpp	Defines the template for working with parameter packed template arguments
Singleton.hpp	Defines the singleton template class
Threadable.hpp	The multithreading API used by the CyberEngine
ThreadableTaskset.hpp	Defines CYB::API::ThreadableTaskset
Typename.hpp	Defines the Typename template prototype
Types.hpp	Defines global level basic types
CyberEngine.hpp	Precompiled header for engine API
Engine
Core
CYBCore.cpp	Implements engine core
CYBCore.hpp	Defines the engine core interface and static pointer as well as the Engine() access function
CYBEngineParameters.cpp	Engine compilation configuration string variables
CYBEngineParameters.hpp	Engine compilation configuration variables
CYBException.cpp	Exception constructors of the non-unit kind
CYBInterop.cpp	Implements various engine interop functions
CYBInterop.hpp	Defines the implementations of virtual functions defined in CYB::API::Interop
CYBLogger.cpp	Implements CYB::Engine::Logger
CYBLogger.hpp	Defines CYB::Engine::Logger
Helpers
CYBCommandLine.cpp	Implements CYB::Engine::Helpers::CommandLine
CYBCommandLine.hpp	Contains the definition of CYB::Engine::Helpers::CommandLine
CYBHelpers.hpp	Contains all headers for core engine helpers
Memory
CYBBlock.cpp	Implements functions from CYB::Engine::Block
CYBBlock.hpp	Defines the Block class used by the Heap
CYBHeap.cpp	Implements functions from CYB::Engine::Heap
CYBHeap.hpp	Defines the Heap implementation
CYBLargeBlock.cpp	Implements functions from CYB::Engine::LargeBlock
CYBLargeBlock.hpp	Defines the LargeBlock class used by the Heap
CYBMemory.hpp	Contains all headers relating to memory
CYBEngine.hpp	Includes headers for platform agnostic engine functions
Platform
Modules
Win32
CYBWin32Module.cpp	Implements CYB::Platform::Modules::Module for Win32
CYBWin32Module.hpp	Defines CYB::Platform::Modules::Module for Win32
CYBWin32ModuleImplementation.hpp
CYBAutoModule.hpp	Defines the interface for creating templates that are modules as objects
CYBModule.cpp	Shared function implementations for CYB::Platform::Module
CYBModule.hpp	Defines the interface for loading module functions
CYBModuleDefinitions.hpp	Uses the module macros to define AutoModules that will be used by the engine
CYBModuleMacros.hpp	Defines the DEFINE_MODULE macro for easily adding modules
CYBModuleManager.hpp	Contains the declaration of CYB::Platform::Manager
CYBModules.hpp	Includes Module headers
System
Win32
CYBWin32Console.cpp	Implements CYB::Platform::System::Console's Log and Show for Win32
CYBWin32File.cpp	Implements CYB::Platform::System::File for Win32
CYBWin32File.hpp	Defines the Win32 implementation for CYB::Platform::System::File
CYBWin32Mutex.cpp	Implements CYB::Platform::System::Mutex for Win32
CYBWin32Mutex.hpp	Defines the Win32 implementation for CYB::Platform::System::Mutex
CYBWin32Path.cpp	Implements CYB::Platform::System::Path for Win32
CYBWin32Path.hpp	Defines the Win32 implementation for CYB::Platform::System::Path
CYBWin32Process.cpp
CYBWin32Process.hpp	Defines the Win32 implementation for CYB::Platform::System::Process
CYBWin32Semaphore.cpp	Implements CYB::Platform::System::Semaphore for Win32
CYBWin32Semaphore.hpp	Defines the Win32 implementation for CYB::Platform::System::File
CYBWin32Syscalls.cpp
CYBWin32Syscalls.hpp	Contains the Win32 Sys implementation
CYBWin32SystemImplementation.hpp	Include implementation headers of CYB::Platform::System for Win32
CYBWin32Thread.cpp
CYBWin32Thread.hpp	Implements CYB::Platform::System::Thread for Win32
CYBWin32VirtualMemory.cpp
CYBWin32VirtualMemory.hpp	Contains the Win32 VirtualMemory implementation
CYBConsole.cpp	Implements CYB::Platform::System::Console shared functions
CYBConsole.hpp	Defines the stdout interface
CYBFile.cpp	Implements CYB::Platform::System::File shared functions
CYBFile.hpp	Defines the filesystem interface
CYBMutex.hpp	Contains the definition for an process unique, fast thread safety mechanism
CYBPath.cpp	Implements CYB::Platform::System::Path shared functions
CYBPath.hpp	Defines the Path interface
CYBProcess.cpp	Shared function implementations for CYB::Platform::Process
CYBProcess.hpp	Defines the platform process interface
CYBSemaphore.cpp	Implements CYB::Platform::System::Semaphore logic and alogorithms
CYBSemaphore.hpp	Contains the declaration of CYB::Platform::System::Semaphore
CYBSyscalls.hpp	Defines the System Call interface
CYBSystem.hpp	Includes platform system headers
CYBThread.cpp	Shared function implementations for CYB::Platform::Thread
CYBThread.hpp	Contains the platform thread definition
CYBVirtualMemory.cpp	Implements shared functions of CYB::Platform::System::VirtualMemory
CYBVirtualMemory.hpp	Contains the platform memory manager functions
SystemHeaders
CYBSystemHeaders.hpp	Includes files which include Platform specific headers
CYBUTF16String.cpp	Implements the Win32 only UTF16 converter
CYBUTF16String.hpp	Defines the Win32 only UTF16 converter
CYBWin32Headers.hpp	Includes headers for Windows platforms
CYBPlatform.hpp	Includes platform headers
CYB.cpp	MSVC precompiled header compilation unit
CYB.hpp	Precompiled header for inter-engine operations
Executable
CYBEntry.cpp	The entry point to the program. Sole purpose is to call Main::Entry and return. Also contains exceptional functions that cannot be included in main library for testing purposes