This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Landscape Tool
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
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
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

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 - by 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 - by 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 - by 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 - by 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 - by 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 - by 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:

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 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 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 - by 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 - 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 - by 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 - by 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_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 in 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

Lighting Debugging#

Operations on the lighting debugging.

render_show_lightmap_checker
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables the Baked Lightmap Checker debug mode. This mode maps the checker texture onto the baked lightmap polygons, which can be used to facilitate the process of comparing UV map texels on neighboring planes.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_voxel_probe_visualizerConfig file: *.user
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables displaying of visualizer for Voxel Probes (shown for the selected probe only).
Arguments:
0 - disabled (by default)
1 - enabled
render_show_voxel_probe_visualizer_grid_size
Description:
  • Variable.   Prints the current size of the grid that is used to visualize Voxel Probes (number of spheres along the axis).
  • Command.   Sets the size of the grid that is used to visualize Voxel Probes (number of spheres along the axis).
Arguments:
[7; 40] - available range
15 - by default
render_show_voxel_probe_visualizer_sphere_scale
Description:
  • Variable.   Prints the current scale factor of the sphere that is used to visualize Voxel Probes. The sphere size depends on the scale factor and the voxel size.
  • Command.   Sets the scale factor of the sphere that is used to visualize Voxel Probes. The sphere size depends on the scale factor and the voxel size.
Arguments:
[0.0f; 1.0f] - available range
0.25f - by default

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 - by 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 - mask vizualization is disabled (by default)
1 - DetailMask 0
2 - DetailMask 1
3 - ...
4 - 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

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 - by 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 Microprofile.
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 - by 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 - by 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 - by 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_height0 - 640 × 360
1 - 960 × 540
2 - 1024 × 576
3 - 1280 × 720
4 - 1366 × 768
5 - 1600 × 900 (by default)
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 - by 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 - by 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 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 - by 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:
  • Variable.   Prints the current render budget value, in seconds, which limits the number of loaded/created graphics resources during a frame according to loading/creation time.
  • Command.   Sets the render budget value, in seconds, which limits the number of loaded/created graphics resources during a frame according to loading/creation time.
Arguments:
[0.0f; inf] - available range
1/60 - by default
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 to be used for textures and meshes.
  • Command.   Sets the streaming mode to be used for textures and meshes. The Forced mode implies force-loading of all meshes and/or textures required for each frame at once and can be used for grabbing frame sequences, rendering node previews, warmup, etc.
Arguments:
0 - Asynchronous (by default)
1 - Forced
render_streaming_use_memory_limit
Description:
Arguments:
0 - disabled
1 - enabled (by default)
render_streaming_meshes_memory_limit
Description:
  • Variable.   Prints the current cache memory limit used for mesh streaming.
  • Command.   Sets the cache memory limit used for mesh streaming. The limit is applied if the corresponding option (see render_streaming_use_memory_limit) is enabled.
Arguments:
[0; 100] - available range
15 - by 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 - by default
render_streaming_max_threads
Description:
  • Variable.   Prints the current maximum number of threads used for streaming.
  • Command.   Sets the maximum number of threads used for 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 - by 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 used for texture streaming.
  • Command.   Sets the cache memory limit used for texture streaming. The limit is applied if the corresponding option (see render_streaming_use_memory_limit) is enabled.
Arguments:
[0; 100] - available range
65 - by 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.
  • Command.   Sets the cache memory limit for vertices of particle systems, in percentage of the total GPU memory. The limit is applied if the corresponding option (see render_streaming_use_memory_limit) is enabled.
    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 - by default
render_streaming_update_limit
Description:
  • Variable.   Prints the current maximum cache update limit.
  • Command.   Sets the maximum cache update limit. This limit cuts down the time that can be spent on validation.
    Notice
    Lower values may help reducing spikes, but be careful, as setting too low values may result in growing cache size due to slower unloading of resources.
Arguments:
[0.0f; inf] - available range
1.5f - by 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 - by 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 - by 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: *.
Description:
  • Variable.   Prints the current display mode for texture buffers used by the renderer.
  • Command.   Sets the display mode for texture buffers used by the renderer. The number of displayed buffers depends on the number of buffers in a row specified by the corresponding command (see render_show_textures_number) .
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 value indicating the current screen precision.
  • Command.   Sets the value indicating the current screen precision. This parameter determines the texture format used for screen HDR buffers.
Arguments:
0 - RG11B10F
1 - RGBA16F (by default)
render_show_textures_numberConfig file: *.
Description:
  • Variable.   Prints the current number of buffers in a row and column displayed in the full view mode (see render_show_textures) .
  • Command.   Sets the number of buffers in a row and column displayed in the full view mode (see 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 - by default
render_show_textures_offsetConfig file: *.
Description:
  • Variable.   Prints the current number of the buffer to start displaying from in the full view mode (see render_show_textures) .
  • Command.   Sets the number of the buffer to start displaying from in the full view mode (see render_show_textures) .
Arguments:
[0; 256] - available range
0 - by default

Rendering Passes#

Operations on rendering passes.

render_debug
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether debug materials (the debug_materials material) are rendered or not. Debug materials can be used for debugging of image generation stages. For example, you can render only SSR, or only cubemaps and so on.
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.   Toggles the value indicating if depth pre-pass rendering is enabled. 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: *.
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if scissor rectangles are displayed.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_ambientConfig file: *.
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the ambient pass buffer is displayed.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_alpha_testConfig file: *.
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is displayed for transparent objects using alpha test.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_transparentConfig file: *.
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is displayed 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.   Toggles the value indicating if rendering of clouds is enabled.
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.   Toggles the value indicating if rendering of lights is enabled.
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.   Toggles the value indicating if rendering of water is enabled.
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.   Toggles the value indicating if rendering of screen-space effects is enabled.
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.   Toggles the value indicating if the transparent pass is rendered.
    Notice
    This option 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.   Toggles the value indicating if the transparent ambient pass is rendered.
    Notice
    This option 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.   Toggles the value indicating if the transparent light pass is rendered.
    Notice
    This option 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.   Toggles the value indicating if the deferred pass for transparent objects is enabled.
    Notice
    This option 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.   Toggles the value indicating if the transparent multiple environment probes pass is rendered.
    Notice
    This method 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.   Toggles the value indicating if alpha-blend fading (dithering) is enabled for objects. When the feature is enabled, objects LODs are smoothly blended into each other over a fade distance.
Arguments:
0 - disabled
1 - enabled (by default)
render_show_dynamicConfig file: *.
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is displayed 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.
  • 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 - by 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.
  • 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 - by default
render_tessellation_shadow_density_multiplier
Description:
  • Variable.   Prints the current global Shadow Density multiplier for the Tessellated Displacement effect.
  • Command.   Sets the global Shadow Density multiplier for the Tessellated Displacement effect. Higher values produce more detailed shadows. You can make shadows from tessellated meshes simpler to save performance.
Arguments:
[0.01f; 10.0f] - available range
1.0f - by 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.   Toggles the value indicating if rendering of decals is enabled.
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.
    Notice
    Increased resolution significantly affects performance.
Arguments:
0 - 128 x 128
1 - 256 x 256
2 - 512 x 512 (by default)
3 - 1024 x 1024
4 - 2048 x 2048
5 - 4096 x 4096
6 - 8192 x 8192
render_field_precision
Description:
  • Variable.   Prints the current value indicating the precision of textures used for field objects.
  • Command.   Sets the value indicating the precision of textures used for field objects. Either of the following:
    • 16-bit precision R16 texture
    • 32-bit precision R32F texture
Arguments:
0 - 16 bit (by default)
1 - 32 bit
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.
    Notice
    Increased resolution significantly affects performance.
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 resolution of textures.
  • Command.   Sets the resolution of textures.
Arguments:
One of the following values:
  • 0 - low quality
  • 1 - medium quality
  • 2 - high quality
The default value is (2)
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 mip maps 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
1 - Trilinear (by default)
render_textures_anisotropy
Description:
  • Variable.   Prints the current anisotropy level for textures (degree of anisotropic filtering).
  • Command.   Sets the anisotropy level for textures (degree of anisotropic filtering).
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.   Toggles the value indicating if all shaders that are used in the loaded world are compiled and loaded to RAM every time the world is loaded.
    Notice
    Pre-loading shaders 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 current global scale for rotation angle of vegetation leaves.
  • Command.   Sets the global scale for rotation angle of vegetation leaves.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_animation_scale
Description:
  • Variable.   Prints the current global scale for rotation speed of vegetation leaves.
  • Command.   Sets the global scale for rotation speed of vegetation leaves.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_animation_stem
Description:
  • Variable.   Prints the current global scale for movement amplitude of vegetation stems.
  • Command.   Sets the global scale for movement amplitude of vegetation stems.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_animation_wind
Description:
  • Variable.   Prints the current direction of wind for all vegetation (grass and trees).
  • 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).
Arguments:
(0.0f, 0.0f, 0.0f) - default value
render_auxiliary
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if auxiliary render buffer is used. The 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.   Toggles the value indicating if ray-traced bent normals calculation is enabled. The use of SSRTGI for bent normals allows for smooth ambient lighting.
    Notice
    Ray-traced bent normals calculation available only when the SSRTGI technique (see render_ssrtgi) is enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_bent_normal_preset
Description:
  • Variable.   Prints the current currently used Bent Normal preset.
  • Command.   Sets the currently used Bent Normal preset.
Arguments:
0 - Raytracing Low (by default)
1 - Raytracing Medium
2 - Raytracing High
3 - Custom
render_bent_normal_ray_tracing_denoise
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if noise reduction for ray-traced bent normals calculation is enabled. This option reduces noise by using blur effect.
    Notice
    Ray-traced bent normals calculation is available only when the SSRTGI technique (see render_ssrtgi) is enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled (by default)
1 - enabled
render_bent_normal_denoise_quality
Description:
  • Variable.   Prints the current noise reduction quality level for Bent Normals calculation defining the number of samples used.
  • Command.   Sets the noise reduction quality level for Bent Normals calculation defining the number of samples used. Higher values provide better reduction, but for a performance cost (choosing Medium is enough in most cases).
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
One of the following values:
  • 0 - low quality
  • 1 - medium quality
  • 2 - high quality
  • 3 - ultra quality
The default value is (1)
render_bent_normal_denoise_intensity
Description:
  • Variable.   Prints the current noise reduction intensity for the Bent Normals effect.
  • Command.   Sets the noise reduction intensity for the Bent Normals effect. Higher values provide a less noisy, but more blurred result.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
0.2f - by default
render_bent_normal_denoise_gaussian_sigma
Description:
  • Variable.   Prints the current sigma parameter of Gaussian blur used for noise reduction for the bent normals effect.
  • Command.   Sets the sigma parameter of Gaussian blur used for noise reduction for the bent normals effect. This parameter controls the amount of blur applied.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 100.0f] - available range
10.0f - by default
render_bent_normal_denoise_threshold
Description:
  • Variable.   Prints the current threshold value for color difference of neighboring pixels used for noise reduction for the bent normals effect.
  • Command.   Sets the threshold value for color difference of neighboring pixels used for noise reduction for the bent normals effect. Blur is applied when the color difference is less than the threshold value.
    Notice
    Too high values result in blurring the whole image.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
0.2f - by default
render_bent_normal_denoise_radius
Description:
  • Variable.   Prints the current radius of the area to be affected by noise reduction for the bent normal effect.
  • Command.   Sets the radius of the area to be affected by noise reduction for the bent normal effect.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[1; 3] - available range
1 - by default
render_bent_normal_fix_overlit_areas
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if correction of overlit areas for bent normals calculation is enabled.
    Notice
    • This option may significantly affect performance, so disable it when it's not necessary.
    • Ray-traced bent normals calculation is available only when the SSRTGI technique (see render_ssrtgi) is enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled (by default)
1 - enabled
render_bent_normal_ray_tracing_threshold
Description:
  • Variable.   Prints the current threshold value for the ray-traced bent normals calculation.
  • Command.   Sets the threshold value for the ray-traced bent normals calculation.
    Notice
    Ray-traced bent normals calculation is available only when the SSRTGI technique (see render_ssrtgi) is enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_bent_normal_color_clamping_intensity
Description:
  • Variable.   Prints the current intensity of TAA color clamping at zero pixel velocity for the bent normals effect.
  • Command.   Sets the intensity of TAA color clamping at zero pixel velocity for the bent normals 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 Bent Normal Color Clamping Velocity Threshold (see render_bent_normal_color_clamping_velocity_threshold) , while higher values reduce ghosting effect, but increase flickering.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_bent_normal_color_clamping_velocity_threshold
Description:
  • Variable.   Prints the current sensitivity of TAA color clamping for the bent normals effect to pixel velocity change.
  • Command.   Sets the sensitivity of TAA color clamping for the bent normals effect to pixel velocity change. This parameter is used to reduce ghosting effect for lower Color Clamping Intensity values (see render_bent_normal_color_clamping_intensity) : it automatically increases clamping intensity for higher velocities, and disables clamping for low velocity values.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
0.0f - by default
render_bloom
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the Bloom effect is enabled.
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 the pass a Bloom texture is generating. 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 form the final Bloom texture.
    Notice
    The higher the value, the smoother the effect is. However, this option significantly affects performance.
Arguments:
[2; 8] - available range
6 - by default
render_bloom_power
Description:
  • Variable.   Prints the current power of the Bloom effect.
  • Command.   Sets the power of the Bloom effect.
    • 0.0f (min) - the Bloom effect is blurred.
    • 1.0f (max) - the Bloom effect is more contrast.
Arguments:
[0.0f; 1.0f] - available range
0.7f - by default
render_bloom_resolution
Description:
  • Variable.   Prints the current resolution of the Bloom effect.
  • Command.   Sets the resolution of the Bloom effect.
Arguments:
0 - quarter
1 - half
2 - full (by default)
render_bloom_scale
Description:
  • Variable.   Prints the current scale of the Bloom effect.
  • Command.   Sets the scale of the Bloom effect.
Arguments:
[0.0f; 1.0f] - available range
0.3f - by default
render_border
Description:
  • Variable.   Prints the current width and height of the image border (in pixels), to be rendered outside the horizontal bounds of the screen to reduce artefacts of post effects.
  • Command.   Sets the width and height of the image border (in pixels), to be rendered outside the horizontal bounds of the screen to reduce artefacts of post effects.
    Notice
    Increasing the width of the border may increase performance costs.
Arguments:
(0, 0) - default value
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. By the minimum value of 0, the bright areas can become overexposed.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_camera_effects_temporal_filtering
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if temporal filtering for camera effects is enabled. Temporal filtering reduces flickering of the bloom effect on the small bright objects (such flickering may appear when the camera moves). For example, it can be used in scenes with industrial pipes.
Arguments:
0 - disabled (by default)
1 - enabled
render_dirt_scale
Description:
  • Variable.   Prints the current intensity of lens dirt effect modulating the pattern of lens flares defined by the Dirt Texture.
  • Command.   Sets the intensity of lens dirt effect modulating the pattern of lens flares defined by the Dirt Texture. 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 - by default
render_dof
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the DOF (Depth Of Field) effect is enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_dof_preset
Description:
  • Variable.   Prints the current DoF effect quality preset.
  • Command.   Sets the DoF effect quality preset.
Arguments:
0 - Very Low (by default)
1 - Low
2 - Medium
3 - High
4 - Ultra
5 - Extreme
6 - Custom
render_dof_blur
Description:
  • Variable.   Prints the current intensity of blur for the DOF (Depth Of Field) effect.
  • Command.   Sets the intensity of blur for the DOF (Depth Of Field) effect.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_dof_chromatic_aberration
Description:
Arguments:
[0.0f; inf] - available range
0.0f - by default
render_dof_far_distance
Description:
  • Variable.   Prints the current far DOF limit of the camera: the distance between the camera and the furthest element that is considered to be acceptably sharp.
  • 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. Black zone on the DOF mask means in-focus zone.
Arguments:
[0.0f; inf] - available range
10.0f - by default
render_dof_near_distance
Description:
  • Variable.   Prints the current near DOF limit of the camera: the distance between the camera and the first element that is considered to be acceptably sharp.
  • Command.   Sets the near DOF limit of the camera: the distance between the camera and the first element that is considered to be acceptably sharp. Black zone on the DOF mask means in-focus zone.
Arguments:
[0.0f; inf] - available range
10.0f - by default
render_dof_focal_distance
Description:
  • Variable.   Prints the current focal distance of the camera, i.e. a point where objects are in-focus and visible clearly.
  • Command.   Sets the focal distance of the camera, i.e. a point where objects are in-focus and visible clearly.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_dof_far_focal_offset
Description:
  • Variable.   Prints the current Sets the offset from the focal to the farthest blurred zone for the DOF effect.
  • Command.   Sets the Sets the offset from the focal to the farthest blurred zone for the DOF effect. In other words, the distance when background (far) is in focus.
Arguments:
[0.0f; inf] - available range
0.0f - by default
render_dof_near_focal_offset
Description:
  • Variable.   Prints the current offset from the focal to the nearest blurred zone.
  • Command.   Sets the offset from the focal to the nearest blurred zone. In other words, the distance when foreground (near) is in focus.
Arguments:
[0.0f; inf] - available range
0.0f - by default
render_dof_resolution
Description:
  • Variable.   Prints the current resolution of the DOF (Depth Of Field) effect.
  • Command.   Sets the resolution of the DOF (Depth Of Field) effect.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - quarter
1 - half
2 - full (by default)
render_dof_quality
Description:
  • Variable.   Prints the current quality of the DOF (Depth Of Field) effect.
  • Command.   Sets the quality of the DOF (Depth Of Field) effect.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
One of the following values:
  • 0 - low quality
  • 1 - medium quality
  • 2 - high quality
  • 3 - ultra quality
The default value is (1)
render_dof_bokeh_mode
Description:
  • Variable.   Prints the current shape of the Bokeh for the DOF effect.
  • Command.   Sets the shape of the Bokeh for the DOF effect. This parameter determines the way the lens renders out-of-focus points of light.
    Notice
    For the DOF effect, the Bokeh effect is enabled by default.
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.   Toggles the value indicating if the increased accuracy option is enabled for the DOF (Depth Of Field) effect. When enabled, focusing calculation is performed with increased accuracy.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
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.   Toggles the value indicating if the focus improvement option is enabled for the DOF (Depth Of Field) effect. When enabled, transitions between the focused and unfocused parts of the scene become more accurate.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled
1 - enabled
render_exposure_mode
Description:
Arguments:
0 - static (by default)
1 - logarithmic adaptive exposure
2 - quadratic adaptive exposure
render_exposure
Description:
  • Variable.   Prints the current camera exposure (a multiplier of the scene luminance and brightness).
  • Command.   Sets the camera exposure (a multiplier of the scene luminance and brightness).

    It determines the resulting amount of luminance:

    • By the minimum value of 0.0f, the image is rendered black.
    • The higher the value, the more luminance and the brighter the scene lit.
    Available only when the Camera Mode (see render_camera_mode) is set to Classic.
Arguments:
[0.0f; 4.0f] - available range
0.0f - by default
render_exposure_adaptation
Description:
  • Variable.   Prints the current time for the camera to adjust exposure, in seconds.
  • Command.   Sets the time for the camera to adjust exposure, in seconds. 0.0f - means instant adaptation. If a too small or even negative value is provided, 1E-6 will be used instead.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_iso
Description:
  • Variable.   Prints the current ISO value used for static exposure calculation.
  • Command.   Sets the ISO value used for static exposure calculation. This value is available for the physically-based camera (see render_camera_mode) and represents the sensitivity of the camera sensor. The higher the ISO number, the more light is collected and the brighter the image is.
Arguments:
[0; inf] - available range
100 - by default
render_shutter_speed
Description:
  • Variable.   Prints the current shutter speed used for static exposure calculation.
  • Command.   Sets the shutter speed used for static exposure calculation. This setting is available for the physically-based camera (see render_camera_mode) and indicates how long the sensor of the camera is actively collecting light. Higher values make the shutter speed faster and the image — darker.
Arguments:
[0; inf] - available range
250 - by default
render_f_stop
Description:
  • Variable.   Prints the current f-stop value used for static exposure calculation.
  • Command.   Sets the f-stop value used for static exposure calculation. This setting is available for the physically-based camera (see render_camera_mode) and represents the ratio of the focal length (f) and the diameter of the lens opening (D): f / D. It is the reciprocal of the relative aperture. The higher the value, the darker the image is.
Arguments:
[0; inf] - available range
11 - by default
render_camera_mode
Description:
  • Variable.   Prints the current camera mode, which determines the way the exposure is set.
  • Command.   Sets the camera mode, which determines the way the exposure is set. Either of the following:
    • Physically-Based - the real-world values are used to set up lighting and camera exposure: ISO (see render_iso) , shutter speed (see render_shutter_speed) , F-stop (see render_f_stop) . With the default values of these parameters, the static exposure value is near 1.
      Notice
      For the physically-based mode, the exposure mode (see render_exposure_mode) should be set to Static to avoid exposure issues.
    • Classic - the exposure is set by the Exposure value (see render_exposure) .
Arguments:
0 - classic (by default)
1 - physically-based
render_white_balance
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if automatic white balance correction is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_white_balance_intensity
Description:
  • Variable.   Prints the current value of white balance correction intensity.
  • Command.   Sets the value of white balance correction intensity.
    • 0.0f - no white balance correction is performed.
    • higher values result in stronger 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 - by default
render_white_balance_adaptation_time
Description:
  • Variable.   Prints the current time period set for the camera to adjust white balance.
  • Command.   Sets the time period set for the camera to adjust white balance. During this time white balance correction is performed (0.0f - instant correction is to be used).
    Notice
    It is recommended to use lower values, when possible, to make correction process unnoticeable, otherwise it'll be slow and will catch 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 transition smoooth. You can set it equal to the Exposure Adaptation value (see render_exposure_adaptation) .
Arguments:
[0.0f; inf] - available range
1.0f - by 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 - by default
render_occluders
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if rendering of occluders is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_occluders_resolution
Description:
  • Variable.   Prints the current resolution of the texture, to which occluders (see render_occluders) are rendered.
  • Command.   Sets the resolution of the texture, to which occluders (see render_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.   Toggles the value indicating whether rendering of occluders for shadows is enabled.
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 (see render_occluders_shadows) are rendered.
  • Command.   Sets the resolution of the texture, to which occluders for shadows (see render_occluders_shadows) are rendered.
Arguments:
From 1x1 to 1024x1024 Default: 512x512
render_gi_preset
Description:
  • Variable.   Prints the current index of the currently used GI (Global Illumination) preset.
  • Command.   Sets the index of the currently used GI (Global Illumination) preset.
Arguments:
0 - Disabled (by default)
1 - Low
2 - Medium
3 - High
4 - High + SSGI
5 - Ultra
6 - Ultra + SSGI
7 - Extreme
8 - Extreme + SSGI
9 - Custom
render_ssgi
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the SSGI (Screen Space Global Illumination) effect is enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_ssgi_preset
Description:
  • Variable.   Prints the current currently used SSGI (Screen-Space Global Illumination) preset.
  • Command.   Sets the currently used SSGI (Screen-Space Global Illumination) preset. The following presets are available:
    • Raytracing — raytracing calculations for SSGI are enabled
    • Raytracing + Denoise — raytracing calculations along with the noise reduction for SSAO are enabled
    • Custom — adjust the feature's quality manually
Arguments:
0 - Raytracing (by default)
1 - Raytracing + Denoise
2 - Custom
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 SSGI Color Clamping Velocity Threshold (see render_ssgi_color_clamping_velocity_threshold) , while higher values reduce ghosting effect, but increase flickering.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
1.0f - by 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 (see render_ssgi_color_clamping_intensity) values: it automatically increases clamping intensity for higher velocities, and disables clamping for low velocity values.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
0.0f - by 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). The radius determines the size of the region surrounding a particular sampling point:
    • By low values, each point affects only the points in the close range.
    • By high values, each point affects farther positioned points.
Arguments:
[0.0f; 1.0f] - available range
1.0f - by 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. By the minimum value of 0.0f, the global illumination is the darkest.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_ssgi_intensity_boost
Description:
  • Variable.   Prints the current boost intensity value.
  • Command.   Sets the boost intensity value. Increases the SSGI intensity by raising the value to the specified power.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - power of 1 (by default)
1 - power of 2
2 - power of 3
3 - power of 4
render_ssgi_resolution_color
Description:
  • Variable.   Prints the current resolution of the color buffer used for SSGI (Screen Space Global Illumination) calculation.
  • Command.   Sets the resolution of the color buffer used for SSGI (Screen Space Global Illumination) calculation. This option significantly affects performance.
Arguments:
One of the following values:
  • 0 - quarter resolution
  • 1 - half resolution
The default value is (1)
render_ssgi_denoise
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if noise reduction for the ray-traced SSGI (Screen Space Global Illumination) is enabled. This option reduces noise by using blur effect. SSRTGI technique (see render_ssrtgi) must be enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
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 defining the number of samples used.
  • Command.   Sets the noise reduction quality level for the SSGI (Screen-Space Global Illumination) 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:
One of the following values:
  • 0 - low quality
  • 1 - medium quality
  • 2 - high quality
  • 3 - ultra quality
The default value is (1)
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.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
0.2f - by 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; 3] - available range
1 - by default
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. This parameter controls the amount of blur applied.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 100.0f] - available range
10.0f - by 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.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
0.1f - by 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).
    Notice
    Ray-traced SSGI calculation available only when the SSRTGI technique (see render_ssrtgi) is enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_fxaa
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if FXAA (post-process anti-aliasing) is enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
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. The higher the value, the more blurred image will be.
Arguments:
[0.0f; 1.0f] - available range
0.0f - by default
render_aa_preset
Description:
  • Variable.   Prints the current index of the currently used AA (Anti-Aliasing) preset.
  • Command.   Sets the index of the currently used AA (Anti-Aliasing) preset.
Arguments:
0 - Sharpest (by default)
1 - Sharp
2 - Smooth
3 - Smooth + SRAA
4 - Smoothest
5 - Smoothest + SRAA
6 - VR Mode
7 - Custom
render_taa
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if TAA (Temporal Anti-Aliasing) is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_taa_preset
Description:
  • Variable.   Prints the current currently used TAA (Temporal Anti-Aliasing) preset.
  • Command.   Sets the currently used TAA (Temporal Anti-Aliasing) preset.
Arguments:
0 - Sharpest (by default)
1 - Sharp
2 - Smooth
3 - Smoothest
4 - VR Mode
5 - Custom
render_taa_antialiasing_in_motion
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if improved anti-aliasing in motion (for moving camera and objects) is enabled. TAA (see render_taa) must be enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled (by default)
1 - enabled
render_taa_frame_count
Description:
  • Variable.   Prints the current frame count of TAA (Temporal Anti-Aliasing).
  • Command.   Sets the frame count of TAA (Temporal Anti-Aliasing). Specifies the number of frames combined for pixels. The higher the value, the more frames are combined into the final image and the better anti-aliasing. This value is used only when the Frames By Velocity option (see render_taa_frames_by_velocity) is disabled.
Arguments:
[0.0f; inf] - available range
30.0f - by default
render_taa_catmull_resampling
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if Catmull-Rom resampling is enabled. This option enables you to reduce image blurring when the camera moves forward/backward. It is recommended to disable resampling fow low-quality presets.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
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.   Toggles the value indicating if TAA color clamping option is enabled. This option clamps the color of the current and previous frame. The image becomes more sharp. TAA (see render_taa) must be enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
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.   Toggles the value indicating if diagonally neighboring pixels are to be taken into account in the process of color clamping for TAA. This mode can be used for relatively static scenes when improved antialiasing is required. In case of a dynamic scene, blurring artefacts near the screen borders may appear.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
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 the image is. Can produce additional flickering.
Arguments:
[0.0f; inf] - available range
0.5f - by 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. The offset can be less than a pixel: for example, if 0.5 is set, frames will shift to half a pixel.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
1.0f - by 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. The parameter allows reducing image jittering and blurring. By the minimum value of 0 (1 sample offset), there will be no offsets, and, therefore, no anti-aliasing. TAA (see render_taa) must be enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
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 in the velocity buffer combined for pixels that don't move relative to the screen space.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
60.0f - by 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 in the velocity buffer combined for fast moving pixels on the screen.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
4.0f - by default
render_taa_frames_by_velocity
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the TAA velocity clamping option is enabled. This option controls the number of frames combined for pixels depending on the velocity in the fragment: the number of frames is clamped to the [Min frame count; Max frame count]. It reduces blurring in dynamic scenes with a lot of moving objects.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled
1 - enabled (by default)
render_taa_frames_velocity_threshold
Description:
  • Variable.   Prints the current velocity threshold of TAA (Temporal Anti-Aliasing), at which pixels are treated as fast moving ones.
  • Command.   Sets the velocity threshold of TAA (Temporal Anti-Aliasing), at which pixels are treated as fast moving ones.This value specifies the intensity of velocity clamping. The following options must be enabled: TAA (see render_taa) and TAA velocity clamping (see render_taa_frames_by_velocity) .
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_taa_fix_flicker
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the taa fix flicker option is enabled. This option fixes flickering edges caused by TAA: it removes bright pixels by using the pixel brightness information from the previous frame. It is recommended to enable the option for bright thin ropes, wires and lines. The option is available only when TAA (see render_taa) is enabled.
    Notice
    Enabling this option may increase performance costs.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
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. This value may significantly affect performance, so keep it low when the image quality differences are not apparent.
Arguments:
0 - 2
1 - 4 (by default)
2 - 8
render_sraa_temporal
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if TAA integration is enabled. SRAA will use the shading sample from the previously rendered frame (TAA) to achieve correct anti-aliasing. Uses camera jittering, so it works only when the TAA (see render_taa) is enabled. It is recommended to use this option by default.
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.   Toggles the value indicating if the SRAA debug mode is enabled. This mode shows the geometry edges smoothed by the SRAA.
Arguments:
0 - disabled (by default)
1 - enabled
render_sraa_depth_threshold
Description:
  • Variable.   Prints the current depth threshold value used for edges detection that specifies the area for the SRAA processing.
  • Command.   Sets the depth threshold value used for edges detection that specifies the area for the SRAA processing. Turn on the debug mode and adjust this parameter in such a way that covers the required edges but at the same time leaves out the unnecessary geometry in the scene.
