CyberEngineMkIII
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 123456]
\NCYBEncapsulates the engine in it's entirety
 oNAPINamespace containing the public API define EXPLICIT_API_USAGE to prevent automatic 'using'
 |oNContainerContains usings of STL contianer types
 |oNInteropDefines interop classes that should not be used individually
 ||oCAllocatableDefines the base class for allocatable engine objects
 ||oCAllocatorUsed for allocating objects within and without the engine
 ||oCConstructorTemplate for defining the types of parameters for engine object constructors with multiple arguments
 ||oCConstructor< void >Used as a base class by all constructors
 ||oCConstructor< AType >Template for defining the types of parameters for engine object constructors
 ||oCNullConstructorUsed for object which aren't allocatables
 ||oCContextClass which is used as an API for the engine
 ||oCObjectTemplate type for wrapping pointers and treating them as objects. Only works with CyberEngine interface types
 ||\CSTLAllocatorRemaps STL style allocations to the CyberEngine Allocator. Based on std::allocator, usable on STL containers
 || \CrebindSee std::allocator::rebind
 |oNStringContains all string implementations
 ||oCCStyleA basic char contained string
 ||oCDynamicUsed for string of allocated variable length
 ||oCStaticA string pointing to unchanging data in the stack above it or the data segment. Must have UTF-8 encoding
 ||oCUTF8A variable length UTF-8 string
 ||\CUTF16UTF-16 String enabled only under windows
 |oCFileContains the basic File interface. Does not perform locking of any kind, be aware of possible race conditions. Note that reads and writes that fail should not be retried
 |oCMutexA fast locking, no order guaranteed, mutex
 |oCPathUsed for manipulating Paths. Paths will always exist either as a file or directory. Paths are '/' delimited when forming though may not be while retrieving. File names ".." will ascend a directory and '.' represents a no-op
 ||\CDirectoryEntryIterator for paths in a directory
 |oCSemaphoreA reliable wait queue
 |oCAssertContains assertion functions
 |oCEndianessStatic Endianess definitions
 |oCByteConvertersConverters from large byte types to smaller ones
 |oCPlatformStrong typing for Platform::Identifier
 |oCLockGuardA RAII locking mechanism
 |oCUniquePointerUniquePointer that uses our Allocator
 |oCCommandLineAn interface for running callbacks based on command line parameters
 |oCHeapAn interface which can allocate memory
 |oCLoggerThe interface for writing safe logs
 |oCStreamThe interface for streaming reads and writes
 |oCSafeStreamA Stream guaranteed to not throw exceptions
 |oCEngineInformationInfomation about the running engine version
 |oCParameterPackContains information about a template parameter pack
 ||\CIndexerA class which can be used to get the type at AIndex of the pack
 |oCSingletonA class for creating static singletons
 |oCThreadableThe basic multithreading interface
 |oCThreadableTasksetA mutlithreading interface with a number of jobs in mind
 |\CTypenameGets the typename of a type
 oNEngineEncapsulates platform agnostic engine functions
 |oNHelpersContains key engine helpers
 ||\CCommandLineCommand line string parser and manager
 || \CTokenA parsed command line token
 |oNMemoryA grouping of the Heap and its constituents
 ||oCBlockA unit of memory allocation
 ||oCHeapA memory pool manager and allocator
 ||\CLargeBlockUsed to identify the end of a Heap
 |oCCoreAn instance of this object is the entirety of the engine
 |oCParametersCompilation configuration variables
 |oCAllocatorImplements InteropAllocation for the public allocator
 |oCContextImplements the engine level functions for API::Interop::Contexts
 |oCPushContextContext switching RAII helper
 |\CLoggerThe threaded, queued engine logger
 | \CLogEntryLog entries to be inserted into the queue
 oNExceptionThe namespace containing engine exception classes
 |oCBaseThe base exception recognized by the entire engine
 |oCViolationExceptions indicating an API contract violation. Should not be anticipated
 |oCSystemDataExceptions caused by external call failures or invalid external data. Only classifies ones that can pass through the ABI
 |\CInternalExceptions that are thrown internally in the engine that the should never see, these are a superset of SystemData type exceptions. If one of these exceptions appear in a unit, please contant the engine development team
 \NPlatformNamespace containing engine Platform functions
  oNModulesContains functions for manipulating shared libraries
  |oNImplementationContains Platform specific module functions
  ||\CModuleContains the Module handle
  |oCAutoModuleOptionalHelpersAutoModule external helper for functions that rely on the state of AOptionalFunctions
  |oCAutoModuleAutomated intialization, function loading, and calling of module functions
  |oCModuleEncompasses a handle on loaded modules
  |oCAMFakeFake AutoModule used in place of other Platform's AutoModules
  |\CManagerEncapsulates the engine's loaded modules
  oNSystemContain basic OS operations
  |oNImplementationContains Platform specific OS functions
  ||oCFileThe file handle manager
  ||oCMutexContains the CRITICAL_SECTION struct
  ||oCPathAdds a UTF16 accompaniment to the UTF8 string of System::Path
  |||\CDirectoryEntryUses the FindFile API to enumerate directories
  ||oCProcessContains the Process handle and spawning function
  ||oCSemaphoreThe CS, CV pair handler
  ||oCSysUsed for Linked calls only
  ||oCThreadContains the thread handle and startup function
  ||\CVirtualMemoryVarious aligment functions
  |oCConsoleContains the basic File interface. Does not perform locking of any kind, be aware of possible race conditions
  |oCFileContains the basic File interface. Does not perform locking of any kind, be aware of possible race conditions
  |oCMutexA fast locking, no order guaranteed, mutex
  |oCPathUsed for manipulating Paths. Paths will always exist either as a file or directory. Paths are '/' delimited when forming though may not be while retrieving. File names ".." will ascend a directory and '.' represents a no-op
  |oCProcessAn object representing an operating system process
  |oCSemaphoreA reliable wait queue
  |oCSysContains the functionality for making asm syscalls and linked calls
  ||\CUnion64Used for passing arguments to calls to this class. If the call in question requires const, const_casting away constness for this intermediary is well defined
  |oCThreadDefinition of a platform thread object
  |\CVirtualMemoryAccess and abstraction to the basic OS memory functions
  \NWin32Includes headers for Windows platforms