class ART::IOptions

Force real mesh shadows to be used for a given category of prisms.

Parameters:

Returns:

Returns:

Returns:

Returns:

Returns:

Returns:

Returns:

Returns:

Parameters:

Returns:

Returns:

Returns:

Get clouds fading distances.

Parameters:

Returns:

Returns:

Returns:

Returns:

Returns:

Returns:

Returns:

Returns:

Returns:

Return the number of auxiliary threads used to calculate the landscape.

Returns:

Returns:

Returns:

Returns:

Parameters:

Returns:

Parameters:

Get prisms fading distances.

Parameters:

Returns:

Parameters:

Returns:

Returns:

Parameters:

Returns:

Parameters:

Returns:

Parameters:

Returns:

Get the snow color and reflectance.

Parameters:

Gets the radius of the SSAO effect.

Returns:

Gets the number of samples to compute the SSAO.

Returns:

Gets the distance where the effect fades out to the screen border.

Returns:

Gets the direction for which the SSR starts to fade when looking at the camera.

Returns:

Gets the object thickness for computing the SSR.

Returns:

Gets the resolution of the SSR ray marching between 0 and 1.

The resolution is the number of samples per pixel. Its value is strictly greater than 0 and lower or equal to 1.

Returns:

Gets the number of refining step after the first raymarching of the SSR.

Returns:

Gets the rendering resolution of the SSR.

Returns:

Gets the strength of the SSR effect.

Returns:

Returns:

Get the bias of star cascaded shadow maps.

Parameters:

Returns:

Returns:

Returns:

Returns:

Parameters:

Access the dimensions of each star cascaded shadow map.

Parameters:

Returns:

Returns:

Return the number of auxiliary threads used for all the calculations.

Returns:

Tests if the SSAO is enabled or not.

Returns:

Returns:

Parameters:

Sets all options default values.

Returns:

Sets the temporal anti-aliasing level for the deferred pipeline.

This method sets the level of AA in use for the entire deferred pipeline. The value if iAA is turned into the square number of samples. iAA = 4 means 4 x 4 = 16 sub samples per pixel. The AA for the deferred pipeline is a temporal anti-aliasing.

Parameters:

Define the maximal anti-aliasing frame to frame accumulation factor.

This alpha value must be greater than the alpha value set using ART::IOptions::SetAntiAliasingAlphaMin. It defines, with the minimal alpha value, the range of variations used by the temporal anti-aliasing to integrate a new frame contribution to the final image.

Larger values for this setting reduce the ghosting but increase flickering.

The startup value for this setting is 0.8. Usual range is in 0.5 - 1.0.

Parameters:

Define the anti-aliasing frame to frame accumulation factor.

This 'alpha' value defines the accumulation factor of the current frame vs. the history of all frames that were rendered before. The accumulation is color = alpha * color( n ) + ( 1 - alpha ) * color( n - 1 ).

The temporal anti-aliasing algorithm may dynamically change the alpha used for frame to frame accumulation and increase it up to the maximal alpha value defined by ART::IOptions::SetAntiAliasingAlphaMax.

Larger values for this setting reduce the ghosting but increase flickering.

The startup value for this setting is 0.1. Usual range is in 0.05 - 0.2.

Parameters:

Defines the anti-aliasing motion threshold.

The anti-aliasing motion threshold defines how much the temporal samples accumulation can be reduced in image areas that exhibit strong differences in motion (for instance with moving objects or after camera movements that change the visibility in an image). A low value of this value increases the ghosting effects of the temporal anti-aliasing and tend to generate smoother variations in the image, while higher values will show less ghosting and more flickering in the image.

Starting values for this setting are in the 0.1 - 0.7 range. Default is 0.4.

Parameters:

Toggle the sky cloud shadows over the atmosphere.

Enabling sky cloud shadows adds shadow casting of the clouds over the atmosphere, resulting in a higher realism, resulting in a higher rendering cost.

Sets the atmospheric gamma transform.

The atmosphere has a specific extra gamma transform that can be applied to it's in-scattering term. This can be used to compensate low sampling rates of the sky to avoid getting dark horizons.

Usual ranges for this setting are in 0.5 - 5.0.

Parameters:

Toggle the sky landscape shadows over the atmosphere.

Enabling sky landscape shadows adds shadow casting of the landscape and vegetation over the atmosphere, resulting in a higher realism, resulting in a higher rendering cost.

Sets the number of atmospheric samples used for the rendering of the atmosphere for a given category of effects.

Parameters:

Enable or disable the display of celestial bodies trajectories.

Parameters:

Define the field of view for switching to 'close orbit' graphics.

A planetary body has three graphics display:

• A 'star in the sky' representation when it's seen from a very far distance like a star in the sky.
• A 'far away' representation which allow for more details.
• A 'close orbit' representation for detailed walkthroughs.

Switching among these graphics mode is based on the visible size of the planetary body on screen. A percentage of the field of view determines when the engine has to switch graphics.

Parameters:

Sets the clouds density.

This is a global scaling factor applied to clouds to control the global clouds density.

Parameters:

Define the clouds fade distances.

Parameters:

Setup the sky relighting amount generated by clouds and clouds covers.

This percentage is a relighting effect generated by clouds and clouds covers resulting of the absorption of the sunlight by clouds and clouds covers. It brightens cloudy shadowed regions.

Parameters:

Sets the clouds rendering resolution.

Sets the clouds downscaling factor in [ 1, 4 ]. The cloud rendering resolution is lowered by 1 << iScale. So setting iScale to 2 reduces the rendering resolution of clouds by 2 in width and height, so 1/4 pixels.

Parameters:

Sets the global world display mode.

Parameters:

Apply a rendered image scaling to the rendered images.

This method can be used to render larger images than actually requested. By setting a scale to x2 x3 or x4, the initial rendered image size will be increased by x2 x3 or x4. For instance rendering a 1920 x 1080 image with a x2 scale renders a 3840 x 2160 real image.

Scaled images are downsized before display or are accessed "as is" if offscreen rendering is enabled.

Modifying FSAA does not change the size of kernels used by the post process camera, that may need to be rescaled accordingly by the calling application.

A change in the FSAA setting has a one frame delay before being actually visible.

Parameters:

Sets the amount of time allowed to update global illumination caches for geometries.

Geometries may need an update, mostly for dynamic global illumination caches. This is the amount of time allowed each frame to perform these update tasks. If 0.0 milliseconds are allowed, geometry updates are still processed at minimal performance rate.

Parameters:

Sets the spreading of GI cache samples used by geometries.

Parameters:

Sets the time allowed to planet landscape operations per frame.

This is the maximal time allowed per frame dedicated to the planet geometry update. Lowering this number smoothes the framerate but the landscape can take longer to update and to show at full quality. Increasing this number will on the other hand favor landscape update speed. In the latter case, depending on the data available from calculating threads, the FPS may suffer some variations.

Parameters:

Sets the number of auxiliary threads used to calculate the landscape.

The default value for this setting is 4096.

Parameters:

Define the planet 'off screen' patch split pixel size.

Parameters:

Define the planet 'on screen' patch split pixel size.

Parameters:

Set the resolution of a planet.

This option value must be set before the simulation startup.

Parameters:

Returns:

Define the prisms density.

This value defines the overall prism density that are spawned. 1.0 is normal density, that can be strengthened or lowered. The default density is 8.0.

Parameters:

Define the prisms spawning method.

If set to true, prisms are accurately scattered over the landscape. When false (the default), prisms are scattered using an approximative method that can lead to a lower amount of representation of prisms in thin densities areas.

Parameters:

Define the prisms fade distances in meters.

This value defines the prism fading distances. Prisms of iType start fading out at iFadeStart and have disappeared at iFadeEnd.

Parameters:

Shift the prism meshes display distance.

This method can be used to globally shift the display distances of all prisms meshes in a category of prisms.

Parameters:

Define the number of passes used for the rendering of prisms.

Reducing the number of passes will improve display performance at the expense of a loss in the visual quality of rendered plants. The default is to use 3 rendering passes for prisms.

Parameters:

Define the shadowing range of prisms.

This sets the number of cascaded shadow maps (starting from the closest CSM number 0 up to the specified iMaxCSM number) that'll cast shadows for the corresponding prisms.

