UnigineEditor
界面概述
资产工作流程
设置和首选项
项目开发
调整节点参数
Setting Up Materials
Setting Up Properties
照明
Landscape Tool
Sandworm (Experimental)
使用编辑器工具执行特定任务
Extending Editor Functionality
编程
基本原理
搭建开发环境
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine Tools
GUI
双精度坐标
应用程序接口
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes

Console

UNIGINE console is used for 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:

  • Open the user configuration file (configs/default.user by default) and change the ASCII-based key code in the following line:
    Source code (XML)
    <console_key>96</console_key>

Console#

Basic operations on the console, command and variable.

bindConfig file: *.user
Description:
  • Command. Binds a key to a command.
    For example, to bind the asterisk (*) key to the world_reload command, type:
    Source code
    Unigine~# bind * world_reload
Arguments:
  1. Key to bind
  2. Command to execute
clear
Description:
  • Command. Clears all messages from the console window.
console_keyConfig file: *.user
Description:
  • Variable. Prints the ASCII code of the current console turning on or off key.
  • Command. Assigns a new key to turn on or off the console.
Arguments:
ASCII code of the key
help
Description:
  • Command. Prints the list of the built-in commands.
hide
Description:
  • Command. Hides the console.
ls
Description:
  • Command. Prints a set of all available console keys, commands and variables.
show
Description:
  • Command. Show the console.
switch
Description:
  • Command. Switches among all variable values.
    Notice
    Make sure that the variable is an integer.
Arguments:
Variable, which values will be switched
toggle
Description:
  • Command. Enables or disables a variable.
    Notice
    Enabled variable will have a default value.
    For example, if you toggle the show_visualizer variable, you will get the following result:
    Source code
    toggle show_visualizer
    show_visualizer = 0 // disabled visualizer
    toggle show_visualizer
    show_visualizer = 1 // enabled visualizer
Arguments:
Variable to be toggled
unbind
Description:
  • Command. Unbinds a key from a command.
Arguments:
Key to unbind
console_limitConfig file: *.user
Description:
  • Variable. Prints the current maximum number of messages the console can output.
  • Command. Sets the maximum number of messages the console can output.
Arguments:
[0; INT_MAX] - available range
16384 - default
console_heightConfig file: *.user
Description:
  • Variable. Prints the current console height in percentage of the window height.
  • Command. Sets the console height in percentage of the window height.
Arguments:
[0; 100] - available range
75 - default

Console GUI#

Operations on the console GUI.

console_sizeConfig file: *.boot
Description:
  • Variable. Prints the current size for the console font.
  • Command. Sets the size for the console font.
Arguments:
[4; 32] - available range
16 - default
console_fontConfig file: *.boot
Description:
  • Variable. Prints a current path to a *.ttf file used as a console font.
  • Command. Sets a path to a *.ttf file to be used as a console font.
Arguments:
Path to a *.ttf file
core/gui/console.ttf (by default)
console_onscreenConfig file: *.user
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables displaying of the onscreen overlay.
Arguments:
0 - disabled (by default)
1 - enabled
console_onscreen_font_sizeConfig file: *.user
Description:
  • Variable. Prints the current size for the onscreen overlay.
  • Command. Sets the size for the onscreen overlay.
Arguments:
[4; 32] - available range
14 - default
console_onscreen_heightConfig file: *.user
Description:
  • Variable. Prints the current height of the onscreen overlay in percentage of the window height.
  • Command. Sets the height of the onscreen overlay in percentage of the window height.
Arguments:
[0; 100] - available range
20 - default
console_onscreen_timeConfig file: *.user
Description:
  • Variable. Prints the current the time in seconds during which the text is displayed on the screen.
  • Command. Sets the the time in seconds during which the text is displayed on the screen.
Arguments:
[0.0f; 100.0f] - available range
2.0f - default
console_wrappingConfig file: *.user
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables word wrapping for the Console.
Arguments:
0 - disabled (by default)
1 - enabled

Engine#

Basic operations on the engine.

background_updateConfig file: *.boot
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Sets the value indicating whether the application window is updated when the window is hidden or out of focus (rendering frames in background). By default, your UNIGINE application stops rendering frames and updating its main window when its window goes out of focus (e.g. user switches to another window). Setting the background update mode enables constant rendering regardless of whether the application window is focused or in the background.
Arguments:
0 - disabled (by default)
1 - enabled
engine_version_info
Description:
  • Command. Prints the current engine version info.
quit
Description:
  • Command. Quits the engine.
splash_screenConfig file: *.boot
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Sets the value indicating whether the Splash screen is enabled at the engine start-up.
Arguments:
0 - disabled
1 - enabled (by default)

Engine Configuration Files#

General operations on the engine configuration.

boot_config
Description:
Arguments:
Path to the Engine startup configuration file
(data/default.boot by default)
boot_config_autosave
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables automatic saving of current Engine startup configuration settings to the file specified by the boot_config variable on loading, closing, and saving the world, as well as on the Engine shutdown.
Arguments:
0 - disabled (by default)
1 - enabled
boot_config_load
Description:
  • Command. Loads Engine startup configuration settings from a configuration file specified by the boot_config variable (configs/default.boot by default).
boot_config_save
Description:
  • Command. Saves Engine startup configuration settings to a configuration file specified by the boot_config variable (configs/default.boot by default).
configConfig file: *.boot
Description:
Arguments:
Path to the application configuration file
(configs/default.config by default)
config_autosave
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables automatic saving of current application configuration settings to the file specified by the config variable on loading, closing, and saving the world, as well as on the Engine shutdown.
Arguments:
0 - disabled
1 - enabled (by default)
config_load
Description:
  • Command. Loads the application configuration settings from a configuration file specified by the config variable (configs/default.config by default).
config_save
Description:
  • Command. Saves the current application configuration settings to a configuration file specified by the config variable (configs/default.config by default).
controls_configConfig file: *.boot
Description:
Arguments:
Path to the controls configuration file
(configs/default.controls by default)
controls_config_autosave
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables automatic saving of current controls configuration settings to the file specified by the controls_config variable on loading, closing, and saving the world, as well as on the Engine shutdown.
Arguments:
0 - disabled
1 - enabled (by default)
controls_config_load
Description:
controls_config_save
Description:
user_configConfig file: *.boot
Description:
Arguments:
Path to the user configuration file
(configs/default.user by default)
user_config_autosave
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables automatic saving of current user configuration settings to the file specified by the user_config variable on loading, closing, and saving the world, as well as on the Engine shutdown.
Arguments:
0 - disabled
1 - enabled (by default)
user_config_load
Description:
user_config_save
Description:

Engine Analyzer#

Operations on the engine debugging.

Notice
Available for debug builds only.
engine_analyze
Description:
  • Command. Analyzes the performance of the engine. The information can be printed to the console or dumped into a specified file.
Arguments:
Path to the log file to dump the log file information into (optional)

World#

Basic operations on world.

starting_worldConfig file: *.boot
Description:
  • Variable. Prints the current world to be loaded at the engine and editor start-up.
  • Command. Sets the current world to be loaded at the engine and editor start-up.
Arguments:
A world name or a path to a world relative to the -data_path folder.
world_load
Description:
  • Loads the specified world. A cache file can also be specified for faster application loading.
Arguments:
  1. Name of the world to load (inside of the data directory)
  2. Name of the world cache file (optional)
world_quit
Description:
  • Clears all the world data.
world_save
Description:
  • Saves the world.
    Notice
    Materials won't be saved on running the command. To save them, use materials_save.
world_reload
Description:
  • Reloads the world. A cache file can also be specified to be reloaded.
Arguments:
Name of the world cache file (optional)

World State#

Serialized operations on world.

state_save
Description:
  • Command. Saves 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.
Arguments:
  1. Path to the file (optional)
  2. Noscreenshot flag - save a state without taking a screenshot (optional)
state_restore
Description:
  • Command. Restores 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.
Arguments:
  1. Path to the file (optional)

World Resources#

Operations, representing information on objects generated using CPU logic, such as ObjectGrass, ObjectMeshClutter and WorldClutter objects.

world_manager_info
Description:
  • Command. Print general information (the number of registered/loaded resources; used memory) on world manager resources, such as:
    • ImageManaged - loaded images (if not fully loaded, a dummy texture or one-mipmap texture is used)
    • PathManaged - loaded splines
    • ImageStream - streamed mask images
    • MeshStream - streamed meshes used as an intersection mask for grass or clutters
world_manager_list
Description:
  • Command. Prints the list of resources handled by the world manager (mask images for ObjectGrass and WorldClutter objects), if any.
world_spawn_list
Description:
  • Command. Print the list of generation requests for ObjectGrass and ObjectMeshClutter nodes with the following information:
    • Node type
    • Node ID
    • Camera position coordinates
    • Frame number
world_manager_images_memoryConfig file: *.boot
Description:
  • Variable. Prints the current cache memory limit for images in MB.
  • Command. Sets the cache memory limit for images in MB.
Arguments:
[0; 8192] - available range
128 - default
world_manager_meshes_memoryConfig file: *.boot
Description:
  • Variable. Prints the current cache memory limit for meshes in MB.
  • Command. Sets the cache memory limit for meshes in MB.
Arguments:
[0; 8192] - available range
128 - default

World Queueing#

Operations on the world queued nodes.

world_delay
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the time delay between loading of the queued nodes in seconds. For example, this function can be used to debug streaming of resources.
Arguments:
0 - disabled
1 - enabled (by default)

Sound#

Operations on the sound.

sound_occlusion
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables occlusion of a sound if other nodes are found in front of the sound source.
Arguments:
0 - disabled
1 - enabled (by default)
sound_reverb
Description:
  • Variable. Prints the current sound reverberation mode.
  • Command. Sets the sound reverberation mode.
Arguments:
0 - sound reverberation is disabled
1 - single-environment sound reverberation
2 - multi-environment sound reverberation (by default)

Sound Resources#

Operations on the sound resources.

sound_manager_load_samples
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables preloading sound samples on world loading (ensure there are no lags afterwards but increases loading time and memory footprint).
Arguments:
0 - disabled (by default)
1 - enabled
sound_manager_info
Description:
  • Command. Prints general information on sound resources: the number of static and streamed sound sources (registered/loaded; memory used).
sound_manager_list
Description:
  • Command. Prints the detailed list of sound files, if any, with used space.
sound_manager_sample_static_memory
Description:
  • Variable. Prints the current cache memory limit for static sound resources in Mb.
  • Command. Sets the cache memory limit for static sound resources in Mb.
Arguments:
[1; 1024] - available range
64 - default
sound_manager_sample_stream_memory
Description:
  • Variable. Prints the current cache memory limit for streamed sound resources in Mb.
  • Command. Sets the cache memory limit for streamed sound resources in Mb.
Arguments:
[1; 1024] - available range
16 - default

Material Manager#

Operations on materials.

material_load
Description:
  • Command. Loads the specified manual material.
Arguments:
Path to the manual material file
material_reload
Description:
  • Command. Reloads the specified manual material.
Arguments:
Path to the manual material file
material_create_shaders
Description:
  • Command. Creates all shaders for the specified manual material.
