VoxelEngine
Singleton holding common settings and handling voxel processing tasks in background threads.
Singleton holding common settings and handling voxel processing tasks in background threads.
Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.
Properties1
SingletonProperty
public static VoxelEngineInstance Singleton { get; }Methods11
GetStatsReckfell.Collections.Dictionary
public static Reckfell.Collections.Dictionary GetStats();Gets debug information about shared voxel processing. The returned dictionary has the following structure:
{
"thread_pools": {
"general": {
"tasks": int,
"active_threads": int,
"thread_count": int,
"task_names": PackedStringArray
}
},
"tasks": {
"streaming": int,
"meshing": int,
"generation": int,
"main_thread": int,
"gpu": int
},
"memory_pools": {
"voxel_used": int,
"voxel_total": int,
"block_count": int,
"std_allocated": int,
"std_deallocated": int,
"std_current": int
}
}Reckfell.Collections.DictionaryGetThreadCountint
public static int GetThreadCount();Returns the number of threads currently used internally by the ThreadedTaskRunner.
intGetThreadedGraphicsResourceBuildingEnabledbool
public static bool GetThreadedGraphicsResourceBuildingEnabled();Tells if the voxel engine is able to create graphics resources from different threads. This will usually be true if the current renderer's thread model is safe or multi-threaded, but might also be false if the renderer would poorly benefit from this (such as legacy OpenGL).
boolGetVersionEditionstring
public static string GetVersionEdition();Tells the edition of the voxel engine, which is either of the following: module, extension
stringGetVersionGitHashstring
public static string GetVersionGitHash();Gets the Git hash that was used to compile the voxel engine.
stringGetVersionMajorint
public static int GetVersionMajor();Gets the major version number of the voxel engine. For example, in 1.2.0, 1 is the major version.
intGetVersionMinorint
public static int GetVersionMinor();Gets the minor version number of the voxel engine. For example, in 1.2.0, 2 is the minor version.
intGetVersionPatchint
public static int GetVersionPatch();Gets the patch version number of the voxel engine. For example, in 1.2.0, 0 is the patch version.
intGetVersionStatusstring
public static string GetVersionStatus();Gets the version status, which may be one of the following: dev, release
stringGetVersionVVector3I
public static Vector3I GetVersionV();Gets the major (x), minor (y) and patch (z) version numbers of the voxel engine as a single vector. May be useful for comparisons.
Vector3ISetThreadCountvoid
public static void SetThreadCount(int count);Sets the number of threads to be used internally by the ThreadedTaskRunner. Setting this can cause lagging, and it might take some time until the number of threads actually matches the given value.
| Name | Type | Default |
|---|---|---|
count | int | — |