Arguments:
[0.0f; inf] - available range
0.1f - by default
render_filmic_shoulder_scale
Description:
  • Variable.   Prints the current Shoulder Strength tonemapping parameter value that is used to change bright values.
  • Command.   Sets the Shoulder Strength tonemapping parameter value that is used to change bright values.
Arguments:
[0.0f; 1.0f] - available range
0.2f - by default
render_filmic_linear_scale
Description:
  • Variable.   Prints the current Linear Strength tone mapping parameter value that is used to change gray values.
  • Command.   Sets the Linear Strength tone mapping parameter value that is used to change gray values. The Linear Scale controls the length of the tone mapping curve linear part.
Arguments:
[0.0f; 1.0f] - available range
0.3f - by default
render_filmic_linear_angle
Description:
  • Variable.   Prints the current Linear Angle tone mapping parameter value.
  • Command.   Sets the Linear Angle tone mapping parameter value. This parameter controls the slope of the linear part of the tone mapping curve.
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_filmic_toe_scale
Description:
  • Variable.   Prints the current Toe Scale tonemapping parameter value that is used to change dark values.
  • Command.   Sets the Toe Scale tonemapping parameter value that is used to change dark values. The Toe Scale controls the slope of the tone mapping curve toe (the area of underexposure).
Arguments:
[0.0f; 1.0f] - available range
0.2f - by default
render_filmic_toe_numerator
Description:
  • Variable.   Prints the current Toe Numerator tonemapping parameter value.
  • Command.   Sets the Toe Numerator tonemapping parameter value.
Arguments:
[0.0f; 1.0f] - available range
0.01f - by default
render_filmic_toe_denominator
Description:
Arguments:
[0.0f; 1.0f] - available range
0.3f - by default
render_filmic_white_level
Description:
  • Variable.   Prints the current Linear White Point tonemapping parameter value, which is mapped as pure white in the resulting image.
  • Command.   Sets the Linear White Point tonemapping parameter value, which is mapped as pure white in the resulting image.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_filmic_saturation_recovery
Description:
  • Variable.   Prints the current color saturation recovery value for the filmic tonemapper.
  • Command.   Sets the color saturation recovery value for the filmic tonemapper. Filmic tonemapper desaturates image colors in bright areas making them look grayish. This parameter enables you to recover initial color saturation in such areas. Higher values make colors more saturated:
    • 0.0f - standard filmic tonemapping, no saturation recovery is performed.
    • 1.0f - color saturation is recovered to the full extent.
    Notice
    When the 1.0f value is set specular highlights appear too saturated, so the recommended value is 0.75f (default)
Arguments:
[0.0f; 1.0f] - available range
0.75f - by default
render_cross
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if cross flares are enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_cross_color
Description:
  • Variable.   Prints the current color of the cross flares.
  • Command.   Sets the color of the cross flares. To use this option, rendering of cross flares (see render_cross) should be enabled.
Arguments:
vec4_one - default value (white)
render_cross_scale
Description:
  • Variable.   Prints the current cross color scale — a multiplier for the color of cross flares.
  • Command.   Sets the color multiplier.cross color scale — a multiplier for the color of cross flares. Higher values produce more pronounced flares. To use this option, rendering of cross flares (see render_cross) should be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - by 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, rendering of cross flares (see render_cross) should be enabled.
Arguments:
[2; 32] - available range
4 - by default
render_cross_length
Description:
  • Variable.   Prints the current length of a cross flare relative to the screen width.
  • Command.   Sets the length of a cross flare relative to the screen width. Increasing this value also leads to fading of the shafts across their length. To use this option, rendering of cross flares (see render_cross) should be enabled.
Arguments:
[0.0f; 2.0f] - available range
0.2f - by default
render_cross_angle
Description:
  • Variable.   Prints the current cross flares orientation angle.
  • Command.   Sets the cross flares orientation angle. To use this option, rendering of cross flares (see render_cross) should be enabled.
Arguments:
[-inf; inf] - available range
45.0f - by default
render_cross_threshold
Description:
  • Variable.   Prints the current brightness threshold for areas to produce flare
  • Command.   Sets the brightness threshold for areas to produce flare. The higher the threshold value, the brighter the area should be to produce a flare. To use this option, rendering of cross flares (see render_cross) should be enabled.
Arguments:
[0.0f; inf] - available range
0.0f - by default
render_distance_scale
Description:
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_distance_offset
Description:
  • Variable.   Prints the current global distance offset for all distance parameters: shadow distance, light distance, LOD distances, etc.
  • Command.   Sets the global distance offset for all distance parameters: shadow distance, light distance, LOD distances, etc.
Arguments:
[0.0f; inf] - available range
0.0f - by default
render_decal_distance
Description:
  • Variable.   Prints the current distance at which (and farther) decals will not be rendered.
  • Command.   Sets the distance at which (and farther) decals will not be rendered. The distance is measured from the camera to the decal's bound. If the value is greater than the World Distance value, the latter is used instead.
Arguments:
[0.0f; inf] - available range
inf - by default
render_field_distance
Description:
  • Variable.   Prints the current distance at which (and farther) field nodes will not be rendered.
  • Command.   Sets the distance at which (and farther) field nodes will not be rendered. The distance is measured from the camera to the field's bound. If the value is greater than the World Distance value, the latter is used instead.
Arguments:
[0.0f; inf] - available range
inf - by default
render_light_distance
Description:
  • Variable.   Prints the current distance at which (and farther) dynamic lights will not be rendered.
  • Command.   Sets the distance at which (and farther) dynamic lights will not be rendered. The distance is measured from the camera to the light's bound. If the value is greater than the World Distance value, the latter is used instead.
Arguments:
[0.0f; inf] - available range
inf - by default
render_object_distance
Description:
  • Variable.   Prints the current distance at which (and farther) objects will not be rendered.
  • Command.   Sets the distance at which (and farther) objects will not be rendered.
    Notice
    If this value is less than the scale multiplier for shadows (see render_shadow_distance_scale) , the shadows will still be rendered even though the objects themselves are not. Please, make sure you set these parameters properly to avoid wasting performance on rendering unnecessary shadows.
Arguments:
[0.0f; inf] - available range
inf - by default
render_reflection_dynamic
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if dynamic reflections for materials are enabled.
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.   Toggles the value indicating if reduction of resolution of dynamic reflections when the camera moves away is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_reflection_distance
Description:
  • Variable.   Prints the current distance starting from which (and farther) reflections will not be rendered.
  • Command.   Sets the distance starting from which (and farther) reflections will not be rendered.
Arguments:
[0.0f; inf] - available range
inf - by default
render_wireframe_color
Description:
  • Variable.   Prints the current color of the wireframe.
  • Command.   Sets the color of the wireframe.
Arguments:
vec4_one - default value (white)
render_background_color
Description:
  • Variable.   Prints the current background color vector.
  • Command.   Sets the background color vector. The Alpha channel of this color sets background transparency: lower alpha channel values produce darker background color. This parameter allows creating colored transparent background instead of rendering an environment cubemap. However, if the environment cubemap is rendered, the background color will always be rendered over the environment.
Arguments:
vec4_one - default value (white)
render_fade_color
Description:
  • Variable.   Prints the current current fade color for the scene on the screen.
  • Command.   Sets the current fade color for the scene on the screen. By gradually changing this value it is possible to create "fade in" and "fade out" effects depending on the w component of the given vector. For example, when the following vectors are passed the result will be:
    • vec4(1,1,1,1) - a fully white screen. Positive w results in additive blending.
    • vec4(0.5,0.5,0.5,1) - light colors on the screen.
    • vec4(1,0,0,1) - R channel for all screen colors is to its maximum; G and B without changes.
    • vec4(0,0,0,0) - there is no fading (no color alterations are done to the screen).
    • vec4(1,1,1,-1) - a fully black screen. Negative w results in scene colors * (1 - RGB), where RGB is the first three components of the passed vector.
    • vec4(0.5,0.5,0.5,-1) - dark colors on the screen.
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.   Toggles the value indicating if lens flares are enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_lens_color
Description:
  • Variable.   Prints the current color of HDR lens flares.
  • Command.   Sets the color of HDR lens flares. To use this option, rendering of lens flares (see render_lens) should be enabled.
Arguments:
vec4_one - default value (white)
render_lens_scale
Description:
  • Variable.   Prints the current multiplier for color (see render_lens_color) of HDR lens flares.
  • Command.   Sets the multiplier for color (see render_lens_color) of HDR lens flares. To use this option, rendering of lens flares (see render_lens) should be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_lens_length
Description:
  • Variable.   Prints the current length of the radial lens flare indicating if the whole radial lens flare is rendered on the screen or only a part of it.
  • Command.   Sets the length of the radial lens flare indicating if the whole radial lens flare is rendered on the screen or only a part of it. This option controls how lens flares pattern is distributed. To use this option, rendering of lens flares (see render_lens) should be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.5f - by default
render_lens_radius
Description:
  • Variable.   Prints the current radius of the spherical lens flares on the screen.
  • Command.   Sets the radius of the spherical lens flares on the screen. 1.0f corresponds to a screen-wide radius (a lens flare is not visible). To use this option, rendering of lens flares (see render_lens) should be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.5f - by 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, rendering of lens flares (see render_lens) should be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.5f - by default
