L3DT users' wiki
Large 3D terrain generator

Sapphire settings

You can edit rendering settings for Sapphire using the 'Extensions→Sapphire→Renderer settings' menu option. This opens a standard Zeolite edit dialog box containing the tree of options, as shown below:

:plugins:sapphire:userguide:sapphire_settings.png
Sapphire settings

The settings are as follows:

UI

StartMaximised

A flag for whether the rendering window should be maximised (true) or normal (false) when it it is first shown.

ShowMenu

A boolean (true/false) flag for whether the menu should be shown at the top of the window in Sapphire.

MouseSpeed

A floating-point number that determines how fast the camera should move when the user moves the mouse. The default value is 1, with larger values giving faster turn rates, and lower values giving slower turn rates.

Keys

This list contains the hotkeys used for Sapphire controls. Please refer to the changing shortcut kets guide for tips on changing these settings.

Timers

Loop

The timer delay, in milliseconds, used to redraw the scene and check key/mouse input. The default value is 10ms.

Terrain

FarDistance

The maximum view distance beyond which terrain/objects are not shown, measured in terrain pixel units (independent of horizontal scale).

ROAM

PatchSize

FIXME

OptimiseForView

A boolean (true/false) flag for whether Sapphire should optimise the terrain mesh to look best from the camera position (more detail up close), or be more accurate on average (preserves detail in distance). This can also be set via the 'Options→View-optimised mesh' menu entry in Sapphire.

MinFrameVariance

A floating point value that sets the minimum allowed frame variance for the ROAM terrain algorithm. The default value is 0.1, and this value should not be changed.

Texture

StitchTileBorders

A boolean (true/false) flag for whether Sapphire should automatically stitch the borders of texture tiles together to remove seams. This option eliminates subtle seams at tile borders, but is more disk/CPU/GPU-intensive.

LodEnabled

A boolean (true/false) flag for whether level-of-detail management should be used on the terrain texture. If enabled, Sapphire will use disk-paged mipmaps to automatically provide the highest possible terrain texture resolution that can fit within the given hardware profile (see 'Extensions→Sapphire→Hardware settings' menu option in L3DT.)

LodDistance

The distance from the camera, in vertex units, after which the texture level-of-detail algorithm should halve the texture resolution. The default value is 2048.

LodAutoBiasEnabled

A boolean (true/false) flag for whether Sapphire should automatically manage the bias setting in the texture level of detail algorithm. This can also be enabled by pressing the '\' key.

TotalVram / MaxUsedVram / MinUsedVram

These settings should not be edited directly. Instead, use the 'Extensions→Sapphire→Hardware settings' menu option in L3DT to set the amount of video RAM to be used by Sapphire.

Atmosphere

SkyColour

The RGB colour of the background sky.

FogColour

The RGB colour of the fog.

FogDistanceFactor

The distance to the fog cutoff (100% fog), relative to the renderer's far distance. A value of 0.67 (default) means that 100% fog is reached at ~2/3rds the way to the far clipping distance.

FogEnabled

A boolean (true/false) flag for whether OpenGL fog should be enabled. This can also be set via the 'Options→Show fog' menu entry in Sapphire.

WaterMap

IsShown

A boooan (true/false) flag for whether the water map should be shown if it is available. This can also be set via the 'Options→Show water' menu entry in Sapphire.

Texture

The filename of the image to be used as the water texture. Standard image formats are supported.

TextureScale

A floating point number that sets the horizontal stretching of the water texture. The default value is 10 texture pixels per heightfield pixel, with lower values giving a more stretched-out water texture, and higher values giving a more compressed water texture (more detailed, but more repetitive).

TextureAlpha

The alpha value, as a decimal from 0..1, used to set the transparency of the water texture. A value of 1 is fully opaque, and a value of 0 is fully transparent.

Camera

ViewportAngle

The default viewport angle for the scene renderer, in degrees (45 is defualt). A lower value gives telescopic zoom, and a higher value gives fish-eye perspective. Note that the scroll-wheel can be used to zoom-in during rendering (decreasing the viewport angle).

Skybox

Textures

These are the six texture images (right/left, front/back and top/bottom) used to decorate the skybox in Sapphire. To generate new skybox images, please refer to the maping a skybox using Terragen tutorial.

IsShown

A boolean (true/false) flag for whether the skybox should be shown. This can also be set via the 'Options→Show skybox' menu entry in Sapphire.

 
plugins/sapphire/userguide/settings.txt · Last modified: 2017/08/31 06:43 (external edit)
 
Except where otherwise noted, content on this wiki is licensed under the following license:CC Attribution-Share Alike 3.0 Unported
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki