This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Basics
Rendering
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Version Control
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
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
Materials and Shaders
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Animations-Related Classes
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
VR-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials

Streaming

This section contains settings related to resource streaming.

Streaming settings

Streaming Settings
Free Space VRAM The size of additionally reserved VRAM for allocations per frame, in bytes.
Range of values: [0, INT_MAX]. The default value is : 512.
Console access: render_streaming_free_space_vram (API control)
Free Space RAM The size of additionally reserved RAM for allocations per frame, in bytes.
Range of values: [0, INT_MAX]. The default value is : 1024.
Console access: render_streaming_free_space_ram (API control)
Usage Limit VRAM The percentage of the committed video memory available for streaming. If the streaming exceeds the VRAM usage limit, it will start using RAM for loading graphic resources.
Range of values: [10, 100]. The default value is : 80.
Console access: render_streaming_usage_limit_vram (API control)
Usage Limit RAM The percentage of the committed memory available for streaming. If the streaming exceeds the RAM usage limit, the application will crash.
Range of values: [10, 100]. The default value is : 80.
Console access: render_streaming_usage_limit_ram (API control)
Particles Memory Limit The cache memory limit for vertices of particle systems, in percentage of the total GPU memory.
Notice
Setting a too low limit for a huge number of particle systems in the scene may lead to rendering only some of them.

Range of values: [0, 100]. The default value is : 3.
Console access: render_streaming_particles_memory_limit (API control)

Shaders#

Compile Mode The compilation mode for shaders that are used in the loaded world. The following modes are available:
  • Async - asynchronous shaders compilation.
  • Force - forced compilation of shaders required for each frame at ones.
Option #1 is selected by default (see above).
Console access: render_shaders_compile_mode (API control)

Textures#

Streaming Mode The streaming mode for textures. The following modes are available:
  • Async - asynchronous loading of textures.
  • Force - force-loading of textures required for each frame at ones.
Option #1 is selected by default (see above).
Console access: render_streaming_textures_mode (API control)
Mipmaps The value indicating whether texture mipmap loading is enabled. disabled by default.
Console access: render_streaming_textures_mipmaps (API control)
Mipmaps Density The density of mipmaps relative to the screen resolution. This value helps to define which mipmap should be loaded at the current moment. You can specify different values for different quality presets.
Range of values: [0.0f, 1000000.0f]. The default value is : 2.0f.
Console access: render_streaming_textures_mipmaps_density (API control)

Meshes GPU#

Streaming Mode The streaming mode for loading meshes to video memory (VRAM). The following modes are available:
  • Async - asynchronous loading of meshes.
  • Force - force-loading of meshes required for the current frame at once.
  • All - loading all meshes available in the project on the application start-up. This mode is good for small projects with few meshes.
Option #1 is selected by default (see above).
Console access: render_streaming_meshes_mode_vram (API control)

Meshes CPU#

Streaming Mode The streaming mode for loading meshes to memory (RAM). The following modes are available:
  • Async - asychronous loading of meshes.
  • Force - force-loading of meshes required for the current frame at once.
  • All - loading all meshes available in the project on the application start-up. This mode is good for small projects with few meshes.
Option #1 is selected by default (see above).
Console access: render_streaming_meshes_mode_ram (API control)

Prefetch CPU#

Collision Mode The mode of asynchronous pre-loading of meshes to memory before they are used. Pre-loading is available only for meshes, which have at least one surface with the Collision flag set. There are 3 modes of loading such meshes to RAM:
  • Disable - loading is disabled.
  • Radius - meshes within the prefetch radius are loaded.
  • Full - all meshes with the Collision flag are loaded.
This method should be used when the Async streaming mode for meshes is set. Option #1 is selected by default (see above).
Console access: render_streaming_meshes_prefetch_collision (API control)
Intersection Mode The mode of asynchronous pre-loading of meshes into memory before they are used. Pre-loading is available only for meshes, which have at least one surface with the Intersection flag set. There are 3 modes of loading such meshes to RAM:
  • Disable - loading is disabled.
  • Radius - all meshes within the prefetch radius are loaded.
  • Full - all meshes with the Intersection flag are loaded.
This method should be used when the Async streaming mode for meshes is set. Option #1 is selected by default (see above).
Console access: render_streaming_meshes_prefetch_intersection (API control)
Radius The radius within which meshes are pre-loaded into memory. The value should exceed the physics radius (for collisions) and/or the radius within which intersections are calculated.
Range of values: [0.0f, inf]. The default value is : 0.0f.
Console access: render_streaming_meshes_prefetch_radius (API control)
Last update: 2024-08-16
Build: ()