render_lens_dispersion
Description:
  • Variable.   Prints the current color displacement for red, green, and blue channels of the lens flares.
  • Command.   Sets the color displacement for red, green, and blue channels of the lens flares. Can be used to create light dispersion (chromatic aberrations). If a negative value is set for a channel, 0 will be used instead. To use this option, rendering of lens flares (see 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.   Toggles the value indicating if the motion blur effect is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_motion_blur_preset
Description:
  • Variable.   Prints the current Motion Blur preset.
  • Command.   Sets the Motion Blur preset.
Arguments:
0 - Low (by default)
1 - Medium
2 - High
3 - Ultra
4 - Custom
render_motion_blur_camera_velocity
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if camera velocity contributes to the motion blur effect (false to take into account velocities of objects only). To use this option, rendering of the motion blur effect (see render_motion_blur) should be enabled.
    Notice
    Disabled in VR mode by default.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
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.   Toggles the value indicating if neat silhouettes option for motion blur is enabled. This option keeps contours of objects in front of the camera unblurred. To use this option, rendering of the motion blur effect (see render_motion_blur) should be enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
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, rendering of the motion blur effect (see render_motion_blur) should be enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
0.5f - by 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. The higher the value, the more correct the motion blur effect is. At low values, moving objects may look doubled, however, performance will increase. To use this option, rendering of the motion blur effect (see render_motion_blur) should be enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[2; 64] - available range
8 - by 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. The higher the value, the more blurred the objects will appear when moving. To use this option, rendering of the motion blur effect (see render_motion_blur) should be enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_motion_blur_max_velocity
Description:
  • Variable.   Prints the current maximum possible amount of motion blur for moving physical objects.
  • Command.   Sets the maximum possible amount of motion blur for moving physical objects. When their body velocity exceeds the set value, they will be blurred as if they have the maximum velocity set by the parameter.

    This parameter should be used:

    • To avoid excessive blurring of fast moving objects.
    • To save performance, as increasing the object's velocity leads increasing the radius of the motion blur effect that drops performance at too high values.
    To use this option, rendering of the motion blur effect (see render_motion_blur) should be enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_transparent_blur
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if transparent blur is enabled 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.   Toggles the value indicating if refraction is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_refraction_warp_background_transparent_surfaces
Description:
  • Variable.   Prints the current value indicating if refraction affects background transparent surfaces (except for water and clouds).
  • Command.   Sets the value indicating if refraction affects background transparent surfaces (except for water and clouds). The following values are available:
    • Never — no refraction distortion is applied to transparent surfaces.
    • Behind Farthest Refractive Surface — apply refraction distortion to all transparent surfaces behind the farthest refractive surface.
    This method takes effect only when rendering of refractions (see render_refraction) is enabled.
Arguments:
0 - Never (by default)
1 - Behind Farthest Refractive Surface
render_refraction_dispersion
Description:
  • Variable.   Prints the current refraction displacement for red, green, and blue channels (according to the refraction texture of refractive materials).
  • Command.   Sets the refraction displacement for red, green, and blue channels (according to the refraction texture of refractive materials). Can be used to create light dispersion (chromatic aberrations). To use this option, render_refraction (see 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.   Toggles the value indicating if the sharpening post-processing effect is enabled.
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.intensity of the sharpening effect. To use this option, sharpening post-processing effect should be enabled (see render_sharpen) .
Arguments:
[0.0f; inf] - available range
0.5f - by default
render_vr_emulation
Description:
  • Variable.   Prints the current value indicating the current VR emulation mode.
  • Command.   Sets the value indicating the current VR emulation mode.
Arguments:
0 - Disabled (by default)
1 - HTC Vive
2 - HTC Vive Pro
3 - Oculus Rift
render_ssr
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the SSR (Screen Space Reflections) effect is enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_ssr_preset
Description:
  • Variable.   Prints the current currently used SSR (Screen-Space Reflections) preset.
  • Command.   Sets the currently used SSR (Screen-Space Reflections) preset.
Arguments:
0 - Low (by default)
1 - Medium
2 - High
3 - Ultra
4 - Extreme
5 - Custom
render_ssr_color_clamping_intensity
Description:
  • Variable.   Prints the current intensity of TAA color clamping at zero pixel velocity for the SSR (Screen-Space Reflections) effect.
  • Command.   Sets the intensity of TAA color clamping at zero pixel velocity for the SSR (Screen-Space Reflections) 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 SSR Color Clamping Velocity Threshold (see render_ssr_color_clamping_velocity_threshold) , while higher values reduce ghosting effect, but increase flickering.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
0.0f - by default
render_ssr_color_clamping_velocity_threshold
Description:
  • Variable.   Prints the current sensitivity of TAA color clamping for the SSR (Screen-Space Reflections) effect to pixel velocity change.
  • Command.   Sets the sensitivity of TAA color clamping for the SSR (Screen-Space Reflections) effect to pixel velocity change. This parameter is used to reduce ghosting effect for lower Color Clamping Intensity (see render_ssr_color_clamping_intensity) values: it automatically increases clamping intensity for higher velocities, and disables clamping for low velocity values.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
0.0f - by default
render_ssr_fast_tracing
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if fast tracing for the SSR (Screen Space Reflections) effect is enabled. This mode makes it possible to obtain distant reflections using low number of steps while keeping performance high. However, tiny objects may not be reflected. Disabling this mode improves quality but significantly drops performance.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
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.   Toggles the value indicating if increased accuracy option is enabled for the SSR (Screen Space Reflections). This option reduces visual artifacts around objects, which can appear at a resolution that is lower than Full, by increasing accuracy of the last step.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
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.   Toggles the value indicating if noise reduction for the SSR (Screen Space Reflections) effect is enabled.
    Notice
    Noise reduction is effective only for screen-space reflections on rough surfaces. Reflections on smooth surfaces (Roughness = 0) will not be affected.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled
1 - enabled (by default)
render_ssr_denoise_quality
Description:
  • Variable.   Prints the current noise reduction quality level for the SSR (Screen-Space Reflections) effect defining the number of samples used.
  • Command.   Sets the noise reduction quality level for the SSR (Screen-Space Reflections) effect defining the number of samples used. Higher values provide better reduction, but for a performance cost (choosing Medium is enough in most cases).
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
One of the following values:
  • 0 - low quality
  • 1 - medium quality
  • 2 - high quality
  • 3 - ultra quality
The default value is (1)
render_ssr_denoise_intensity
Description:
  • Variable.   Prints the current noise reduction intensity for the SSR (Screen-Space Reflections) effect.
  • Command.   Sets the noise reduction intensity for the SSR (Screen-Space Reflections) effect. Higher values provide a less noisy, but more blurred result.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
0.2f - by default
render_ssr_denoise_radius
Description:
  • Variable.   Prints the current radius of the area to be affected by noise reduction for the SSR (Screen-Space Reflections) effect.
  • Command.   Sets the radius of the area to be affected by noise reduction for the SSR (Screen-Space Reflections) effect.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[1; 3] - available range
1 - by default
render_ssr_denoise_gaussian_sigma
Description:
  • Variable.   Prints the current sigma parameter of Gaussian blur used for noise reduction for the SSR (Screen-Space Reflections) effect.
  • Command.   Sets the sigma parameter of Gaussian blur used for noise reduction for the SSR (Screen-Space Reflections) effect. This parameter controls the amount of blur applied.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 100.0f] - available range
10.0f - by 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 (Screen-Space Reflections) effect.
  • Command.   Sets the threshold value for color difference of neighboring pixels used for noise reduction for the SSR (Screen-Space Reflections) 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.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
0.1f - by default
render_ssr_resolution
Description:
  • Variable.   Prints the current resolution of SSR (Screen Space Reflections).
  • Command.   Sets the resolution of SSR (Screen Space Reflections).
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
One of the following values:
  • 0 - quarter resolution
  • 1 - half resolution
  • 2 - full resolution
The default value is (1)
render_ssr_resolution_depth
Description:
  • Variable.   Prints the current resolution of the depth buffer used for SSR (Screen Space Reflections) calculation.
  • Command.   Sets the resolution of the depth buffer used for SSR (Screen Space Reflections) calculation. It affects detailing of reflections of tiny objects.
    Notice
    To gain performance, this option can be set to lower values while enabling increased accuracy (see render_ssr_increased_accuracy) .
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
One of the following values:
  • 0 - quarter resolution
  • 1 - half resolution
  • 2 - full resolution
The default value is (0)
render_ssr_resolution_color
Description:
  • Variable.   Prints the current resolution of the color buffer used for SSR (Screen Space Reflections) calculation.
  • Command.   Sets the resolution of the color buffer used for SSR (Screen Space Reflections) calculation. It significantly affects performance.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
One of the following values:
  • 0 - quarter resolution
  • 1 - half resolution
  • 2 - full resolution
The default value is (0)
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. Using more rays provides more precise SSR roughness calculation, however, it is more expensive.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[1; 64] - available range
4 - by default
render_ssr_num_steps
Description:
  • Variable.   Prints the current number of SSR steps per ray that are used for trace calculation.
  • Command.   Sets the number of SSR steps per ray that are used for trace calculation. The number of steps defines accuracy of reflections and causes a reasonable performance impact. The higher the value, the more accurate obstacles between objects are accounted.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[1; 64] - available range
16 - by 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 (however, tiny objects may become missing), lower values produce more detailed reflections of tiny objects.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
0.5f - by default
render_ssr_noise_ray
Description:
  • Variable.   Prints the current intensity of the ray noise used for SSR (Screen-Space Reflections) calculation.
  • Command.   Sets the intensity of the ray noise used for SSR (Screen-Space Reflections) calculation. It is used to reduce the banding effect on rough reflections. Higher values make the banding effect less pronounced.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
0.5f - by default
render_ssr_noise_step
Description:
  • Variable.   Prints the current intensity of the step noise used for SSR (Screen-Space Reflections) calculation.
  • Command.   Sets the intensity of the step noise used for SSR (Screen-Space Reflections) calculation. It is used to reduce the banding effect of tracing. Higher values make the banding effect less pronounced.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
0.5f - by default
render_ssr_visibility_roughness_min
Description:
  • Variable.   Prints the current minimum roughness value, starting from which the SSR (Screen-Space Reflections) effect begins to fade out.
  • Command.   Sets the minimum roughness value, starting from which the SSR (Screen-Space Reflections) effect begins to fade out. It allows reducing noise of reflections on rough materials.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_ssr_visibility_roughness_max
Description:
  • Variable.   Prints the current maximum roughness value, starting from which the SSR (Screen-Space Reflections) effect is not rendered.
  • Command.   Sets the maximum roughness value, starting from which the SSR (Screen-Space Reflections) effect is not rendered. It allows reducing noise of reflections on rough materials.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_ssr_threshold
Description:
  • Variable.   Prints the current threshold used for SSR (Screen-Space Reflections) calculation to limit imitation of reflections in areas where SSR cannot get information.
  • Command.   Sets the threshold used for SSR (Screen-Space Reflections) calculation to limit imitation of reflections in areas where SSR cannot get information. Higher values make the effect less pronounced.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_ssr_threshold_occlusion
Description:
  • Variable.   Prints the current value that limits imitation of environment cubemap occlusion in areas where SSR (Screen-Space Reflections) cannot get information.
  • Command.   Sets the value that limits imitation of environment cubemap occlusion in areas where SSR (Screen-Space Reflections) 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.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_ssr_normal_bias
Description:
  • Variable.   Prints the current bias value to which the ray starting position has been shifted along the normal vector.
  • Command.   Sets the bias value to which the ray starting position has been shifted along the normal vector. This value is used for SSR (Screen-Space Reflections) calculation. Can be adjusted to fine-tune reflections of small objects at far distances. Recommended for narrow FOV angles. To use this option, SSR (see render_ssr) should be enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_ssr_view_bias
Description:
  • Variable.   Prints the current bias value to which the ray starting position has been shifted along the view vector.
  • Command.   Sets the bias value to which the ray starting position has been shifted along the view vector. This value is used for SSR (Screen-Space Reflections) calculation. Can be adjusted to fine-tune reflections of small objects at far distances. Recommended for narrow FOV angles. To use this option, SSR (see render_ssr) should be enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_ssrtgi
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the SSRTGI (screen space ray-traced global illumination) effect is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_ssrtgi_preset
Description:
  • Variable.   Prints the current index of the currently used SSRTGI (Screen-Space Ray-Traced Global Illumination) preset.
  • Command.   Sets the index of the currently used SSRTGI (Screen-Space Ray-Traced Global Illumination) preset.
Arguments:
0 - Low (by default)
1 - Medium
2 - High
3 - Ultra
4 - Extreme
5 - Custom
render_ssrtgi_fast_tracing
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if fast tracing is enabled for the SSRTGI (Screen Space Ray-Traced Global Illumination). This option dynamically changes 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. SSRTGI must be enabled (see render_ssrtgi) .
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
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.   Toggles the value indicating if increased accuracy is enabled for the SSRTGI (Screen Space Ray-Traced Global Illumination). This option reduces visual artifacts by increasing accuracy of the last step. SSRTGI must be enabled (see render_ssrtgi) .
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled
1 - enabled (by default)
render_ssrtgi_noise_ray
Description:
  • Variable.   Prints the current intensity of the ray noise used for SSRTGI calculation.
  • Command.   Sets the intensity of the ray noise used for SSRTGI calculation. This parameter is used to reduce the banding effect on the final image by using the noise: higher values make the banding effect less pronounced. SSRTGI must be enabled (see render_ssrtgi) .
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
0.5f - by 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 of tracing by using the noise: the higher is the value, the less pronounced is the banding effect. SSRTGI must be enabled (see render_ssrtgi) .
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
0.5f - by default
render_ssrtgi_num_rays
Description:
  • Variable.   Prints the current number of rays of SSRTGI per pixel that are used to calculate the final image.
  • Command.   Sets the number of rays of SSRTGI per pixel that are used to calculate the final image. Using more rays provides more precise SSRTGI calculation, however, it is more expensive. SSRTGI must be enabled (see render_ssrtgi) .
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[1; 1024] - available range
8 - by default
render_ssrtgi_num_steps
Description:
  • Variable.   Prints the current number of steps of SSRTGI per ray that are used for trace calculation.
  • Command.   Sets the number of steps of SSRTGI per ray that are used for trace calculation. The higher the value, the more accurate obstacles between objects are accounted. However, this option significantly affects performance. SSRTGI must be enabled (see render_ssrtgi) .
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[1; 256] - available range
8 - by default
render_ssrtgi_resolution
Description:
  • Variable.   Prints the current resolution of the SSRTGI (screen space ray-traced global illumination) effect.
  • Command.   Sets the resolution of the SSRTGI (screen space ray-traced global illumination) effect. This option significantly affects performance. At low values, edges of objects become blurred. SSRTGI must be enabled (see render_ssrtgi) .
Arguments:
One of the following values:
  • 0 - quarter resolution
  • 1 - half resolution
  • 2 - full resolution
The default value is (1)
render_ssrtgi_resolution_depth
Description:
  • Variable.   Prints the current resolution of the depth buffer used for SSRTGI (screen space ray-traced global illumination) calculation.
  • Command.   Sets the resolution of the depth buffer used for SSRTGI (screen space ray-traced global illumination) calculation. This option significantly affects performance. To gain performance this option can be set to lower values while enabling the increased accuracy (see render_ssrtgi_increased_accuracy) . SSRTGI must be enabled (see render_ssrtgi) .
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
One of the following values:
  • 0 - quarter resolution
  • 1 - half resolution
  • 2 - full resolution
The default value is (0)
render_ssrtgi_step_size
Description:
  • Variable.   Prints the current size of the trace step used for SSRTGI calculation.
  • Command.   Sets the size of the trace step used for SSRTGI calculation. The higher the value, the longer the trace. However, tiny objects may be missed. The lower the value, the more detailed will be the tiny objects. The SSRTGI effect must be enabled (see render_ssrtgi) .
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_ssrtgi_upscaling
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if upscaling is enabled for the SSRTGI (screen space ray-traced global illumination). This option makes the quality of edges in half and quarter resolution look closer to full. SSRTGI must be enabled (see render_ssrtgi) .
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.   Toggles the value indicating if the SSSSS (Screen-Space Subsurface Scattering) effect is enabled. This effect is used to imitate human skin, wax, etc.
Arguments:
0 - disabled (by default)
1 - enabled
render_sssss_preset
Description:
  • Variable.   Prints the current currently used SSSSS (Screen-Space Subsurface Scattering) preset.
  • Command.   Sets the currently used SSSSS (Screen-Space Subsurface Scattering) preset.
Arguments:
0 - Low (by default)
1 - Medium
2 - High
3 - Ultra
4 - Extreme
5 - Custom
render_sssss_diffuse
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the SSSSS (Screen-Space Subsurface Scattering) calculation for diffuse lighting (directional lights) is enabled. If this option is not required, disable it to save performance. To use this option, the SSSSS effect (see render_sssss) should be enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
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.   Toggles the value indicating if the SSSSS (Screen-Space Subsurface Scattering) calculation for ambient lighting (environment) is enabled. If this option is not required, disable it to save performance. To use this option, the SSSSS effect (see render_sssss) should be enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
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 will be sampled.
  • Command.   Sets the subsurface scattering radius — distance in the screen space, within which colors will be sampled. It controls how much wrinkles, pores and cavities will be 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.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_sssss_color
Description:
  • Variable.   Prints the current subsurface scattering color used to simulate the subsurface component of skin lighting, i.e. the light that bounces inside of the subsurface tissue layers (epidermis and dermis) before exiting.
  • Command.   Sets the subsurface scattering color used to simulate the subsurface component of skin lighting, i.e. the light that bounces inside of 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 (see render_sssss) 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 of SSSSS (Screen-Space Subsurface Scattering) for the material's Translucent parameter equal to 1 (maximum translucency).
  • Command.   Sets the threshold of SSSSS (Screen-Space Subsurface Scattering) for the material's Translucent parameter equal to 1 (maximum translucency). To use this option, the SSSSS effect (see render_sssss) should be enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
10.0f - by default
render_sssss_min_threshold
Description:
  • Variable.   Prints the current threshold of SSSSS (Screen-Space Subsurface Scattering) for the material's Translucent parameter equal to 0 (minimum translucency).
  • Command.   Sets the threshold of SSSSS (Screen-Space Subsurface Scattering) for the material's Translucent parameter equal to 0 (minimum translucency). To use this option, the SSSSS effect (see render_sssss) should be enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
4.0f - by default
render_sssss_noise_ray
Description:
  • Variable.   Prints the current intensity of the ray noise used for SSSSS (Screen-Space Subsurface Scattering) calculation to reduce banding artifacts of tracing.
  • Command.   Sets the intensity of the ray noise used for SSSSS (Screen-Space Subsurface Scattering) calculation to reduce banding artifacts of tracing. Higher values make banding less visible. To use this option, the SSSSS effect (see render_sssss) should be enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
0.5f - by default
render_sssss_noise_step
Description:
  • Variable.   Prints the current intensity of the step noise used for SSSSS (Screen-Space Subsurface Scattering) calculation to reduce banding artifacts of tracing.
  • Command.   Sets the intensity of the step noise used for SSSSS (Screen-Space Subsurface Scattering) calculation to reduce banding artifacts of tracing. Higher values make banding less visible. To use this option, the SSSSS effect (see render_sssss) should be enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
0.5f - by default
render_sssss_interleaved
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the interleaved rendering mode for SSSSS (Screen-Space Subsurface Scattering) is enabled. This option 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 used to reduce ghosting effect.
  • Command.   Sets the color clamping mode used to reduce ghosting effect. 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.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
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 (Screen-Space Subsurface Scattering) 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 (Screen-Space Subsurface Scattering) effect with subsequent reconstruction of neighboring pixels using the data from previous frames. The following options are available:
    • 1 x 2 (1.0 * width x 0.5 * height) — a half of all pixels is rendered, skipping each second line
    • 2 x 2 (0.5 * width x 0.5 * height) — a quarter of all pixels is rendered, skipping each second line and row
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - 1 x 2 (by default)
1 - 2 x 2
render_sssss_resolution
Description:
  • Variable.   Prints the current resolution of the SSSSS (Screen-Space Subsurface Scattering) effect.
  • Command.   Sets the resolution of the SSSSS (Screen-Space Subsurface Scattering) effect.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
One of the following values:
  • 0 - quarter resolution
  • 1 - half resolution
  • 2 - full resolution
The default value is (1)
render_sssss_quality
Description:
  • Variable.   Prints the current quality of the SSSSS (Screen-Space Subsurface Scattering) effect.
  • Command.   Sets the quality of the SSSSS (Screen-Space Subsurface Scattering) effect.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
One of the following values:
  • 0 - low quality
  • 1 - medium quality
  • 2 - high quality
  • 3 - ultra quality
The default value is (1)
render_sssss_taa_fix_flicker
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value of TAA parameter for Screen-Space Subsurface Scattering that is similar to TAA Fix Flicker (see render_taa_fix_flicker) .
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled
1 - enabled (by default)
render_sssss_taa_antialiasing_in_motion
Description:
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled (by default)
1 - enabled
render_sssss_taa_frames_by_color
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value of TAA parameter for Screen-Space Subsurface Scattering that is similar to TAA Frames By Color (see render_taa_frames_by_color) .
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled
1 - enabled (by default)
render_sssss_taa_frames_by_velocity
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value of TAA parameter for Screen-Space Subsurface Scattering that is similar to TAA Frames By Velocity (see render_taa_frames_by_velocity) .
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled
1 - enabled (by default)
render_sssss_taa_preserve_details
Description:
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
0.5f - by default
render_sssss_taa_frame_count
Description:
Arguments:
[0.0f; inf] - available range
30.0f - by default
render_sssss_taa_frames_velocity_threshold
Description:
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_sssss_taa_max_frames_by_velocity
Description:
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
60.0f - by default
render_sssss_taa_min_frames_by_velocity
Description:
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
4.0f - by default
render_sssss_taa_pixel_offset
Description:
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_sssss_taa_catmull_resampling
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value of TAA parameter for Screen-Space Subsurface Scattering that is similar to TAA Catmull Resampling (see render_taa_catmull_resampling) .
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled
1 - enabled (by default)
render_sssss_taa_samples
Description:
  • Variable.   Prints the current value of TAA parameter for Screen-Space Subsurface Scattering that is similar to TAA Samples (see render_taa_samples) .
  • Command.   Sets the value of TAA parameter for Screen-Space Subsurface Scattering that is similar to TAA Samples (see render_taa_samples) .
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - 1 sample offset, no anti-aliasing
1 - 4 offsets (by default)
2 - 8 offsets
3 - 16 offsets
render_translucent_color
Description:
  • Variable.   Prints the current color used for translucent objects globally.
  • Command.   Sets the color 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.   Toggles the value indicating if the Screen-Space Bevels (SSBevel effect) are enabled.
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. The following modes are available:
    • Better Edges smoothes vertex and surface normals of the object. In this mode, the relief created by using Normal Mapping will be smoothed along with the mesh edges.
    • Better Normals smoothes only vertex normals. In this mode, only edges of the mesh geometry will be bevelled. The mode may produce visual artifacts on the edges. However, they can be reduced by increasing quality settings of anti-aliasing.
    To use this option, rendering of SSBevel (see render_ssbevel) should be enabled.
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:
One of the following values:
  • 0 - low quality
  • 1 - medium quality
  • 2 - high quality
  • 3 - ultra quality
The default value is (1)
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, rendering of SSBevel (see render_ssbevel) should be enabled.
Arguments:
[0.0f; inf] - available range
0.01f - by default
render_ssbevel_noise
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the noise is enabled for smoothing bevels. It is recommended to use the noise with TAA (see render_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, rendering of SSBevel (see 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.   Toggles the value indicating if the Screen-Space Dirt (SSDirt) effect is enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_ssdirt_quality
Description:
  • Variable.   Prints the current quality for the SSDirt effect.
  • Command.   Sets the quality for the SSDirt effect. SSDirt (see render_ssdirt) must be enabled. Quality implies the number of samples used for the Screen-Space Dirt effect:
    • Low — 4 samples
    • Medium — 8 samples
    • High — 16 samples
    • Ultra — 32 samples
    Notice
    This parameter significantly affects performance, so choose it reasonably.
Arguments:
One of the following values:
  • 0 - low quality
  • 1 - medium quality
  • 2 - high quality
  • 3 - ultra quality
The default value is (2)
render_ssdirt_resolution
Description:
  • Variable.   Prints the current resolution of the SSDirt effect.
  • Command.   Sets the resolution of the SSDirt effect. SSDirt (see render_ssdirt) must be enabled.
    Notice
    This parameter significantly affects performance, so choose it reasonably.
Arguments:
One of the following values:
  • 0 - quarter resolution
  • 1 - half resolution
  • 2 - full resolution
The default value is (1)
render_ssdirt_intensity
Description:
  • Variable.   Prints the current intensity of the SSDirt effect.
  • Command.   Sets the intensity of the SSDirt effect.
    • By the minimum value of 0.0f, the effect is not visible.
    • Higher values make the effect more pronounced.
    SSDirt (see render_ssdirt) must be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_ssdirt_radius
Description:
  • Variable.   Prints the current size of the SSDirt effect.
  • Command.   Sets the size of the SSDirt effect. SSDirt (see render_ssdirt) must be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_ssdirt_threshold
Description:
  • Variable.   Prints the current threshold of the SSDirt effect.
  • Command.   Sets the threshold of the SSDirt effect. It determines depth limit for the SSDirt effect in areas where information cannot be obtained. Higher values make the effect less pronounced. SSDirt (see render_ssdirt) must be enabled.
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_ssdirt_angle_bias
Description:
  • Variable.   Prints the current angle bias value to limit the SSDirt effect where information cannot be obtained.
  • Command.   Sets the angle bias value to limit the SSDirt effect where information cannot be obtained. This parameter can be used to remove visual artefacts at the edges of polygons. SSDirt (see render_ssdirt) must be enabled.
    Notice
    This parameter affects both, concave and convex areas.
Arguments:
[0.0f; 1.0f] - available range
0.35f - by default
render_ssdirt_perspective
Description:
  • Variable.   Prints the current perspective value, that determines the degree of impact of distance from the camera on the radius of the Screen-Space Dirt effect.
  • Command.   Sets the perspective value, that determines the degree of impact of distance from the camera on the radius of the Screen-Space Dirt effect.
    • 0.0f - radius of the effect is bound to screen space (it remains constant relative to screen size, regardless of the distance to the camera).
    • 1.0f - radius of the effect is bound to world space (it remains the same relative to objects, i.e. gets smaller as the camera moves away from them).
    SSDirt (see render_ssdirt) must be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.02f - by default
render_ssdirt_increase_accuracy
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if increased accuracy for the SSDirt effect. This option should be used to remove visual artefacts along the screen edges, in case if they appear. Otherwise, it should be disabled. SSDirt (see render_ssdirt) must be enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_ssdirt_cavity_texture_size
Description:
  • Variable.   Prints the current scaling factor for the textures used for cavities.
  • Command.   Sets the scaling factor for the textures used for cavities. SSDirt (see render_ssdirt) must be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_ssdirt_cavity_color
Description:
  • Variable.   Prints the current color multiplier for the Albedo texture used for cavities (global dirt and dust color pattern).
  • Command.   Sets the color multiplier for the Albedo texture used for cavities (global dirt and dust color pattern). SSDirt (see render_ssdirt) must be enabled.
Arguments:
vec4(0.26f, 0.24f, 0.21f, 1.0f) - default value
render_ssdirt_cavity_exponent
Description:
  • Variable.   Prints the current exponent value that determines the rate of gradual change of intensity along the radius for cavities.
  • Command.   Sets the exponent value that determines the rate of gradual change of intensity along the radius for cavities. Lower values make gradual change of intensity smoother. SSDirt (see render_ssdirt) must be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_ssdirt_cavity_metalness
Description:
  • Variable.   Prints the current metalness value for cavities.
  • Command.   Sets the metalness value for cavities. When set to 0 (by default), the SSDirt effect does not modify metalness buffer in cavities. SSDirt (see render_ssdirt) must be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.0f - by default
render_ssdirt_cavity_metalness_visibility
Description:
  • Variable.   Prints the current metalness visibility value for cavities.
  • Command.   Sets the metalness visibility value for cavities. A multiplier that determines the degree of impact of the effect on metalness buffer (the higher the value the more metalness buffer is affected. SSDirt (see render_ssdirt) must be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.0f - by default
render_ssdirt_convexity_texture_size
Description:
  • Variable.   Prints the current scaling factor for the textures used for convexities.
  • Command.   Sets the scaling factor for the textures used for convexities. SSDirt (see render_ssdirt) must be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_ssdirt_convexity_color
Description:
  • Variable.   Prints the current color multiplier for the Albedo texture used for convexities (global wear and scratch color pattern).
  • Command.   Sets the color multiplier for the Albedo texture used for convexities (global wear and scratch color pattern). SSDirt (see render_ssdirt) must be enabled.
Arguments:
vec4(0.48f, 0.44f, 0.39f, 1.0f) - default value
render_ssdirt_convexity_exponent
Description:
  • Variable.   Prints the current exponent value that determines the rate of gradual change of intensity along the radius for convexities.
  • Command.   Sets the exponent value that determines the rate of gradual change of intensity along the radius for convexities. Lower values make gradual change of intensity smoother. SSDirt (see render_ssdirt) must be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_ssdirt_convexity_metalness
Description:
  • Variable.   Prints the current metalness value for convexities.
  • Command.   Sets the metalness value for convexities. When set to 0 (by default), the SSDirt effect does not modify metalness buffer in convex areas. SSDirt (see render_ssdirt) must be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.0f - by default
render_ssdirt_convexity_metalness_visibility
Description:
  • Variable.   Prints the current metalness visibility value for convexities.
  • Command.   Sets the metalness visibility value for convexities. A multiplier that determines the degree of impact of the effect on metalness buffer (the higher the value the more metalness buffer is affected. SSDirt (see render_ssdirt) must be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.0f - by default
render_tonemapper
Description:
Arguments:
0 - disable
1 - Filmic (by default)
2 - ACES
3 - ACES with Reinhard
4 - Reinhard
5 - Reinhard Luma Based
render_reinhard_contribution
Description:
  • Variable.   Prints the current Reinhard tonemapping operator contribution.
  • Command.   Sets the Reinhard tonemapping operator contribution.

    The value is calculated according to the following formula:

    C / (1 + C)
    It controls the overall contribution that the Reinhard operator makes to the final color grading of the image. The higher values result in more tonemapping contribution to the final image.
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_reinhard_luma_based_contribution
Description:
  • Variable.   Prints the current Reinhard Luma Based tonemapping operator contribution.
  • Command.   Sets the Reinhard Luma Based tonemapping operator contribution. Controls the overall contribution that the Reinhard operator makes to the final color grading of the image. Higher values result in more tonemapping contribution to the final image.
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_aces_with_reinhard_mix
Description:
Arguments:
[0.0f; 1.0f] - available range
0.5f - by default
render_aces_white_clip
Description:
  • Variable.   Prints the current white clip parameter for the ACES operator. Controls the cut-off point for white.
  • Command.   Sets the white clip parameter for the ACES operator. Controls the cut-off point for white.
Arguments:
[0.0f; 10.0f] - available range
2.51f - by default
render_aces_toe
Description:
  • Variable.   Prints the current toe parameter for the ACES operator.
  • Command.   Sets the toe parameter for the ACES operator. Controls the dark color. Higher values result in darker colors.
Arguments:
[0.0f; 10.0f] - available range
0.03f - by default
render_aces_shoulder_angle
Description:
  • Variable.   Prints the current shoulder angle parameter for the ACES operator.
  • Command.   Sets the shoulder angle parameter for the ACES operator. Controls how much overshoot should be added to the curve's shoulder.
Arguments:
[0.0f; 10.0f] - available range
2.43f - by default
render_aces_shoulder_strength
Description:
  • Variable.   Prints the current shoulder strength parameter for the ACES operator.
  • Command.   Sets the shoulder strength parameter for the ACES operator. Controls the strength of the transition between the curve's midsection and the curve's shoulder.
Arguments:
[0.0f; 10.0f] - available range
0.59f - by default
render_aces_shoulder_length
Description:
  • Variable.   Prints the current shoulder length parameter for the ACES operator.
  • Command.   Sets the shoulder length parameter for the ACES operator. Controls the amount of f-stops to add to the dynamic range of the curve. Defines how much of the highlights the curve takes into account.
Arguments:
[0.0f; 1.0f] - available range
0.59f - by default
render_aces_with_reinhard_white_clip
Description:
  • Variable.   Prints the current white clip parameter for the ACES with Reinhard operator.
  • Command.   Sets the white clip parameter for the ACES with Reinhard operator. Controls the cut-off point for white.ACES with Reinhard operator's white clip.
Arguments:
[0.0f; 10.0f] - available range
2.51f - by default
render_aces_with_reinhard_toe
Description:
  • Variable.   Prints the current toe parameter for the ACES with Reinhard operator.
  • Command.   Sets the toe parameter for the ACES with Reinhard operator. Controls the dark color. Higher values result in darker colors.
Arguments:
[0.0f; 10.0f] - available range
0.03f - by default
render_aces_with_reinhard_shoulder_angle
Description:
  • Variable.   Prints the current shoulder angle parameter for the ACES with Reinhard operator.
  • Command.   Sets the shoulder angle parameter for the ACES with Reinhard operator. Controls how much overshoot should be added to the curve's shoulder.
Arguments:
[0.0f; 10.0f] - available range
2.43f - by default
render_aces_with_reinhard_shoulder_strength
Description:
  • Variable.   Prints the current shoulder strength parameter for the ACES with Reinhard operator.
  • Command.   Sets the shoulder strength parameter for the ACES with Reinhard operator. Controls the strength of the transition between the curve's midsection and the curve's shoulder.
Arguments:
[0.0f; 10.0f] - available range
0.59f - by default
render_aces_with_reinhard_shoulder_length
Description:
  • Variable.   Prints the current shoulder length parameter for the ACES with Reinhard operator.
  • Command.   Sets the shoulder length parameter for the ACES with Reinhard operator. Controls the amount of f-stops to add to the dynamic range of the curve. Defines how much of the highlights the curve takes into account.
Arguments:
[0.0f; 1.0f] - available range
0.14f - by 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.   Toggles the value indicating if rendering of environment of the scene is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_environment_correct_roughness
Description:
  • Variable.   Prints the current correction mode for environment reflections on rough surfaces.
  • Command.   Sets the correction mode for environment reflections on rough surfaces. Correction modes differ in the number of rays used to create a reflection on a rough surface.
Arguments:
0 - Off (by default)
1 - Low
2 - Medium
3 - High
4 - Ultra
render_environment_cubemap_blend
Description:
  • Variable.   Prints the current blending mode for the environment cubemap.
  • Command.   Sets the blending mode for the environment cubemap.
Arguments:
0 - alpha blend (by default)
1 - additive blend
2 - multiply
3 - overlay
render_environment_hemisphere
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if rendering of environment only for the top (above-ground) hemisphere is enabled. The underground is rendered black. When disabled, environment for the whole sphere is rendered.
Arguments:
0 - disabled (by default)
1 - enabled
render_environment_haze
Description:
  • Variable.   Prints the current mode for the haze effect.
  • Command.   Sets the mode for the haze effect.
    • If Disabled, no haze is applied.
    • The Solid mode uses the solid color from the Color parameter.
    • The Scattering mode uses the color from the sky LUTs is blended with the Color parameter. This value is recommended for better realism: objects will smoothly fade into the distance.
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. By using this option, you can make the haze look more realistic for a specific distance range.
    • Short Distance Range — better suitable for near-surface haze
    • Long Distance Range — better suitable for hazy mountains
    • Physically Based — for physically based haze simulation
Arguments:
0 - Short Distance Range (by default)
1 - Long Distance Range
2 - Physically Based
render_lightmap_color
Description:
  • Variable.   Prints the current color multiplier for lightmaps.
  • Command.   Sets the color multiplier for lightmaps.
    Notice
    Some light sources may be modified after the lightmap was baked. To make lighting in the scene consistent once again without any re-baking you can simply adjust the color multiplier for lightmaps. See the How-To video tutorial for additional information.
Arguments:
vec4_one - default value (white)
render_lights_max_per_batch
Description:
  • Variable.   Prints the current maximum number of lights rendered by a tile (see render_lights_tile_grid_size) per batch call.
  • Command.   Sets the maximum number of lights rendered by a tile (see render_lights_tile_grid_size) per batch call.

    With lights batching optimization, omni lights divided into tiles are rendered in batches: each tile renders the specified number of lights per batch. It allows decreasing the number of DIP calls and increasing performance. The optimization works only for omni lights with point shape and without shadows.

    0 disables batching optimization.

Arguments:
[32; 1024] - available range
1024 - by default
render_lights_tile_grid_size
Description:
  • Variable.   Prints the current number of grid tiles per axis for tiled rendering optimization.
  • Command.   Sets the number of grid tiles per axis for tiled rendering optimization. During this optimization, the screen space is divided into tiles that render lights in batches (see render_lights_max_per_batch) . The optimization works only for omni lights with point shape and without shadows.
Arguments:
[1; 32] - available range
8 - by 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). You should set the nonzero value to increase performance: it is not recommended to use more than 4 World lights per object.
Arguments:
[0; 128] - available range
4 - by 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). You should set the nonzero value to increase performance: it is not recommended to use more than 4 Omni lights per object.
Arguments:
[0; 128] - available range
4 - by 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). You should set the nonzero value to increase performance: it is not recommended to use more than 4 Projected lights per object.
Arguments:
[0; 128] - available range
4 - by 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). You should set the nonzero value to increase performance: it is not recommended to use more than 4 Voxel Probes per object.
Arguments:
[0; 128] - available range
4 - by default
render_lights_forward_per_object_planar
Description:
  • Variable.   Prints the current maximum number of Planar Reflection Probes per object (available only for materials rendered in the forward rendering pass).
  • Command.   Sets the maximum number of Planar Reflection Probes per object (available only for materials rendered in the forward rendering pass). You should set the nonzero value to increase performance: it is not recommended to use more than 4 Planar Reflection Probes per object.
Arguments:
[0; 128] - available range
4 - by 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). You should set the nonzero value to increase performance: it is not recommended to use more than 4 Voxel Probes per object.
Arguments:
[0; 128] - available range
4 - by default
render_lights_lens_flares
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if rendering of per-light lens flares is enabled.
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.   Toggles the value indicating if interleaved mode for rendering lights during the deferred pass is enabled. 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.   Toggles the value indicating if the Catmull-Rom resampling for interleaved lights rendering mode is enabled. This mode 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 to be used for interleaved lights rendering mode.
  • Command.   Sets the color clamping mode to be used for interleaved lights rendering mode. This mode is 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 the 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 interleaved rendering mode defining the number of pixels to be skipped when rendering lights during the deferred pass with subsequent reconstruction of neighboring pixels using the data from previous frames.
  • Command.   Sets the interleaved rendering mode defining the number of pixels to be skipped when rendering lights during the deferred pass with subsequent reconstruction of neighboring pixels using the data from previous frames.
    • 1 x 2 — half of all pixels are rendered skipping each second line (1.0 * width x 0.5 * height)
    • 2 x 2 — quarter of all pixels are rendered skipping each second line and row (0.5 * width x 0.5 * height)
