This page has been translated automatically.
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
FAQ
Программирование
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and 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
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
CIGI Client Plugin
Rendering-Related Classes
Внимание! Эта версия документация УСТАРЕЛА, поскольку относится к более ранней версии SDK! Пожалуйста, переключитесь на самую актуальную документацию для последней версии SDK.
Внимание! Эта версия документации описывает устаревшую версию SDK, которая больше не поддерживается! Пожалуйста, обновитесь до последней версии SDK.

Camera Effects

A camera effects list contains features specific to the usual SLR camera. To tweak, use Rendering panel -> Camera Effects.

Camera Effects Applied to Viewport

Camera Effects

Common

Threshold Brightness threshold used to determine areas to be illuminated:
  • By the minimum value of 0, the bright areas can become overexposed.
  • The higher the value, the fewer objects are bright enough to be illuminated.
Threshold = 0.6
Threshold = 1.2
Dirt Scale Intensity of the dirt texture.
Dirt A texture that creates an effect of dirty camera lens. For example, it can be used to create an effect of light reflections or unclean optics when the camera looks at the sun.

Example of dirt texture
No dirt texture
Custom dirt texture
Notice
If you can't see the dirt texture, try tweaking the threshold parameter.
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.

Exposure

Camera Mode Camera mode, determines the way the exposure is set:
  • Classic - classic camera model. The amount of luminance is determined by the Exposure parameter, when Exposure Mode is set to Static.
  • Physically Based - physically based camera model. The amount of luminance is determined by the following set of parameters: ISO, Shutter Speed, F-Stop.
    Notice
    Exposure Mode for a physically based camera should always be set to Static.
Notice
Can be controlled via the render_camera_mode console command.
Exposure Mode Exposure mode:
  • Static - a static exposure. The amount of luminance is determined depending on the Camera Mode parameter.
  • Logarithmic adaptive - adaptive logarithmic mapping technique.
  • Quadratic adaptive - adaptive quadratic mapping technique.
Notice
Can be controlled via the render_exposure_mode console command.
Exposure Camera exposure. It determines the resulting amount of luminance:
  • By the minimum value of 0, the image is rendered black.
  • The higher the value, the more luminance and the brighter the scene lit.
Notice
This parameter is available only when the Camera Mode is set to Classic.
Exposure = 0.2
Exposure = 1
Notice
Can be controlled via the render_exposure console command.
ISO ISO number represents the sensitivity of the camera sensor. The higher the ISO number, the more light will be collected and the brighter the image will be.
Notice
  • This parameter is available only when the Camera Mode is set to Physically Based.
  • Can be controlled via the render_iso console command.
Shutter Speed Shutter speed indicates how long the sensor of the camera is actively collecting light. The higher the value, the faster the shutter is and the darker the image will be.
Notice
F-Stop 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 will be.
Notice
  • This parameter is available only when the Camera Mode is set to Physically Based.
  • Can be controlled via the render_f_stop console command.
Adaptation Time in seconds for the camera to adjust exposure (0 is for instant adaptation).
Min Luminance The minimum luminance offset relative to the default luminance of the scene used for rendering of adaptive exposure effect:
  • The higher the value, the darker the adapted image will be.
The parameter can take on negative values.
Notice
If the specified value is greater than the current maximum luminance, the maximum luminance value will be changed to the specified minimum luminance so that they are equal.
Min Luminance = -1
Min Luminance = 2
Max Luminance The maximum luminance offset relative to the default luminance of the scene used for rendering of adaptive exposure effect:
  • The lower the value, the brighter the adapted image will be.
The parameter can take on negative values.
Notice
If the specified value is less than the current minimum luminance, the minimum luminance value will be changed to the specified maximum luminance so that they are equal.

Filmic

The filmic tone mapping provides better image quality. It lightens the darkest image regions and makes the lightest regions darker.

All of the parameters described below represent the tone mapping curve, which is constructed by using the following formula:

  • A - Shoulder Scale
  • B - Linear Scale
  • C - Linear Angle
  • D - Toe Scale
  • E - Toe Numerator
  • F - Toe Denominator

Tone Mapping Curve

For more details about tone mapping curve construction see the article on An efficient and user-friendly tone mapping operator.

The parameters described below are available only when filmic tone mapping is enabled (Rendering -> Camera Effects -> Filmic tone mapping).

