Classes

Classes

List of all classes within the kernel library.

Classes
Class 
Description 
This is a File wrapper implementation that buffers all the I/O operations of the file it delegates to. 
Tracks the number of times a certain measured event took place. 
A File implementation that delegates all calls to the specified file pointer. This class can be used to create File wrappers that provide extra functionality. 
File 
A pure virtual base class for random access files. 
Contains various flags set for file and directory access. 
Base class for all formatters and can be used as a standalone object. 
Key 
Key code wrapper class. 
Describes the state of modifier keys (such as Shift,Ctrl, Caps lock) when used in keyboard handling. 
Used for storing location specific information. 
Log 
A base class interface that can be implemented to catch both debug and runtime messages. 
Wraps a message Id passed to the Log::LogMessageVarg
Maintains current heap and the global allocator, wrapping heap access functions. 
Memory file. 
The memory heap interface for allocations and supports creation of child heaps. 
Records memory allocation statistics for a particular allocation Id type. 
Provides thread-safe implementation of reference counting; used by default in most places. 
Holds the reference count (RefCount) value and defines a few utility functions shared by all implementations. 
Provides thread-safe implementation of reference counting with virtual AddRef and Release
Provides non-thread safe implementation of reference counting. 
Holds the non-thread-safe reference count (RefCount) value and defines a few utility functions shared by all implementations. 
Provides reference counting with WeakProxy support, allowing for WeakPtr<> to be used on objects derived from this class. 
Stat 
Base class for all of the statistics generated. Statistics are obtained for different subsystems such as Renderer, MovieDef etc. 
Represents a bag, or collection of statistics data. 
String is UTF-8 based string class with heap support. 
String buffer which is used to build strings. 
A dynamic heap version of String, which stores its memory heap in an internal pointer. 
A structure-local version of String, which determines its own memory heap (local heap) based on 'this' pointer location. 
Memory allocation interface that can be overridden to provide memory for GFx. 
Base class for SysAllocPaged and SysAlloc
An malloc version of SysAlloc interface. 
System allocator which uses posix functions - mmap(), mremap(), and munmap(). 
Default implementation of SysAllocPaged interface and is a system allocator that works entirely in a single large block of memory. 
An abstract interface used to provide allocations to page based MemoryHeapPT memory system; users can implement it to delegate allocations to their own memory allocator. 
An malloc version of SysAllocPaged interface which uses standard library functions such as memalign() and free(). 
Default system specific implementation of SysAllocPaged interface that makes use of VirtualAlloc/VirtualFree and is suited for the Windows and Xbox 360 platforms. 
Core Initialization class which must take place before any other Kernel objects are used. 
A system file class that is used to read or write file system files directly. 
Records the number of nano-second ticks used for a certain measured activity, such as rendering or tessellation. 
Helper for making objects that can have weak pointers. 
Used to store string buffer of wchar_t. This class is used when a variable size Unicode character buffer is needed. 
Enumerations
Enumeration 
Description 
LogMessageId values used by Kernel
The idea of message channels is that they correspond to separate logs that can be displayed individually. Several message sub-types can, however, be generated within the same channel. End users may choose to ignore the recommended channel structure and either combine all of the messages (default output), or separate them further into individual logs. 
Describes the severity of log messages and automatic prefix/suffix that should be given to it. 
Templates
Template 
Description 
Dynamic-heap allocator which allocates memory for containers created on the stack, or anywhere else, where the heap pointer is explicitly specified. 
Global allocator interface which allocates memory for items coming from GlobalHeap. 
Local allocator which acts as an interface for memory allocations and allocates memory for containers that are part of other data structures. 
Ptr 
A template reference-counted smart pointer class that automatically calls AddRef and Release functions of its object. 
Base class for classes that require thread-safe reference counting; also overrides the new and delete operators to use MemoryHeap. (Default class.) 
Base class for classes that require non-thread-safe reference counting; overrides the new and delete operators to use MemoryHeap
Same as RefCountBase but with virtual AddRef and Release. 
A common class that adds new/delete override with statistics tracking to the reference counting implementation. 
Base class for classes that require non-thread-safe reference counting and WeakPtr<> support; overrides the new and delete operators to use MemoryHeap
A weak pointer points at an object, but the object may be deleted at any time, in which case the weak pointer automatically becomes NULL. The only way to use a weak pointer is by converting it to a strong pointer (i.e. for temporary use). 
Structures
Structure 
Description 
Provides debugging support for allocations in memory heaps. 
File statistics, provides information about file modified time and accessed time.