Arguments:
0 - 1 x 2 (by default)
1 - 2 x 2
render_ssao
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the SSAO (Screen Space Ambient Occlusion) effect is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_ssao_preset
Description:
  • Variable.   Prints the current currently used SSAO (Screen-Space Ambient Occlusion) preset.
  • Command.   Sets the currently used SSAO (Screen-Space Ambient Occlusion) preset.
Arguments:
0 - Simple Low (by default)
1 - Simple Medium
2 - Simple High
3 - Simple Ultra
4 - Raytracing
5 - Raytracing + Denoise
6 - Custom
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).
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
One of the following values:
  • 0 - low quality
  • 1 - medium quality
  • 2 - high quality
  • 3 - ultra quality
The default value is (1)
render_ssao_denoise_intensity
Description:
  • Variable.   Prints the current noise reduction intensity for the SSAO (Screen Space Ambient Occlusion) effect.
  • Command.   Sets the noise reduction intensity for the SSAO (Screen Space Ambient Occlusion) effect. Higher values provide a less noisy, but more blurred result.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
0.2f - by default
render_ssao_denoise_gaussian_sigma
Description:
  • Variable.   Prints the current sigma parameter of Gaussian blur used for noise reduction for the SSAO (Screen Space Ambient Occlusion) effect.
  • Command.   Sets the sigma parameter of Gaussian blur used for noise reduction for the SSAO (Screen Space Ambient Occlusion) effect. This parameter controls the amount of blur applied.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 100.0f] - available range