Enabled Enables filmic tone mapping.
Shoulder Scale The Shoulder Strength filmic tone mapping parameter value that is used to change bright values.
Shoulder Scale = 0.2 (by default)
Shoulder Scale = 1
Linear Scale The Linear Strength filmic tone mapping parameter value that is used to change grey values. The Linear Scale controls the length of the tone mapping curve linear part.
Linear Scale = 0.3 (by default)
Linear Scale = 1
Linear Angle The Linear Angle filmic tone mapping parameter value. This parameter controls the slope of the linear part of the tone mapping curve.
Linear Angle = 0.10 (by default)
Linear Angle = 1
Toe Scale The Toe Strength filmic tone mapping 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).
Toe Scale = 0.20 (by default)
Toe Scale = 1
Toe Numerator The Toe Numerator filmic tone mapping parameter value.
Toe Numerator = 0.01 (by default)
Toe Numerator = 0.08
Toe Denominator The Toe Denominator filmic tone mapping parameter value.
Toe Denominator = 0.3 (by default)
Toe Denominator = 1
White Level The Linear White Point filmic tone mapping parameter value, which is mapped as pure white in the resulted image.
White Level = 1.0 (by default)
White Level = 0.5

Bloom

Enabled Enables the bloom effect.
Resolution Resolution of the bloom effect:
  • Quarter - quarter resolution.
  • Half - half resolution (by default).
  • Full - full resolution.
Scale Scale of the bloom effect.
Power Power of the bloom effect.
  • At the minimum value of 0.0, the bloom effect is blurred.
  • At the maximum value of 1.0, the bloom effect is more contrast.
Passes Number of passes for the bloom effect. During each pass a bloom texture is generated. Up to 8 bloom textures can be generated: each texture has lower resolution (original size, original size /2, original size /4, so forth) with bloom effect. After that, all these bloom textures with the different resolution are composed for the final bloom texture.

Cross

The parameters described below are available only when cross flares are enabled (Rendering -> Camera Effects -> Cross).

Default cross flares

Enabled Enables cross flares.
Color The color of a cross flares.
Scale Scale of the cross flares, higher values produce more pronounced flares.
Scale = 0.4 (by default)
Scale = 0.7
Shafts The number of shafts in a cross flare.
  • The maximum number of shafts is 32 (high number of flares can cause a FPS drop on low-performance hardware).
Shafts = 1 (minimum)
Shafts = 6 (by default)
Shafts = 32 (maximum)
Length The length of cross flare shafts. Increasing this value also leads to fading of the shafts across their length.
Length = 0.2 (by default)
Length = 0.4
Angle Cross flares orientation angle. The default is 45 degrees.
Angle = 45 (by default)
Angle = 90
Threshold Brightness threshold for areas to produce flare:
  • The higher the threshold value, the brighter the area should be to produce flare.

Sun Shafts

The parameters described below are available only when the light shaft effect is enabled (Rendering -> Sun Shafts).

Shaft flare around the sun

Enabled Enables sun shafts.
Color The color of light shaft.
Scale Scale of the sun shafts, higher values produce larger shafts.
Scale = 1 (by default)
Scale = 2
Length Length of light shaft.
Length = 0.8
Length = 0.95
Attenuation How fast the shafts fade out along their length:
  • By the value of 1 there is no additional attenuation.
  • The lower the value, the smaller the shaft is.
Threshold Brightness threshold for sun to generate light shaft:
  • The higher the threshold value, the brighter the sun should be to generate light shaft.

Lens

The parameters described below are available only when lens flares are enabled (Rendering -> Lens).

Lens flares

Enabled Enables lens flares.
Color The color of lens flares.
Scale A multiplier for a color of lens flares.
Scale = 0.25
Scale = 0.5
Length Length 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.
Radius A radius of the spherical lens flares on the screen.
Radius = 0.07
Radius = 0.1
Threshold The brightness threshold for areas to produce flare:
  • The higher the threshold value, the brighter the area should be to produce flare.
Red Color displacement for the red channel of the lens flares.
Red = 0.9
Red = 1
Red = 1.1
Green Color displacement for the green channel of the lens flares.
Green = 0.9
Green = 1
Green = 1.1
Blue Color displacement for the blue channel of the lens flares.
Blue = 0.9
Blue = 1
Blue = 1.1
Last update: 10.08.2018
Build: ()