reckfellENGINE

VoxelEngine

Singleton holding common settings and handling voxel processing tasks in background threads.

On this page
class VoxelEngineReckfellSharp

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
# Singleton
C#
public static VoxelEngineInstance Singleton { get; }

Methods11

GetStatsReckfell.Collections.Dictionary
# GetStats
C#
public static Reckfell.Collections.Dictionary GetStats();

Gets debug information about shared voxel processing. The returned dictionary has the following structure:

Text
{
    "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
    }
}
Returns Reckfell.Collections.Dictionary
GetThreadCountint
# GetThreadCount
C#
public static int GetThreadCount();

Returns the number of threads currently used internally by the ThreadedTaskRunner.

Returns int
GetThreadedGraphicsResourceBuildingEnabledbool
# GetThreadedGraphicsResourceBuildingEnabled
C#
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).

Returns bool
GetVersionEditionstring
# GetVersionEdition
C#
public static string GetVersionEdition();

Tells the edition of the voxel engine, which is either of the following: module, extension

Returns string
GetVersionGitHashstring
# GetVersionGitHash
C#
public static string GetVersionGitHash();

Gets the Git hash that was used to compile the voxel engine.

Returns string
GetVersionMajorint
# GetVersionMajor
C#
public static int GetVersionMajor();

Gets the major version number of the voxel engine. For example, in 1.2.0, 1 is the major version.

Returns int
GetVersionMinorint
# GetVersionMinor
C#
public static int GetVersionMinor();

Gets the minor version number of the voxel engine. For example, in 1.2.0, 2 is the minor version.

Returns int
GetVersionPatchint
# GetVersionPatch
C#
public static int GetVersionPatch();

Gets the patch version number of the voxel engine. For example, in 1.2.0, 0 is the patch version.

Returns int
GetVersionStatusstring
# GetVersionStatus
C#
public static string GetVersionStatus();

Gets the version status, which may be one of the following: dev, release

Returns string
GetVersionVVector3I
# GetVersionV
C#
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.

Returns Vector3I
SetThreadCountvoid
# SetThreadCount
C#
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.

Parameters
NameTypeDefault
countint—
Reckfell Engine documentationBack to top ↑
QUICK LINKSGetting startedEntity hierarchyC# & .NET 10Scenes and prefabs
Reckfell guides and full API K
reckfellENGINE
RECKFELL ACCOUNT

Sign in

Sign in to your Reckfell account.

One account for the entire Reckfell platform.