10.0f - by default
render_ssao_denoise_threshold
Description:
  • Variable.   Prints the current threshold value for color difference of neighboring pixels used for noise reduction for the SSAO (Screen Space Ambient Occlusion) effect.
  • Command.   Sets the threshold.threshold value for color difference of neighboring pixels used for noise reduction for the SSAO (Screen Space Ambient Occlusion) effect. The blur is applied when the color difference is less than the threshold value.
    Notice
    Setting too high values results in blurring the whole image.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
0.1f - by default
render_ssao_denoise_radius
Description:
  • Variable.   Prints the current radius of the area to be affected by noise reduction for the SSAO (Screen Space Ambient Occlusion) effect.
  • Command.   Sets the radius of the area to be affected by noise reduction for the SSAO (Screen Space Ambient Occlusion) effect.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[1; 3] - available range
1 - by default
render_ssao_ray_tracing
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if ray tracing is used for SSAO (Screen Space Ambient Occlusion) calculation. When enabled, SSAO provides more realistic shadows between the objects.
    Notice
    Ray-traced SSAO calculation available only when the SSRTGI technique (see render_ssrtgi) 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.   Toggles the value indicating if noise reduction for the ray-traced SSAO (Screen Space Ambient Occlusion) is enabled. This option reduces noise by using blur effect.
    Notice
    Ray-traced SSAO calculation is available only when the SSRTGI technique (see render_ssrtgi) 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 (Screen Space Ambient Occlusion).
  • Command.   Sets the threshold value for the ray-traced SSAO (Screen Space Ambient Occlusion). Ray-traced SSAO calculation is available only when the SSRTGI technique (see render_ssrtgi) is enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_ssao_cavity
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the cavity option for the SSAO (Screen Space Ambient Occlusion) effect is enabled. 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).
    Notice
    When checking the parameter value via API, you'll get the corresponding setting stored in the active preset (default or custom one).
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
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 (see render_ssao_cavity) .
  • Command.   Sets the intensity of sharpening of contours for the cavity option (see render_ssao_cavity) .
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_ssao_cavity_radius
Description:
  • Variable.   Prints the current size of junction contours area for the cavity option for the SSAO (Screen Space Ambient Occlusion) effect (see render_ssao_cavity) .
  • Command.   Sets the size of junction contours area for the cavity option for the SSAO (Screen Space Ambient Occlusion) effect (see render_ssao_cavity) .
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
1.0f - by 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). The radius is the distance for each of the points in the world space, up to which they can shadow their neighboring points:
    • By low values, each point can cast shadows only on the points in the close range.
    • By high values, each point casts shadows on points at more distant locations.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_ssao_threshold
Description:
  • Variable.   Prints the current threshold value for the SSAO (Screen Space Ambient Occlusion) effect.
  • Command.   Sets the threshold value for the SSAO (Screen Space Ambient Occlusion) effect. It limits SSAO in areas where information cannot be obtained. The higher the value, the less pronounced the effect is.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
0.5f - by 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. The intensity value affects brightness of shadows: by the minimum value of 0.0f, the ambient occlusion shadowing is the lightest.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
1.0f - by 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.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_ssao_intensity_reflection
Description:
  • Variable.   Prints the current intensity of SSAO (Screen Space Ambient Occlusion) on reflections.
  • Command.   Sets the intensity of SSAO (Screen Space Ambient Occlusion) on reflections.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_ssao_quality
Description:
  • Variable.   Prints the current quality of SSAO (Screen Space Ambient Occlusion).
  • Command.   Sets the quality of SSAO (Screen Space Ambient Occlusion). Each quality uses the following number of samples:
    • Low — 4 samples
    • Medium — 8 samples
    • High — 16 samples
    • Ultra — 32 samples
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
One of the following values:
  • 0 - low quality
  • 1 - medium quality
  • 2 - high quality
  • 3 - ultra quality
The default value is (1)
render_ssao_resolution
Description:
  • Variable.   Prints the current resolution of SSAO (Screen Space Ambient Occlusion).
  • Command.   Sets the resolution of SSAO (Screen Space Ambient Occlusion).
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
One of the following values:
  • 0 - quarter resolution
  • 1 - half resolution
  • 2 - full resolution
The default value is (1)
render_ssao_color_clamping_intensity
Description:
  • Variable.   Prints the current intensity of TAA color clamping at zero pixel velocity for the SSAO (Screen Space Ambient Occlusion) effect.
  • Command.   Sets the intensity of TAA color clamping at zero pixel velocity for the SSAO (Screen Space Ambient Occlusion) 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 SSAO Color Clamping Velocity Threshold (see render_ssao_color_clamping_velocity_threshold) , while higher values reduce ghosting effect, but increase flickering.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_ssao_color_clamping_velocity_threshold
Description:
  • Variable.   Prints the current sensitivity of TAA color clamping for the SSAO (Screen Space Ambient Occlusion) effect to pixel velocity change.
  • Command.   Sets the sensitivity of TAA color clamping for the SSAO (Screen Space Ambient Occlusion) effect to pixel velocity change. This parameter is used to reduce ghosting effect for lower Color Clamping Intensity values (see render_ssao_color_clamping_intensity) : it automatically increases clamping intensity for higher velocities, and disables clamping for low velocity values.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
0.0f - by default
render_ssao_noise
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if noise for the SSAO (Screen Space Ambient Occlusion) effect is enabled. This option reduces banding effect.
    Notice
    It is recommended to use noise with TAA (see render_taa) enabled.
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.   Toggles the value indicating if lightmap data is stored in the gbuffer.
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.   Toggles the value indicating whether shadows are rendered or not.
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.   Toggles the value indicating if alpha test is enabled 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.   Toggles the value indicating if screen space shadows are enabled. They provide high-quality penumbra, per-light work, per-pixel detail at any zoom level and infinite visibility distance (when enabled, distant objects can cast shadows next to the horizon). Supports depth cutout parallax. Screen space shadows can be mixed with regular ones.
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 translucent objects shifting the shadow.
Arguments:
[0.0f; inf] - available range
0.1f - by default
render_shadow_distance
Description:
  • Variable.   Prints the current distance from the camera, beyond which shadows will not be rendered.
  • Command.   Sets the distance from the camera, beyond which shadows will not be rendered.
    Notice
    If this value is greater than the visibility distance for objects the shadows will still be rendered even though the objects themselves are not. Please, pay attention to setting these parameters properly to avoid wasting performance on rendering unnecessary shadows.
Arguments:
[0.0f; inf] - available range
100.0f - by default
render_shadow_distance_scale
Description:
  • Variable.   Prints the current global scale multiplier for shadow distances.
  • Command.   Sets the global scale multiplier for shadow distances. This option enables you to easily increase or decrease shadows rendering performance by changing the scale.
    Notice
    If this value is greater than the scale multiplier for objects (see render_distance_scale) , the shadows will still be rendered even though the objects themselves are not. Please, make sure you set these parameters properly to avoid wasting performance on rendering unnecessary shadows.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_shadow_shafts
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if volumetric shadows are enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_shadow_shafts_exposure
Description:
  • Variable.   Prints the current contrast used for volumetric shadows.
  • Command.   Sets the contrast used for volumetric shadows.
    By the value of 0.0f shadows are not seen.
    Rendering of shadow shafts must be enabled (see render_shadow_shafts) .
Arguments:
[0.0f; 1.0f] - available range
0.5f - by default
render_shadow_shafts_length
Description:
  • Variable.   Prints the current relative length of volumetric shadows in the screen space.
  • Command.   Sets the relative length of volumetric shadows in the screen space.
    By the value of 0.0f shadows are not seen. By the value of 1.0f shadows are long enough to occupy the whole screen.
    Rendering of shadow shafts must be enabled (see render_shadow_shafts) .