Arguments:
Path to the manual material file
material_manager_info
Description:
  • Command. Prints information on all loaded materials (e.g. the number of loaded shaders; states, textures and parameters that don't exist in the parent material).
materials_loading_modeConfig file: *.boot
Description:
  • Variable. Prints the current materials loading mode.
  • Command. Sets the materials loading mode.
Arguments:
0 - Minimal memory consumption and maximum Engine loading speed. Сaching for materials and shaders is disabled, so everything is loaded on demand resulting in lots of freezes, spikes, etc. This method can be used when spikes are less important than memory consumption. It is recommended for fast iterations during the application development phase as less time is spent on launching your application and loading resources.
1 - Caching is enabled for materials, so materials are created at Engine's startup rather than at run time. Engine startup takes more time than for the first mode and more memory is used. There are less spikes in this mode, but they occur sometimes. This mode can be enabled on a constant basis for a small project having a small number of materials (in case of satisfactory performance and sufficient memory amount).
2 - Caching of materials is enabled along with shader cache generation and loading. This mode requires compilation of all shaders resulting in very long loading times. Everything is kept in memory with no streaming required. This mode is the best as it ensures stable work and significant reduction of spikes.
Notice
In case of large projects with tens of thousands of materials the amount of available memory can be exceeded, as shader cache takes a lot of it.
Thus, it is recommended to be used for production phase (when you hand over you application to the end user). (by default)
materials_reload
Description:
  • Command. Reloads all loaded materials and used shaders. Shader variables are updated automatically. It can be called, for example, for graphics API changes to come to effect.
materials_save
Description:
  • Command. Saves all loaded materials.
shaders_create
Description:
  • Command. Creates all shaders for all loaded materials, updates the shaders cache if necessary, and loads shaders to RAM.
shaders_create_all
Description:
  • Command. Creates possible shader combinations for the current configuration.
shaders_compile
Description:
  • Command. Compiles shaders for all loaded materials.
shaders_destroy
Description:
  • Command. Removes all shaders from RAM.
    Notice
    This command can be used to clear RAM after shader cache generation.

Camera#

Operations for fast positioning of the game camera.

camera_get
Description:
  • Command. Returns the current position of the game camera and its rotation (Euler angles).
camera_set
Description:
  • Command. Set position and rotation (Euler angles) of the game camera.
    Notice
    Position and rotation of the game camera can be changed only if the camera is unlocked.
    Source code
    camera_set 20.0 19.0 3.0 0.0 45.0 90.0
Arguments:
The first 3 arguments set position.
The second 3 arguments set rotation (optional)

File System#

Operations on the File system.

filesystem_clear_paths
Description:
  • Command. Removes all non-existent file system paths.
filesystem_mmapConfig file: *.boot
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the use of memory-mapped files for faster access.
Arguments:
0 - disabled
1 - enabled (by default)
filesystem_reload
Description:
  • Command. Reloads the file system, thereby update the list of files.
filesystem_save_guids
Description:
  • Command. Saves all file system guids to the specified file path in JSON format, or binary format if the corresponding flag is set.
Arguments:
  1. Path to the file
  2. Binary flag - save guids to a file in binary format (optional)

File System Info#

Operations, representing information on the File system.

filesystem_guids
Description:
  • Command. Prints the list of all file system guids.
filesystem_info
Description:
  • Command. Print general file system information (the total number of files and files per package).
filesystem_list
Description:
  • Command. Print the list of all files.

Assets#

Operations on assets.

assets_info
Description:
  • Command. Prints information on the number of non-native assets and runtime files generated for them.
assets_list
Description:
  • Command. Prints the list of all non-native assets and information on runtime files generated for them (file path, alias).

Scripts#

Operations on the world, system and editor scripts.

Editor Script Analyzer#

Operations on the editor script debugging.

Notice
Available only for debug builds.
editor_memory_usage
Description:
  • Command. Prints memory usage by the editor script to the console or dump into a specified file.
Arguments:
Path to a file to dump the information into (optional)
editor_analyze
Description:
  • Command. Analyzes the performance of the editor script. The information can be printed to the console or dumped into a specified file.
Arguments:
Path to the log file to dump the log file information into (optional)
editor_disassemble
Description:
  • Command. Disassembles the editor script. The information can be printed to the console or dumped into a specified file.
Arguments:
Path to a file to dump the information into (optional)

System Script Analyzer#

Operations on the system script debugging.

Notice
Available for debug builds only.
system_memory_usage
Description:
  • Command. Prints memory usage by the system script to the console or dump into a specified file.
Arguments:
Path to a file to dump the information into (optional)
system_analyze
Description:
  • Command. Analyzes the performance of the system script. The information can be printed to the console or dumped into a specified file.
Arguments:
Path to the log file to dump the log file information into (optional)
system_disassemble
Description:
  • Command. Disassembles the system script. The information can be printed to the console or dumped into a specified file.
Arguments:
Path to a file to dump the information into (optional)

World Script Analyzer#

Operations on the world script debugging.

Notice
Available for debug builds only.
world_memory_usage
Description:
  • Command. Prints memory usage by the world script to the console or dump into a specified file.
Arguments:
Path to a file to dump the information into (optional)
world_analyze
Description:
  • Command. Analyzes the performance of the world script. The information can be printed to the console or dumped into a specified file.
Arguments:
Path to the log file to dump the log file information into (optional)
world_disassemble
Description:
  • Command. Disassembles the world script. The information can be printed to the console or dumped into a specified file.
Arguments:
Path to a file to dump the information into (optional)

Script 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
world_breakpoint
Description:
  • Command. Sets a breakpoint to the specified function in the world script.
The syntax to set the breakpoint is the following:
Source code
world_breakpoint set/remove function_name number_of_arguments
Arguments:
  1. Name of function
  2. Number of arguments
system_breakpoint
Description:
  • Command. Sets a breakpoint to the specified function in the system script.
The syntax to set the breakpoint is the following:
Source code
system_breakpoint set/remove function_name number_of_arguments
Arguments:
  1. Name of function
  2. Number of arguments
editor_breakpoint
Description:
  • Command. Set a breakpoint to the specified function in the editor script.
The syntax to set the breakpoint is the following:
Source code
editor_breakpoint set/remove function_name number_of_arguments
Arguments:
  1. Name of function
  2. Number of arguments

Asynchronous Operations#

Asynchronous operations.

async_log_modeConfig file: *.boot
Description:
  • Variable. Prints the current mode for printing the list of asynchronous operations (loading / unloading of images, meshes, files, etc.) related to the specified engine component.
  • Command. Sets the mode for printing the list of asynchronous operations (loading / unloading of images, meshes, files, etc.) related to the specified engine component.
    Notice
    • Available for debug builds only, won't work for release builds.
    • You can specify whether only loading and unloading operations, or all operations should be shown.
Arguments:
0 - do not print (by default)
1 - print operations with the nodes
2 - print operations with the renderer resources (loading / unloading of meshes and textures)
3 - print operations with the file system resources (loading / unloading of files)
4 - print all operations with the nodes, renderer and file systems resources
async_log_priorityConfig file: *.boot
Description:
  • Variable. Prints the current scope of asynchronous operations to be shown via async_log_mode: only loading and unloading operations or all operations.
  • Command. Sets the scope of asynchronous operations to be shown via async_log_mode: only loading and unloading operations or all operations.
Arguments:
0 - print only frequently used operations (by default)
1 - print all operations
async_queue_info
Description:
  • Command. Prints the info on async queue resource count and memory usage.
async_queue_list
Description:
  • Command. Prints the list of async queue resources.
async_queue_clear
Description:
  • Command. Clears the async queue.

Visualizer#

Operations on the visualizer.

Notice
To debug the world and objects within it, the show_visualizer command should be set to 1.
show_visualizerConfig file: *.user
Description:
  • Variable. Prints the current visualizer mode.
  • Command. Sets the visualizer mode. It specifies if the visualizer geometry (bounding volumes, wireframe, physics bodies and shapes, etc.) is shown.
Arguments:
0 - visualizer is not shown (by default)
1 - visualizer is shown with depth testing (to check if other objects in the scene do not occlude visualized geometry)
2 - visualizer is shown without depth testing (visualized geometry is rendered in front of all objects in the scene)
show_fpsConfig file: *.user
Description:
  • Variable. Prints the current FPS counter display mode.
  • Command. Sets the FPS counter display mode.
Arguments:
0 - hide the FPS counter (by default)
1 - display the FPS counter
2 - display the FPS counter and statistics on the last 600 frames: minimum FPS, maximum FPS and average FPS for the last 600 frames.
visualizer_fix_flickerConfig file: *.user
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Reduces wireframe visualizer flickering when TAA is on.
Arguments:
0 - disabled (by default)
1 - enabled
render_wireframe_antialiasing
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables antialiasing of wireframes.
Arguments:
0 - disabled
1 - enabled (by default)
render_ffp_antialiasing_lines
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables antialiasing of the Visualizer and other FFP lines.
Arguments:
0 - disabled
1 - enabled (by default)

World Debugging#

Operations on the world debugging.

world_show_spatialConfig file: *.user
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables displaying of the scene spatial tree.
Arguments:
0 - disabled (by default)
1 - enabled
world_show_visualizerConfig file: *.user
Description:
  • Variable. Prints the list of node types for which the visualizer is displayed.
  • Command. Sets the node types for which the visualizer is displayed.
Arguments:
all
world
field
light
decal
object
player
physical
navigation
obstacle
sound
"" - to hide all handlers
render_show_trianglesConfig file: *.user
Description:
  • Variable. Prints the current wireframe mode for scene triangles.
  • Command. Sets the wireframe mode for scene triangles.
Arguments:
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

Node Debugging#

Operations on the node debugging.

world_show_handlerConfig file: *.user
Description:
  • Variable. Prints the value indicating if node handlers for lights, particle systems, sectors, portals and so on are displayed.
  • Command. Displays node handlers for lights, particle systems, sectors, portals, etc.
Arguments:
The node type:
  • all
  • world
  • field
  • light
  • decal
  • object
  • player
  • physical
  • navigation
  • obstacle
  • sound
  • "" - to hide all handlers
world_handler_3dConfig file: *.user
Description:
  • Variable. Prints the current world handlers icon type to be used.
  • Command. Sets the world handlers icon type to be used.
Arguments:
0 - screen scale (by default)
1 - 3D
world_handler_distanceConfig file: *.user
Description:
  • Variable. Prints the current world handlers visibility distance.
  • Command. Sets the world handlers visibility distance.
Arguments:
[0; inf] - available range
500 - default
render_show_decalsConfig file: *.user
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables displaying of the wireframe for decals.
Arguments:
0 - disabled (by default)
1 - enabled

Occluder Debugging#

Operations on the occluder debugging.

render_show_occluderConfig file: *.user
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables displaying of the buffer used for occluders shown in the viewport.
Arguments:
0 - disabled (by default)
1 - enabled

Landscape Terrain Debugging#

Operations on the Landscape Terrain debugging.

render_show_landscape_albedoConfig file: *.user
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables visualization of albedo data of a Landscape Terrain.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_landscape_maskConfig file: *.user
Description:
  • Variable. Prints the current visualization of a detail mask of a Landscape Terrain.
  • Command. Sets the visualization of a detail mask of a Landscape Terrain.
Arguments:
0 - disabled (by default)
1 - DetailMask 0
2 - DetailMask 1
...
20 - DetailMask 19
render_show_landscape_terrain_vt_streamingConfig file: *.user
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables visualization of tiles being streamed. In this mode colored areas show the tiles that are currently being rendered in a lower resolution until the highest MIP-level is loaded.
Arguments:
0 - disabled (by default)
1 - enabled

Physics Debugging#

physics_show_collision_surfacesConfig file: *.user
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables displaying of collision surfaces.
Arguments:
0 - disabled (by default)
1 - enabled
physics_show_contactsConfig file: *.user
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables displaying of contact points between physical bodies.
Arguments:
0 - disabled (by default)
1 - enabled
physics_show_jointsConfig file: *.user
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables displaying of joints between physical bodies.
Arguments:
0 - disabled (by default)
1 - enabled
physics_show_shapesConfig file: *.user
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables displaying of collision shapes for physical bodies.
Arguments:
0 - disabled (by default)
1 - enabled

Texture Debugging#

Operations on the texture debugging.

render_show_mipmapsConfig file: *.user
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables displaying of texture mipmap levels in color.
Arguments:
0 - disabled (by default)
1 - enabled

Occlusion Queries#

render_show_queriesConfig file: *.user
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables displaying of occlusion query boxes.
    Notice
    Make sure that the Culled by occlusion query flag is set for nodes.
Arguments:
0 - disabled (by default)
1 - enabled

Performance Profiling#

Operations on the Performance profiler.

show_profilerConfig file: *.user
Description:
  • Variable. Prints the current mode for the Performance profiler.
  • Command. Sets the mode for the Performance profiler.
Arguments:
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
show_profiler_chartsConfig file: *.user
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables displaying of Performance profiler's charts.
Arguments:
0 - disabled
1 - enabled (by default)

Profiler GUI#

Operations on the Performance profiler style.

profiler_sizeConfig file: *.boot
Description:
  • Variable. Prints the current size for the profiler font.
  • Command. Sets the size for the profiler font.
Arguments:
[4; 32] - available range
13 - default
profiler_fontConfig file: *.boot
Description:
  • Variable. Prints a current path to a *.ttf file used as a profiler font.
  • Command. Sets a path to a *.ttf file to be used as a profiler font.
Arguments:
Path to a *.ttf file
core/gui/font.ttf (by default)

Microprofile#

Operations on the Microprofile.

microprofile_enabled
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables Microprofiler.
Arguments:
0 - disabled
1 - enabled (by default)
microprofile_info
Description:
  • Command. Prints the Microprofile settings:
    • Maximum number of frames that can be profiled
    • Number of dump frames
    • Flag indicating if GPU profiling is enabled
    • Web server status
    • Web server port
    • Number of webserver frames
    If the application is compiled without Microprofile, the corresponding message will be printed to the console.
microprofile_webserver_framesConfig file: *.user
Description:
  • Variable. Prints the current number of frames to be visualised in your Web browser.
  • Command. Sets the number of frames to be visualised in your Web browser.
Arguments:
[1; 500] - available range
200 - default
microprofile_dump_framesConfig file: *.user
Description:
  • Variable. Prints the current number of frames to be included in the Microprofile dump.
  • Command. Sets the number of frames to be included in the Microprofile dump.
Arguments:
[1; 500] - available range
500 - default
microprofile_dump_html
Description:
  • Command. Saves the Microprofile dump to an .html file.
If the path isn't specified, the dump is saved to data/microprofile_dump_html folder.
Arguments:
Path to an .html file.

Video Settings#

video_adapterConfig file: *.boot
Description:
  • Variable. Prints the current the hardware video adapter ID to be used for rendering.
  • Command. Sets the the hardware video adapter ID to be used for rendering. The value must be from 0 to the number of available video adapters.
Arguments:
[0; 32] - available range
0 - default
video_debugConfig file: *.boot
Description:
  • Variable. Prints the current video debug mode for graphical API.
  • Command. Sets the video debug mode for graphical API.
    Notice
    Beware of severe slowdown when enabled.
Arguments:
0 - release rendering context (no debug) (by default)
1 - debug rendering context
2 - debug rendering context with break on error (only on debug binaries)
video_restart
Description:
  • Command. Restarts the video application.

Resolution and Full Screen#

Operations on the video resolution adjustment.

video_modeConfig file: *.boot
Description:
  • Variable. Prints the current video resolution mode.
  • Command. Sets the video resolution mode.
Arguments:
-1 - video_width × video_height
0 - 640 × 360
1 - 960 × 540
2 - 1024 × 576
3 - 1280 × 720
4 - 1366 × 768 (by default)
5 - 1600 × 900
6 - 1920 × 1080
7 - 2560 × 1440
8 - 3840 × 2160
9 - 640 × 400
10 - 960 × 600
11 - 1024 × 640
12 - 1280 × 800
13 - 1440 × 900
14 - 1680 × 1050
15 - 1920 × 1200
16 - 2560 × 1600
17 - 640 × 480
18 - 800 × 600
19 - 1024 × 768
20 - 1280 × 960
21 - 1280 × 1024
22 - 1600 × 1200
23 - 2048 × 1536
24 - 2560 × 2048
video_widthConfig file: *.boot
Description:
  • Variable. Prints the current custom screen width.
  • Command. Sets the custom screen width.
    Notice
    Valid only if the video_mode command is set to -1.
Arguments:
[0; 16384] - available range
0 - default
video_heightConfig file: *.boot
Description:
  • Variable. Prints the current custom screen height.
  • Command. Sets the custom screen height.
    Notice
    Valid only if the video_mode command is set to -1.
Arguments:
[0; 16384] - available range
0 - default
video_resizableConfig file: *.boot
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the resizable mode for an application window (its size can be changed on the fly without restarting the application).
Arguments:
0 - disabled
1 - enabled (by default)
video_fullscreenConfig file: *.boot
Description:
  • Variable. Prints the current screen mode for the application window.
  • Command. Sets the screen mode for the application window.
Arguments:
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.

video_vsyncConfig file: *.boot
Description:
  • Variable. Prints the current vertical FPS synchronization.
  • Command. Sets the vertical FPS synchronization.
Arguments:
0 - not to synchronize FPS (by default)
1 - synchronize FPS
2 - enable adaptive vertical sync

Multi-Monitor and Stereo Rendering#

video_surroundConfig file: *.boot
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables rendering of the application across 3 monitors.
Arguments:
0 - disabled (by default)
1 - enabled
video_surround_borderConfig file: *.boot
Description:
  • Variable. Prints the current monitor bezel compensation in pixels, used for surround mode.
  • Command. Sets the monitor bezel compensation in pixels, used for surround mode.
Arguments:
[0; 1024] - available range
0 - default
render_bloom_passes
Description:
  • Variable. Prints the current size of monitor bezel compensation in pixels.
  • Command. Sets the size of monitor bezel compensation in pixels. It is used together with video_surround enabled.
Arguments:
[0; 1024] - available range
0 - default
video_quad_bufferConfig file: *.boot
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables quad buffered stereo.
Arguments:
0 - disabled (by default)
1 - enabled

Rendering Settings#

Operations on the renderer.

textures_reload
Description:
  • Command. Reloads all render textures.
render_streaming_reload
Description:
  • Command. Reloads all rendering resources. You can specify an optional argument to reload resources selectively.

Usage with the argument: render_streaming_reload [mesh/texture]
Arguments:
none - reloads all resources
mesh - reload only meshes
texture - reload only textures

Rendering Resources#

Operations representing information on the rendering resources.

render_budget
Description:
  • Command. Prints current render budget value, which limits the number of loaded/created graphics resources during a frame according to loading/creation time. Budget value is measured in seconds.
Arguments:
[0.0f; inf] - available range
render_streaming_info
Description:
  • Command. Prints general information (the number of registered/loaded resources; memory used) on rendering 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_streaming_list
Description:
  • Command. Prints 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).
render_streaming_mode
Description:
  • Variable. Prints the current streaming mode for meshes and textures.
  • Command. Sets the streaming mode for meshes and textures.
Arguments:
0 - asynchronous (by default)
1 - forced
render_streaming_use_memory_limit
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables memory limitation for asynchronous resource loading (streaming of meshes and textures).
Arguments:
0 - disabled
1 - enabled (by default)
render_streaming_meshes_memory_limit
Description:
  • Variable. Prints the current cache memory limit for meshes, in percentage of the total GPU memory.
  • Command. Sets the cache memory limit for meshes, in percentage of the total GPU memory.
Arguments:
[0; 100] - available range
15 - default
render_streaming_destroy_duration
Description:
  • Variable. Prints the current resource cleanup interval, in number of frames.
  • Command. Sets the resource cleanup interval, in number of frames.
Arguments:
[1; 300] - available range
30 - default
render_streaming_max_threads
Description:
  • Variable. Prints the current maximum number of threads used for resource streaming.
  • Command. Sets the maximum number of threads used for resource streaming. Higher number of threads results in faster streaming, but may cause spikes in case of excessive consumption of GPU resources.
Arguments:
[1; 256] - available range
1 - default
render_streaming_textures_cache_resolution
Description:
  • Variable. Prints the current resolution for texture cache elements.
  • Command. Sets the resolution for texture cache elements. These minimized copies of textures are used instead of the originals while the latter are loaded.
Arguments:
0 - 8x8
1 - 16x16 (by default)
2 - 32x32
3 - 64x64
4 - 128x128
5 - 256x256
6 - 512x512
render_streaming_textures_memory_limit
Description:
  • Variable. Prints the current cache memory limit for textures, in percentage of the total GPU memory.
  • Command. Sets the cache memory limit for textures, in percentage of the total GPU memory.
Arguments:
[0; 100] - available range
65 - default
textures_cache_preloadConfig file: *.boot
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables preloading of the texture cache at engine startup.
    Notice
    Textures cache always remains in memory after loading.
Arguments:
0 - disabled
1 - enabled (by default)
render_streaming_textures_reload
Description:
  • Command. Reloads all textures.
render_streaming_textures_cache_create
Description:
  • Command. Generates texture cache for all textures used in the project.
    Notice
    Generated textures cache is incomplete, only images are created, as all metadata (flags, etc.) is stored in materials.
render_streaming_textures_cache_destroy
Description:
  • Command. Clears texture cache (images and metadata) stored on disk. All files in the data/.cache_textures will be removed.
render_streaming_textures_cache_load
Description:
  • Command. Loads texture cache from the disk. Texture cache always remains in memory after loading.
render_streaming_textures_cache_unload
Description:
  • Command. Unloads texture cache from the memory. This method does not delete files in the data/.cache_textures.
render_streaming_particles_memory_limit
Description:
  • Variable. Prints the current cache memory limit for vertices of particle systems, in percentage of the total GPU memory.
    Notice
    Setting a too low limit for a huge number of particle systems in the scene may lead to rendering only some of them.
  • Command. Sets the cache memory limit for vertices of particle systems, in percentage of the total GPU memory.
    Notice
    Setting a too low limit for a huge number of particle systems in the scene may lead to rendering only some of them.
Arguments:
[0; 100] - available range
3 - default

Rendering Resources: OpenGL-Specific Commands#

Operations representing information on the rendering resources for OpenGL.

Notice
OpenGL API only.
gl_async_bufferConfig file: *.boot
Description:
  • Variable. Prints the current size of an intermediate buffer (between the CPU and new resource) used for streaming, in Mb.
  • Command. Sets the size of an intermediate buffer (between the CPU and new resource) used for streaming, in Mb.
    Notice
    • The size of this buffer must be equal to the size of the largest resource (mesh/texture), otherwise in case of a larger resource, the buffer will be resized causing a spike.
    • Be aware, that the size of this intermediate buffer will be added to total memory consumption.
Arguments:
[0; 1024] - available range
128 - default
gl_async_buffer_indicesConfig file: *.boot
Description:
  • Variable. Prints the current size of an intermediate buffer used for mesh streaming (to store vertex indices of meshes), in Mb.
  • Command. Sets the size of an intermediate buffer used for mesh streaming (to store vertex indices of meshes), in Mb.
Arguments:
[0; 256] - available range
16 - default
gl_async_buffer_synchronizationConfig file: *.boot
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables buffer synchronization for transferring data from the streaming thread to the main one.
    Notice
    When enabled, async buffers are created only once and then synchronized reducing the time on allocating and freeing memory. When disabled, both async buffer and async buffer for indices are created anew. This reduces the number of buffer synchronizations but increases the number of memory allocations. Sometimes (depending on the hardware/driver used, e.g. when the main thread is affected by sychronization primitives in other threads) memory allocation may be faster than synchronizations, in such cases, when streaming becomes unacceptably slow, it is recommended to disable buffer synchronization.
Arguments:
0 - disabled
1 - enabled (by default)
gl_use_debug_infoConfig file: *.boot
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables debug info usage.
    Notice
    Available for debug builds only.
Arguments:
0 - disabled (by default)
1 - enabled
gl_terrain_use_async
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables asynchronous loading of Landscape Terrain tiles.
    Notice
    When disabled, it may reduce performance spikes on certain AMD and Intel GPUs at the cost of the loading speed.
Arguments:
0 - disabled
1 - enabled (by default)
gl_terrain_waiting_frames
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Set the number of frames to wait for streaming Landscape Terrain tiles. Increase this value (4-16 frames) to avoid more performance spikes and slightly improve the loading speed by forcing deferred data loading that imitates asynchronous data streaming without synchronization points.
Arguments:
0 - disabled
1 - enabled (by default)

Rendering Buffers#

Rendering Buffer Info#

Operations representing information on the rendering buffers.

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

Rendering Buffer Debugging#

Operations on the rendering buffer debugging.

render_show_texturesConfig file: *.user
Description:
  • Variable. Prints the current a mode of displaying texture buffers used by the renderer.
  • Command. Sets the a mode of displaying texture buffers used by the renderer. The number of displayed buffers depends on the number of buffers in a row specified by the render_show_textures_number command.
Arguments:
0 - all buffers are hidden (by default)
1 - show render textures (compact)
2 - show render textures (full)
render_screen_precision
Description:
  • Variable. Prints the current texture format used for screen HDR buffers.
  • Command. Sets the texture format used for screen HDR buffers.
Arguments:
0 - RG11B10F
1 - RGBA16F (by default)
render_show_textures_numberConfig file: *.user
Description:
  • Variable. Prints the current number of texture rows and columns displayed on the screen.
  • Command. Sets the number of texture rows and columns displayed on the screen. This feature affects render_show_textures.
    Textures are displayed in the following manner, depending on the set value:
    • 1 - a single texture per screen
    • 2 - 2x2 textures per screen
    • 3 - 3x3 textures per screen
    • ... etc.
Arguments:
[0; 16] - available range
7 - default
render_show_textures_offsetConfig file: *.user
Description:
  • Variable. Prints the current number of the buffer to start displaying from in the full-view mode.
  • Command. Sets the number of the buffer to start displaying from in the full-view mode.
Arguments:
[0; 256] - available range
0 - default

Rendering Passes#

Operations on rendering passes.

render_composite_deferred_material
Description:
  • Variable. Prints the list of materials to be used at the Deferred Composite stage of rendering sequence as a string constant.
  • Command. Updates the list of materials to be used at the Deferred Composite stage of rendering sequence.
Arguments:
"mat_1, mat_2, ... mat_n" - the list of composite deferred materials
render_debug
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables rendering of debug materials (the debug_materials material). Debug materials can be used for debugging of image generation stages.
Arguments:
0 - disabled (by default)
1 - enabled
render_depth_pre_pass
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables depth pre-pass rendering. When enabled, an additional depth buffer rendering pass is performed in the beginning of the rendering sequence.
    Notice
    This option can be used to gain performance for well-optimized scenes using LODs and having a low-to-medium number of triangles in case of GPU bottlenecks. In other cases (heavy CAD models, large number of triangles and CPU bottlenecks) it may reduce performance, so it is recommended to use profiling tools to make sure that a positive effect is obtained.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_scissorsConfig file: *.user
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables scissor rectangles.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_ambientConfig file: *.user
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables displaying of the ambient pass buffer.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_alpha_testConfig file: *.user
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the visualizer for objects that use alpha test.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_transparentConfig file: *.user
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the visualizer for transparent objects.
Arguments:
0 - disabled (by default)
1 - enabled
render_clouds_enabled
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables rendering of clouds.
Arguments:
0 - disabled
1 - enabled (by default)
render_lights_enabled
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables rendering of lights.
Arguments:
0 - disabled
1 - enabled (by default)
render_water_enabled
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables rendering of water.
Arguments:
0 - disabled
1 - enabled (by default)
render_screen_space_effects
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables rendering of screen-space effects.
Arguments:
0 - disabled
1 - enabled (by default)
render_pre_post_materials_enabled
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables rendering of pre-post materials.
Arguments:
0 - disabled
1 - enabled (by default)
render_transparent_enabled
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the transparent pass.
    Notice
    This console command takes effect only when the forward rendering pass is used for transparent objects rendering.
Arguments:
0 - disabled
1 - enabled (by default)
render_transparent_ambient
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the ambient rendering pass for transparent objects rendering.
    Notice
    This console command takes effect only when the forward rendering pass is used for transparent objects rendering.
Arguments:
0 - disabled
1 - enabled (by default)
render_transparent_light
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the world lights' rendering pass for transparent objects rendering.
    Notice
    This console command takes effect only when the forward rendering pass is used for transparent objects rendering.
Arguments:
0 - disabled
1 - enabled (by default)
render_transparent_deferred
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the deferred pass for transparent objects.
    Notice
    This console command takes effect only when the forward rendering pass is used for transparent objects rendering.
Arguments:
0 - disabled
1 - enabled (by default)
render_transparent_multiple_env_probes
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the multiple environment probes mode for transparent objects.
    Notice
    This console command takes effect only when the forward rendering pass is used for transparent objects rendering.
Arguments:
0 - disabled
1 - enabled (by default)

Meshes#

Operations on mesh rendering.

render_alpha_fade
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables alpha fading (dithering) for objects.
Arguments:
0 - disabled
1 - enabled (by default)
render_show_dynamicConfig file: *.user
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables visualizer for dynamic objects.
Arguments:
0 - disabled (by default)
1 - enabled

Tessellation#

Operations on mesh tessellation.

render_tessellation_density_multiplier
Description:
  • Variable. Prints the current global Density multiplier for the adaptive hardware-accelerated tessellation: higher values produce denser meshes.
  • Command. Sets the global Density multiplier for the adaptive hardware-accelerated tessellation: higher values produce denser meshes.
Arguments:
[0.0f; 10.0f] - available range
1.0f - default
render_tessellation_distance_multiplier
Description:
  • Variable. Prints the current global multiplier for all distance parameters of the adaptive hardware-accelerated tessellation used for distance-dependent optimization: higher values make tessellation visible at longer distances from the camera (consuming more resources).
  • Command. Sets the global multiplier for all distance parameters of the adaptive hardware-accelerated tessellation used for distance-dependent optimization: higher values make tessellation visible at longer distances from the camera (consuming more resources).
Arguments:
[0.0f; 10.0f] - available range
1.0f - default
render_tessellation_shadow_density_multiplier
Description:
  • Variable. Prints the current global Shadow Density multiplier for the adaptive hardware-accelerated tessellation: higher values produce more detailed shadows.
  • Command. Sets the global Shadow Density multiplier for the adaptive hardware-accelerated tessellation: higher values produce more detailed shadows.
Arguments:
[0.01f; 10.0f] - available range
1.0f - default

Decals#

Operations on decal rendering.

render_decals
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables rendering of decals.
Arguments:
0 - disabled
1 - enabled (by default)

Fields#

Operations on field rendering.

render_field_height_resolution
Description:
  • Variable. Prints the current resolution of the texture into which all textures set for all FieldHeight objects are rendered.
  • Command. Sets the resolution of the texture into which all textures set for all FieldHeight objects are rendered.
Arguments:
0 - 128x128
1 - 256x256
2 - 512x512 (by default)
3 - 1024x1024
4 - 2048x2048
5 - 4096x4096
6 - 8192x8192
render_field_precision
Description:
  • Variable. Prints the current precision of textures used for field objects.
  • Command. Sets the precision of textures used for field objects.
Arguments:
0 - 16-bit precision R16 texture (by default)
1 - 32-bit precision R32F texture
render_field_shoreline_resolution
Description:
  • Variable. Prints the current resolution of the texture into which all textures set for all FieldShoreline objects are rendered.
  • Command. Sets the resolution of the texture into which all textures set for all FieldShoreline objects are rendered.
Arguments:
0 - 128x128 (by default)
1 - 256x256
2 - 512x512
3 - 1024x1024
4 - 2048x2048
5 - 4096x4096
6 - 8192x8192

Textures#

Operations on texture rendering.

render_textures_quality
Description:
  • Variable. Prints the current texture resolution.
  • Command. Sets the texture resolution.
Arguments:
0 - low
1 - medium
2 - high (by default)
render_textures_max_resolution
Description:
  • Variable. Prints the current maximum resolution of all textures.
  • Command. Sets the maximum resolution of all textures. The engine doesn't compress existing textures: it uses specified mipmaps of *.dds textures.
Arguments:
0 - 128x128
1 - 256x256
2 - 512x512
3 - 1024x1024
4 - 2048x2048
5 - 4096x4096
6 - 8192x8192 (by default)
7 - 16384x16384
render_textures_min_resolution
Description:
  • Variable. Prints the current minimum resolution of all textures.
  • Command. Sets the minimum resolution of all textures. The engine doesn't compress existing textures: it uses specified mipmaps of *.dds textures.
Arguments:
0 - 128x128 (by default)
1 - 256x256
2 - 512x512
3 - 1024x1024
4 - 2048x2048
5 - 4096x4096
6 - 8192x8192
7 - 16384x16384
render_textures_filter
Description:
  • Variable. Prints the current texture filtering mode.
  • Command. Sets the texture filtering mode.
Arguments:
0 - bilinear filtering
1 - trilinear filtering (by default)
render_textures_anisotropy
Description:
  • Variable. Prints the current texture anisotropy level.
  • Command. Sets the texture anisotropy level.
Arguments:
0 - level 1
1 - level 2
2 - level 4
3 - level 8 (by default)
4 - level 16

Shaders#

Operations on shaders.

render_defines
Description:
  • Command. Print the macros list related to the renderer (defines to make corresponding resources available in shaders).

Shader Loading#

Operations on the shader loading.

render_shaders_preload
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables compiling of all shaders that are used in the loaded world on start-up.
    Notice
    This command compiles and loads all shaders to RAM every time the world is loaded, which results in significant memory consumption. It is recommended to use pre-generated shaders cache instead, when possible (see the shaders_create command). In this case, necessary shaders are loaded from cache to RAM on demand.
Arguments:
0 - disabled (by default)
1 - enabled

Effects and Postprocesses#

Operations on the effects and postprocesses.

render_animation_leaf
Description:
  • Variable. Prints the value of a global scale for rotation angle of vegetation leaves.
  • Command. Sets the global scale for rotation angle of vegetation leaves.
render_animation_scale
Description:
  • Variable. Prints the value of a global scale for rotation speed of vegetation leaves.
  • Command. Sets the global scale for rotation speed of vegetation leaves.
render_animation_stem
Description:
  • Variable. Prints the global scale for movement amplitude of vegetation stems.
  • Command. Sets the global scale for movement amplitude of vegetation stems.
render_animation_wind
Description:
  • Variable. Prints the offset for vegetation under wind by X, Y and Z axes.
  • Command. Sets the direction of wind for all vegetation (grass and trees). It is a multiplier for the stem offset (in grass, stem and leaves materials).
render_auxiliary
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables auxiliary render buffer (should be enabled for render and post post-processes to work).
Arguments:
0 - disabled
1 - enabled (by default)
render_bent_normal_ray_tracing
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the ray-traced bent normals calculation. The use of bent normals allows for smooth ambient lighting.
Arguments:
0 - disabled (by default)
1 - enabled
render_bent_normal_ray_tracing_denoise
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables noise reduction for ray-traced bent normals rendering. This option reduces noise by using the blur effect.
Arguments:
0 - disabled (by default)
1 - enabled
render_bent_normal_denoise_quality
Description:
  • Variable. Prints the current noise reduction quality level for bent normals rendering.
  • Command. Sets the noise reduction quality level for bent normals rendering.This level defines the number of samples used: higher values provide better reduction, but for a performance cost (choosing Medium is enough in most cases).
Arguments:
0 - low
1 - medium (by default)
2 - high
3 - ultra
render_bent_normal_fix_overlit_areas
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables correction of overlit areas for bent normals calculation. This option performs light intensity correction.
    Notice
    This option may significantly affect performance, so disable it when it's not necessary.
Arguments:
0 - disabled (by default)
1 - enabled
render_bent_normal_ray_tracing_threshold
Description:
  • Variable. Prints the current threshold used for the ray-traced bent normals calculation.
  • Command. Sets the threshold used for the ray-traced bent normals calculation.
Arguments:
[0.0f; inf] - available range
1.0f - default
render_bloom
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the bloom effect.
Arguments:
0 - disabled (by default)
1 - enabled
render_bloom_passes
Description:
  • Variable. Prints the current number of passes for the bloom effect.
  • Command. Sets the number of passes for the bloom effect. During each pass a bloom texture is generated. Up to 8 bloom textures can be generated: each texture has lower resolution (original size, original size /2, original size /4, so forth) with bloom effect. After that, all these bloom textures with the different resolution are composed for the final bloom texture.
Arguments:
[2; 8] - available range
6 - default
render_bloom_power
Description:
  • Variable. Prints the current power of the bloom effect.
  • Command. Sets the power of the bloom effect.
Arguments:
[0.0f; 1.0f] - available range
0.7f - default
render_bloom_resolution
Description:
  • Variable. Prints the current Bloom rendering resolution.
  • Command. Sets the Bloom rendering resolution.
Arguments:
0 - quarter
1 - half
2 - full (by default)
render_bloom_scale
Description:
  • Variable. Prints the current value of the bloom scale.
  • Command. Sets the value of the bloom scale.
Arguments:
[0.0f; 1.0f] - available range
0.3f - default
render_border
Description:
  • Variable. Prints the width of the image border (in pixels), to be rendered outside the bounds of the screen to reduce artefacts of post effects.
  • Command. Sets the width of the image border (in pixels), to be rendered outside the bounds of the screen to reduce artefacts of post effects.
Notice
Increasing the width of the border may increase performance costs.
render_camera_effects_threshold
Description:
  • Variable. Prints the current brightness threshold, which is used to detect if an object should be blurred in the HDR mode.
  • Command. Sets the brightness threshold, which is used to detect if an object should be blurred in the HDR mode.
Arguments:
[0.0f; inf] - available range
1.0f - default
render_camera_effects_temporal_filtering
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Toggles temporal filtering on and off.
Arguments:
0 - disabled (by default)
1 - enabled
render_dirt_scale
Description:
  • Variable. Prints the current scale of lens dirt effect modulating the pattern of lens flares.
  • Command. Sets the scale of lens dirt effect modulating the pattern of lens flares. For example, it can be used to create an effect of unclean optics when the camera looks at the sun.
Arguments:
[0.0f; 1.0f] - available range
0.5f - default
render_dof
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the Gaussian blur depth of field effect.
Arguments:
0 - disabled (by default)
1 - enabled
render_dof_blur
Description:
  • Variable. Prints the current intensity of blur for DoF (Depth Of Field) effect.
  • Command. Sets the intensity of blur for DoF (Depth Of Field) effect.
Arguments:
[0.0f; inf] - available range
1.0f - default
render_dof_chromatic_aberration
Description:
  • Variable. Prints the current intensity of chromatic aberration effect for DoF (Depth Of Field).
  • Command. Sets the intensity of chromatic aberration effect for DoF (Depth Of Field).
Arguments:
[0.0f; inf] - available range
0.0f - default
render_dof_far_distance
Description:
  • Variable. Prints the current far DoF limit of the camera.
  • Command. Sets the far DoF limit of the camera. The distance between the camera and the furthest element that is considered to be acceptably sharp.
Arguments:
[0.0f; inf] - available range
10.0f - default
render_dof_near_distance
Description:
  • Variable. Prints the current near DoF limit of the camera.
  • Command. Sets the near DoF limit of the camera. The distance between the camera and the nearest element that is considered to be acceptably sharp.
Arguments:
[0.0f; inf] - available range
10.0f - default
render_dof_focal_distance
Description:
  • Variable. Prints the current focal distance of the camera.
  • Command. Sets the focal distance of the camera.. A point where objects are in-focus and clear.
Arguments:
[0.0f; inf] - available range
1.0f - default
render_dof_far_focal_offset
Description:
  • Variable. Prints the current far focal offset for DoF (Depth Of Field) effect.
  • Command. Sets the far focal offset for DoF (Depth Of Field) effect. The offset from the focal point to the furthest blurred zone.
Arguments:
[0.0f; inf] - available range
0.0f - default
render_dof_near_focal_offset
Description:
  • Variable. Prints the current near focal offset for DoF (Depth Of Field) effect.
  • Command. Sets the near focal offset for DoF (Depth Of Field) effect. The offset from the focal point to the nearest blurred zone.
Arguments:
[0.0f; inf] - available range
0.0f - default
render_dof_resolution
Description:
  • Variable. Prints the current DOF rendering resolution.
  • Command. Sets the DOF rendering resolution.
Arguments:
0 - quarter
1 - half
2 - full (by default)
render_dof_quality
Description:
  • Variable. Prints the current DOF rendering quality.
  • Command. Sets the DOF rendering quality.
Arguments:
0 - low
1 - medium (by default)
2 - high
3 - ultra
render_dof_bokeh_mode
Description:
  • Variable. Prints the current DOF Bokeh effect mode.
  • Command. Sets the DOF Bokeh effect mode.
