SDK:SDK/Engine/Options/List

From Programmer Art

Contents

realWorld

interpupillaryDistance

(floating-point)
distance between the player's pupils

distanceToScreen

(floating-point)
distance from the player's eyes to the screen

displayWidth

(floating-point)
physical width of the screen. Used in conjunction with displayAspectX & displayAspectY options

displayAspectX

(floating-point)
eg. 4 or 16

displayAspectY

(floating-point)
eg. 3 or 9

headMountedDisplay

(true/false)
the display is head-mounted (HMD)

debug

testFloat

(floating-point)
a general-purpose test float Currently used in a stereo ZPD test (see CViewInfo::ApplyCamera).

testBool

(true/false)
a general-purpose test option. Currently enables a stereo ZPD test (see CViewInfo::ApplyCamera).

exhibitLighting

(true/false)
exhibit lighting & shadows

saveOptions

(true/false)

chugmaster

(true/false)

processFonts

(true/false)

processMeshes

(true/false)

processMenus

(true/false)

reloadOnWindowFocus

(true/false)

pauseModeOnWindowFocus

(true/false)

allowFrozenPauseBackground

(true/false)

overCullRedraws

(true/false)

allowInstanceRainOcclusion

(true/false)

timeTillAttractMode

(floating-point)

attractModeDuration

(floating-point)
number of seconds taken to do the attract loop (controls speed)

drawBanner

(true/false)
draw v16 banner in attract mode

attractLerpT

(floating-point)
T for matrix lerp for attract cam

lockMenus

(true/false)
menu options can't be changed

lockLights

(true/false)
lights can't be toggled

lockProjectors

(true/false)
lock projector assignments

display

useMaxRefreshRate

(true/false)
use the highest supported refresh rate

refreshRate

(integer)
specific refresh rate to use if !useMaxRefreshRate

fullScreen

(true/false)
start in full-screen mode

fullScreenXRes

(integer)
res for full-screen mode

fullScreenYRes

(integer)
res for full-screen mode

windowXRes

(integer)
desired window width

windowYRes

(integer)
desired window height

frameRT

(render target)

adapterOrdinal

(integer)
index of the adapter (monitor) on which we want to create the D3D device

lighting

RT

(render target)

RTFavourFloat

(true/false)
for lighting render-targets, use a floating-point format if 2-10-10-10 is unavailable

RTForceFloat

(true/false)
for lighting render-targets, force a floating-point format

shadows

numProjectors

(integer)

projectorRT

(render target)
width & height of projector depth images. See CProjector::RestoreDeviceObjects

sourceRT

(render target)
width & height of shadow image

destRT

(render target)
width & height of blurred shadow image

soft

(true/false)
soften the shadows

groundCastsShadows

(true/false)
ground casts shadows (kerbs etc)

defaultLightEmissionRadius

(floating-point)
default value for lights' emission radius. TODO: emission radius parameter on the lights themselves?

maxDiffusionRadius

(floating-point)
maximum limit on the world-space diffusion that a shadow can attain. Larger = more diffused shadows (more artefacts and more expensive).

reflections

RT

(render target)

HDR

toneMapping

(true/false)

blueShift

(true/false)

bloom

(true/false)

bloomStrength

(floating-point)
bloom strength multiplier

glare

(true/false)

glareStrength

(floating-point)
glare strength multiplier

middleGrey

(floating-point)
0..1

screenEffects

colourGrading

(true/false)
enable colour grading

colourGradingMap

(enumeration)
RGB curve map for colour grading

  • ECOLOURGRADINGMAP_DEFAULT
  • ECOLOURGRADINGMAP_3DVISOR

edgeBlur

(true/false)
blur/darken the edges of the screen

landscape

groundPatchwork

(true/false)
enable ground patchwork?

groundReflections

(true/false)
enable ground reflections?

groundPatchworkRT

(render target)

dimpleNormalsRT

(render target)

dimples

(true/false)
simple puddles otherwise

groundPOM

(true/false)
enable parallax occlusion mapping on the ground

groundPOMMaxSamples

(integer)
maximum number of height samples per pixel for ground POM

POM_LOD

(true/false)
use LODding for all POM

weather

rainOcclusion

(true/false)
occlusion of rain visuals

rainOcclusionRT

(render target)
RT for rain occlusion

rainFalling

(true/false)
falling rain

rainSplashes

(true/false)
rain impact splashes

rainRipples