Arguments:
[0.0f; 1.0f] - available range
0.5f - by default
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 quality of soft shadows. Higher quality produces smoother shadow edges. When disabled, no filtering is performed and the stair-step effect is clearly seen at the edges of shadows.
    Notice
    You can set filtering mode or disable filtering for each light source individually.
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.   Toggles the value indicating if noise for shadow filtering is enabled. This noise is used for smoothing.
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).
    Notice
    You can set penumbra quality mode or disable penumbra rendering for each light source individually.
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.   Toggles the value indicating if noise for penumbra rendering is enabled. This noise is used for smoothing.
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.   Toggles the value indicating if linear interpolation of shadow cascades is enabled, 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: *.
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether geodetic pivots are displayed.
Arguments:
0 - disabled (by default)
1 - enabled

Clouds Rendering#

render_clouds_quality_preset
Description:
  • Variable.   Prints the current index of the currently used clouds quality preset.
  • Command.   Sets the index of the currently used clouds quality preset.
Arguments:
0 - Low (by default)
1 - Medium
2 - High + Interleaved
3 - High
4 - Ultra + Interleaved
5 - Ultra
6 - Extreme + Interleaved
7 - Extreme
8 - Custom
render_clouds_accurate_layers_sorting
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if correct sorting of intersecting cloud layers is enabled.
    Notice
    Enabling this feature may reduce raymarching 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.   Toggles the value indicating if clouds ray-marched depth is used for upsampling the downsampled clouds without obscuring the geometry and reprojection depending on the cloud depth. Recommended for flying through clouds.
    Notice
    Works only with the clouds downsampling rendering mode (see render_clouds_downsampling_rendering) set to half and/or the clouds interleaved rendering mode (see render_clouds_interleaved_rendering) set to 2x2.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled (by default)
1 - enabled
render_clouds_depth_based_reconstruction_threshold
Description:
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
100.0f - by default
render_clouds_distortion_texture
Description:
  • Variable.   Prints the current value indicating which texture type is currently used for clouds distortion.
  • Command.   Sets the value indicating which texture type is currently used for clouds distortion. This parameter has a significant impact on performance:
    • 2D Texture — more performance-friendly, but may cause an excessive vertical extrusion of clouds.
    • 3D Texture — ensures homogeneous detail distortion and better image quality, but at a higher performance cost.
Arguments:
0 - 2D texture (by default)
1 - 3D texture
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.
    Notice
    This parameter has a significant impact on performance.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
One of the following values:
  • 0 - quarter resolution
  • 1 - half resolution
  • 2 - full resolution
The default value is (1)
render_clouds_dynamic_coverage_area
Description:
  • Variable.   Prints the current dynamic coverage area for clouds, in units.
  • Command.   Sets the dynamic coverage area for clouds, in units. This parameter determines visibility distance for coverage of FieldWeather objects.
    Notice
    Increasing dynamic coverage area leads to reduction of quality of FieldWeather coverage texture and loss of details. This effect can be mitigated by increasing dynamic coverage resolution using the corresponding command (see render_clouds_dynamic_coverage_resolution) .
Arguments:
[10.0f; 400000.0f] - available range
10000.0f - by default
render_clouds_dynamic_coverage_resolution
Description:
  • Variable.   Prints the current the value defining the size of the square dynamic coverage resolution texture for clouds, in pixels.
  • Command.   Sets the the value defining the size of the square dynamic coverage resolution texture for clouds, in pixels. This parameter determines the quality of dynamic coverage texture for FieldWeather objects. Higher values make it possible to preserve texture details at high distances.
    Notice
    Increased resolution significantly affects performance.
Arguments:
[16; 8192] - available range
256 - by default
render_clouds_ground_shadows
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if rendering of shadows from the clouds on the ground is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_clouds_3d_texture_horizontal_resolution
Description:
  • Variable.   Prints the current horizontal resolution for the 3D texture to be used for clouds rendering.
  • Command.   Sets the horizontal resolution for the 3D texture to be used for clouds rendering.
    Notice
    Setting too high resolution may significantly affect performance, so adjust it wisely.
Arguments:
0 - 64
1 - 128
2 - 256 (by default)
3 - 512
4 - 1024
5 - 2048
render_clouds_3d_texture_vertical_resolution
Description:
  • Variable.   Prints the current vertical resolution for the 3D texture to be used for clouds rendering.
  • Command.   Sets the vertical resolution for the 3D texture to be used for clouds rendering.
    Notice
    Setting too high resolution may significantly affect performance, so adjust it wisely.
Arguments:
0 - 32
1 - 64
2 - 128
3 - 256 (by default)
4 - 512
render_clouds_interleaved_rendering
Description:
  • Variable.   Prints the current interleaved rendering mode for clouds.
  • Command.   Sets the interleaved rendering mode for clouds. In cases when clouds are viewed from the ground, or from above (at significant distance) and viewer's velocities are less than 200 units per second, this parameter can be used to provide a significant gain in performance.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
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.   Toggles the value indicating if temporal accumulation of noises for interleaved sampling for clouds is enabled.
    Notice
    Works only when the clouds interleaved rendering mode (see render_clouds_interleaved_rendering) is set to 2x2.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled
1 - enabled (by default)
render_clouds_lighting_cone_radius
Description:
Arguments:
[0.0f; 1.0f] - available range
0.3f - by 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. The following values are available:
    • Low — 1 sample, low quality
    • Medium — 3 samples, medium quality
    • High — 5 samples, high quality
    • Ultra — 6 samples, ultra quality
    Notice
    This parameter has a significant impact on performance. Therefore, it is recommended to use low settings, when possible.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
One of the following values:
  • 0 - low quality
  • 1 - medium quality
  • 2 - high quality
  • 3 - ultra quality
The default value is (1)
render_clouds_lighting_samples_distribution
Description:
  • Variable.   Prints the current value that controls distribution of samples for clouds lighting.
  • Command.   Sets the value that controls distribution of samples for clouds lighting. Can be used to keep small details for long shadows when the lighting trace length value (see render_clouds_lighting_tracelength) is high.
Arguments:
[0.001f; 5.0f] - available range
1.0f - by default
render_clouds_lighting_tracelength
Description:
Arguments:
[1.0f; 2048.0f] - available range
230.0f - by default
render_clouds_noise_step
Description:
  • Variable.   Prints the current value of the noise step parameter for clouds.
  • Command.   Sets the value of the noise step parameter for clouds. This parameter determines the amount of jitter in the areas within clouds, that is used to reduce banding effect due to insufficient number of steps.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
0.3f - by default
render_clouds_noise_step_skip
Description:
  • Variable.   Prints the current value of the noise step skip parameter for clouds.
  • Command.   Sets the value of the noise step skip parameter for clouds. This parameter determines the amount of jitter in the areas between clouds, that is used to reduce banding effect due to insufficient number of steps.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
0.3f - by default
render_clouds_noise_iterations
Description:
  • Variable.   Prints the current value of the noise iterations parameter for clouds.
  • Command.   Sets the value of the noise iterations parameter for clouds. This parameter determines the amount of jitter in the areas within clouds, that is used to reduce banding effect due to insufficient number of steps.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
0.1f - by default
render_clouds_noise_lighting
Description:
  • Variable.   Prints the current value of the noise lighting parameter for the clouds.
  • Command.   Sets the value of the noise lighting parameter for the clouds. This parameter determines the amount of jitter for tracing steps of lighting calculation, that is used to reduce banding effect due to insufficient number of steps.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
0.3f - by default
render_clouds_rounded
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if cloud layers are to be curved 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 radius of the planet to be used for clouds curving.
  • Command.   Sets the radius of the planet to be used for clouds curving. Visual curving can be used to make clouds look more natural imitating planet's curvature.
Arguments:
[100.0f; inf] - available range
200000.0f - by 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. The higher the value, the less noise in clouds rendering. The following values are available:
    • Low — 1 sample, low quality
    • Medium — 3 samples, medium quality
    • High — 5 samples, high quality
    • Ultra — 6 samples, ultra quality
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
One of the following values:
  • 0 - low quality
  • 1 - medium quality
  • 2 - high quality
  • 3 - ultra quality
The default value is (2)
render_clouds_sampling_quality
Description:
  • Variable.   Prints the current sampling quality for clouds.
  • Command.   Sets the sampling quality for clouds. This parameter sets the number of noise samples that affects the cloud shape processing quality. The higher the value, the less are visual artifacts. The following modes are available:
    • Low — 1 sample, low quality (higher cloud density)
    • Medium — 3 samples, medium quality
    • High — 5 samples, high quality
    • Ultra — 6 samples, ultra quality (lower density, the clouds are softer)
    Notice
    Visual difference between low and ultra quality is not significant. Therefore, it is recommended to use low settings, when possible, to gain performance.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
One of the following values:
  • 0 - low quality
  • 1 - medium quality
  • 2 - high quality
  • 3 - ultra quality
The default value is (1)
render_clouds_soft_intersection
Description:
Arguments:
[0.0f; 100000.0f] - available range
100.0f - by 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. Higher values provide more accurate form and less noise, while lower ones gain more performance.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
0.5f - by default
render_clouds_transparent_order
Description:
  • Variable.   Prints the current rendering order for clouds relative to transparent objects (except water).
  • Command.   Sets the rendering order for clouds relative to transparent objects (except water).
    • Render Before Transparent — render clouds before all transparent objects (except water).
    • Render After Transparent — render clouds after all transparent objects (except water).
    • Sort Transparent — enable rough sorting for transparent objects relative to clouds (below the lowest cloud layer base -> inside the clouds -> above the highest cloud layer top).
Arguments:
0 - Render Before Transparent (by default)
1 - Render After Transparent
2 - Sort Transparent

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 CPU cache size to be used for landscape terrain rendering, in percentage of the total memory.
  • Command.   Sets the CPU cache size to be used for landscape terrain rendering, in percentage of the total memory. CPU cache size affects intersections, physics, streaming, etc. The size of CPU cache depends on the scene.
Arguments:
[1; 100] - available range
10 - by default
render_landscape_cache_gpu_size
Description:
  • Variable.   Prints the current GPU cache size to be used for landscape terrain rendering, in percentage of the total GPU memory.
  • Command.   Sets the GPU cache size to be used for landscape terrain rendering, in percentage of the total GPU memory. GPU cache is used to accumulate tiles, that are visible to the camera, before streaming them to the megatexture.
    Notice
    High-resolution maps require larger cache capacity.
Arguments:
[1; 100] - available range
4 - by default
render_landscape_cache_gpu_life_time
Description:
  • Variable.   Prints the current lifetime of GPU cache used for Landscape Terrain rendering, in frames.
  • Command.   Sets the lifetime of GPU cache used for Landscape Terrain rendering, in frames.
Arguments:
[1; 60] - available range
4 - by default
render_landscape_operations_per_frame
Description:
  • Variable.   Prints the current maximum number of Landscape texture draw operations (asyncTextureDraw) that can be performed per frame.
  • Command.   Sets the maximum number of Landscape texture draw operations (asyncTextureDraw) that can be performed per frame.
Arguments:
[1; 1000] - available range
10 - by default
render_landscape_terrain_culling_aggressive
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if frustum culling optimization is enabled for the Landscape Terrain. When enabled, the number of culled polygons increases thereby increasing performance. In case of any issues with polygons rendering, try disabling this 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 used for culling tessellation patches of the Landscape Terrain oriented to the camera with their back faces (it is a multiplier for the angle between the tessellation patch normal and the camera's view direction).
  • Command.   Sets the threshold used for culling tessellation patches of the Landscape Terrain oriented to the camera with their back faces (it is a multiplier for the angle between the tessellation patch normal and the camera's view direction). Higher values result in a smaller angle between the patch normal and the camera's view direction required for culling this patch.
Arguments:
[0.0f; 1.0f] - available range
0.5f - by default
render_landscape_terrain_culling_frustum_padding
Description:
  • Variable.   Prints the current multiplier for the size of viewing frustum to be used for culling polygons of the Landscape Terrain (value, by which the borders of the current frustum are increased).
  • Command.   Sets the multiplier for the size of viewing frustum to be used for culling polygons of the Landscape Terrain (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 - by default
render_landscape_terrain_culling_oblique_frustum
Description:
  • Variable.   Prints the current multiplier for culling of tessellation patches of the Landscape Terrain beyond the oblique frustum plane.
  • Command.   Sets the multiplier for culling of tessellation patches of the Landscape Terrain beyond the oblique frustum plane. Higher values result in more patches culled.
Arguments:
[0.0f; 1.0f] - available range
0.9f - by 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:
  • Variable.   Prints the current global dither amount multiplier to be used for rendering details of the Landscape Terrain.
  • Command.   Sets the global dither amount multiplier to be used for rendering details of the Landscape Terrain. Dithering enables reduction of graphical artefacts in case of increased Mask Contrast values set for a detail. This is a global multiplier for dithering values set for each detail mask.
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_landscape_terrain_geometry_fade_lods
Description:
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
0.5f - by default
render_landscape_terrain_geometry_holes
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if decal-based holes for the Landscape Terrain are enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_landscape_terrain_geometry_polygon_size
Description:
  • Variable.   Prints the current size of Landscape Terrain polygons defining the maximum allowed density of Landscape Terrain geometry.
  • Command.   Sets the size of Landscape Terrain polygons defining the maximum allowed density of Landscape Terrain geometry.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1000.0f] - available range
0.01f - by default
render_landscape_terrain_geometry_progression
Description:
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 50.0f] - available range
1.5f - by default
render_landscape_terrain_geometry_subpixel_reduction
Description:
  • Variable.   Prints the current minimum ratio between the polygon size (in screen space) to the size of an area in the viewport for skipping polygons rendering (the ones having a lower ratio will be removed).
  • Command.   Sets the minimum ratio between the polygon size (in screen space) to the size of an area in the viewport for skipping polygons rendering (the ones having a lower ratio will be removed).
    Notice
    Setting too high values may cause small but noticeable visual artifacts when the camera moves.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 50.0f] - available range
6.0f - by default
render_landscape_terrain_geometry_preset
Description:
  • Variable.   Prints the current index of the currently used Landscape Terrain geometry preset.
  • Command.   Sets the index of the currently used Landscape Terrain geometry preset.
    Notice
    Presets override user-defined custom settings. When any preset other than Custom is active, modification of the parameters via API has no effect. The parameter value set via the last API call shall be used only when the Custom preset is active. When checking the current parameter value via API you'll get the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - Low (by default)
1 - Medium
2 - High
3 - Ultra
4 - Extreme
5 - Custom
render_landscape_terrain_streaming_preset
Description:
  • Variable.   Prints the current index of the currently used Landscape Terrain streaming preset.
  • Command.   Sets the index of the currently used Landscape Terrain streaming preset.
    Notice
    Presets override user-defined custom settings. When any preset other than Custom is active, modification of the parameters via API has no effect. The parameter value set via the last API call shall be used only when the Custom preset is active. When checking the current parameter value via API you'll get the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - Low (by default)