Arguments:
0 - ring (by default)
1 - circle
render_dof_increased_accuracy
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the DOF increased accuracy. Enabling the parameter allows for increasing accuracy of focusing calculation.
Arguments:
0 - disabled (by default)
1 - enabled
render_dof_focus_improvement
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables focus improvement for the DOF effect. When enabled, transitions between the focused and unfocused parts of the scene become more accurate.
Arguments:
0 - disabled (by default)
1 - enabled
render_exposure_mode
Description:
  • Variable. Prints the current adaptive exposure effect mode.
  • Command. Sets the adaptive exposure effect mode.
Arguments:
0 - disabled (by default)
1 - logarithmic adaptive exposure
2 - quadratic adaptive exposure
render_exposure
Description:
  • Variable. Prints the current camera exposure value.
  • Command. Sets the camera exposure value.
    Notice
    Available only when render_camera_mode = 0.
Arguments:
[0.0f; 4.0f] - available range
0.0f - default
render_exposure_adaptation
Description:
  • Variable. Prints the value of the period of exposure adaptation.
  • Command. Sets the value of the period of exposure adaptation.
render_iso
Description:
  • Variable. Prints the current ISO value for the physically-based camera.
  • Command. Sets the ISO value for the physically-based camera.
Arguments:
[0; inf] - available range
100 - default
render_shutter_speed
Description:
  • Variable. Prints the current shutter speed for the physically-based camera.
  • Command. Sets the shutter speed for the physically-based camera.
Arguments:
[0; inf] - available range
250 - default
render_f_stop
Description:
  • Variable. Prints the current F-stop value for the physically-based camera.
  • Command. Sets the F-stop value for the physically-based camera.
Arguments:
[0; inf] - available range
11 - default
render_camera_mode
Description:
  • Variable. Prints the current camera mode.
  • Command. Sets the camera mode.
    • If the classic camera is used, the static exposure is set directly.
    • If the physically-based camera is use, the static exposure calculation is based on physical parameters of the camera (ISO, shutter speed, and f-stop).
Arguments:
0 - classic camera (by default)
1 - physically-based camera
render_white_balance
Description:
Arguments:
0 - disabled
1 - enabled (by default)
render_white_balance_intensity
Description:
  • Variable. Prints the current intensity of white balance correction.
  • Command. Sets the intensity of white balance correction.
    Notice
    Do not set too high values for night-time and dimly lit scenes, as it may lead to heavy color distortion making the scene look totally unnatural.
Arguments:
[0.0f; 1.0f] - available range
0.3f - default
render_white_balance_adaptation_time
Description:
  • Variable. Prints the current time period (in seconds) during which white balance correction is performed.
  • Command. Sets the time period (in seconds) during which white balance correction is performed. 0 is for instant correction.
    Notice
    It is recommended to use lower values, when possible, to make the correction process unnoticeable, otherwise it'll be slow and will catch the user's eye. However, setting too low values may result in abrupt switching of colors as the camera moves. So, adjust this parameter carefully to make the transition smoooth. You can set it equal to the Exposure Adaptation value.
Arguments:
[0.0f; inf] - available range
1.0f - default
render_supersampling
Description:
  • Variable. Prints the current number of samples per pixel used for supersampling.
  • Command. Sets the number of samples per pixel used for supersampling.
Arguments:
[1e-6f; 8.0f] - available range
1.0f - default
render_occluders
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables rendering of occluders.
Arguments:
0 - disabled
1 - enabled (by default)
render_occluders_resolution
Description:
  • Variable. Prints the current resolution of the texture, to which occluders are rendered.
  • Command. Sets resolution of the texture, to which occluders are rendered.
Arguments:
From 1x1 to 1024x1024 Default: 128x64
render_occluders_shadows
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables rendering of occluders for shadows.
Arguments:
0 - disabled (by default)
1 - enabled
render_occluders_shadows_resolution
Description:
  • Variable. Prints the current resolution of the texture, to which occluders for shadows are rendered.
  • Command. Sets resolution of the texture, to which occluders for shadows are rendered.
Arguments:
From 1x1 to 1024x1024 Default: 512x512
render_ssgi
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the SSGI (Screen Space Global Illumination) effect.
Arguments:
0 - disabled (by default)
1 - enabled
render_ssgi_color_clamping_intensity
Description:
  • Variable. Prints the current intensity of TAA color clamping at zero pixel velocity for the SSGI (Screen Space Global Illumination) effect.
  • Command. Sets the intensity of TAA color clamping at zero pixel velocity for the SSGI (Screen Space Global Illumination) effect. Lower values result in more accumulated frames combined, which reduces noise flickering, but increases ghosting effect (to reduce ghosting in this case you can use render_ssgi_color_clamping_velocity_threshold), while higher values reduce ghosting effect, but increase flickering.
Arguments:
[0.0f; 1.0f] - available range
1.0f - default
render_ssgi_color_clamping_velocity_threshold
Description:
  • Variable. Prints the current sensitivity of TAA color clamping for the SSGI (Screen Space Global Illumination) effect to pixel velocity change.
  • Command. Sets the sensitivity of TAA color clamping for the SSGI (Screen Space Global Illumination) effect to pixel velocity change. This parameter is used to reduce ghosting effect for lower Color Clamping Intensity values: it automatically increases clamping intensity for higher velocities, and disables clamping for low velocity values.
Arguments:
[0.0f; inf] - available range
0.0f - default
render_ssgi_radius
Description:
  • Variable. Prints the current radius of the SSGI (Screen Space Global Illumination).
  • Command. Sets the radius of the SSGI (Screen Space Global Illumination).
Arguments:
[0.0f; 1.0f] - available range
1.0f - default
render_ssgi_intensity
Description:
  • Variable. Prints the current intensity of the SSGI (Screen Space Global Illumination) for the scene.
  • Command. Sets the intensity of the SSGI (Screen Space Global Illumination) for the scene.
Arguments:
[0.0f; 1.0f] - available range
1.0f - default
render_ssgi_intensity_boost
Description:
  • Variable. Prints the current intensity boost value
  • Command. Sets the intensity boost value to the spicified power.
Arguments:
1 - power of 1 (by default)
2 - power of 2
3 - power of 3
4 - power of 4
render_ssgi_resolution
Description:
  • Variable. Prints the current SSGI effect resolution.
  • Command. Sets the SSGI effect resolution.
Arguments:
0 - quarter resolution
1 - half resolution (by default)
2 - full resolution
render_ssgi_denoise
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables noise reduction for the ray-traced SSGI (Screen Space Global Illumination). This option reduces noise by using blur effect. Ray-traced SSGI calculation is available only when the SSRTGI technique is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_ssgi_denoise_quality
Description:
  • Variable. Prints the current noise reduction quality level for the SSGI (Screen Space Global Illumination) effect.
  • Command. Sets the noise reduction quality level for the SSGI (Screen Space Global Illumination) effect. The quality level defines the number of samples used: higher values provide better reduction, but for a performance cost (choosing Medium is enough in most cases).
Arguments:
0 - low
1 - medium) (by default)
2 - high
3 - ultra
render_ssgi_denoise_intensity
Description:
  • Variable. Prints the current noise reduction intensity for the SSGI (Screen Space Global Illumination) effect.
  • Command. Sets the noise reduction intensity for the SSGI (Screen Space Global Illumination) effect. Higher values provide a less noisy, but more blurred result.
Arguments:
[0.0f; 1.0f] - available range
0.2f - default
render_ssgi_denoise_radius
Description:
  • Variable. Prints the current radius of the area to be affected by noise reduction for the SSGI (Screen Space Global Illumination) effect.
  • Command. Sets the radius of the area to be affected by noise reduction for the SSGI (Screen Space Global Illumination) effect.
Arguments:
1
2 (by default)
3
render_ssgi_denoise_gaussian_sigma
Description:
  • Variable. Prints the current sigma parameter of Gaussian blur used for noise reduction for the SSGI (Screen Space Global Illumination) effect.
  • Command. Sets the sigma parameter of Gaussian blur used for noise reduction for the SSGI (Screen Space Global Illumination) effect. It controls the amount of blur applied.
Arguments:
[0.0f; 100.0f] - available range
10.0f - default
render_ssgi_denoise_threshold
Description:
  • Variable. Prints the current threshold value for color difference of neighboring pixels used for noise reduction for the SSGI (Screen Space Global Illumination) effect.
  • Command. Sets the threshold value for color difference of neighboring pixels used for noise reduction for the SSGI (Screen Space Global Illumination) effect. Blur is applied when the color difference is less than the threshold value.
    Notice
    Setting too high values result in blurring the whole image.
Arguments:
[0.0f; 1.0f] - available range
0.1f - default
render_ssgi_threshold
Description:
  • Variable. Prints the current threshold value for the ray-traced SSGI (Screen Space Global Illumination).
  • Command. Sets the threshold value for the ray-traced SSGI (Screen Space Global Illumination). Ray-traced SSGI calculation is available only when the SSRTGI technique is enabled.
Arguments:
[0.0f; inf] - available range
1.0f - default
render_fxaa
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables FXAA.
Arguments:
0 - disabled
1 - enabled (by default)
render_fxaa_intensity
Description:
  • Variable. Prints the current intensity of FXAA.
  • Command. Sets the intensity of FXAA. Intensity specifies the sample offset of FXAA fragment.
Arguments:
[0.0f; 1.0f] - available range
0.0f - default
render_taa
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables TAA.
Arguments:
0 - disabled
1 - enabled (by default)
render_taa_antialiasing_in_motion
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables improved anti-aliasing in motion (moving camera and objects). To use this option, render_taa should be enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_taa_frame_count
Description:
  • Variable. Prints the current frame count for TAA (Temporal Anti-Aliasing).
  • Command. Sets the frame count for TAA (Temporal Anti-Aliasing). It specifies the number of frames for velocity buffer. To use this option, render_taa should be enabled.
Arguments:
[0.0f; inf] - available range
30.0f - default
render_taa_catmull_resampling
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables Catmull-Rom resampling. It allows you to reduce image blurring when the camera moves forward/backward. It is recommended to disable resampling at low settings.
Arguments:
0 - disabled
1 - enabled (by default)
render_taa_frames_by_color
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables TAA color clamping. This command clamps the color of the current and previous frame. The image becomes more sharp. To use this option, render_taa should be enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_taa_diagonal_neighbors
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables taking diagonally neighboring pixels into account in the process of color clamping. To use this option, render_taa should be enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_taa_preserve_details
Description:
  • Variable. Prints the current detail level of TAA (Temporal Anti-Aliasing).
  • Command. Sets the detail level of TAA (Temporal Anti-Aliasing). The higher the value the more detailed is the image. Can produce additional flickering. To use this option, render_taa should be enabled.
Arguments:
[0.0f; inf] - available range
0.5f - default
render_taa_pixel_offset
Description:
  • Variable. Prints the current size of the sample offset performed during subpixel jittering.
  • Command. Sets the size of the sample offset performed during subpixel jittering. By default, samples shift to one pixel during subpixel jittering, you can lower this offset.
Arguments:
[0.0f; 1.0f] - available range
1.0f - default
render_taa_samples
Description:
  • Variable. Prints the current number of the sample offsets performed during subpixel jittering.
  • Command. Sets the number of the sample offsets performed during subpixel jittering. By the minimum value of 1, there will be no offsets, and, therefore, no anti-aliasing. To use this option, render_taa should be enabled.
Arguments:
0 - 1 sample offset, no anti-aliasing
1 - 4 offsets (by default)
2 - 8 offsets
3 - 16 offsets
render_taa_max_frames_by_velocity
Description:
  • Variable. Prints the current maximum frame count of TAA (Temporal Anti-Aliasing).
  • Command. Sets the maximum frame count of TAA (Temporal Anti-Aliasing). Specifies the maximum number of frames for velocity buffer.
Arguments:
[0.0f; inf] - available range
60.0f - default
render_taa_min_frames_by_velocity
Description:
  • Variable. Prints the current minimum frame count of TAA (Temporal Anti-Aliasing).
  • Command. Sets the minimum frame count of TAA (Temporal Anti-Aliasing). Specifies the minimum number of frames for velocity buffer.
Arguments:
[0.0f; inf] - available range
4.0f - default
render_taa_frames_by_velocity
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables TAA velocity clamping. This command controls the number of frames for velocity buffer. That reduces the blurring in dynamic scenes with a lot of moving objects. To use this option, render_taa should be enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_taa_frames_velocity_threshold
Description:
  • Variable. Prints the current velocity threshold of TAA (Temporal Anti-Aliasing).
  • Command. Sets the velocity threshold of TAA (Temporal Anti-Aliasing). This value specifies the intensity of velocity clamping. To use this option, both render_taa and render_taa_frames_by_velocity should be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - default
render_taa_fix_flicker
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables bright pixels flicker fix. To use this option, render_taa should be enabled.
    Notice
    Enabling fix flicker may increase performance costs.
Arguments:
0 - disabled
1 - enabled (by default)
render_sraa
Description:
Arguments:
0 - disabled (by default)
1 - enabled
render_sraa_samples
Description:
  • Variable. Prints the current number of depth geometry samples per pixel.
  • Command. Sets the number of depth geometry samples per pixel.
Arguments:
0 - 2 depth samples per pixel
1 - 4 depth samples per pixel
2 - 8 depth samples per pixel
render_sraa_temporal
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the usage of additional shading sample from the previous frame. To use this option, render_taa should be enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_sraa_debug
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the debug mode.
Arguments:
0 - disabled (by default)
1 - enabled
render_sraa_depth_threshold
Description:
  • Variable. Prints the current depth threshold value used for edges detection.
  • Command. Sets the depth threshold value used for edges detection.
Arguments:
[0.0f; inf] - available range
0.1f - default
render_filmic
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables filmic high-dynamic range color correction rendering.
Arguments:
0 - disabled (by default)
1 - enabled
render_filmic_shoulder_scale
Description:
  • Variable. Prints the current shoulder strength filmic tonemapping parameter value.
  • Command. Sets the shoulder strength filmic tonemapping parameter value. This value is used to change brightness. To use this option, render_filmic should be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.2f - default
render_filmic_linear_scale
Description:
  • Variable. Prints the current linear strength filmic tonemapping parameter value.
  • Command. Sets the linear strength filmic tonemapping parameter value. This parameter is used to change grey values and controls the length of the tone mapping curve linear part. To use this option, render_filmic should be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.3f - default
render_filmic_linear_angle
Description:
  • Variable. Prints the current linear angle filmic tonemapping parameter value.
  • Command. Sets the linear angle filmic tonemapping parameter value. This parameter controls the slope of the linear part of the tone mapping curve. To use this option, render_filmic should be enabled.
Arguments:
[0.0f; 1.0f] - available range
1.0f - default
render_filmic_toe_scale
Description:
  • Variable. Prints the current toe scale filmic tonemapping parameter value.
  • Command. Sets the toe scale filmic tonemapping parameter value. This parameter controls the slope of the tone mapping curve toe (the area of underexposure) and is used to change dark values. To use this option, render_filmic should be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.2f - default
render_filmic_toe_numerator
Description:
  • Variable. Prints the current toe numerator filmic tonemapping parameter value.
  • Command. Sets the toe numerator filmic tonemapping parameter value. To use this option, render_filmic should be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.01f - default
render_filmic_toe_denominator
Description:
Arguments:
[0.0f; 1.0f] - available range
0.3f - default
render_filmic_white_level
Description:
  • Variable. Prints the current white level filmic tonemapping parameter value.
  • Command. Sets the white level filmic tonemapping parameter value. This value is mapped as pure white in the resulting image. To use this option, render_filmic should be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - default
render_filmic_saturation_recovery
Description:
  • Variable. Prints the current color saturation recovery filmic tonemapping parameter value.
  • Command. Sets the color saturation recovery filmic tonemapping parameter value. This parameter is used for bright areas desaturated by the filmic tonemapper (grayish look). Higher values make colors more saturated.
Arguments:
[0.0f; 1.0f] - available range
0.75f - default
render_cross
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the cross flares camera effect.
Arguments:
0 - disabled (by default)
1 - enabled
render_cross_color
Description:
  • Variable. Prints the color of the cross flares.
  • Command. Sets the color of the cross flares.
To use this option, render_cross should be enabled.
Arguments:
vec4_one - default value (white)
render_cross_length
Description:
  • Variable. Prints the current
    • Variable. Prints the length of a cross flare.
    • Command. Sets the length of a cross flare. Increasing this value also leads to fading of the shafts across their length.
    To use this option, render_cross should be enabled.
  • Command. Sets the
    • Variable. Prints the length of a cross flare.
    • Command. Sets the length of a cross flare. Increasing this value also leads to fading of the shafts across their length.
    To use this option, render_cross should be enabled.
Arguments:
[0.0f; 2] - available range
0.2f - default
render_cross_scale
Description:
  • Variable. Prints the current scale of the cross flares.
  • Command. Sets the scale of the cross flares. Higher values produce more pronounced flares. To use this option, render_cross should be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - default
render_cross_shafts
Description:
  • Variable. Prints the current number of shafts in a cross flare.
  • Command. Sets the number of shafts in a cross flare. High number of flares can cause a FPS drop on low-performance hardware. To use this option, render_cross should be enabled.
Arguments:
[2; 32] - available range
4 - default
render_cross_scale
Description:
  • Variable. Prints the current length of a cross flare.
  • Command. Sets the length of a cross flare. Higher values lead to fading of shafts endways. To use this option, render_cross should be enabled.
Arguments:
[0.0f; 2.0f] - available range
0.2f - default
render_cross_angle
Description:
  • Variable. Prints the current cross flares orientation angle.
  • Command. Sets the cross flares orientation angle. To use this option, render_cross should be enabled.
Arguments:
[-inf; inf] - available range
45.0f - default
render_cross_threshold
Description:
  • Variable. Prints the current brightness threshold for areas to produce cross flares.
  • Command. Sets the brightness threshold for areas to produce cross flares. The higher the threshold value, the brighter the area should be to produce a flare. To use this option, render_cross should be enabled.
Arguments:
[0.0f; inf] - available range
0.0f - default
render_distance_scale
Description:
  • Variable. Prints the current global distance scale for all distance parameters: shadow distance, light distance, LOD distances, etc.
  • Command. Sets the global distance scale for all distance parameters: shadow distance, light distance, LOD distances, etc.
Arguments:
[0.0f; inf] - available range
1.0f - default
render_decal_distance
Description:
  • Variable. Prints the current distance starting from which the Decal nodes will not be rendered.
  • Command. Sets the distance starting from which the Decal nodes will not be rendered.
Arguments:
[0.0f; inf] - available range
inf - default
render_field_distance
Description:
  • Variable. Prints the current distance starting from which the Field nodes will not be rendered.
  • Command. Sets the distance starting from which the Field nodes will not be rendered.
Arguments:
[0.0f; inf] - available range
inf - default
render_light_distance
Description:
  • Variable. Prints the current distance starting from which the Light nodes will not be rendered.
  • Command. Sets the distance starting from which the Light nodes will not be rendered.
Arguments:
[0.0f; inf] - available range
inf - default
render_object_distance
Description:
  • Variable. Prints the current distance starting from which the Object nodes will not be rendered.
  • Command. Sets the distance starting from which the Object nodes will not be rendered.
Arguments:
[0.0f; inf] - available range
inf - default
render_reflection_dynamic
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables dynamic reflections rendering.
Arguments:
0 - disabled
1 - enabled (by default)
render_reflection_lods
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables reduction of resolution of dynamic reflections when the camera moves away.
Arguments:
0 - disabled
1 - enabled (by default)
render_reflection_distance
Description:
  • Variable. Prints the current distance starting from which reflections will not be rendered.
  • Command. Sets the distance starting from which reflections will not be rendered.
Arguments:
[0.0f; inf] - available range
inf - default
render_wireframe_color
Description:
  • Variable. Prints the color for the wireframe.
  • Command. Sets the color for the wireframe.
Arguments:
vec4_one - default value (white)
render_background_color
Description:
  • Variable. Prints the color rendered for the scene background.
  • Command. Sets the color to be rendered for the scene background. Alpha channel of this color sets background transparency: lower alpha channel values produce darker background color.
Arguments:
vec4_one - default value (white)
render_fade_color
Description:
Arguments:
vec4_zero - default value (white)
render_lens
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the lens flares effect.
Arguments:
0 - disabled (by default)
1 - enabled
render_lens_color
Description:
  • Variable. Prints the value of the lens flares color.
  • Command. Sets the value of the lens flares color. To use this option, render_lens should be enabled.
Arguments:
vec4_one - default value (white)
render_lens_scale
Description:
  • Variable. Prints the current value of the lens flares scale.
  • Command. Sets the value of the lens flares scale. To use this option, render_lens should be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - default
render_lens_length
Description:
  • Variable. Prints the current value of the lens flares length.
  • Command. Sets the value of the lens flares length. This value indicates if the whole radial lens flare is rendered on the screen or only a part of it. The option controls how lens flares pattern is distributed. To use this option, render_lens should be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.5f - default
render_lens_radius
Description:
  • Variable. Prints the current value of the lens flares radius on the screen.
  • Command. Sets the value of the lens flares radius on the screen. To use this option, render_lens should be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.5f - default
render_lens_threshold
Description:
  • Variable. Prints the current value of the brightness threshold for areas to produce lens flares.
  • Command. Sets the value of the brightness threshold for areas to produce lens flares. The higher the threshold value, the brighter the area should be to produce flares. To use this option, render_lens should be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.5f - default
render_lens_dispersion
Description:
  • Variable. Prints the value of the lens flares dispersion: displacement for for red, green and blue channels.
  • Command. Sets the value of the lens flares dispersion: displacement for for red, green and blue channels. To use this option, render_lens should be enabled.
Arguments:
vec3_one - default value
render_motion_blur
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the motion blur effect.
Arguments:
0 - disabled
1 - enabled (by default)
render_motion_blur_camera_velocity
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables camera velocity contribution to the motion blur effect. To use this option, render_motion_blur should be enabled.
    Notice
    Disabled in VR mode by default.
Arguments:
0 - disabled
1 - enabled (by default)
render_motion_blur_neat_silhouettes
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the neat silhouettes option for motion blur. This option keeps contours of objects in front of the camera unblurred. To use this option, render_motion_blur should be enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_motion_blur_noise_intensity
Description:
  • Variable. Prints the current intensity of the noise used in the motion blur.
  • Command. Sets the intensity of the noise used in the motion blur. To use this option, render_motion_blur should be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.5f - default
render_motion_blur_num_steps
Description:
  • Variable. Prints the current number of steps used in the motion blur.
  • Command. Sets the number of steps used in the motion blur. To use this option, render_motion_blur should be enabled.
Arguments:
[2; 64] - available range
8 - default
render_motion_blur_velocity_scale
Description:
  • Variable. Prints the current scale value of bodies' linear and angular velocities used for the motion blur.
  • Command. Sets the scale value of bodies' linear and angular velocities used for the motion blur. To use this option, render_motion_blur should be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - default
render_motion_blur_max_velocity
Description:
  • Variable. Prints the current maximum scaled velocity of bodies used for the motion blur.
  • Command. Sets the maximum scaled velocity of bodies used for the motion blur. To use this option, render_motion_blur should be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - default
render_transparent_blur
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the transparent blur for materials. This option makes it possible to render matte transparent materials like matte glass.
Arguments:
0 - disabled
1 - enabled (by default)
render_refraction
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables refraction.
Arguments:
0 - disabled
1 - enabled (by default)
render_refraction_dispersion
Description:
  • Variable. Prints the value of the refraction dispersion: displacement for for red, green and blue channels.
  • Command. Sets the value of the refraction dispersion: displacement for for red, green and blue channels (according to refraction texture of refractive materials). Can be used to create light dispersion (chromatic aberrations). To use this option, render_refraction should be enabled.
Arguments:
vec3_one - default value
render_sharpen
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the sharpening post-process effect.
Arguments:
0 - disabled (by default)
1 - enabled
render_sharpen_intensity
Description:
  • Variable. Prints the current intensity of the sharpening effect.
  • Command. Sets the intensity of the sharpening effect. To use this option, render_sharpen should be enabled.
Arguments:
[0.0f; inf] - available range
0.5f - default
render_vr_emulation
Description:
  • Variable. Prints the current VR-emulation mode.
  • Command. Sets the VR-emulation mode.
Arguments:
0 - disabled (by default)
1 - HTC Vive emulation
2 - HTC Vive Pro emulation
3 - Oculus Rift emulation
render_ssr
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables screen-space reflections.
Arguments:
0 - disabled (by default)
1 - enabled
render_ssr_color_clamping_intensity
Description:
  • Variable. Prints the current intensity of TAA color clamping at zero pixel velocity for the SSR effect.
  • Command. Sets the intensity of TAA color clamping at zero pixel velocity for the SSR effect. Lower values result in more accumulated frames combined, which reduces noise flickering, but increases ghosting effect (to reduce ghosting in this case you can use render_ssr_color_clamping_velocity_threshold), while higher values reduce ghosting effect, but increase flickering.
Arguments:
[0.0f; 1.0f] - available range
0.0f - default
render_ssr_color_clamping_velocity_threshold
Description:
  • Variable. Prints the current sensitivity of TAA color clamping for the SSR effect to pixel velocity change.
  • Command. Sets the sensitivity of TAA color clamping for the SSR effect to pixel velocity change. This parameter is used to reduce ghosting effect for lower Color Clamping Intensity values: it automatically increases clamping intensity for higher velocities, and disables clamping for low velocity values.
Arguments:
[0.0f; inf] - available range
0.0f - default
render_ssr_fast_tracing
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables fast tracing for the SSR effect. Fast tracing for SSR makes it possible to obtain distant reflections using low number of steps while keeping performance high. To use this option, render_ssr should be enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_ssr_increased_accuracy
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables increased accuracy for the SSR effect. Increased accuracy reduces visual artifacts around objects, which can appear at lower resolutions (lower than full), by increasing accuracy of the last step. To use this option, render_ssr should be enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_ssr_denoise
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables noise reduction for the SSR effect. To use this option, render_ssr should be enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_ssr_denoise_quality
Description:
  • Variable. Prints the current noise reduction quality level for the SSR effect defining the number of samples used.
  • Command. Sets the noise reduction quality level for the SSR effect defining the number of samples used. Higher values provide better reduction, but for a performance cost (choosing Medium is enough in most cases).
Arguments:
0 - low quality
1 - medium quality (by default)
2 - high quality
3 - ultra quality
render_ssr_denoise_intensity
Description:
  • Variable. Prints the current noise reduction intensity for the SSR effect.
  • Command. Sets the noise reduction intensity for the SSR effect. Higher values provide a less noisy, but more blurred result.
Arguments:
[0.0f; 1.0f] - available range
0.2f - default
render_ssr_denoise_radius
Description:
  • Variable. Prints the current radius of the area to be affected by noise reduction for the SSR effect.
  • Command. Sets the radius of the area to be affected by noise reduction for the SSR effect.
Arguments:
1
2 (by default)
3
render_ssr_denoise_gaussian_sigma
Description:
  • Variable. Prints the current sigma parameter of Gaussian blur used for noise reduction for the SSR effect.
  • Command. Sets the sigma parameter of Gaussian blur used for noise reduction for the SSR effect. It controls the amount of blur applied.
Arguments:
[0.0f; 100.0f] - available range
10.0f - default
render_ssr_denoise_threshold
Description:
  • Variable. Prints the current threshold value for color difference of neighboring pixels used for noise reduction for the SSR effect.
  • Command. Sets the threshold value for color difference of neighboring pixels used for noise reduction for the SSR effect. Blur is applied when the color difference is less than the threshold value.
    Notice
    Setting too high values result in blurring the whole image.
Arguments:
[0.0f; 1.0f] - available range
0.1f - default
render_ssr_resolution
Description:
  • Variable. Prints the current resolution of screen space reflections.
  • Command. Sets the resolution of screen space reflections. To use this option, render_ssr should be enabled.
Arguments:
0 - quarter resolution
1 - half resolution (by default)
2 - full resolution
render_ssr_resolution_depth
Description:
  • Variable. Prints the current resolution of the depth buffer used for SSR calculation.
  • Command. Sets the resolution of the depth buffer used for SSR calculation. It affects detailing of reflections of tiny objects. To use this option, render_ssr should be enabled.
Arguments:
0 - quarter resolution (by default)
1 - half resolution
2 - full resolution
render_ssr_resolution_color
Description:
  • Variable. Prints the current resolution of the color buffer used for SSR calculation.
  • Command. Sets the resolution of the color buffer used for SSR calculation. It significantly affects performance. To use this option, render_ssr should be enabled.
Arguments:
0 - quarter resolution (by default)
1 - half resolution
2 - full resolution
render_ssr_num_rays
Description:
  • Variable. Prints the current number of SSR rays per pixel that are used to calculate rough refrections.
  • Command. Sets the number of SSR rays per pixel that are used to calculate rough refrections. To use this option, render_ssr should be enabled.
Arguments:
[1; 64] - available range
4 - default
render_ssr_num_steps
Description:
Arguments:
[1; 64] - available range
16 - default
render_ssr_step_size
Description:
  • Variable. Prints the current size of the trace step used for SSR calculation.
  • Command. Sets the size of the trace step used for SSR calculation. Higher values result in longer traces (tiny objects may become missing), lower values produce more detailed reflections of tiny objects. To use this option, render_ssr should be enabled.
Arguments:
[0.0f; inf] - available range
0.5f - default
render_ssr_noise_ray
Description:
  • Variable. Prints the current intensity of the ray noise used for SSR calculation.
  • Command. Sets the intensity of the ray noise used for SSR calculation. It is used to reduce the banding effect on rough reflections. To use this option, render_ssr should be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.5f - default
render_ssr_noise_step
Description:
  • Variable. Prints the current intensity of the step noise used for SSR calculation.
  • Command. Sets the intensity of the step noise used for SSR calculation. It is used to reduce the banding effect of tracing. To use this option, render_ssr should be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.5f - default
render_ssr_visibility_roughness_min
Description:
  • Variable. Prints the current minimum roughness value, starting from which the SSR effect begins to fade out.
  • Command. Sets the minimum roughness value, starting from which the SSR effect begins to fade out. It allows reducing noise of reflections on rough materials. To use this option, render_ssr should be enabled.
Arguments:
[0.0f; 1.0f] - available range
1.0f - default
render_ssr_visibility_roughness_max
Description:
  • Variable. Prints the current maximum roughness value, starting from which the SSR effect is not rendered.
  • Command. Sets the maximum roughness value, starting from which the SSR effect is not rendered. It allows reducing noise of reflections on rough materials. To use this option, render_ssr should be enabled.
Arguments:
[0.0f; 1.0f] - available range
1.0f - default
render_ssr_threshold
Description:
  • Variable. Prints the current value that limits imitation of reflections in areas where SSR cannot get information.
  • Command. Sets the value that limits imitation of reflections in areas where SSR cannot get information. Higher values make the effect less pronounced. To use this option, render_ssr should be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - default
render_ssr_threshold_occlusion
Description:
  • Variable. Prints the current value that limits imitation of environment cubemap occlusion in areas where SSR cannot get information.
  • Command. Sets the value that limits imitation of environment cubemap occlusion in areas where SSR cannot get information. Higher values make the effect less pronounced. This parameter is mainly used for indoor environment to correct false reflections on occluded areas (false reflections are replaced with black color). For outdoor environment higher values of this parameter are recommended. To use this option, render_ssr should be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - default
render_ssr_normal_bias
Description:
  • Variable. Prints the current shifting of the ray starting position along the normal vector.
  • Command. Sets the shifting of the ray starting position along the normal vector. Can be adjusted to fine-tune reflections of small objects at far distances. Recommended for narrow FOV angles. To use this option, render_ssr should be enabled.
Arguments:
[0.0f; 1.0f] - available range
1.0f - default
render_ssr_view_bias
Description:
  • Variable. Prints the current shifting of the ray starting position along the view vector.
  • Command. Sets the shifting of the ray starting position along the view vector. Can be adjusted to fine-tune reflections of small objects at far distances. Recommended for narrow FOV angles. To use this option, render_ssr should be enabled.
Arguments:
[0.0f; 1.0f] - available range
1.0f - default
render_ssrtgi
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables SSRTGI (Screen-Space Ray-Traced Global Illumination) technology.
Arguments:
0 - disabled
1 - enabled (by default)
render_ssrtgi_fast_tracing
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables fast tracing for the SSRTGI. This option dynamically changes the step size to obtain indirect illumination bounces using low number of steps while keeping performance high. Disabling this option improves quality, but significantly reduces performance. To use this option, the SSRTGI effect should be enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_ssrtgi_increased_accuracy
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables increased accuracy for the SSRTGI. This option reduces visual artifacts by increasing accuracy of the last step. To use this option, the SSRTGI effect should be enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_ssrtgi_noise_ray
Description:
  • Variable. Prints the current intensity of the ray noise used for the SSRTGI calculation.
  • Command. Sets the intensity of the ray noise used for the SSRTGI calculation. This parameter is used to reduce the banding effect. The higher the value, the less pronounced the banding effect is. To use this option, the SSRTGI effect should be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.5f - default
render_ssrtgi_noise_step
Description:
  • Variable. Prints the current intensity of the step noise used for SSRTGI calculation.
  • Command. Sets the intensity of the step noise used for SSRTGI calculation. This parameter is used to reduce the banding effect. The higher the value, the less pronounced the banding effect is. To use this option, the SSRTGI effect should be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.5f - default
render_ssrtgi_num_rays
Description:
  • Variable. Prints the current number of rays used for SSRTGI calculation.
  • Command. Sets the number of rays used for SSRTGI calculation. The higher the value, the better the quality. However, this option significantly affects performance. To use this option, the SSRTGI effect should be enabled.
Arguments:
[1; 1024] - available range
8 - default
render_ssrtgi_num_steps
Description:
  • Variable. Prints the current number of steps used for SSRTGI calculation.
  • Command. Sets the number of steps used for SSRTGI calculation. The higher the value, the better the quality. However, this option significantly affects performance. To use this option, the SSRTGI effect should be enabled.
Arguments:
[1; 256] - available range
8 - default
render_ssrtgi_resolution
Description:
  • Variable. Prints the current resolution of SSRTGI.
  • Command. Sets the resolution of SSRTGI. To use this option, SSRTGI effect should be enabled.
Arguments:
0 - quarter resolution
1 - half resolution (by default)
2 - full resolution
render_ssrtgi_resolution_depth
Description:
  • Variable. Prints the current resolution of the depth buffer used for SSRTGI calculation.
  • Command. Sets the resolution of the depth buffer used for SSRTGI calculation. To use this option, SSRTGI effect should be enabled.
Arguments:
0 - quarter resolution (by default)
1 - half resolution
2 - full resolution
render_ssrtgi_step_size
Description:
  • Variable. Prints the current size of the step used for SSRTGI calculation.
  • Command. Sets the size of the step used for SSRTGI calculation. To use this option, the SSRTGI effect should be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - default
render_ssrtgi_upscaling
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables upscaling for the SSRTGI. This option makes the quality of edges in half and quarter resolution look closer to full. To use this option, the SSRTGI effect should be enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_sssss
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables Screen-Space Subsurface Scattering (SSSSS) effect. This effect is used to imitate human skin, wax, etc.
Arguments:
0 - disabled (by default)
1 - enabled
render_sssss_diffuse
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables SSSSS calculation for diffuse lighting (directional lights). To use this option, the SSSSS effect should be enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_sssss_ambient
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables SSSSS calculation for ambient lighting (environment). To use this option, the SSSSS effect should be enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_sssss_radius
Description:
  • Variable. Prints the current subsurface scattering radius — distance in the screen space, within which colors are sampled.
  • Command. Sets the subsurface scattering radius — distance in the screen space, within which colors are sampled. It controls how much wrinkles, pores and cavities are blurred and highlighted. The higher the value, the farther subsurface scattering reaches. Too high values result in the ghosting effect. By the minimum value of 0, no subsurface scattering is rendered. To use this option, the SSSSS effect should be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - default
render_sssss_color
Description:
  • Variable. Prints the value of the subsurface scattering radius color.
  • Command. Sets the value of the subsurface scattering radius color used to simulate the subsurface component of skin lighting, i.e. the light that bounces inside the subsurface tissue layers (epidermis and dermis) before exiting. For skin, subsurface color is reddish, due to blood circulating in skin tissues. To use this option, SSSSS effect should be enabled.
Arguments:
vec4(1.0f, 0.0f, 0.0f, 1.0f) - default value
render_sssss_max_threshold
Description:
  • Variable. Prints the current threshold for the material's Translucent parameter equal to 1 (maximum tranclucency).
  • Command. Sets the threshold for the material's Translucent parameter equal to 1 (maximum tranclucency). To use this option, the SSSSS effect should be enabled.
Arguments:
[0.0f; inf] - available range
10.0f - default
render_sssss_min_threshold
Description:
  • Variable. Prints the current threshold for the material's Translucent parameter equal to 0 (minimum tranclucency).
  • Command. Sets the threshold for the material's Translucent parameter equal to 0 (minimum tranclucency). To use this option, the SSSSS effect should be enabled.
Arguments:
[0.0f; inf] - available range
4.0f - default
render_sssss_noise_ray
Description:
  • Variable. Prints the current intensity of the ray noise used for SSSSS calculation to reduce banding artifacts of tracing.
  • Command. Sets the intensity of the ray noise used for SSSSS calculation to reduce banding artifacts of tracing. Higher values make banding less visible. To use this option, the SSSSS effect should be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.5f - default
render_sssss_noise_step
Description:
  • Variable. Prints the current intensity of the step noise used for SSSSS calculation to reduce banding artifacts of tracing.
  • Command. Sets the intensity of the step noise used for SSSSS calculation to reduce banding artifacts of tracing. Higher values make banding less visible. To use this option, the SSSSS effect should be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.5f - default
render_sssss_interleaved
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables interleaved rendering mode for the SSSSS effect. Enables rendering of the effect in only half or quarter of all pixels with subsequent reconstruction of neighboring pixels using the data from previous frames, significantly improving performance. The effect is cumulative and works best with Temporal Filter, which reduces ghosting and noise artifacts.
Arguments:
0 - disabled (by default)
1 - enabled
render_sssss_interleaved_color_clamping
Description:
  • Variable. Prints the current color clamping mode for the SSSSS effect used to reduce ghosting.
  • Command. Sets the color clamping mode for the SSSSS effect used to reduce ghosting. Higher values increase clamping intensity, but may cause flickering (to reduce flickering you can choose High + Velocity). When disabled, translucency has a lag as it is several frames behind.
Arguments:
0 - disabled
1 - low (by default)
2 - medium
3 - high
4 - high + velocity
render_sssss_interleaved_samples
Description:
  • Variable. Prints the current number of pixels to be skipped when rendering the SSSSS effect with subsequent reconstruction of neighboring pixels using the data from previous frames.
  • Command. Sets the number of pixels to be skipped when rendering the SSSSS effect with subsequent reconstruction of neighboring pixels using the data from previous frames.
Arguments:
0 - 1.0 * width x 0.5 * height (by default)
1 - 0.5 * width x 0.5 * height
render_sssss_resolution
Description:
  • Variable. Prints the current resolution mode to be used for the SSSSS effect.
  • Command. Sets the resolution mode to be used for the SSSSS effect. To use this option, the SSSSS effect should be enabled.
Arguments:
0 - quarter
1 - half (by default)
2 - full
render_sssss_quality
Description:
  • Variable. Prints the current quality of the Screen-Space Subsurface Scattering (SSSSS) effect.
  • Command. Sets the quality of the Screen-Space Subsurface Scattering (SSSSS) effect. To use this option, the SSSSS effect should be enabled.
Arguments:
0 - low
1 - medium (by default)
2 - high
3 - ultra
render_sssss_taa_fix_flicker
Description:
Controls TAA for Screen-Space Subsurface Scattering similar to render_taa_fix_flicker (see for detailed information).
render_sssss_taa_antialiasing_in_motion
Description:
Controls TAA for Screen-Space Subsurface Scattering similar to render_taa_antialiasing_in_motion (see for detailed information).
render_sssss_taa_frames_by_color
Description:
Controls TAA for Screen-Space Subsurface Scattering similar to render_taa_frames_by_color (see for detailed information).
render_sssss_taa_frames_by_velocity
Description:
Controls TAA for Screen-Space Subsurface Scattering similar to render_taa_frames_by_velocity (see for detailed information).
render_sssss_taa_preserve_details
Description:
Controls TAA for Screen-Space Subsurface Scattering similar to render_taa_preserve_details (see for detailed information).
render_sssss_taa_frame_count
Description:
Controls TAA for Screen-Space Subsurface Scattering similar to render_taa_frame_count (see for detailed information).
render_sssss_taa_frames_velocity_threshold
Description:
Controls TAA for Screen-Space Subsurface Scattering similar to render_taa_frames_velocity_threshold (see for detailed information).
render_sssss_taa_max_frames_by_velocity
Description:
Controls TAA for Screen-Space Subsurface Scattering similar to render_taa_max_frames_by_velocity (see for detailed information).
render_sssss_taa_min_frames_by_velocity
Description:
Controls TAA for Screen-Space Subsurface Scattering similar to render_taa_min_frames_by_velocity (see for detailed information).
render_sssss_taa_pixel_offset
Description:
Controls TAA for Screen-Space Subsurface Scattering similar to render_taa_pixel_offset (see for detailed information).
render_sssss_taa_catmull_resampling
Description:
Controls TAA for Screen-Space Subsurface Scattering similar to render_taa_catmull_resampling (see for detailed information).
render_sssss_taa_samples
Description:
Controls TAA for Screen-Space Subsurface Scattering similar to render_taa_samples (see for detailed information).
render_translucent_color
Description:
  • Variable. Prints the color used for translucent objects globally.
  • Command. Sets the color to be used for translucent objects globally. When light shines on one side of the object, the other side is partially illuminated with this color.
Arguments:
vec4(1.0f, 1.0f, 1.0f, 1.0f) - default value (white)
render_ssbevel
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables rendering of screen-space bevels.
Arguments:
0 - disabled
1 - enabled (by default)
render_ssbevel_vertex_normal
Description:
  • Variable. Prints the current rendering mode of the screen-space bevels.
  • Command. Sets the rendering mode of the screen-space bevels. To use this option, render_ssbevel should be enabled.
    • Better Edges — smooth vertex and surface normals of the object. The relief created by using Normal Mapping is smoothed along with the mesh edges.
    • Better Normals — only vertex normals are smooth. Only edges of the mesh geometry are bevelled.
Arguments:
0 - Better Edges (by default)
1 - Better Normals
render_ssbevel_quality
Description:
  • Variable. Prints the current quality mode for the screen-space bevels.
  • Command. Sets the quality mode for the screen-space bevels.
Arguments:
0 - low
1 - medium (by default)
2 - high
3 - ultra
render_ssbevel_radius
Description:
  • Variable. Prints the current size of the screen-space bevel effect.
  • Command. Sets the size of the screen-space bevel effect. To use this option, render_ssbevel should be enabled.
Arguments:
[0.0f; inf] - available range
0.01f - default
render_ssbevel_noise
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables noise that smoothes screen-space bevels.It is recommended to use the noise with TAA enabled to avoid visual artifacts. The bevel noise is applied at a certain distance from the camera (i.e. if the camera is too far from the object with bevels, the noise won't be applied). To use this option, render_ssbevel should be enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_ssdirt
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the Screen-Space Dirt effect.
Arguments:
0 - disabled (by default)
1 - enabled
render_ssdirt_quality
Description:
  • Variable. Prints the current quality mode for the screen-space dirt effect.
  • Command. Sets the quality mode for the screen-space dirt effect. To use this option, render_ssdirt should be enabled.
Arguments:
0 - low
1 - medium
2 - high (by default)
3 - ultra
render_ssdirt_resolution
Description:
  • Variable. Prints the current resolution mode for the screen-space dirt effect.
  • Command. Sets the resolution mode for the screen-space dirt effect. To use this option, render_ssdirt should be enabled.
Arguments:
0 - quarter
1 - half (by default)
2 - full
render_ssdirt_intensity
Description:
  • Variable. Prints the current intensity of the screen-space dirt effect.
  • Command. Sets the intensity of the screen-space dirt effect. To use this option, render_ssdirt should be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - default
render_ssdirt_radius
Description:
  • Variable. Prints the current radius of the screen-space dirt effect area.
  • Command. Sets the radius of the screen-space dirt effect area. To use this option, render_ssdirt should be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - default
render_ssdirt_threshold
Description:
  • Variable. Prints the current threshold of the screen-space dirt effect.
  • Command. Sets the threshold of the screen-space dirt effect. Determines the depth limit for the effect in areas where information cannot be obtained. To use this option, render_ssdirt should be enabled.
Arguments:
[0.0f; 1.0f] - available range
1.0f - default
render_ssdirt_angle_bias
Description:
  • Variable. Prints the current angle bias value used for the screen-space dirt effect.
  • Command. Sets the angle bias value used for the screen-space dirt effect. Determines the angle limit for the effect in areas where information cannot be obtained. To use this option, render_ssdirt should be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.35f - default
render_ssdirt_perspective
Description:
  • Variable. Prints the current perspective value used for the screen-space dirt effect.
  • Command. Sets the perspective value used for the screen-space dirt effect. Determines degree of impact of distance from the camera on the radius of the screen-space dirt effect. To use this option, render_ssdirt should be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.02f - default
render_ssdirt_increase_accuracy
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the increased accuracy for the screen-space dirt effect. To use this option, render_ssdirt should be enabled.
    Notice
    This option should be used to remove visual artefacts along the screen edges, if they exist. Otherwise, it should be disabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_ssdirt_cavity_texture_size
Description:
Arguments:
[0.0f; inf] - available range
1.0f - default
render_ssdirt_cavity_color
Description:
  • Variable. Prints the color multiplier for the cavity albedo texture used for the screen-space dirt effect.
  • Command. Sets the color multiplier for the cavity albedo texture used for the screen-space dirt effect.

To use this option, render_ssdirt should be enabled.

Arguments:
vec4(0.26f, 0.24f, 0.21f, 1.0f) - default value
render_ssdirt_cavity_exponent
Description:
  • Variable. Prints the current cavity exponent value used for the screen-space dirt effect.
  • Command. Sets the cavity exponent value used for the screen-space dirt effect. This value defines the rate of gradual change of intensity along the radius for cavities. To use this option, render_ssdirt should be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - default
render_ssdirt_cavity_metalness
Description:
  • Variable. Prints the current cavity metalness of the screen-space dirt effect.
  • Command. Sets the cavity metalness of the screen-space dirt effect. This value is the metalness multiplier used for cavities: when set to 0, the effect does not modify the metalness buffer in cavities. To use this option, render_ssdirt should be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.0f - default
render_ssdirt_cavity_metalness_visibility
Description:
Arguments:
[0.0f; 1.0f] - available range
0.0f - default
render_ssdirt_convexity_texture_size
Description:
  • Variable. Prints the current texture scaling factor for convexities in the screen-space dirt effect.
  • Command. Sets the texture scaling factor for convexities in the screen-space dirt effect. To use this option, render_ssdirt should be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - default
render_ssdirt_convexity_color
Description:
  • Variable. Prints the color multiplier for the convexity albedo texture used for the screen-space dirt effect.
  • Command. Sets the color multiplier for the convexity albedo texture used for the screen-space dirt effect.

To use this option, render_ssdirt should be enabled.

Arguments:
vec4(0.48f, 0.44f, 0.39f, 1.0f) - default value
render_ssdirt_convexity_exponent
Description:
  • Variable. Prints the current convexity exponent value used for the screen-space dirt effect.
  • Command. Sets the convexity exponent value used for the screen-space dirt effect. This value is the rate of gradual change of intensity along the radius for convexities. To use this option, render_ssdirt should be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - default
render_ssdirt_convexity_metalness
Description:
  • Variable. Prints the current convexity metalness of the Screen-Space Dirt effect.
  • Command. Sets the convexity metalness of the Screen-Space Dirt effect. Metalness multiplier used for convexities, when set to 0, the effect does not modify metalness buffer in convexities. To use this option, render_ssdirt should be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.0f - default
render_ssdirt_convexity_metalness_visibility
Description:
Arguments:
[0.0f; 1.0f] - available range
0.0f - default

Lighting and Shading#

Operations on lighting and shading.

render_environment
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables rendering of the environment.
Arguments:
0 - disabled
1 - enabled (by default)
render_environment_correct_roughness
Description:
  • Variable. Prints the current environment roughness correction.
  • Command. Sets the environment roughness correction.
Arguments:
0 - off (by default)
1 - low
2 - medium
3 - high
4 - ultra
render_environment_cubemap_blend
Description:
  • Variable. Prints the current environment cubemap blending mode.
  • Command. Sets the environment cubemap blending mode.
Arguments:
0 - alpha blend (by default)
1 - additive blend
2 - multiply
3 - overlay
render_environment_haze
Description:
  • Variable. Prints the current mode of haze rendering.
  • Command. Sets the mode of haze rendering.
Arguments:
0 - haze disabled
1 - haze colored the specific color
2 - haze colored in accordance with the sky LUT (by default)
render_environment_haze_gradient
Description:
  • Variable. Prints the current environment haze gradient mode.
  • Command. Sets the environment haze gradient mode.
Arguments:
0 - better for short distance range (by default)
1 - better for long distance range
2 - should be used for physically based haze simulation
render_lightmap_color
Description:
  • Variable. Prints the color multiplier for lightmaps.
  • Command. Sets the color multiplier for lightmaps.
Arguments:
vec4_one - default value (white)
render_lights_max_per_batch
Description:
  • Variable. Prints the current maximum number of lights per batch call.
  • Command. Sets the maximum number of lights per batch call.
Arguments:
[32; 1024] - available range
1024 - default
0 disables batching optimization
render_lights_tile_grid_size
Description:
  • Variable. Prints the current grid size in tiles per axis.
  • Command. Sets the grid size in tiles per axis.
Arguments:
[1; 32] - available range
8 - default
render_lights_forward_per_object_env
Description:
  • Variable. Prints the current maximum number of environment probes per object (available only for materials rendered in the forward rendering pass).
  • Command. Sets the maximum number of environment probes per object (available only for materials rendered in the forward rendering pass).
Arguments:
[0; 128] - available range
4 - default
render_lights_forward_per_object_omni
Description:
  • Variable. Prints the current maximum number of omni lights per object (available only for materials rendered in the forward rendering pass).
  • Command. Sets the maximum number of omni lights per object (available only for materials rendered in the forward rendering pass).
Arguments:
[0; 128] - available range
4 - default
render_lights_forward_per_object_proj
Description:
  • Variable. Prints the current maximum number of projected lights per object (available only for materials rendered in the forward rendering pass).
  • Command. Sets the maximum number of projected lights per object (available only for materials rendered in the forward rendering pass).
Arguments:
[0; 128] - available range
4 - default
render_lights_forward_per_object_voxel
Description:
  • Variable. Prints the current maximum number of voxel probes per object (available only for materials rendered in the forward rendering pass).
  • Command. Sets the maximum number of voxel probes per object (available only for materials rendered in the forward rendering pass).
Arguments:
[0; 128] - available range
4 - default
render_lights_forward_per_object_world
Description:
  • Variable. Prints the current maximum number of world lights per object (available only for materials rendered in the forward rendering pass).
  • Command. Sets the maximum number of world lights per object (available only for materials rendered in the forward rendering pass).
Arguments:
[0; 128] - available range
4 - default
render_lights_lens_flares
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables rendering of per-light lens flares flares.
Arguments:
0 - disabled
1 - enabled (by default)
render_lights_interleaved
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables interleaved reconstruction mode for rendering lights during the deferred pass on and off. When enabled, lights are rendered in half resolution with subsequent reconstruction of neighboring pixels using the data from previous frames. This mode requires a high framerate (60+ FPS), otherwise anti-aliasing quality reduces and ghosting effect becomes more pronounced. Recommended for relatively static scenes which contain a lot of light sources and do not have a lot of reflective surfaces (in case of small number of light sources may reduce performance).
Arguments:
0 - disabled (by default)
1 - enabled
render_lights_interleaved_catmull_resampling
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the Catmull-Rom resampling for interleaved lights rendering mode. It allows you to reduce image blurring when the camera moves forward/backward.
Arguments:
0 - disabled (by default)
1 - enabled
render_lights_interleaved_color_clamping
Description:
  • Variable. Prints the current color clamping mode for interleaved lights rendering.
  • Command. Sets the color clamping mode for interleaved lights rendering. Can be used to reduce ghosting effect: higher values increase clamping intensity but may cause flickering on rippled reflective surfaces (as this mode is not so good at object's edges). When disabled, shadows and reflections have a lag as they are several frames behind.
Arguments:
0 - disabled
1 - low (by default)
2 - medium
3 - high
4 - high + velocity
render_lights_interleaved_samples
Description:
  • Variable. Prints the current size of reduced lights buffer used for interleaved lights rendering relative to original size.
  • Command. Sets the size of reduced lights buffer used for interleaved lights rendering relative to original size.
Arguments:
0 - 1 x 2 (1.0 * width x 0.5 * height) (by default)
1 - 2 x 2 (0.5 * width x 0.5 * height)
render_ssao
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables screen-space ambient occlusion.
Arguments:
0 - disabled
1 - enabled (by default)
render_ssao_denoise_quality
Description:
  • Variable. Prints the current noise reduction quality level for the SSAO (Screen Space Ambient Occlusion) effect defining the number of samples used.
  • Command. Sets the noise reduction quality level for the SSAO (Screen Space Ambient Occlusion) effect defining the number of samples used. Higher values provide better reduction, but for a performance cost (choosing Medium is enough in most cases).
Arguments:
0 - low
1 - medium (by default)
2 - high
3 - ultra
render_ssao_ray_tracing
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables ray tracing for SSAO (Screen Space Ambient Occlusion) calculation. When enabled, SSAO provides more realistic shadows between the objects. Ray-traced SSAO calculation is available only when the SSRTGI technique is enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_ssao_ray_tracing_denoise
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables noise reduction for the ray-traced SSAO (Screen Space Ambient Occlusion). This option reduces noise by using blur effect. Ray-traced SSAO calculation is available only when the SSRTGI technique is enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_ssao_ray_tracing_threshold
Description:
  • Variable. Prints the current threshold value for the ray-traced SSAO.
  • Command. Sets the threshold value for the ray-traced SSAO. Ray-traced SSAO calculation is available only when the SSRTGI technique is enabled.
Arguments:
[0.0f; inf] - available range
1.0f - default
render_ssao_cavity
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the cavity option for the SSAO effect. This option improves (sharpens) the look of junction contours at low resolutions, so it should be used for detail enhancement (small stones, bolts and so on).
Arguments:
0 - disabled
1 - enabled (by default)
render_ssao_cavity_intensity
Description:
  • Variable. Prints the current intensity of sharpening of contours for the cavity option.
  • Command. Sets the intensity of sharpening of contours for the cavity option.
Arguments:
[0.0f; inf] - available range
1.0f - default
render_ssao_cavity_radius
Description:
  • Variable. Prints the current size of junction contours area for the cavity option.
  • Command. Sets the size of junction contours area for the cavity option.
Arguments:
[0.0f; inf] - available range
1.0f - default
render_ssao_radius
Description:
  • Variable. Prints the current radius of SSAO (Screen Space Ambient Occlusion).
  • Command. Sets the radius of SSAO (Screen Space Ambient Occlusion).
Arguments:
[0.0f; inf] - available range
1.0f - default
render_ssao_threshold
Description:
  • Variable. Prints the current threshold value for the SSAO.
  • Command. Sets the threshold value for the SSAO.
Arguments:
[0.0f; 1.0f] - available range
0.5f - default
render_ssao_intensity
Description:
  • Variable. Prints the current intensity of the SSAO (Screen Space Ambient Occlusion) for the scene.
  • Command. Sets the intensity of the SSAO (Screen Space Ambient Occlusion) for the scene.
Arguments:
[0.0f; inf] - available range
1.0f - default
render_ssao_intensity_lighted_side
Description:
  • Variable. Prints the current intensity of the SSAO (Screen Space Ambient Occlusion) for the scene object's lighted side.
  • Command. Sets the intensity of the SSAO (Screen Space Ambient Occlusion) for the scene object's lighted side.
Arguments:
[0.0f; inf] - available range
1.0f - default
render_ssao_intensity_reflection
Description:
  • Variable. Prints the current intensity of the SSAO (Screen Space Ambient Occlusion) on reflections.
  • Command. Sets the intensity of the SSAO (Screen Space Ambient Occlusion) on reflections.
Arguments:
[0.0f; inf] - available range
1.0f - default
render_ssao_quality
Description:
  • Variable. Prints the current screen-space ambient occlusion quality.
  • Command. Sets the screen-space ambient occlusion quality.
Arguments:
0 - low
1 - medium (by default)
2 - high
3 - ultra
render_ssao_resolution
Description:
  • Variable. Prints the current screen-space ambient resolution quality.
  • Command. Sets the screen-space ambient resolution quality.
Arguments:
0 - quarter
1 - half (by default)
2 - full
render_ssao_noise
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the screen-space ambient occlusion noise.
Arguments:
0 - disabled
1 - enabled (by default)
render_gbuffer_lightmap
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the use of G-Buffer lightmap.
Arguments:
0 - disabled
1 - enabled (by default)

Shadows#

Operations on shadows.

render_shadows
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables rendering of shadows.
Arguments:
0 - disabled
1 - enabled (by default)
render_shadows_alpha_test
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables alpha test for shadows.
Arguments:
0 - disabled
1 - enabled (by default)
render_shadows_screen_space
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables screen-space shadows.
Arguments:
0 - disabled
1 - enabled (by default)
render_shadows_translucent_depth
Description:
  • Variable. Prints the current global translucence depth value defining how deep the light goes through translucent objects shifting the shadow.
  • Command. Sets the global translucence depth value defining how deep the light goes through translucent objects shifting the shadow. The higher the value, the deeper the light penetrates the object.
Arguments:
[0.0f; inf] - available range
0.1f - default
render_shadow_distance
Description:
  • Variable. Prints the current distance starting from which shadows will not be rendered.
  • Command. Sets the distance starting from which shadows will not be rendered.
Arguments:
[0.0f; inf] - available range
100.0f - default
render_shadow_distance_scale
Description:
  • Variable. Prints the current global shadow distance scale multiplier.
  • Command. Sets the global shadow distance scale multiplier.
Arguments:
[0.0f; inf] - available range
1.0f - default
render_shadow_shafts
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables shadows shafts.
Arguments:
0 - disabled (by default)
1 - enabled
render_shadow_shafts_exposure
Description:
  • Variable. Print the value of the contrast used for volumetric shadows.
  • Command. Set the contrast used for volumetric shadows. To use this feature, render_shadow_shafts should be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.5f - default value
0.0f - shadows are not seen
render_shadow_shafts_length
Description:
  • Variable. Print the value of the volumetric shadows length.
  • Command. Set the length of volumetric shadows. To use this feature, render_shadow_shafts should be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.0f - shadows are not seen
1.0f - shadows are long enough to occupy the whole screen
render_show_cascadesConfig file: *.user
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables displaying of Parallel Split Shadow Map — world shadow cascades.
Arguments:
0 - disabled (by default)
1 - enabled
render_shadows_filter_mode
Description:
  • Variable. Prints the current global filtering mode to be used for shadows from all light sources by default.
  • Command. Sets the global filtering mode to be used for shadows from all light sources by default. This mode determines the quality of soft shadows. Higher quality produces smoother shadows. When disabled no filtering is performed, the stair-step effect is clearly seen at the edges of shadows.
Arguments:
0 - disabled
1 - low
2 - medium (by default)
3 - high
4 - ultra
render_shadows_filter_noise
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables noise for soft shadows filtering.
Arguments:
0 - disabled
1 - enabled (by default)
render_shadows_penumbra_mode
Description:
  • Variable. Prints the current global quality mode to be used for rendering penumbra from all light sources by default.
  • Command. Sets the global quality mode to be used for rendering penumbra from all light sources by default. This mode enables simulation of real-world shadows by keeping sharp contact shadows closer to the base and softening the farther the shadow stretches away. Higher values produce softer shadows. When disabled shadow edges are crisp and sharp (no shadow softness at all).
Arguments:
0 - disabled
1 - low (by default)
2 - medium
3 - high
4 - ultra
render_shadows_penumbra_noise
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables noise for penumbra rendering.
Arguments:
0 - disabled
1 - enabled (by default)
render_shadows_world_lerp_cascades
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables linear interpolation of shadow cascades, making transitions between cascades smoother. This option significantly affects performance, as 2 shadow maps are rendered in transition areas.
Arguments:
0 - disabled
1 - enabled (by default)

Geodetics#

Warning
The functionality described in this chapter is not available in the Community SDK edition.
You should upgrade to Engineering / Sim SDK edition to use it.

Operations on geodetics.

render_show_geodetic_pivotConfig file: *.user
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables rendering of geodetic pivots.
Arguments:
0 - disabled (by default)
1 - enabled

Clouds Rendering#

render_clouds_accurate_layers_sorting
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables correct sorting of intersecting cloud layers.
    Notice
    Enabling this feature may reduce ray marching quality as samples shall be distributed among all layers.
Arguments:
0 - disabled (by default)
1 - enabled
render_clouds_depth_based_reconstruction
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables using the clouds ray-marched depth for upsampling the downsampled clouds without obscuring the geometry and reprojection depending on the cloud depth. Recommended for flying through clouds.
Arguments:
0 - disabled (by default)
1 - enabled
render_clouds_depth_based_reconstruction_threshold
Description:
Arguments:
[0.0f; inf] - available range
100.0f - default
render_clouds_distortion_texture
Description:
  • Variable. Prints the current texture type to be used for clouds distortion.
  • Command. Sets the texture type to be used for clouds distortion. This parameter has a significant impact on performance: using a 2D texture is more performance-friendly, but results in excessive vertical distortion of clouds.
Arguments:
0 - 2D texture providing better performance (by default)
1 - 3D texture providing better quality
render_clouds_downsampling_rendering
Description:
  • Variable. Prints the current downsampling rendering mode for clouds.
  • Command. Sets the downsampling rendering mode for clouds. This parameter determines clouds resolution based on current screen resolution. It has a significant impact on performance.
Arguments:
0 - full
1 - half (by default)
2 - quarter
render_clouds_dynamic_coverage_area
Description:
  • Variable. Prints the current dynamic coverage area for clouds.
  • Command. Sets the dynamic coverage area for clouds. This parameter determines visibility distance for coverage of FieldWeather objects.
Arguments:
[10.0f; 400000.0f] - available range
10000.0f - default
render_clouds_dynamic_coverage_resolution
Description:
  • Variable. Prints the current dynamic coverage resolution for clouds.
  • Command. Sets the dynamic coverage resolution for clouds. This parameter determines the quality of dynamic coverage texture for FieldWeather objects. Higher values make it possible to preserve texture details at high distances.
Arguments:
[16; 8192] - available range
256 - default
render_clouds_ground_shadows
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables rendering of shadows from the clouds on the ground.
Arguments:
0 - disabled
1 - enabled (by default)
render_clouds_fix_coverage_tiling
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables tiling reduction for the clouds coverage texture. Such tiling becomes noticeable in large-scale worlds when observing clouds at significant distances.
    Notice
    When enabled, additional texture fetching is performed, which affects performance, so use it wisely.
Arguments:
0 - disabled (by default)
1 - enabled
render_clouds_interleaved_rendering
Description:
Arguments:
0 - disabled (by default)
1 - 2×2
2 - 4×4
3 - 8×8
render_clouds_interleaved_rendering_temporal
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables temporal accumulation of noises for the interleaved sampling.
    Notice
Arguments:
0 - disabled
1 - enabled (by default)
render_clouds_lighting_cone_radius
Description:
Arguments:
[0.0f; 1.0f] - available range
0.3f - default
render_clouds_lighting_quality
Description:
  • Variable. Prints the current lighting quality for clouds.
  • Command. Sets the lighting quality for clouds. This parameter determines the number of samples used to calculate lighting for clouds.
Arguments:
0 - low
1 - medium (by default)
2 - high
3 - ultra
render_clouds_lighting_tracelength
Description:
Arguments:
[1.0f; 2048.0f] - available range
230.0f - default
render_clouds_noise_step
Description:
  • Variable. Prints the current noise step parameter value for clouds.
  • Command. Sets the noise step parameter value for clouds.
Arguments:
[0.0f; 1.0f] - available range
0.3f - default
render_clouds_noise_step_skip
Description:
Arguments:
[0.0f; 1.0f] - available range
0.3f - default
render_clouds_noise_iterations
Description:
Arguments:
[0.0f; 1.0f] - available range
0.1f - default
render_clouds_noise_lighting
Description:
Arguments:
[0.0f; 1.0f] - available range
0.3f - default
render_clouds_rounded
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables visual curving for clouds to make them look more natural imitating planet's curvature.
Arguments:
0 - disabled
1 - enabled (by default)
render_clouds_rounded_planet_radius
Description:
  • Variable. Prints the current planet radius to be used for clouds curving.
  • Command. Sets the planet radius to be used for clouds curving.
Arguments:
[100.0f; inf] - available range
200000.0f - default
render_clouds_samples_count
Description:
  • Variable. Prints the current number of samples used for clouds rendering.
  • Command. Sets the number of samples used for clouds rendering.
Arguments:
0 - 1 sample, low quality
1 - 3 samples, medium quality
2 - 5 samples, high quality (by default)
3 - 6 samples, ultra quality
render_clouds_sampling_quality
Description:
  • Variable. Prints the current sampling quality for clouds.
  • Command. Sets the sampling quality for clouds. This parameter determines the number of samples used and affects cloud density.
Arguments:
0 - 1 sample, low quality (higher cloud density)
1 - 3 samples, medium quality (by default)
2 - 5 samples, high quality
3 - 6 samples, ultra quality (lower density, the clouds are softer)
render_clouds_soft_intersection
Description:
Arguments:
[0.0f; 100000.0f] - available range
100.0f - default
render_clouds_step_accuracy
Description:
  • Variable. Prints the current accuracy of ray marching steps.
  • Command. Sets the accuracy of ray marching steps. This parameter enables you to improve the visual look of clouds when viewed from inside a cloud layer. It reduces the noise of lighting and clouds shape for long ray marching distances, adds some noise-based blur to a sharp border at the bottom sphere of the cloud layer (rounded) and removes popping effect when leaving a rounded cloud layer. Lower numbers gain more performance.
Arguments:
[0.0f; 1.0f] - available range
0.5f - default
render_clouds_transparent_order
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables rendering of clouds after all transparent objects (except water).
Arguments:
0 - disabled (by default)
1 - enabled

Terrain Rendering#

The commands described below are intended for configuring Landscape Terrain object (the ObjectLandscapeTerrain class).

Warning
Changing some of the parameters below triggers reloading of the Landscape Terrain graphic data, so it's not recommended to do it at run time.
render_landscape_cache_cpu_size
Description:
  • Variable. Prints the current limit of CPU cache in percentage of the total memory.
  • Command. Sets the limit of CPU cache in percentage of the total memory.
Arguments:
[1; 100] - available range
10 - default
render_landscape_cache_gpu_size
Description:
  • Variable. Prints the current cache memory limit in percentage of the total GPU memory.
  • Command. Sets the cache memory limit in percentage of the total GPU memory.
Arguments:
[1; 100] - available range
4 - default
render_landscape_cache_gpu_life_time
Description:
  • Variable. Prints the current GPU cache lifetime in frames.
  • Command. Sets the GPU cache lifetime in frames.
Arguments:
[1; 60] - available range
4 - default
render_landscape_terrain_culling_aggressive
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables optimization of frustum culling. When enabled, the number of culled polygons increases thereby increasing performance. If you have some issues with polygons rendering, try to disable the option (however, note that performance may drop).
Arguments:
0 - disabled
1 - enabled (by default)
render_landscape_terrain_culling_back_face
Description:
  • Variable. Prints the current threshold for backface culling.
  • Command. Sets the threshold for backface culling. The value is the multiplier for the angle between the tessellation patch normal and the camera's view direction and used for culling the tessellation patches that are turned to the camera by their back faces. The higher the value, the less the angle between the patch normal and the camera's direction is required for culling this patch.
Arguments:
[0.0f; 1.0f] - available range
0.5f - default
render_landscape_terrain_culling_frustum_padding
Description:
  • Variable. Prints the current value, by which the borders of the current frustum are increased.
  • Command. Sets the value, by which the borders of the current frustum are increased. Frustum culling is performed for the frustum of the increased size. By the maximum value of 1, the frustum borders will be increased by the size of the current frustum.
Arguments:
[0.0f; 1.0f] - available range
0.1f - default
render_landscape_terrain_culling_oblique_frustum
Description:
  • Variable. Prints the current multiplier for culling of tessellation patches beyond the oblique frustum plane.
  • Command. Sets the multiplier for culling of tessellation patches beyond the oblique frustum plane. The higher the value, the more patches will be culled.
Arguments:
[0.0f; 1.0f] - available range
0.9f - default
render_landscape_terrain_detail_resolution_additional_mask
Description:
Arguments:
0 - 64×64
1 - 128×128
2 - 256×256
3 - 512×512
4 - 1024×1024 (by default)
5 - 2048×2048
6 - 4096×4096
7 - 8192×8192
8 - 16384×16384
render_landscape_terrain_detail_resolution_albedo
Description:
Arguments:
0 - 64×64
1 - 128×128
2 - 256×256
3 - 512×512
4 - 1024×1024 (by default)
5 - 2048×2048
6 - 4096×4096
7 - 8192×8192
8 - 16384×16384
render_landscape_terrain_detail_resolution_height
Description:
Arguments:
0 - 64×64
1 - 128×128
2 - 256×256
3 - 512×512
4 - 1024×1024 (by default)
5 - 2048×2048
6 - 4096×4096
7 - 8192×8192
8 - 16384×16384
render_landscape_terrain_mask_dithering
Description:
Arguments:
[0.0f; 1.0f] - available range
1.0f - default
render_landscape_terrain_geometry_fade_lods
Description:
  • Variable. Prints the current intensity of fading between levels of terrain geometry tessellation.
  • Command. Sets the intensity of fading between levels of terrain geometry tessellation.
Arguments:
[0.0f; 1.0f] - available range
0.5f - default
render_landscape_terrain_geometry_holes
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables rendering of decal-based terrain holes.
Arguments:
0 - disabled
1 - enabled (by default)
render_landscape_terrain_geometry_polygon_size
Description:
  • Variable. Prints the current size of Landscape Terrain polygons in units.
  • Command. Sets the size of Landscape Terrain polygons in units. The value defines the maximum allowed density of Landscape Terrain geometry.
Arguments:
[0.0f; 1000.0f] - available range
0.01f - default
render_landscape_terrain_geometry_progression
Description:
Arguments:
[0.0f; 50.0f] - available range
1.5f - default
render_landscape_terrain_geometry_subpixel_reduction
Description:
  • Variable. Prints the current minimum ratio of a polygon size (in screen space) to the size of an area seen in the viewport.
  • Command. Sets the minimum ratio of a polygon size (in screen space) to the size of an area seen in the viewport. If the ratio calculated for the polygon is less than this value, such polygon will be removed.
Arguments:
[0.0f; 50.0f] - available range
6.0f - default
render_landscape_terrain_texel_size
Description:
  • Variable. Prints the current texel size of the Landscape Terrain render textures in units.
  • Command. Sets the texel size of the Landscape Terrain render textures in units. The value represents the maximum level of detail for the albedo, normal and height components of the Landscape Terrain.
Arguments:
[0.0001f; 1.0f] - available range
0.001f - default
render_landscape_terrain_visible_distance
Description:
  • Variable. Prints the current visibility distance of the Landscape Terrain in units.
  • Command. Sets the visibility distance of the Landscape Terrain in units.
Arguments:
[0.0f; inf] - available range
30000.0f - default
render_landscape_terrain_vt_detail_level_by_angle
Description:
  • Variable. Prints the current MIP level offset for texels of detail textures on polygons that are turned to the camera at a low angle.
  • Command. Sets the MIP level offset for texels of detail textures on polygons that are turned to the camera at a low angle.
Arguments:
[0.0f; 1.0f] - available range
0.95f - default
render_landscape_terrain_vt_filtering
Description:
  • Variable. Prints the current filtering mode of the Landscape Terrain textures.
  • Command. Sets the filtering mode of the Landscape Terrain textures.
Arguments:
0 - low (use the lower MIP level)
1 - medium (use the higher MIP level) (by default)
2 - high (linearly interpolate between adjacent MIP levels)
render_landscape_terrain_vt_memory_size
Description:
  • Variable. Prints a value indicating the current size of the Landscape Terrain textures.
  • Command. Sets the current size of the Landscape Terrain textures.
Arguments:
[0.0f; 1.0f] - available range
0 - 3072×3072 (~200 MB of VRAM)
1 - 16384×16384 (~3.1 GB of VRAM)
0.4f - 8192×8192 (by default, ~860 MB of VRAM)
render_landscape_terrain_vt_target_resolution
Description:
  • Variable. Prints a value indicating the current target resolution for the Landscape Terrain in pixels.
  • Command. Sets the current target resolution for the Landscape Terrain in pixels.
Arguments:
width and height values separated by a space
1344 756 - (default)
render_landscape_terrain_vt_tiles_load_per_frame
Description:
  • Variable. Prints the current number of Landscape Terrain tiles loaded per frame.
  • Command. Sets the number of Landscape Terrain tiles loaded per frame.
Arguments:
[1; 64] - available range
4 - default
render_landscape_terrain_vt_tiles_reload_per_frame
Description:
  • Variable. Prints the current number of tiles reloaded per frame after applying changes to the Landscape Terrain surface.
  • Command. Sets the number of tiles reloaded per frame after applying changes to the Landscape Terrain surface.
Arguments:
[1; 64] - available range
4 - default
render_landscape_terrain_vt_tiles_update_per_frame
Description:
  • Variable. Prints the current number of tiles passed to the virtual texture of the Landscape Terrain each frame.
  • Command. Sets the number of tiles passed to the virtual texture of the Landscape Terrain each frame.
Arguments:
[1; 256] - available range
60 - default

Notice
The commands described below affect only terrain (the ObjectTerrainGlobal class).
render_terrain_global_anisotropy
Description:
  • Variable. Prints the current terrain texture anisotropy level.
  • Command. Sets the terrain texture anisotropy level.
Arguments:
0 - anisotropy level 1
1 - anisotropy level 2
2 - anisotropy level 4 (by default)
3 - anisotropy level 8
4 - anisotropy level 16
render_terrain_global_displacement
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables displacement mapping for terrain rendering.
Arguments:
0 - disabled (by default)
1 - enabled
render_terrain_global_displacement_normal
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the use of normals in displacement mapping for terrain rendering.
Arguments:
0 - disabled (by default)
1 - enabled
render_terrain_global_holes
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables rendering of decal-based terrain holes.
Arguments:
0 - disabled (by default)
1 - enabled
render_terrain_global_triplanar
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables triplanar texture mapping for terrain rendering. If disabled, planar UV-mapping is used.
Arguments:
0 - disabled (by default)
1 - enabled

Water Rendering#

Notice
The commands described below affect only global water (the ObjectWater class).
render_water_anisotropy
Description:
  • Variable. Prints the current water texture anisotropy level.
  • Command. Sets the water texture anisotropy level.
Arguments:
0 - anisotropy level 1
1 - anisotropy level 2 (by default)
2 - anisotropy level 4
3 - anisotropy level 8
4 - anisotropy level 16
render_water_environment_probes
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables environment probes for water rendering.
Arguments:
0 - disabled
1 - enabled (by default)
render_water_voxel_probes
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables voxel probes for water rendering.
Arguments:
0 - disabled
1 - enabled (by default)
render_water_lights
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables lights for water rendering.
Arguments:
0 - disabled
1 - enabled (by default)
render_water_opacity_depth
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables writing depth for water in opacity buffer.
Arguments:
0 - disabled
1 - enabled (by default)
render_water_refraction_quality
Description:
  • Variable. Prints the current quality of water refraction.
  • Command. Sets the quality of water refraction.
Arguments:
0 - low
1 - medium
2 - high (by default)
3 - ultra
render_water_ssr
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables water screen-space reflections.
Arguments:
0 - disabled
1 - enabled (by default)
render_water_ssr_quality
Description:
  • Variable. Prints the current quality mode for the water screen-space reflections.
  • Command. Sets the quality mode for the water screen-space reflections.
Arguments:
0 - low
1 - medium (by default)
2 - high
3 - ultra
render_water_ssr_increased_accuracy
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables the increased accuracy for the water screen-space reflections.
Arguments:
0 - disabled (by default)
1 - enabled
render_water_shafts
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables underwater shafts.
Arguments:
0 - disabled
1 - enabled (by default)
render_water_shoreline_wetness
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables shoreline wetness.
Arguments:
0 - disabled
1 - enabled (by default)

Output Modes#

render_viewport_mode
Description:
  • Variable. Prints the current viewport rendering mode.
  • Command. Sets the viewport rendering mode.
    Notice
    If the panoramic rendering is enabled, underwater shafts and water line effects will be disabled.
Arguments:
0 - default rendering mode (by default)
1 - 180-degree panorama with curved edges
2 - 360-degree panorama with curved edges
3 - 180-degree linear panorama without distortion at the edges
4 - 360-degree linear panorama without distortion at the edges
5 - panorama fisheye orthographic
6 - panorama fisheye equidistant
7 - panorama fisheye stereographic
8 - panorama fisheye equisolid
9 - anaglyph stereo
10 - interlaced stereo
11 - horizontal stereo
12 - vertical stereo
render_panorama_fisheye_fov
Description:
  • Variable. Prints the current Field of View (in degrees) for the currently selected panoramic viewport mode.
  • Command. Sets the Field of View (in degrees) for the currently selected panoramic viewport mode.
    Notice
    Available only when render_viewport_mode mode is set to one of the fisheye panorama modes (5-8).
Arguments:
[0; 360] - available range
0 - default
render_stereo_hidden_area
Description:
  • Variable. Prints the current culling mode for pixels that are not visible in VR.
  • Command. Sets the culling mode for pixels that are not visible in VR. The following modes are available:
    • OpenVR-based culling mode — culling is performed using meshes returned by OpenVR.
    • Custom culling mode — culling is performed using an oval or circular mesh determined by custom adjustable parameters
Arguments:
0 - disabled (by default)
1 - OpenVR-based culling mode
2 - Custom culling mode
render_stereo_hidden_area_transform
Description:
  • Variable. Prints the current size (X, Y) and offset (Z, W) along the X and Y axes respectively for a custom oval or circular mesh used for culling pixels, that are not visible in VR.
  • Command. Sets the size (X, Y) and offset (Z, W) along the X and Y axes respectively for a custom oval or circular mesh used for culling pixels, that are not visible in VR (requires render_stereo_hidden_area = 2).
Arguments:
(1.0f, 1.0f, 0.0f, 0.0f) - default value
render_stereo_hidden_area_exposure_transform
Description:
  • Variable. Prints the size (X, Y) and offset (Z, W) along the X and Y axes respectively for a rectangular area to be used for exposure calculation when culling of pixels, that are not visible in VR mode, is used.
  • Command. Sets the size (X, Y) and offset (Z, W) along the X and Y axes respectively for a rectangular area to be used for exposure calculation when culling of pixels, that are not visible in VR mode, is used.
Correction of this area is used to avoid visual artefacts when clipped pixels affect exposure in visible areas.
Notice
The last two components are ignored when render_stereo_hidden_area is set to 2.
Arguments:
(0.6f, 0.6f, 0.0f, 0.0f) - default value

Other Settings#

render_latency
Description:
  • Variable. Prints the current maximum number of back buffer frames that a driver is allowed to queue for rendering.
  • Command. Sets the maximum number of back buffer frames that a driver is allowed to queue for rendering. The buffers are used for GPU load optimization: in certain cases several command buffers (frames) can be processed by GPU at once increasing the Waiting GPU time for one frame and having zero Waiting GPU time for the next ones. Thus, GPU avoids rendering spikes, but increased Waiting GPU time will cause a spike in application logic, in case when the logic is bound to duraton of a single frame. Frame latency is the number of frames that are allowed to be stored in a queue before submission for rendering. Latency is often used to control how the CPU chooses between responding to user input and frames that are in the render queue. In certain cases (high GPU load, VSYNC usage) it may be required to queue more frames of data, it is also beneficial for applications with no user input (e.g., video playback).
    Notice
    Arguments 1-3 are available for DirectX only.
Arguments:
0 - sequential rendering CPU-GPU-CPU-GPU...
1 - 1 buffer (by default)
2 - 2 buffers
3 - 3 buffers
render_occlusion_queries
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables an additional hardware occlusion query test before sending data to the GPU.
Arguments:
0 - disabled
1 - enabled (by default)
render_occlusion_queries_num_frames
Description:
  • Variable. Prints the current number of frames for the occlusion query update.
  • Command. Sets the number of frames for the occlusion query update.
    Notice
    Make sure that the additional hardware occlusion query test is run.
Arguments:
[0; 1024] - available range
5 - default
render_virtual_resolution
Description:
  • Variable. Prints the value of the virtual screen resolution.
  • Command. Sets the virtual screen resolution. This option can be used to render video with high resolution (e.g. 8K) regardless of monitor's resolution.

Usage: render_virtual_resolution [screen_width] [screen_height]
Arguments:
-1; -1 - default value
render_max_fps
Description:
  • Variable. Prints the current maximum FPS value, to which rendering FPS is to be clamped.
  • Command. Sets the maximum FPS value, to which rendering FPS is to be clamped.

    By default, FPS clamping is disabled (equal to 0).
    Notice
    This command is recommended for debugging purposes only, because it can cause frame skipping. For production, use VSYNC.
Arguments:
[0.0f; inf] - available range
0.0f - default

Renderers#

OpenGL#

Operations on the OpenGL API.

gl_render_renderer
Description:
  • Command. Prints the information on the graphics card.
gl_render_vendor
Description:
  • Command. Prints the manufacturer of the OpenGL driver.
gl_render_version
Description:
  • Command. Prints the version of the OpenGL driver.
gl_render_shading_language
Description:
  • Command. Prints the version of the OpenGL shading language.
gl_render_extensions
Description:
  • Command. Prints OpenGL render extensions.
gl_render_skip_errorsConfig file: *.boot
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables skipping of OpenGL errors.
Arguments:
0 - disabled (by default)
1 - enabled

OpenAL Settings#

Operations on the OpenAL API.

al_sound_renderer
Description:
  • Command. Prints the information on the sound card.
al_sound_vendor
Description:
  • Command. Prints the manufacturer of the OpenAL driver.
al_sound_version
Description:
  • Command. Prints the version of the OpenAL driver.
al_sound_extensions
Description:
  • Command. Prints the available OpenAL sound extensions.
alc_sound_extensions
Description:
  • Command. Prints OpenAL context sound extensions.
al_sound_skip_errors
Description:
  • Variable. Prints a value indicating if the option controlled by the command below is enabled.
  • Command. Enables skipping of OpenAL errors.
Arguments:
0 - disabled (by default)
1 - enabled

Plugins#

Operations on external plugins.

plugin_load
Description:
  • Command. Loads an external plugin.
Arguments:
External plugin name
plugin_reload
Description:
  • Command. Reloads an external plugin.
Arguments:
External plugin name
plugin_quit
Description:
  • Command. Quits and unloads an external plugin.
Arguments:
External plugin name

Bake Lighting#

Operations on the Bake Lighting tool.

bake_lighting_bounces
Description:
  • Variable. Prints the current number of light bounces.
  • Command. Sets the number of light bounces.
Arguments:
[1; 32] - available range
1 - default
bake_lighting_per_frame
Description:
  • Variable. Prints the current number of voxels computed and visualized per single frame.
  • Command. Sets the number of voxels computed and visualized per single frame.
Arguments:
[1; 100] - available range
1 - default
bake_lighting_voxel_size_multiplier
Description:
  • Variable. Prints the current voxel size multiplier.
  • Command. Sets the voxel size multiplier.
Arguments:
[0.0f; 8.0f] - available range
1.0f - default
bake_lighting_start
Description:
  • Command. Starts bake lighting.
bake_lighting_stop
Description:
  • Command. Stops bake lighting.

Screenshots#

Operations on screenshots.

video_extensionConfig file: *.user
Description:
  • Variable. Prints the current screenshot format.
  • Command. Sets the screenshot format.
Arguments:
0 - TGA (by default)
1 - DDS
2 - PNG
3 - JPG
video_grab
Description:
  • Command. Takes a screenshot.
Notice
A screenshot is saved in the bin/screenshots directory by default. You can specify another directory.
Arguments:
Path to the folder the screenshots will be saved in (optional)

General Information#

Memory Info#

Operations, representing information on the system memory.

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

CPU Info#

Operations, representing information on the CPU.

cpu_info
Description:
  • Command. Prints information on the CPU and instruction set supported by it.
cpu_frequency
Description:
  • Command. Prints the CPU frequency in MHz.
cpu_count
Description:
  • Command. Prints the number of available CPUs.

System Info#

Operations representing information on the system.

binary_info
Description:
  • Command. Prints information on the engine binary.
system_info
Description:
  • Command. Prints information on the operating system and the engine build version.
system_memory
Description:
  • Command. Prints the system memory size in Mbytes.

GPU Info#

Operations representing information on the GPU.

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

Miscellaneous#

Miscellaneous commands.

gpu_thread_priority
Description:
  • Variable. Prints the current GPU thread priority for the engine.
  • Command. Sets the GPU thread priority for the engine. Available for DirectX only. Positive values increase the likelihood that the GPU scheduler will grant GPU execution cycles to the device when rendering. You should have a comprehensive understanding of GPU scheduling and profile your application to ensure that it behaves as intended. If used inappropriately, this parameter can impede rendering speed and result in a poor user experience.
Arguments:
[-7; 7] - available range
7 - default
process_priorityConfig file: *.boot
Description:
  • Variable. Prints the current engine process priority.
  • Command. Sets the engine process priority. Available for Windows only. A process with a higher priority gets to use the free CPU time available while a lower priority process only has access to the CPU when the higher priority application doesn't need it. If used inappropriately, may significantly affect performance.
Arguments:
0 - idle
1 - normal (by default)
2 - high
3 - real-time
Last update: 2020-11-25