(true/false)
rain impact ripples

rainImpactRT

(render target)
RT for rain splash tile

rainSplashSourceRT

(render target)
RT for rain impact splash source

rainSplashDestRT

(render target)
RT for rain impact splash final

rainImpactNumParticles

(integer)
num splashes/ripples

mist

(true/false)
mist effects enabled

mistLightingRT

(render target)
mist/rain lighting image

wind

(true/false)
wind effects enabled

stereoscopy

mode

(enumeration)
stereoscopy mode

  • ESTEREOSCOPYMODE_NONE
  • ESTEREOSCOPYMODE_DUAL_MONITOR_1
  • ESTEREOSCOPYMODE_DUAL_MONITOR_2
  • ESTEREOSCOPYMODE_IZ3D
  • ESTEREOSCOPYMODE_IZ3D_SWAPPED
  • ESTEREOSCOPYMODE_ANAGLYPH
  • ESTEREOSCOPYMODE_WOWVX
  • ESTEREOSCOPYMODE_SIDE_BY_SIDE_1
  • ESTEREOSCOPYMODE_SIDE_BY_SIDE_2
  • ESTEREOSCOPYMODE_CROSS_EYED
  • ESTEREOSCOPYMODE_OVER_UNDER_1
  • ESTEREOSCOPYMODE_OVER_UNDER_2
  • ESTEREOSCOPYMODE_OVER_UNDER_GAP_1
  • ESTEREOSCOPYMODE_OVER_UNDER_GAP_2
  • ESTEREOSCOPYMODE_CHECKERBOARD_1
  • ESTEREOSCOPYMODE_CHECKERBOARD_2
  • ESTEREOSCOPYMODE_LINE_SEQUENTIAL_1
  • ESTEREOSCOPYMODE_LINE_SEQUENTIAL_2
  • ESTEREOSCOPYMODE_COLUMN_SEQUENTIAL_1
  • ESTEREOSCOPYMODE_COLUMN_SEQUENTIAL_2
  • ESTEREOSCOPYMODE_FRAME_SEQUENTIAL_1
  • ESTEREOSCOPYMODE_FRAME_SEQUENTIAL_2

sceneScale

(floating-point)
stereo scene scale

mirrorMode

(enumeration)
eye mirroring (h-flipping) mode

  • ESTEREOSCOPYMIRRORMODE_NONE
  • ESTEREOSCOPYMIRRORMODE_LEFT
  • ESTEREOSCOPYMIRRORMODE_RIGHT
  • ESTEREOSCOPYMIRRORMODE_BOTH

overUnderGapSize

(floating-point)
size of over-under gap

frameSequentialStyle

(enumeration)
update after every eye, or just after the second eye?

  • EFRAMESEQUENTIALSTYLE_SMOOTHER
  • EFRAMESEQUENTIALSTYLE_MORE_SYNCHRONISED

interlaceStyle

(enumeration)
in interlaced and column modes, do we prefer blockier or fizzier? (see devlog for more details)

  • ESTEREOSCOPYINTERLACESTYLE_BLOCKY
  • ESTEREOSCOPYINTERLACESTYLE_FIZZY

iWearUnleashed

(true/false)
unsynchronised iWear stereo (maximum speed)

iZ3DLeftRightRT

(render target)
specifications of the iZ3D left & right RTs. NOTE: dimenions should always match frameRT! (unless unused)

anaglyph

leftFilterColour

(enumeration)

  • EANAGLYPHFILTERCOLOUR_RED
  • EANAGLYPHFILTERCOLOUR_CYAN
  • EANAGLYPHFILTERCOLOUR_BLUE
  • EANAGLYPHFILTERCOLOUR_GREEN
  • EANAGLYPHFILTERCOLOUR_YELLOW
  • EANAGLYPHFILTERCOLOUR_MAGENTA

rightFilterColour

(enumeration)

  • EANAGLYPHFILTERCOLOUR_RED
  • EANAGLYPHFILTERCOLOUR_CYAN
  • EANAGLYPHFILTERCOLOUR_BLUE
  • EANAGLYPHFILTERCOLOUR_GREEN
  • EANAGLYPHFILTERCOLOUR_YELLOW
  • EANAGLYPHFILTERCOLOUR_MAGENTA

saturation

(floating-point)
(0..1) amount of saturation to enforce in the pre-split scene

ghostReduction

(true/false)
enable ghost reduction

ghostReductionLeft

