UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins
Content Creation
Materials
Unigine Material Library
Tutorials

Console

Represents standard input, output and error streams for the file loading, rendering system, audio and video systems, path-finding system, physics engine, file system and many others.

Can be opened in any UNIGINE-based application.

How to Open Console

A built-in console is called by pressing the grave accent (`) key, placed under the ESC key:

The console can be hidden by pressing the grave accent (`) key one more time. See how to assign another key here.

Console Operation

Console operation can be either command or variable:

  • Command is a directive to a console to perform a specific task.
  • Variable is an identifier that contains some stored value.

Command Syntax

Console command can take null, one or several arguments. The syntax is:

Source code
command_to_execute // null argument
command_to_execute argument // one argument
command_to_execute argument argument // two arguments

Hints

  • To see the current variable value, other acceptable values and short description, just type it and press the Enter key. For example, if you type the video_resizable variable, you get the following result:
    Source code
    video resizable toggle
    0 is non-resizable mode
    1 is resizable mode
    video_resizable = 1
    
  • To complete a command or variable name, just start typing first letters and press the TAB key until you get the required result.

How to Change the Console Opening Key

If you want to change the default grave accent (`) console turning on or off key, do one of the following actions:

  • Specify the console_command option and the console_key console command with ASCII-based key code in your CLI.
    For example, to assign the asterisk (*) key, type:
    Shell commands
    bin\main_x86d.exe -console_command "console_key 42"
    
  • Open the configuration file data/unigine.cfg and change the ASCII-based key code in the following line:
    Source code (XML)
    <item name="console_key" type="int">96</item>
    
  • Open the console and assign a new key via the console_command command.
    For example, to assign the (@) key, type:
    Source code
    Unigine~# console_command 64
    

Console

Basic operations on the console, command and variable.

NameDescriptionArguments
bind
  • Command. Bind a key to a command.

    For example, to bind the asterisk (*) key to the world_reload command, type:

    Source code
    Unigine~# bind * world_reload
    
1. A key to bind
2. A command to execute
clear
  • Command. Clear all messages from the console window.
console_key
  • Variable. Print the ASCII code of the current console turning on or off key.
  • Command. Assign a new key to turn on or off the console.
An ASCII code of the key
hide
  • Command. Hide the console.
ls
  • Command. Print a set of all available console keys, commands and variables.
show
  • Command. Show the console.
switch
  • Command. Switch among all variable values.
    Notice
    Make sure, that the variable is integer.

    For example, if you switch among the three render_hdr variable values, you get the following results:

    Source code
    render_hdr = 0 // disable HDR
    render_hdr = 1 // enable HDR using the standard algorithm
    render_hdr = 2 // enable HDR using the quadratic algorithm
    
A variable, which values will be switched
toggle
  • Command. Enable or disable a variable.
    Notice
    Enabled variable will have a default value.

    For example, if you toggle the render_hdr variable, you will get the following result:

    Source code
    render_hdr = 0 // disable HDR 
    render_hdr = 1 // enable HDR
    
A variable to be toggled
unbind
  • Command. Unbind a key from a command.
A key to unbind

Engine

Basic operations on the engine.

NameDescriptionArguments
console_command
  • Command. Print console commands passed as CLI arguments on the engine start-up.
    Notice
    If there are several commands, they are separated using the && sequence. If none are specified, console commands passed on the current run are printed.
engine_threaded
Notice
If these variables are enabled, multithreading is used.
0 - disabled
1 - enabled (by default)
extern_define
  • Variable. Print all used external #DEFINE directives.
  • Command. Specify an external #DEFINE directive. For example, to specify an external directive "TEST" with the value of 2, type:
    Source code
    extern_define "TEST=2"
    
    If you want to clear all defines, pass quotation marks ("") as an argument to this command.
    Notice
    If there are several commands, they are separated using the commas (without whitespace).
"DEFINE_NAME" - name of the directive
"DEFINE_NAME=VALUE" - name and value of the directive
extern_plugin
  • Variable. Print all loaded external plugins.
  • Command. Load an external plugin library.

    The library name should go without any prefixes and postfixes. For example, libNetwork_x86d.so should be passed as Network.

    Notice
    If there are several plugins, they are separated using the commas (without whitespace).
A name of the plugin
quit Quit the engine.

Engine Analyzer

Operations on the engine debugging.

NameDescriptionArguments
engine_analyze
  • Command. Analyze the performance of the engine. Can be used only in the single-threaded mode. The information can be printed to the console or dumped into a specified file.
A path to the logfile to dump the log file information into (optional)
Notice
Available only for debug builds.

World

Basic operations on world.

NameDescriptionArguments
world_load
  • Command. Load the specified world. A cache file can also be specified for faster application loading.
1. A name of the world to load (inside of the data directory)
2. A name of the world cache file (optional)
world_quit
  • Command. Clear all the world data.
world_save
  • Command. Save the world.
world_reload
  • Command. Reload the world. A cache file can also be specified to be reloaded.
A name of the world cache file (optional)
world_threaded
  • Variable. Print the thread mode used to update the world.
  • Command. Specify if the world will be updated in a single or multiple-threaded mode.
0 - single-threaded
1 - multiple-threaded (by default)

World State

Serialized operations on world.

NameDescriptionArguments
state_save
  • Command. Save states of all world nodes into the .save file and take a screenshot.
    Notice
    File is saved as quicksave.save in the /bin/save directory by default. You can pass another directory as an argument.
1. A path to the file (optional)
2. A noscreenshot flag - save a state without taking a screenshot (optional)
state_restore
  • Command. Restore states of all world nodes.
    Notice
    File is restored using quicksave.save file in the /bin/save directory by default. You can pass another directory as an argument.
A path to the file (optional)

World Analyzer

World Resources

Operations, representing information on ObjectGrass, ObjectMeshClutter and WorldClutter objects.

NameDescription
world_manager_info
  • Command. Print general information (the number of registered/loaded resources; used memory) on world manager resources, such as:
    1. ImageManaged - loaded images (if not fully loaded, a dummy texture or one-mipmap texture is used)
    2. SplineManaged - loaded splines
    3. ImageStream - streamed mask images
    4. MeshStream - streamed meshes used as an intersection mask for grass or clutters
world_manager_list
  • Command. Print the list of resources handled by the world manager (mask images for ObjectGrass and WorldClutter objects), if any.
Notice
To get information on loaded meshes and images, see the Render resources section.

World Script

Operations on the world script debugging.

NameDescriptionArguments
world_memory_usage
  • Command. Print memory usage by the world script to the console or dump into a specified file.
A path to a file to dump the information into (optional)
world_analyze
  • Command. Analyze the performance of the world script. Can be used only in the single-threaded mode. The information can be printed to the console or dumped into a specified file.
A path to the logfile to dump the log file information into (optional)
world_disassemble
  • Command. Disassemble the world script. The information can be printed to the console or dumped into a specified file.
A path to a file to dump the information into (optional)
Notice
Available only for debug builds.

World Queueing

Operations on the world queued nodes.

NameDescriptionArguments
world_queue
  • Command. Print names of all the queued nodes, if any.
world_delay
  • Variable. Print the current time delay between loading of the queued nodes in seconds.
  • Command. Set the time delay between loading of the queued nodes in seconds. For example, this function can be used to debug streaming of resources.
01
(0 by default)
world_clear
  • Command. Clear the queue and all of the loaded nodes.

Editor

Operations on UNIGINE Editor.

NameDescriptionArguments
editor_load
  • Command. Load the visual editor.
editor_quit
  • Command. Quit the visual editor.
editor_reload
  • Command. Reload the visual editor. This command reloads the editor script, all unsaved changes are lost.
editor_script A path to the editor script (relatively to the data directory)
editor_cache
  • Variable. Print the current editor script cache name.
  • Command. Set a new file name for the editor script cache.
A name of the editor script cache

Editor Analyzer

Debug operations on the editor script.

NameDescriptionArguments
editor_memory_usage
  • Command. Print memory usage by the editor script to the console or dump into a specified file.
A path to a file to dump the information into (optional)
editor_analyze
  • Command. Analyze the performance of the editor script. Can be used only in the single-threaded mode. The information can be printed to the console or dumped into a specified file.
A path to the file to dump the log file information into (optional)
editor_disassemble
  • Command. Disassemble the editor script. The information can be printed to the console or dumped into a specified file.
A path to file to dump the information into (optional)
Notice
Available only for debug builds.

File System

Operations on the File system.

NameDescriptionArguments
data_path
  • Variable. Print the current path to the data directory containing all resources.
  • Command. Set a new path to the data directory.
A path to the data directory (relatively to the binary executable)
extern_package
  • Variable. Print UNG or ZIP packages outside the data directory added to the file system.
  • Command. Add UNG or ZIP packages outside the data directory. It is needed to access resources by specifying a relative path to the file only inside the package. The path can be specified relatively to the binary executable or as an absolute path.
    Notice
    Several packages are comma separated (no whitespaces).
"../RELATIVE_PATH" - relative path
"ABSOLUTE_PATH" - absolute path
filesystem_reload
  • Command. Reload the file system, thereby update the list of files.
filesystem_clear
  • Command. Remove all the loaded, but unused resources.
filesystem_ignore
  • Variable. Print the list of ignored directories.
  • Command. Set the folders to be ignored within the data directory. It can be used to discard version control system folders. This option comes into effect only after the filesystem_reload command is run.
    Notice
    Multiple values are comma separated (no whitespaces).
A full directory name
filesystem_icase
  • Variable. Print the value indicating if the case of file names in the data directory is ignored.
  • Command. Ignore the case of file names in the data directory.
0 - checked (by default)
1 - ignored
filesystem_mmap
  • Variable. Print the value indicating if memory-mapped files are used.
  • Command. Use memory-mapped files for faster access.
0 - not used
1 - used (default)

File System Info

Operations, representing information on the File system.

NameDescriptionArguments
filesystem_info
  • Command. Print general file system information (the total number of files and files per package).
filesystem_list
  • Command. Print the list of all files.

File Queueing

Operations, representing information on the file loading queue.

NameDescriptionArguments
filesystem_queue
  • Command. Print names of the queued files, if any.
filesystem_delay
  • Variable. Print the current time delay between the loading of the queued files in seconds.
  • Command. Set the time delay between loading of the queued files in seconds. For example, this function can be used to debug streaming of resources.
01
(0 by default)
filesystem_data_memory
  • Variable. Print the current cache memory limit for queued data in Mbytes.
  • Command. Set the cache memory limit for queued data in Mbytes.
81024
(32 by default)
filesystem_files_memory
  • Variable. Print the current cache memory limit for queued files in Mbytes.
  • Command. Set the cache memory limit for queued files in Mbytes.
81024
(64 by default)
filesystem_images_memory
  • Variable. Print the current cache memory limit for queued images in Mbytes.
  • Command. Set the cache memory limit for queued images in Mbytes.
81024
(64 by default)

Memory Info

Operations, representing information on the system memory.

NameDescription
memory_dump
  • Command. Print information on the memory dump in form of the fragmentation map.
memory_info
  • Command. Print information on the memory usage:
    1. Heap usage - size of the heap memory
    2. Memory usage - size of the used system memory
    3. Allocations - number of allocations
memory_save
  • Command. Dump memory pools (useful for offline analysis).

GUI

Operations on the GUI and console style.

NameDescriptionArguments
gui_path
  • Variable. Print a current path to a GUI skin.
  • Command. Set a path to a GUI skin to be used.
A path to the GUI skin
(core/gui/ by default)
console_size
  • Variable. Print a current size of the console font.
  • Command. Set a size for the console font.
432
(16 by default)
console_font
  • Variable. Print a current path to a *.ttf file used as a console font.
  • Command. Set a path to a *.ttf file to be used as a console font.
A path to a *.ttf file
(core/gui/console.ttf by default)

Visualizer and Perfomance Profiler

Operations on the visualizer.

Notice
To debug the world and objects within it, the show_visualizer command should be set to 1.

NameDescriptionArguments
show_visualizer
  • Variable. Print the current visualizer mode.
  • Command. Specify if the visualizer geometry (bounding volumes, wireframe, physics bodies and shapes, etc.) is shown.
0 - visualizer is not shown (by default)
1 - visualizer is shown with a depth testing (to check if other objects in the scene do not occlude visualized geometry)
2 - visualizer is shown without a depth testing (visualized geometry is rendered in front of all objects in the scene)
show_fps
  • Variable. Print the value indicating if the FPS counter is hidden.
  • Command. Hide the FPS counter.
0 - hidden
1 - displayed (by default)
show_messages
  • Variable. Print the value indicating if the system messages are displayed in the viewport.
  • Command. Hide the system messages.
0 - hidden
1 - displayed (by default)
show_gpu
  • Variable. Print the value indicating if the GPUMonitor plugin information is displayed.
  • Command. Show/Hide the GPUMonitor plugin information.
0 - hidden
1 - displayed (by default)
Notice
This operation can be performed if the GPUMonitor plugin is enabled.
Notice
For more visualization settings, see Debug part in the Rendering Settings section below.

Performance Profiler

Operations on the Performance profiler.

NameDescriptionArguments
show_profiler
  • Variable. Print a mode set to Performance profiler.
  • Command. Specify a mode for Performance profiler.
0 - profiler information is hidden (by default)
1 - generic profiler information is shown
2 - rendering profiler information is shown
3 - physics profiler information is shown
4 - world profiler information is shown
5 - pathfinding and sound usage profiler information is shown
render_profiler 0 - disabled (by default)
1 - enabled

Profiler GUI

Operations on the Performance profiler style.

NameDescriptionArguments
profiler_size
  • Variable. Print a current size of the profiler font.
  • Command. Set a size for the profiler font.
432
(13 by default)
profiler_font
  • Variable. Print a current path to a *.ttf file used as a profiler font.
  • Command. Set a path to a *.ttf file to be used as a profiler font.
A path to a *.ttf file
(core/gui/font.ttf by default)

Screenshots

Operations on the screenshot.

NameDescriptionArguments
video_extension
  • Variable. Print the current screenshot format.
  • Command. Set a screenshot format.
0 - TGA (by default)
1 - DDS
2 - PNG
3 - JPG
video_grab
  • Command. Take a screenshot.
    Notice
    A screenshot is saved in the bin/screenshots directory by default. You can specify another directory.
A path to the folder the screenshots will be saved in (optional)

Debugger

Operations on the per-function breakpoint.

The syntax to set the breakpoint is the following:

Source code
 
system_breakpoint/world_breakpoint/editor_breakpoint set/remove function_name number_of_arguments

NameDescriptionArguments
system_breakpoint
  • Command. Set a breakpoint to the specified function in the system script.
1. Name of the function
2. The number of the arguments
world_breakpoint
  • Command. Set a breakpoint to the specified function in the world script.
1. Name of the function
2. The number of the arguments
editor_breakpoint
  • Command. Set a breakpoint to the specified function in the editor script.
1. Name of the function
2. The number of the arguments
Notice
Available only for debug builds.

General Settings

Configuration File

General operations on the engine configuration.

NameDescriptionArguments
config_load
  • Variable. Print the current path to the engine configuration file.
  • Command. Set a new path to the engine configuration file.
A path to the configuration file
(data/unigine.cfg by default)
config_save
  • Command. Save the engine configuration file.
A path to the configuration file (optional)

System Script

Operations on the system script.

NameDescriptionArguments
system_script
  • Variable. Print a path to the current system script.
  • Command. Set a path to a new system script.
A path to the system script (relatively to the data directory)
(core/unigine.cpp by default)
system_reload
  • Command. Restart the system script.
system_cache
  • Variable. Print a current file name of the system script cache.
  • Command. Set a new file name of the system script cache.
A name of the system script cache
(unigine.cache by default)

System Analyzer

Operations on the system script debugging.

NameDescriptionArguments
system_memory_usage
  • Command. Print memory usage by the system script to the console or dump into a specified file.
A path to a file to dump the information into (optional)
system_analyze
  • Command. Analyze the performance of the system script. Can be used only in the single-threaded mode. The information can be printed to the console or dumped into a specified file.
A path to the file to dump the log file information into (optional)
system_disassemble
  • Command. Disassemble the system script. The information can be printed to the console or dumped into a specified file.
A path to the file to dump the information into (optional)
Notice
Available only for debug builds.

CPU Info

Operations, representing information on the CPU.

NameDescription
cpu_info
  • Command. Print an information on the CPU and instruction sets supported by it.
cpu_frequency
  • Command. Print the CPU frequency in MHz.
cpu_count
  • Command. Print the number of available CPUs.

System Info

Operations, representing information on the system.

NameDescription
binary_info
  • Command. Print an information on the engine binary.
system_info
  • Command. Print an information on the operating system and the engine build version.
system_memory
  • Command. Print the system memory size in Mbytes.

Video Settings

Notice
To come to effect, the commands below require either video_restart or render_reload commands to be run after them.

NameDescription
video_restart
  • Command. Restart the video application to apply changes to video settings, if any.

GPU Info

Operations, representing information on the GPU.

NameDescription
gpu_info
  • Command. Print the video card and driver versions.
gpu_memory
  • Command. Print the video memory size in Mbytes.
gpu_count
  • Command. Print the number of available GPUs.

Resolution and Full Screen

Operations on the video resolution adjustment.

NameDescriptionArguments
video_mode
  • Variable. Print the current video resolution mode.
  • Command. Set a new video resolution mode.
-1 - video_width × video_height
0 - 640 × 360
1 - 960 × 540 (by default)
2 - 1024 × 576
3 - 1280 × 720
4 - 1366 × 768
5 - 1600 × 900
6 - 1920 × 1080
7 - 2560 × 1440
8 - 640 × 400
9 - 960 × 600
10 - 1024 × 640
11 - 1280 × 800
12 - 1440 × 900
13 - 1680 × 1050
14 - 1920 × 1200
15 - 2560 × 1600
16 - 640 × 480
17 - 800 × 600
18 - 1024 × 768
19 - 1280 × 960
20 - 1280 × 1024
21 - 1600 × 1200
22 - 2048 × 1536
video_width
  • Variable. Print the current screen width.
  • Command. Set the custom screen width.
Notice
Valid only if the video_mode command is set to -1.
010000
video_height
  • Variable. Print the current screen height.
  • Command. Set the custom screen height.
Notice
Valid only if the video_mode command is set to -1.
010000
video_resizable
  • Variable. Print the value indicating if the application window is resizable.
  • Command. Set a resizable mode for an application window (its size can be changed on the fly without restarting the application).
0 - non-resizable mode (by default)
1 - resizable mode
video_fullscreen
  • Variable. Print the value indicating if the application is running in full-screen mode.
  • Command. Set full-screen mode for the application window.
0 - windowed mode (by default)
1 - full-screen mode
2 - full-window mode when an application window is rendered without decorations

Graphics Settings

Operations on the graphics adjustment.

NameDescriptionArguments
video_app
  • Variable. Print the current graphics API used for rendering.
  • Command. Set a graphics API to be used for rendering:
    • Do not render anything onto the screen (for example, for servers, in case of playing on the network)
    • Automatically choose the best option from available ones
    • Use DirectX 9
    • Use DirectX 11
    • Use OpenGL

    For mobile SDK:
    • Use OpenGL ES
    • Use DirectX 11 renderer of DirectX 9 feature level. (Using this mode, you can check how applications are rendered on ARM mobile devices run with Windows RT. Shadows are not supported in this mode due to hardware limitations.)

    For SDK with PlayStation support:
    • Use PlayStation 3
"null" - no renderer
"auto" (by default) - automatically
"direct3d9" - DirectX 9
"direct3d11" - DirectX 11
"opengl" - OpenGL

"opengles" - OpenGL ES
"direct3d119" - DirectX 11 renderer of DirectX 9 feature level

"playstation3" - PlayStation 3
video_vsync
  • Variable. Print the value indicating if the vertical FPS synchronization is enabled.
  • Command. Set the vertical FPS synchronization.
0 - not to synchronize FPS (by default)
1 - synchronize FPS
video_refresh
  • Variable. Print the current graphics refresh rate.
  • Command. Set the graphics refresh rate.
0 (by default) – 200
video_gamma
  • Variable. Print the current gamma correction value.
  • Command. Set the gamma correction value.
0.53.5
(1.0 by default)

Anti-aliasing

Operations on the anti-aliasing adjustment.

NameDescriptionArguments
video_multisample
  • Variable. Print the current hardware anti-aliasing mode.
  • Command. Set the hardware anti-aliasing mode.
0 - no anti-aliasing (by default)
1 - 2× anti-aliasing
2 - 4× anti-aliasing
3 - 8× anti-aliasing
4 - 16× anti-aliasing
video_renderable
  • Variable. Print the value indicating if the hardware anti-aliasing is set for:
    1. GUI widgets
    2. Flash movie clips
    3. Mobile devices run with iOS
  • Command. Set the hardware anti-aliasing for objects listed above.
0 - disabled (by default)
1 - enabled

Rendering Settings

Operations on the renderer.

Notice
Many of the following options require the render_reload command to be run after them to take effect.

NameDescriptionArguments
render_reload
  • Command. Reload the renderer. This command reloads all shaders (but does not update shader variables). It can also be called, for example, for graphics API changes to come to effect.
render_restart
  • Command. Update shader variables. This command analyzes if any of render variables were changed. After that, it reloads required shaders and passes new variables for them or updates textures, depending on which action is necessary. For example, if alpha dithering for object LODs, parallax mapping or environment texture lighting is enabled, etc., a new variable should be registered with the shaders via this command for changes to take effect.
render_manager_reload
  • Command. Reload all render manager resources. You can specify an optional argument to reload resources selectively.
  • mesh - reload only meshes
  • texture - reload only textures

Renderer Resources

Operations, representing information on the renderer resources.

NameDescription
render_manager_info
  • Command. Print general information (the number of registered/loaded resources; memory used) on renderer manager resources:
    1. Mesh - loaded meshes
    2. MeshSkinned - skinned meshes
    3. MeshDynamic - dynamic meshes stored in the memory rather than on disk
    4. TextureManaged - images loaded into the memory; if image is not fully loaded, a dummy texture or a mipmap texture is used
    5. TextureStream - streamed images
render_manager_list
  • Command. Print the list of loaded resources and detailed information regarding:
    1. Meshes, MeshSkinned and MeshDynamic with used memory
    2. TextureManaged (textures loaded into memory at once) and TextureStream (textures streamed on demand) with texture format, used compression, if any, texture dimensions and size (available only for already loaded textures).

Renderer Buffers

Operations on the renderer buffers.

NameDescriptionArguments
render_use_rgb10a2
  • Variable. Print the current texture format used for the screen buffer.
  • Command. Use the RGB10A2 texture format for the screen buffer (it provides more color gradations). If disabled, the RGBA8 format will be used instead.
0 - RGBA8 format
1 - RGB10A2 format (by default)
render_use_d32f
  • Variable. Print the current precision type.
  • Command. Use the depth buffer of 32-bit floating point precision for DirectX 11 and OpenGL. (For example, for rendering more then 100 km within the visible range.)
0 - standard precision (24-bit for depth values and 8 for stencil)
1 - 32-bit floating point precision (by default)

Renderer Buffer Info

Operations, representing information on the renderer buffers.

NameDescription
render_info
  • Command. Print general information on render buffers:
    1. Renderer - GPU and available video memory
    2. Per-type information on buffers created by the renderer, their number and used space
    3. Total - how much video memory is used in whole
render_list
  • Command. Print the detailed list of render buffers, with texture size, format and used space.

Renderer Buffer Debugging

Operations on the renderer buffer debugging.

NameDescriptionArguments
render_show_textures
  • Variable. Print the current set of buffers used by the renderer.
  • Command. Specify a set of buffers used by the renderer (how many buffers are shown depends on the number of buffers in a row specified by the render_show_number) command.
0 - all buffers are hidden (by default)
A number of buffers (can be up to 16)
render_show_number
  • Variable. Print the current number of buffers in a row to be output to the screen.
  • Command. Set the number of buffers in a row to be output to the screen.
A number of buffers in a row (from 1 to 8)
(4 by default)

Meshes

Mesh Loading

Operations on the mesh loading.

NameDescriptionArguments
render_manager_create_dummy_meshes
  • Variable. Print the current loading mode for the dummy meshes.
  • Command. Preload dummy meshes (without any vertex data, only surfaces) on the world start-up. Meshes with full geometry data are loaded on demand, when they get into the view frustum. This option increases the world loading time, but safeguards against any lags on resource loading in run-time.
0 - dummy meshes are loaded only when they get into a view frustum
1 - dummy meshes are preloaded on the start-up (by default)
render_manager_create_meshes
  • Variable. Print the current loading mode for all meshes.
  • Command. Load all meshes on the start-up. This option insures against any lags on mesh loading at run-time, but increases world loading time.
0 - meshes are loaded only when they get into a view frustum (by default)
1 - meshes are preloaded on the start-up
render_manager_meshes_memory
  • Variable. Print the current cache memory limits for meshes, in percents of the total GPU memory.
  • Command. Set the cache memory limits for meshes, in percents of the total GPU memory.
0 - 100
(25 by default)
render_manager_textures_memory
  • Variable. Print the current cache memory limits for textures, in percents of the total GPU memory.
  • Command. Set the cache memory limits for textures, in percents of the total GPU memory.
0 - 100
(50 by default)

Mesh Rendering

Operations on the mesh rendering.

NameDescriptionArguments
render_alpha_fade
  • Variable. Print the value indicating if alpha fading (dithering) is enabled for objects.
  • Command. Use alpha fading (dithering) for objects.
0 - disabled
1 - enabled (by default)
render_use_dual_quaternions
  • Variable. Print the value indicating if dual quaternions for skinned meshes are enabled.
  • Command. Use dual quaternions for skinned meshes.
0 - disabled (by default)
1 - enabled
render_use_vertex_float
  • Variable. Print the value indicating if full-precision floating point vertex format for static meshes is enabled.
  • Command. Use full-precision floating point vertex format for static meshes. If disabled (by default), only half precision is used for Z-axis coordinates, texture coordinates, normal and tangent vectors of meshes, which provides lesser load, but might cause precision issues in case of too large input values.
    Full precision is available only with OpenGL, Direct3D9 and Direct3D11 rendering APIs.
0 - disabled (by default)
1 - enabled

Mesh Debugging

Operations on the mesh debugging.

NameDescriptionArguments
render_show_triangles
  • Variable. Print the current wireframe mode for scene triangles.
  • Command. Set the wireframe mode for scene triangles.
0 - triangles are hidden (by default)
1 - front faces with the depth test are shown
2 - front faces without the depth test are shown
3 - front and back faces without the depth test are shown
render_show_normals
  • Variable. Print the value indicating if mesh normals based on normal map are displayed.
  • Command. Display mesh normals based on the normal map.
0 - hidden (by default)
1 - displayed

Textures

Texture Loading

Operations on the texture loading.

NameDescriptionArguments
render_manager_create_dummy_textures
  • Variable. Print the current loading mode for the dummy textures.
  • Command. Preload dummy textures (a texture mipmap) on the world start-up. Full-sized are loaded on demand, when they get into the view frustum. This option increases the world loading time, but safeguards against any lags on resource loading in run-time.
0 - dummy textures are loaded only when they get into a view frustum
1 - dummy textures are preloaded on the start-up (by default)
render_manager_create_textures
  • Variable. Print the current loading mode for all textures.
  • Command. Load all textures on the start-up. This option insures against any lags on texture loading at run-time, but increases world loading time.
0 - textures are loaded only when they get into a view frustum (by default)
1 - textures are preloaded on the start-up

Texture Rendering

Operations on the texture rendering.

NameDescriptionArguments
render_textures
  • Variable. Print the current texture resolution.
  • Command. Set the texture resolution.
0 - low resolution
1 - medium resolution
2 - high resolution (by default)
render_filter
  • Variable. Print the current texture filtering mode.
  • Command. Set the texture filtering mode.
    Notice
    This command doesn't require the render_restart command execution.
0 - bilinear filtering
1 - trilinear filtering (by default)
render_anisotropy
  • Variable. Print the current texture anisotropy level.
  • Command. Set the texture anisotropy level.
    Notice
    This command doesn't require the render_restart command execution.
0 - level 1
1 - level 2 (by default)
2 - level 4
3 - level 8
4 - level 16

Texture Debugging

Operations on the texture debugging.

NameDescriptionArguments
render_show_mipmaps
  • Variable. Print the value indicating if mipmap levels are displayed in color.
  • Command. Display mipmap levels in color.
0 - hidden (by default)
1 - displayed in color

Shaders

Operations on shaders.

NameDescriptionArguments
render_shader_defines
  • Command. Print the macros list related to the renderer (defines to make corresponding resources available in shaders).
render_shaders
  • Variable. Print the current shader quality.
  • Command. Set the shader quality.
0 - low
1 - medium (by default)
2 - high

Shader Loading

Operations on the shader loading.

NameDescriptionArguments
render_manager_check_shaders
  • Variable. Print the value indicating if shaders are cached and compiled on the start-up.
  • Command. Compile all shaders on start-up and cache them. This option is for debugging purposes only. In the release version of the project it should be always turned off. (Shader cache file is too big to be used in release projects as well).
0 - non-compiled (by default)
1 - compiled
render_manager_create_shaders
  • Variable. Print the value indicating if shaders are compiled on the start-up.
  • Command. Compile all shaders that are used in the loaded world on start-up.
0 - non-compiled (by default)
1 - compiled

Effects and Postprocesses

Operations on the effects and postprocesses.

NameDescriptionArguments
render_auxiliary
  • Variable. Print the value indicating if the auxiliary render buffer is enabled.
  • Command. Enable auxiliary render buffer (should be enabled for render and post post-processes to work)
0 - disabled
1 - enabled (by default)
render_dof
  • Variable. Print the value indicating if the Gaussian blur depth of field effect is enabled.
  • Command. Enable the Gaussian blur depth of field effect.
0 - disabled (by default)
1 - enabled
render_glow
  • Variable. Print the value indicating if the glow post-processing effect is enabled.
  • Command. Enable the glow post-processing effect.
0 - disabled
1 - enabled using the half-screen sized buffer for glow (by default)
render_hdr
  • Variable. Print the value indicating if the high-dynamic range rendering is enabled.
  • Command. Enable the high-dynamic range rendering.
0 - disabled (by default)
1 - enabled using the standard logarithmic algorithm
2 - enabled using the quadratic algorithm (for brighter light)
render_use_filmic
  • Variable. Print the value indicating if the filmic high-dynamic range color correction rendering is enabled.
  • Command. Enable the filmic high-dynamic range color correction rendering.
0 - disabled (by default)
1 - enabled
render_motion_blur
  • Variable. Print the value indicating if the motion blur effect is enabled.
  • Command. Enable the motion blur effect.
0 - disabled (by default)
1 - enabled
render_reflection
  • Variable. Print the value indicating if dynamic reflection is enabled.
  • Command. Enable dynamic reflection.
0 - disable
1 - enabled (by default)
render_refraction
  • Variable. Print the value indicating if refraction is enabled.
  • Command. Enable refraction.
0 - disabled
1 - enabled (by default)
render_scattering
  • Variable. Print the value indicating if the light scattering is enabled.
  • Command. Enable the light scattering.
0 - disabled
1 - enabled (by default)
render_translucent
  • Variable. Print the value indicating if translucent shadow maps are enabled.
  • Command. Enable translucent shadow maps (colored shadows).
0 - disabled (by default)
1 - enabled
render_stereo
  • Variable. Print the value indicating the current stereo rendering mode.
  • Command. Set the stereo rendering mode (it is not possible to set a stereo mode via a console if a default system script is used; it allows for setting it only on the start-up).
0 - disabled (by default)
1 - enabled anaglyph stereo
2 - enabled side-by-side stereo
3 - enabled top-bottom stereo

Lighting and Shading

Operations on the lighting and shading.

NameDescriptionArguments
render_use_phong_rim
  • Variable. Print the value indicating if the Phong rim shading is enabled.
  • Command. Enable Phong rim shading.
0 - enable simple Phong shading
1 - enable Phong rim shading (by default)
render_use_environment
  • Variable. Print the value indicating if the environment modulation is enabled.
  • Command. Use environment texture and exposure modulation for lighting. If this texture is not enabled, this option can be turned off without any visual impact to increase performance.
0 - disabled
1 - enabled (by default)
render_use_directional_lightmaps
  • Variable. Print the value indicating what kind of light maps is used.
  • Command. Use directional light maps that account for surface normal map thus providing higher detailed results. If enabled, one light map contains 2×2 tiles. If the light map is exported from an external light mapping tool, disable this option.
0 - simple non-directional light maps
1 - directional light maps (by default)
render_parallax
  • Variable. Print the value indicating if the parallax occlusion mapping is enabled.
  • Command. Enable parallax occlusion mapping.
0 - disabled
1 - enabled (by default)
render_use_normalization
  • Variable. Print the value indicating if tangent basis normalization is enabled.
  • Command. Enable tangent basis normalization. This option can be toggled off to increase performance. However, no meshes can be scaled in this case, because scaled meshes will not be lit correctly.
0 - disabled
1 - enabled (by default)

Lights

Operations on lights.

NameDescriptionArguments
world_show_lights
  • Variable. Print the value indicating if the direction and radius for all light sources are displayed.
  • Command. Display the direction and radius for all light sources.
0 - hidden (by default)
1 - shown
render_show_lights
  • Variable. Print the value indicating if the light areas are displayed without attenuation.
  • Command. Display light areas without attenuation.
0 - lights are faded (by default)
1 - lights are displayed without attenuation
render_use_scissors
  • Variable. Print the value indicating if scissor test for lights is enabled.
  • Command. Enable scissor test for lights.
0 - disabled
1 - enabled (by default)
render_show_scissors
  • Variable. Print the value indicating if scissor rectangles are shown.
  • Command. Enable scissor rectangles.
0 - hidden (by default)
1 - shown

Deferred (Simplified) Lighting

Operations on deferred lights.

NameDescriptionArguments
render_deferred
  • Variable. Print the current deferred lighting mode.
  • Command. Enable deferred lighting (simplified screen-space lighting).
0 - disabled
1 (by default) - 2 - deferred shading is enabled for all lights (all lights and scene geometry are rendered only once, in screen-space)
render_force_deferred
  • Variable. Print the value indicating if all lights are rendered as deferred.
  • Command. Force all lights to be rendered as deferred
    (valid only when render_deferred = 1).
0 - lights are rendered with their normal settings (by default)
1 - lights are rendered with the force deferred lighting

Shadows

Operations on shadows.

NameDescriptionArguments
render_volumetric
  • Variable. Print the value indicating if volumetric shadows from world light sources are enabled.
  • Command. Enable volumetric shadows from world light sources.
0 - disabled
1 - enabled (by default)
render_use_shadow_kernel
  • Variable. Print the value indicating if high-quality shadows are rendered.
  • Command. Render high-quality shadows. This option affects the quality of the shadows only if high quality render settings are set.
0 - simplified shadows
1 - high-quality shadows (by default)
render_show_splits
  • Variable. Print the value indicating if Parallel Split Shadow Map (PSSM) splits for world lights are enabled.
  • Command. Enable Parallel Split Shadow Map (PSSM) splits for world lights.
0 - disabled (by default)
1 - enabled
render_show_penumbra
  • Variable. Print the value indicating if penumbra (half-shade regions) in color is enabled.
  • Command. Enable penumbra (half-shade regions).
0 - disabled (by default)
1 - enabled

Ambient Occlusion and GI

Operations on ambient and light occlusion.

NameDescriptionArguments
render_occlusion
  • Variable. Print the value indicating the current occlusion mode.
  • Command. Use ambient occlusion, light occlusion (real-time global illumination) or both of them.
0 - disabled (by default)
1 - enabled ambient occlusion
2 - enabled light occlusion (GI)
3 - enabled both ambient and light occlusion (GI)
render_light_prob
  • Variable. Print the value indicating if global illumination baked into prob lights is enabled.
  • Command. Enable global illumination baked into prob lights.
0 - disabled (by default)
1 - enabled
render_show_occlusion
  • Variable. Print the value indicating if screen-space ambient occlusion is displayed in gray-scale.
  • Command. Display screen-space ambient occlusion in gray-scale.
0 - disabled (by default)
1 - enabled

Other Settings

NameDescriptionArguments
render_use_srgb
  • Variable. Print the value indicating if a sRGB color space is enabled.
  • Command. Enable sRGB color space and apply color correction.
0 - disabled (by default)
1 - enabled
render_use_queries
  • Variable. Print the value indicating if a query test is run.
  • Command. Run an additional hardware occlusion query test before sending date to the GPU.
    Notice
    Make sure that the Query flag for nodes is enabled.
0 - not run
1 - run (by default)
render_show_queries
  • Variable. Print the value indicating if occlusion query boxes are displayed.
  • Command. Display occlusion query boxes.
    Notice
    Make sure that the Query flag for nodes is enabled.
0 - hidden (by default)
1 - displayed

Renderer Debugging

Operations on rendering passes.

NameDescriptionArguments
render_force_no_shadows
  • Variable. Print the value indicating if all shadows are disabled.
  • Command. Disable all shadows.
0 - enabled (by default)
1 - disabled
render_skip_translucent
  • Variable. Print the value indicating if the translucency is disabled.
  • Command. Disable the translucency.
0 - enabled (by default)
1 - disabled
render_skip_auxiliary
  • Variable. Print the value indicating if the auxiliary rendering pass is skipped.
  • Command. Skip the auxiliary rendering pass.
0 - enabled (by default)
1 - skipped
render_skip_decal_ambient
  • Variable. Print the value indicating if the ambient rendering pass is skipped for decal rendering.
  • Command. Skip the ambient rendering pass is skipped for decal rendering.
0 - enabled (by default)
1 - skipped
render_skip_decal_light
  • Variable. Print the value indicating if the lights & shadows rendering pass is skipped for decal rendering.
  • Command. Skip the lights & shadows rendering pass for decal rendering.
0 - enabled (by default)
1 - skipped
render_skip_deferred
  • Variable. Print the value indicating if the deferred rendering pass is skipped.
  • Command. Skip the deferred rendering pass.
0 - enabled (by default)
1 - skipped
render_skip_light_prob
  • Variable. Print the value indicating if the rendering of global illumination created with prob lights is skipped.
  • Command. Skip the rendering of global illumination created with prob lights.
0 - enabled (by default)
1 - skipped
render_skip_motion_blur
  • Variable. Print the value indicating if the velocity (motion blur) rendering pass is skipped.
  • Command. Skip the velocity (motion blur) rendering pass.
0 - enabled (by default)
1 - skipped
render_skip_occlusion
  • Variable. Print the value indicating if the ambient occlusion and indirect illumination rendering pass is skipped.
  • Command. Skip the ambient occlusion and indirect illumination rendering pass.
0 - enabled (by default)
1 - skipped
render_skip_opacity_ambient
  • Variable. Print the value indicating if the ambient rendering pass is skipped for opaque objects rendering.
  • Command. Skip the ambient rendering pass for opaque objects rendering.
0 - enabled (by default)
1 - skipped
render_skip_opacity_light
  • Variable. Print the value indicating if the lights & shadows rendering pass is skipped for opaque objects rendering.
  • Command. Skip the lights & shadows rendering pass for opaque objects rendering.
0 - enabled (by default)
1 - skipped
render_skip_post_materials 0 - enabled (by default)
1 - skipped
render_skip_reflection
  • Variable. Print the value indicating if the rendering of reflection is skipped.
  • Command. Skip the rendering of reflection.
0 - enabled (by default)
1 - skipped
render_skip_refraction
  • Variable. Print the value indicating if the rendering of refraction is skipped.
  • Command. Skip the rendering of refraction.
0 - enabled (by default)
1 - skipped
render_skip_render_materials 0 - enabled (by default)
1 - skipped
render_skip_scattering
  • Variable. Print the value indicating if the light scattering pass is skipped.
  • Command. Skip the light scattering pass.
0 - enabled (by default)
1 - skipped
render_skip_transparent_ambient
  • Variable. Print the value indicating if the ambient rendering pass is skipped for transparent objects rendering.
  • Command. Skip the ambient rendering pass for transparent objects rendering.
0 - enabled (by default)
1 - skipped
render_skip_transparent_light
  • Variable. Print the value indicating if the lights & shadows rendering pass is skipped for transparent objects rendering.
  • Command. Skip the lights & shadows rendering pass for transparent objects rendering.
0 - enabled (by default)
1 - skipped

World Debugging

Operations on the world debugging.

NameDescriptionArguments
world_show_spatial
  • Variable. Print the value indicating if the scene spatial tree is displayed.
  • Command. Display the scene spatial tree.
0 - hidden (by default)
1 - displayed
world_show_portals
  • Variable. Print the value indicating if portals between sectors are displayed.
  • Command. Display the portals between sectors.
0 - hidden (by default)
1 - displayed
world_show_sectors
  • Variable. Print the value indicating if sectors are displayed.
  • Command. Display sectors.
0 - hidden (by default)
1 - displayed

Node Debugging

Operations on the node debugging.

NameDescriptionArguments
world_show_handlers
  • Variable. Print the value indicating if nodes handlers for lights, particle systems, sectors, portals, etc. are displayed.
  • Command. Display nodes handlers for lights, particle systems, sectors, portals, etc.
0 - hidden (by default)
1 - displayed
render_show_decals
  • Variable. Print the value indicating if the wireframe for decals is displayed.
  • Command. Display the wireframe for decals.
0 - hidden (by default)
1 - displayed
world_show_transforms
  • Variable. Print the value indicating if the spline and radius for WorldTransform nodes are displayed.
  • Command. Display the spline and radius for WorldTransform nodes.
0 - hidden (by default)
1 - displayed
world_show_triggers
  • Variable. Print the value indicating if the box-shaped WorldTrigger nodes are displayed.
  • Command. Display the box-shaped WorldTrigger nodes.
0 - hidden (by default)
1 - displayed
world_show_fields
  • Variable. Print the value indicating if the Field nodes are displayed.
  • Command. Display the Field nodes.
0 - hidden (by default)
1 - displayed
world_show_players
  • Variable. Print the value indicating if the WorldPlayer nodes are displayed.
  • Command. Display the WorldPlayer nodes.
0 - hidden (by default)
1 - displayed

Occluder Debugging

Operations on the occluder debugging.

NameDescriptionArguments
world_show_occluders
  • Variable. Print the value indicating if WorldOccluder, WordOccluderMesh and WorldOccluderTerrain are displayed in the viewport.
  • Command. Display WorldOccluder, WordOccluderMesh and WorldOccluderTerrain in the viewport.
0 - hidden (by default)
1 - displayed
render_show_occluder
  • Variable. Print the value indicating if buffer used for occluders is displayed in the viewport.
  • Command. Display buffer used for occluders displayed in the viewport.
0 - hidden (by default)
1 - displayed

Renderers

DirectX 11

Operations on the Direct3D11 API.

NameDescriptionArguments
d3d11_render_desc
  • Command. Print the information about the hardware configuration.
d3d11_render_use_alpha_test_level_101
  • Variable. Print the value indicating if the Direct3D 10.1 level alpha test is run.
  • Command. Run the Direct3D 10.1 level alpha test.
0 - not run
1 - run (by default)
d3d11_render_use_compute_shader_10
  • Variable. Print the value indicating if the Direct3D 10 level compute shader is applied.
  • Command. Apply the Direct3D 10 level compute shader.
0 - not applied
1 - applied (by default)
d3d11_render_use_compute_shader_11
  • Variable. Print the value indicating if the Direct3D 11 level compute shader is applied.
  • Command. Apply the Direct3D 11 level compute shader.
0 - not applied
1 - applied (by default)
d3d11_render_use_feature_level_101
  • Variable. Print the value indicating if the Direct3D 10.1 features are applied.
  • Command. Apply the Direct3D 10.1 features, if possible.
0 - not applied
1 - applied (by default)
d3d11_render_use_feature_level_11
  • Variable. Print the value indicating if the Direct3D 11 features are applied.
  • Command. Apply the Direct3D 11 features, if possible.
0 - not applied
1 - applied (by default)
d3d11_render_use_instancing
  • Variable. Print the value indicating if mesh instancing is enabled.
  • Command. Enable mesh instancing.
0 - disabled
1 - enabled (by default)
d3d11_render_use_tessellation
  • Variable. Print the value indicating if tessellation is enabled.
  • Command. Enable tessellation.
0 - disabled
1 - enabled (by default)
d3d11_render_use_transforming
  • Variable. Print the value indicating if skinned meshes are baked before rendering.
  • Command. Bake skinned meshes before rendering.
    Notice
    Apply this option only using a weak graphics card (e.g. for laptops). In case of high-end PCs, enabling this option causes performance decreases.
0 - disabled (by default)
1 - enabled

DirectX 9

Operations on the Direct3D9 API.

NameDescriptionArguments
d3d9_render_desc
  • Command. Print the information about the hardware configuration.
d3d9_render_driver
  • Command. Print the information about the Direct3D9 driver.
d3d9_render_use_ati_texture_fetch4
  • Variable. Print the value indicating if ATI fetch4 texture sampling for shadow maps is enabled.
  • Command. Enable ATI fetch4 texture sampling for shadow maps.
0 - disabled
1 - enabled (by default)
d3d9_render_use_instancing
  • Variable. Print the value indicating if mesh instancing is enabled.
  • Command. Enable mesh instancing.
0 - disabled
1 - enabled (by default)
d3d9_render_use_alpha_to_coverage
  • Variable. Print the value indicating if the Alpha to coverage multisampling technique is enabled.
  • Command. Enable mesh the Alpha to coverage multisampling technique.
0 - disabled
1 - enabled (by default)
d3d9_render_use_nvidia_hardware_shadow
  • Variable. Print the value indicating if the NVIDIA hardware shadows are enabled.
  • Command. Enable NVIDIA hardware shadows.
0 - disabled
1 - enabled (by default)

OpenGL

Operations on the OpenGL API.

NameDescriptionArguments
gl_render_renderer
  • Command. Print the information on the graphics card.
gl_render_vendor
  • Command. Print the manufacturer of the OpenGL driver.
gl_render_version
  • Command. Print the version of the OpenGL driver.
gl_render_shading_language
  • Command. Print the version of the OpenGL shading language.
gl_render_extensions
  • Command. Print OpenGL render extensions.
gl_render_use_arb_blend_func_extended
  • Variable. Print the value indicating if the GL_ARB_blend_func_extended extension is set.
  • Command. Set the GL_ARB_blend_func_extended extension.
0 - not set
1 - set (by default)
gl_render_use_arb_draw_instanced
  • Variable. Print the value indicating if the ARB_draw_instanced extension is set.
  • Command. Set the ARB_draw_instanced extension.
0 - not set
1 - set (by default)
gl_render_use_arb_compute_shader
  • Variable. Print the value indicating if the GL_ARB_compute_shader extension is set.
  • Command. Set the GL_ARB_compute_shader extension.
0 - not set (by default)
1 - set
gl_render_use_arb_sample_shading
  • Variable. Print the value indicating if the GL_ARB_sample_shading extension is set.
  • Command. Set the GL_ARB_sample_shading extension.
0 - not set
1 - set (by default)
gl_render_use_arb_tessellation_shader
  • Variable. Print the value indicating if the GL_ARB_tessellation_shader extension is set.
  • Command. Set the GL_ARB_tessellation_shader extension.
0 - not set
1 - set (by default)
gl_render_use_arb_shader_bit_encoding
  • Variable. Print the value indicating if the GL_ARB_shader_bit_encoding extension is set.
  • Command. Set the GL_ARB_shader_bit_encoding extension for getting/setting the bit encoding for floating-point values.
0 - not set
1 - set (by default)
gl_render_use_arb_transform_feedback
  • Variable. Print the value indicating if the GL_ARB_transform_feedback extension is set.
  • Command. Set the GL_ARB_shader_bit_encoding, thereby baking skinned meshes before rendering.
    Notice
    Apply this option only using a weak graphics card (e.g. for laptops). In case of high-end PCs, enabling this option causes performance decreases.
0 - not set (by default)
1 - set
gl_render_use_arb_uniform_buffer_object
  • Variable. Print the value indicating if the GL_ARB_uniform_buffer_object extension is set.
  • Command. Set the GL_ARB_uniform_buffer_object extension.
0 - not set (by default)
1 - set
gl_render_skip_errors
  • Variable. Print the value indicating if OpenGL errors are skipped.
  • Command. Skip OpenGL errors.
0 - checked (by default)
1 - skipped

Renderers for Mobile Platforms

DirectX 11 of DirectX 9 Feature Level

Operations on the Direct3D119 API.

NameDescriptionArguments
d3d119_render_desc
  • Command. Print the information on the hardware configuration.
d3d119_render_use_instancing
  • Variable. Print the value indicating if mesh instancing is enabled.
  • Command. Enable mesh instancing.
0 - disabled
1 - enabled (by default)
d3d119_render_use_rgba8
  • Variable. Print the value indicating if the RGBA format is used.
  • Command. Use the RGBA8 format (instead of the R5G6B5) for color buffers. It controls the precision of the reflection texture. This option increases rendering speed, decreases memory usage (up to 2 times lower) at the cost of small quality degradation (artifacts can appear when rendering transparent objects).
0 - R5G6B5 is used (by default)
1 - RGBA8 is used for the screen buffer, R5G6B5 for the reflection buffer
2 - RGBA8 is used

OpenGL ES Settings

Operations on the OpenGL ES API.

NameDescriptionArguments
gles_render_renderer
  • Variable. Print the information on the hardware configuration.
gles_render_vendor
  • Variable. Print the manufacturer of the OpenGL ES driver.
gles_render_version
  • Variable. Print the version of the OpenGL ES driver.
gles_render_shading_language
  • Variable. Print the version of the OpenGL ES shading language.
gles_render_extensions
  • Variable. Print OpenGL ES render extensions.
gles_render_use_amd_texture_compression_3dc
  • Variable. Print the value indicating if the AMD_compressed_3DC_texture extension is set.
  • Command. Set the AMD_compressed_3DC_texture extension.
0 - not set
1 - set (by default)
gles_render_use_amd_texture_compression_atc
  • Variable. Print the value indicating if the AMD_compressed_ATC_texture extension is set.
  • Command. Set the AMD_compressed_ATC_texture extension.
0 - not set
1 - set (by default)
gles_render_use_ext_texture_array
  • Variable. Print the value indicating if the EXT_texture_array extension is set.
  • Command. Set the EXT_texture_array extension.
0 - not set (by default)
1 - set
gles_render_use_ext_texture_compression_latc
  • Variable. Print the value indicating if the EXT_texture_compression_latc extension is set.
  • Command. Set the EXT_texture_compression_latc extension.
0 - not set
1 - set (by default)
gles_render_use_ext_texture_compression_s3tc
  • Variable. Print the value indicating if the EXT_texture_compression_s3tc extension is set.
  • Command. Set the EXT_texture_compression_s3tc extension.
0 - not set
1 - set (by default)
gles_render_use_img_texture_compression_pvrtc
  • Variable. Print the value indicating if the IMG_texture_compression_pvrtc extension is set.
  • Command. Set the IMG_texture_compression_pvrtc extension.
0 - not set
1 - set (by default)
gles_render_use_oes_texture_3d
  • Variable. Print the value indicating if the OES_texture_3D extension is set.
  • Command. Set the OES_texture_3D extension.
0 - not set (by default)
1 - set
gles_render_use_oes_texture_compression_etc
  • Variable. Print the value indicating if the OES_compressed_ETC1_RGB8_texture extension is set.
  • Command. Set the OES_compressed_ETC1_RGB8_texture extension.
0 - not set
1 - set (by default)
gles_render_use_rgba8
  • Variable. Print the value indicating if the RGBA format is used.
  • Command. Use the RGBA8 format (instead of the R5G6B5) for color buffers. It controls the precision of the reflection texture. This option increases rendering speed, decreases memory usage (up to 2 times lower) at the cost of small quality degradation (artifacts can appear when rendering transparent objects).
0 - R5G6B5 is used (by default)
1 - RGBA8 is used for the screen buffer, R5G6B5 for the reflection buffer
2 - RGBA8 is used
gles_render_skip_errors
  • Variable. Print the value indicating if OpenGL ES errors are skipped.
  • Command. Skip OpenGL ES errors.
0 - checked (by default)
1 - skipped

PlayStation 3 Settings

Operations on the PlayStation 3 API.

NameDescriptionArguments
ps3_render_memory_dump
  • Command. Print memory usage by PS3.
ps3_render_memory_info
  • Command. Print PS3 renderer information.
ps3_render_use_instancing
  • Variable. Print the value indicating if mesh instancing is enabled.
  • Command. Enable mesh instancing.
0 - disabled
1 - enabled (by default)
ps3_render_use_mesh_raw
  • Variable. Print the value indicating if all mesh vertices and indices are stored in the video memory.
  • Command. Store all mesh vertices and indices in the video memory and do not cull invisible triangles. Enabling this option decreases system memory usage.
0 - disabled (by default)
1 - enabled

Physics

Operations on the engine physics.

NameDescriptionArguments
physics_threaded
  • Variable. Print the value indicating how many threads are used to perform physical calculations.
  • Command. Set a number of threads used to perform physical calculations.
0 - separate thread is not used at all
1 - one separate thread is used
2 - all available CPUs are used to perform multi-threaded physical calculations (by default)
physics_show_contacts
  • Variable. Print the value indicating if contact points between physical bodies are displayed.
  • Command. Display contact points between physical bodies.
0 - hidden (by default)
1 - displayed
physics_show_joints
  • Variable. Print the value indicating if joints between physical bodies are displayed.
  • Command. Display joints between physical bodies.
0 - hidden (by default)
1 - displayed
physics_show_shapes
  • Variable. Print the value indicating if collision shapes for physical bodies are displayed.
  • Command. Display collision shapes for physical bodies.
0 - hidden (by default)
1 - displayed
world_show_physicals
  • Variable. Print the value indicating if PhysicalForce, PhysicalWind, PhysicalWater and PhysicalTrigger nodes are displayed.
  • Command. Display PhysicalForce, PhysicalWind, PhysicalWater and PhysicalTrigger nodes.
0 - hidden (by default)
1 - displayed

Pathfinding

Operations on the pathfinding.

NameDescriptionArguments
pathfind_threaded
  • Variable. Print the value indicating how many threads are used to perform physical calculations.
  • Command. Set a number of threads used to perform physical calculations.
0 - separate thread is not used at all
1 - one separate thread is used
2 - all available CPUs are used to perform multi-threaded physical calculations (by default)
world_show_navigations
  • Variable. Print the value indicating if the navigation nodes used in pathfinding are displayed.
  • Command. Display navigation nodes used in pathfinding.
0 - hidden (by default)
1 - displayed
world_show_obstacles
  • Variable. Print the value indicating if the obstacle nodes used in pathfinding are displayed.
  • Command. Display obstacle nodes used in pathfinding.
0 - hidden (by default)
1 - displayed

Sound

Operations on the sound.

NameDescriptionArguments
sound_app
  • Variable. Print the current sound API.
  • Command. Sound API to be used:
    • No sound
    • Automatically choose the best sound library option from available ones (OpenAL)
    • OpenAL sound library
    • XAudio2 sound library
    • PlayStation 3
"null" - no sound
"auto" - automatically (by default)
"openal" - OpenAL
"xaudio2" - XAudio2
"playstation3" - PlayStation 3
sound_occlusion
  • Variable. Print the value indicating if sound occlusion is enabled.
  • Command. Occlude sound if other nodes are found in front of the sound source.
0 - disabled
1 - enabled (by default)
sound_reverb
  • Variable. Print the current sound reverberation mode.
  • Command. Set a sound reverberation mode.
0 - sound reverberation is disabled
1 - single-environment sound reverberation
2 - multi-environment sound reverberation (by default)
world_show_sounds
  • Variable. Print the value indicating if sound resources are displayed.
  • Command. Display the sound resources.
0 - hidden (by default)
1 - displayed

Sound Resources

Operations on the sound resources.

NameDescriptionArguments
sound_manager_load_samples
  • Variable. Print the value indicating if sound samples are preloaded on world loading.
  • Command. Preload sound samples on world loading (ensure there are no lags afterwards but increases loading time and memory footprint).
0 - disabled (by default)
1 - enabled
sound_manager_info
  • Command. Print general information on sound resources: the number of static and streamed sound sources (registered/loaded; memory used).
sound_manager_list
  • Command. Print the detailed list of sound files, if any, with used space.
sound_manager_sample_static_memory
  • Variable. Print the current cache memory limit for static sound resources in Mbytes.
  • Command. Set the cache memory limit for static sound resources in Mbytes.
11024
(64 by default)
sound_manager_sample_stream_memory
  • Variable. Print the current cache memory limit for streamed sound resources in Mbytes.
  • Command. Set the cache memory limit for streamed sound resources in Mbytes.
11024
(16 by default)

XAudio2 Settings

Operations on the XAudio2 API.

NameDescriptionArguments
xa2_sound_device
  • Variable. Print the name of the sound device with an XAudio2 API.
  • Command. Set a name of the sound device with an XAudio2 API.
A name of the sound device

OpenAL Settings

Operations on the OpenAL API.

NameDescriptionArguments
al_sound_renderer
  • Command. Print the information on the sound card.
al_sound_vendor
  • Command. Print the manufacturer of the OpenAL driver.
al_sound_version
  • Command. Print the version of the OpenAL driver.
al_sound_extensions
  • Command. Print OpenAL sound extensions.
alc_sound_extensions
  • Command. Print OpenAL context sound extensions.
al_sound_skip_errors
  • Variable. Print the value indicating if OpenAL errors are skipped.
  • Command. Skip OpenAL errors.
0 - checked (by default)
1 - skipped
Last update: 2017-07-03