1 - Medium
2 - High
3 - Ultra
4 - Extreme
5 - Custom
render_landscape_terrain_texel_size
Description:
  • Variable.   Prints the current texel size of the Landscape Terrain render textures representing the maximum level of detail for the albedo, normal, and height components of the Landscape Terrain.
  • Command.   Sets the texel size of the Landscape Terrain render textures representing 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 - by default
render_landscape_terrain_visible_distance
Description:
Arguments:
[0.0f; inf] - available range
30000.0f - by default
render_landscape_terrain_vt_detail_level_by_angle
Description:
  • Variable.   Prints the current value indicating detail level reduction depending on the inclination of the the Landscape Terrain polygons relative to viewing direction.
  • Command.   Sets the value indicating detail level reduction depending on the inclination of the the Landscape Terrain polygons relative to viewing direction. Can be used to reduce streaming load and memory consumption. The value of 1 corresponds to the pixel-to-pixel quality, and lower values decrease it.
Arguments:
[0.0f; 1.0f] - available range
0.95f - by default
render_landscape_terrain_vt_filtering
Description:
  • Variable.   Prints the current filtering mode for the Landscape Terrain textures.
  • Command.   Sets the filtering mode for the Landscape Terrain textures. The following values are available:
    • Low — use the lower mip-level
    • Medium — use the higher mip-level
    • High — linearly interpolate between adjacent mip-levels
Arguments:
0 - Low
1 - Medium (by default)
2 - High
render_landscape_terrain_vt_memory_size
Description:
  • Variable.   Prints the current value defining memory consumption for the Landscape Terrain textures.
  • Command.   Sets the value defining memory consumption for the Landscape Terrain textures. The value is interpreted as follows:
    • 0.0f - 3072×3072 (~200 MB of VRAM)
    • 1.0f - 16384×16384 (~3.1 GB of VRAM)
    • 0.4f - 8192×8192 (~860 MB of VRAM)
Arguments:
[0.0f; 1.0f] - available range
0.4f - by default
render_landscape_terrain_vt_target_resolution
Description:
  • Variable.   Prints the current target resolution (width x height) for the Landscape Terrain, in pixels.
  • Command.   Sets the target resolution (width x height) for the Landscape Terrain, in pixels.
Arguments:
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. You can decrease the value of this parameter to reduce spikes, but in this case streaming becomes slower and more noticeable.
Arguments:
[1; 64] - available range
4 - by default
render_landscape_terrain_vt_tiles_reload_per_frame
Description:
  • Variable.   Prints the current number of tiles to be reloaded per frame after applying changes to the Landscape Terrain surface.
  • Command.   Sets the number of tiles to be reloaded per frame after applying changes to the Landscape Terrain surface.
Arguments:
[1; 64] - available range
4 - by 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 - by default

Notice
The commands described below affect only terrain (the ObjectTerrainGlobal class).
render_terrain_global_anisotropy
Description:
  • Variable.   Prints the current global terrain texture anisotropy level (degree of anisotropic filtering).
  • Command.   Sets the global terrain texture anisotropy level (degree of anisotropic filtering). Anisotropy for the global terrain has a huge impact for the performance if terrain has a lot of tiled detail materials as anisotropy filtering for the terrain is much slower than for the other objects.
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.   Toggles the value indicating if displacement mapping is enabled for the Global Terrain.
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.   Toggles the value indicating if displacement mapping for the Global Terrain rendering uses normals.
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.   Toggles the value indicating if decal-based holes are enabled for the global terrain.
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.   Toggles the value indicating if triplanar texture mapping is enabled for the Global Terrain. If disabled, planar UV-mapping is used.
Arguments:
0 - disabled (by default)
1 - enabled

ObjectWaterGlobal 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. The following values are available:
    • 1x — anisotropy level 1
    • 2x — anisotropy level 2
    • 4x — anisotropy level 4
    • 8x — anisotropy level 8
    • 16x — anisotropy level 16
Arguments:
0 - 1x
1 - 2x (by default)
2 - 4x
3 - 8x
4 - 16x
render_water_environment_probes
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if rendering of environment probes on the water surface is enabled.
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.   Toggles the value indicating if voxel probes are enabled for water rendering.
Arguments:
0 - disabled
1 - enabled (by default)
render_water_planar_probes
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables rendering of planar probes on the water surface.
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.   Toggles the value indicating if rendering of lights on the water surface is enabled.
    Notice
    The option doesn't affect the World Light source.
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.   Toggles the value indicating if depth data for water is written to the 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:
One of the following values:
  • 0 - low quality
  • 1 - medium quality
  • 2 - high quality
  • 3 - ultra quality
The default value is (2)
render_water_ssr
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the SSR (Screen Space Reflections) effect is enabled for water.
Arguments:
0 - disabled
1 - enabled (by default)
render_water_ssr_quality
Description:
  • Variable.   Prints the current resolution of water SSR (Screen Space Reflections).
  • Command.   Sets the resolution of water SSR (Screen Space Reflections).
Arguments:
One of the following values:
  • 0 - low quality
  • 1 - medium quality
  • 2 - high quality
  • 3 - ultra quality
The default value is (1)
render_water_ssr_increased_accuracy
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if increased accuracy for the water SSR (Screen Space Reflections). This option reduces visual artifacts by increasing accuracy of the last step.
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.   Toggles the value indicating if rendering of underwater shafts is enabled.
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.   Toggles the value indicating if the wetness effect for objects near the shoreline is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_water_geometry_preset
Description:
  • Variable.   Prints the current index of the currently used Global Water geometry preset.
  • Command.   Sets the index of the currently used Global Water geometry preset.
Arguments:
0 - Low (by default)
1 - Medium
2 - High
3 - Ultra
4 - Extreme
5 - Custom
render_water_visible_distance
Description:
  • Variable.   Prints the current maximum visibility distance for the Global Water.
  • Command.   Sets the maximum visibility distance for the Global Water. The water is visible, as long as the distance between the camera and the water object does not exceed this value.
Arguments:
[0.0f; inf] - available range
30000.0f - by default
render_water_geometry_polygon_size
Description:
  • Variable.   Prints the current size of Global Water polygons.
  • Command.   Sets the size of Global Water polygons. The value defines the maximum allowed density of Global Water geometry. If the polygon size is large, small waves will be lost. It is better to set this parameter to about 1/3 or 1/4 of the smallest wavelength.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1000.0f] - available range
0.01f - by default
render_water_geometry_progression
Description:
  • Variable.   Prints the current progression of Global Water geometry tessellation.
  • Command.   Sets the progression of Global Water geometry tessellation.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 50.0f] - available range
1.5f - by default
render_water_geometry_fade_lods
Description:
  • Variable.   Prints the current intensity of fading between levels of Global Water geometry tessellation.
  • Command.   Sets the intensity of fading between levels of Global Water geometry tessellation. This value can be increased to remove sharp edges between areas with different geometry density.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
0.5f - by default
render_water_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.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active. Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 50.0f] - available range
6.0f - by default
render_water_culling_aggressive
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if frustum culling optimization is enabled for the Global Water. When enabled, the number of culled polygons increases thereby increasing performance. In case of any issues with polygons rendering, try disabling this option (however, note that performance may drop).
Arguments:
0 - disabled
1 - enabled (by default)
render_water_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 - by default
render_water_culling_oblique_frustum
Description:
  • Variable.   Prints the current multiplier for the size of viewing frustum used for culling polygons of Global Water object beyond the oblique frustum plane.
  • Command.   Sets the multiplier for the size of viewing frustum used for culling polygons of Global Water object beyond the oblique frustum plane. The higher the value, the more patches will be culled.
Arguments:
[0.0f; 1.0f] - available range
0.9f - by default
render_water_waterline_accuracy
Description:
  • Variable.   Prints the current quality of underwater and waterline determination.
  • Command.   Sets the quality of underwater and waterline determination. Use high quality only if you need to submerge underwater (to see the waterline) and at medium and high Beaufort values.
Arguments:
One of the following values:
  • 0 - low quality
  • 1 - medium quality
  • 2 - high quality
  • 3 - ultra quality
The default value is (0)

Output Modes#

render_viewport_mode
Description:
  • Variable.   Prints the current viewport rendering mode.
  • Command.   Sets the viewport rendering mode. The following modes are available:
    • Default — default rendering mode.
    • Curved Panorama 180 — 180-degree panorama with curved edges.
    • Curved Panorama 360 — 360-degree panorama with curved edges.
    • Linear Panorama 180 — 180-degree linear panorama without distortion at the edges.
    • Linear Panorama 360 — 360-degree linear panorama without distortion at the edges.
    • Panorama Fisheye Orthographic — orthographic spherical panorama (fisheye) with an adjustable Field of View.
    • Panorama Fisheye Equidistant — equidistant (tru-theta or f-theta) spherical panorama (fisheye) with an adjustable Field of View.
    • Panorama Fisheye Stereographic — stereographic spherical panorama (fisheye) with an adjustable Field of View.
    • Panorama Fisheye Equisolid — equisolid (equal-area) spherical panorama (fisheye) with an adjustable Field of View.
    • Anaglyph — stereo mode that is viewed with red-cyan anaglyph glasses.
    • Interlaced — stereo mode that is used with interlaced stereo monitors and polarized 3D glasses.
    • Horizontal — horizontal stereo mode.
    • Vertical — vertical stereo mode.
    Notice
    If the panoramic rendering is enabled, underwater shafts and water line effects will be disabled.
Arguments:
0 - Default (by default)
1 - Curved Panorama 180
2 - Curved Panorama 360
3 - Linear Panorama 180
4 - Linear Panorama 360
5 - Panorama Fisheye Orthographic
6 - Panorama Fisheye Equidistant
7 - Panorama Fisheye Stereographic
8 - Panorama Fisheye Equisolid
9 - Anaglyph
10 - Interlaced
11 - Horizontal
12 - Vertical
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 the viewport rendering mode (see render_viewport_mode) is set to one of the fisheye panorama modes (5-8).
Arguments:
[0; 360] - available range
0 - by default
render_stereo_hidden_area
Description:
  • Variable.   Prints the current culling mode for pixels that are not visible in VR mode.
  • Command.   Sets the culling mode for pixels that are not visible in VR mode. One of the following values:
    • 0 - hidden area culling is disabled (by default).
    • 1 - OpenVR-based culling mode. Culling is performed using meshes returned by OpenVR.
      Notice
      Culling result depends on HMD used.
    • 2 - Custom culling mode. Culling is performed using mesehes returned by OpenVR and an oval or circular mesh determined by custom adjustable parameters (see render_stereo_hidden_area_transform) .
    This parameter is used for performance optimization.
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 and offset parameters for a new oval or circular mesh to be used for culling pixels, that are not visible in VR mode.
  • Command.   Sets the size and offset parameters for a new oval or circular mesh to be used for culling pixels, that are not visible in VR mode. A four-component vector (X, Y, Z, W), that determines an area to be used for exposure calculation, when culling of pixels, that are not visible in VR mode, is enabled:
    • First two components (X, Y) - sizes along the X and Y axes respectively.
    • Second two components (Z, W) - offset values along the X and Y axes respectively.
      Notice
      These components are ignored whenthe hidden area culling mode (see render_stereo_hidden_area) is set to 2
    All components are specified within the [0.0f, 1.0f] range
Arguments:
(1.0f, 1.0f, 0.0f, 0.0f) - default value
render_stereo_hidden_area_exposure_transform
Description:
  • Variable.   Prints the current area to be used for exposure calculation, when culling of pixels that are not visible in VR mode (see render_stereo_hidden_area) is enabled.
  • Command.   Sets the area to be used for exposure calculation, when culling of pixels that are not visible in VR mode (see render_stereo_hidden_area) is enabled. Correction of this area is used to avoid visual artefacts when clipped pixels affect exposure in visible areas. A four-component vector (X, Y, Z, W):
    • First two components (X, Y) - sizes along the X and Y axes respectively.
    • Second two components (Z, W) - offset values along the X and Y axes respectively.
      Notice
      These components are ignored when the hidden area culling mode (see render_stereo_hidden_area) is set to 2
    All components are specified within the [0.0f, 1.0f] range.
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 duration 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
    Values 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.   Toggles the value indicating if additional hardware occlusion query test before sending data to GPU is enabled. This test is performed for all objects with the Culled by occlusion query flag set.
Arguments:
0 - disabled
1 - enabled (by default)
render_occlusion_queries_num_frames
Description:
  • Variable.   Prints the current number of frames for additional hardware occlusion query test performed before sending data to GPU.
  • Command.   Sets the number of frames for additional hardware occlusion query test performed before sending data to GPU. Make sure that the additional hardware occlusion query test (see render_occlusion_queries) is enabled.
Arguments:
[0; 1024] - available range
5 - by default
render_virtual_resolution
Description:
  • Variable.   Prints the current 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.
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.
    0 - disables FPS clamping.
    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 - by 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:
Arguments:
[1; 32] - available range
1 - by default
bake_lighting_samples_per_frame
Description:
  • Variable.   Prints the current number of voxels computed and visualized per single frame during bake lighting process (higher values cause longer UI response, but speed up calculations).
  • Command.   Sets the number of voxels computed and visualized per single frame during bake lighting process (higher values cause longer UI response, but speed up calculations).
Arguments:
[1; 500] - available range
10 - by default
bake_lighting_voxel_size_multiplier
Description:
Arguments:
[0.0f; 8.0f] - available range
1.0f - by default
bake_lightmap_viewport_mask
Description:
  • Variable. Prints the current viewport mask for the lightmapper.
  • Command. Assigns a new viewport mask for the lightmapper. For a light or surface to contribute to static GI, their viewport masks should match the baking viewport mask.
Arguments:
Viewport mask
bake_lightmap_zfar
Description:
Arguments:
[0.0f; inf] - available range
1000.0f - by default
bake_lightmap_quality
Description:
  • Variable.   Prints the current global baking quality for lightmaps.
  • Command.   Sets the global baking quality for lightmaps.
Arguments:
0 - Draft
1 - Low
2 - Medium (by default)
3 - High
4 - Ultra
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_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

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.
cpu_threads
Description:
  • Variable.   Prints the current CPU threads available.
  • Command.   Sets the CPU threads available.
Arguments:
[0; 1024] - available range
0 - by default
cpu_hyper_threading
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables CPU hyper threading.
Arguments:
0 - disabled (by default)
1 - enabled

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 - by 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
log_stdoutConfig file: *.boot
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables log messages printing in stdout.
    Notice
    Logging to stdout may significantly affect performance, so switch this option off, when you don't need it. You can use log_file for debugging purposes, as it is more performance-friendly.
Arguments:
0 - disabled
1 - enabled (by default)
log_fileConfig file: *.boot
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables log messages saving in the Engine's log file.
    Notice
    This option is used for debugging. Do not turn it off if you need to debug something.
Arguments:
0 - disabled
1 - enabled (by default)
Last update: 2022-02-18
Build: ()