(floating-point)
amount to deghost left eye

ghostReductionRight

(floating-point)
amount to deghost right eye

ghostReductionMultiply

(floating-point)
amount to multiply desaturated source image before deghosting

ghostReductionAdd

(floating-point)

WOWvx

nearDist

(floating-point)
ws near dist

farDist

(floating-point)
ws far dist

contentType

(enumeration)

  • EWOWVXCONTENTTYPE_NO_DEPTH
  • EWOWVXCONTENTTYPE_SIGNAGE
  • EWOWVXCONTENTTYPE_MOVIE
  • EWOWVXCONTENTTYPE_GAME
  • EWOWVXCONTENTTYPE_CGI
  • EWOWVXCONTENTTYPE_STILL
  • EWOWVXCONTENTTYPE_RESERVED

factor

(integer 0..255)

offset

(integer 0..255)

factorSelect

(true/false)

offsetSelect

(true/false)

motionBlur

type

(enumeration)

  • EMOTIONBLURTYPE_NONE
  • EMOTIONBLURTYPE_EYE
  • EMOTIONBLURTYPE_FILM

blurQuality

(enumeration)
controls number of samples

  • EMOTIONBLURQUALITY_LOW
  • EMOTIONBLURQUALITY_MEDIUM
  • EMOTIONBLURQUALITY_HIGH

eyeStyle_persistence

(floating-point)
0 = none .. 1 = unusable

filmStyle_shutterAngle

(integer)
degrees

secondaryBlur

(true/false)
blend the scene towards the bloom image according to each pixel's speed (done in HDRLighting.fx)

distanceForMaxSamples

(floating-point)
screen-space step above which, the max number of samples will be used for the motion blur

velocityRT

(render target)

blurredVelocityRT

(render target)

blurVelocityImage

(true/false)
blur the velocity image

general

language

(enumeration)
français / English

  • ELANGUAGE_FRANCAIS
  • ELANGUAGE_ENGLISH

nearClip

(floating-point)
default near clipping distance for cameras

farClip

(floating-point)
default far clipping distance for cameras

autoFOV

(true/false)
calculate FOV automatically from aspect ratio, viewing distance and display width

verticalFOVDegrees

(floating-point)
vertical FOV, used if not set to auto-FOV

player

scaleFactor

(floating-point)
scale multiplier

runSpeed

(floating-point)
run speed in units per second (gets multiplied by scaleFactor)

strafeSpeed

(floating-point)
strafe speed in units per second (gets multiplied by scaleFactor)

debugAnimSpeed

(floating-point)
multiplier for animation speed (for prototyping only)

allowThirdPerson

(true/false)
allow the player to enter third-person mode

audio

earWind

(true/false)
sound of wind rushing past the ears

headTracking

threadPriority

(enumeration)
private: read 'windowsThreadPriority' instead

  • ETHREADPRIORITY_LOWEST
  • ETHREADPRIORITY_BELOW_NORMAL
  • ETHREADPRIORITY_NORMAL
  • ETHREADPRIORITY_ABOVE_NORMAL
  • ETHREADPRIORITY_HIGHEST

hardwareHint

(enumeration)
hint for the headtracking mode we want

  • EHEADTRACKINGHARDWAREHINT_NONE
  • EHEADTRACKINGHARDWAREHINT_OPTITRACK
  • EHEADTRACKINGHARDWAREHINT_3DVISOR
  • EHEADTRACKINGHARDWAREHINT_IWEAR
  • EHEADTRACKINGHARDWAREHINT_FORCE_NONE

separateThread

(true/false)
read headtracking hardware on a separate thread

ignoreYaw

(true/false)
ignore headtracker yaw values (only applies to certain headtrackers)

headOffsetMatrix

(matrix)
offset transform from TrackClip to head

OptiTrack

cameraOrientation

(enumeration)

  • EOPTITRACKORIENTATION_0
  • EOPTITRACKORIENTATION_90
  • EOPTITRACKORIENTATION_180
  • EOPTITRACKORIENTATION_270

cameraMountedOnMonitor

(true/false)

smoothingRange

(floating-point)

xHalfFOVTangent

(floating-point)

yHalfFOVTangent

(floating-point)

videoThreshold

(floating-point)

controls

mousePitch

(true/false)
look up & down with the mouse

mousePitchSpeed

(floating-point)

mouseTurnSpeed

(floating-point)

invertMouse

(true/false)
inverted = flight-sim mouse