Parameters:

Modify the prisms spawning distance.

This parameter can be set to modify the distance at which prisms are seeded over the landscape. The specified value is an offset added to the initial patch depth at which the selected category of prisms get spawned over the landscape. Increasing the value increases the display depth thus spawning prisms from a closer distance. This reduces the workload of spawning prisms and also may constraint some prisms in size. Decreasing the value decreases the display depth thus spawning prisms from farther away. This increases the prisms workload, make prisms splats visible from farther away too. This relaxes size constraints on prisms.

Parameters:

Define the prisms splat overlap area with prisms.

This value in meters defines the overlap area between the prism and the splat. At zero meters, at the prisms ending fade distance, splats appear entirely. At a distance greater than zero meters, splats start appearing at the prisms end fade distance minus iOverlapDistance and are fully appeared at the prisms end fade distance.

Parameters:

Sets the reflectance multiplier applied on the sky reflections.

This affects the intensity of the reflected sky on the ground.

Parameters:

Sets the color and reflectance of snow.

Parameters:

Enables or disables the SSAO.

Parameters:

Sets the SSAO radius.

Parameters:

Sets the number of samples to compute the SSAO.

Parameters:

Sets the distance to the screen border to start to fade out the effect.

Parameters:

Sets the direction for which the SSR starts to fade when looking at the camera.

Parameters:

Sets the object thickness for computing the SSR.

Parameters:

Sets the resolution of the SSR ray marching between 0 and 1.

The resolution is the number of samples per pixel. Its value is strictly greater than 0 and lower or equal to 1. Set to 1 for the highest quality with a ray marching on every pixel. Set to lower values to reduces the quality by spacing the samples.

Parameters:

Sets the number of refining step after the first raymarching of the SSR.

Parameters:

Sets the rendering resolution of the SSR.

Sets the SSR downscaling factor in [ 1, 4 ]. The SSR rendering resolution is lowered by 1 << iScale. So setting iScale to 2 reduces the rendering resolution of clouds by 2 in width and height, so 1/4 pixels.

Parameters:

Sets the strength of the SSR effect. Set 0 to disable the SSR.

Parameters:

Sets the alpha shadowing threshold of the star cascaded shadow maps.

This is the alpha value of transparent geometries above which they're casting shadows.

Parameters:

Define the bias of star cascaded shadow maps.

Shadow bias is applied as a geometry shifting factor based on the distance between the shadowing geometry and the observer. The square distance is computed d2 and then bias = iScale * pow( d2, iExponent );

Parameters:

Returns:

Sets the blurring effect of the star cascaded shadow maps.

Parameters:

Define the overlap amount between star cascaded shadow maps.

Star cascaded shadow maps can be set with an overlapping percentage that smoothes their transitions.

Parameters:

Define the range of a star cascaded shadow map.

The specified iNumber CSM starts at the effect distance of the previous CSM and ends at iRange. The first CSM starts at 1 meter from the observer. If the specified ranges are not increasing with iNumber, then the world simulation will return an error.

Parameters:

Returns:

Sets the dimensions of the star cascaded shadow maps.

The star cascaded shadow map has dimensions based on the specified iSize. Depending on the aspect ratio of the world region to cover, the star CSM's maximal pixel size is set to iSize and the other dimension of the star CSM is automatically adjusted.

Parameters:

Sets the amount of star GI in shadows.

This method controls the strength of the amount of global illumination of indirect bounces produced by the sunlight. The real-time shading approximates the sun global illumination in lit and shadowed areas using different methods. This parameter controls the strength of the sun global illumination in shadowed areas.

Parameters:

Define the field of view for switching to 'star in the sky' graphics.

A planetary body has three graphics display:

• A 'star in the sky' representation when it's seen from a very far distance like a star in the sky.
• A 'far away' representation which allow for more details.
• A 'close orbit' representation for detailed walkthroughs.

Switching among these graphics mode is based on the visible size of the planetary body on screen. A percentage of the field of view determines when the engine has to switch graphics.

Parameters:

Sets the number of auxiliary threads used for all the calculations.

The default value for this setting is 4096.

Parameters:

Show rendered triangles on / off.

Parameters: