Torque 3D - Script Manual: Advanced Lighting

TorqueScript

Main   Class List   Namespace List   Online

Advanced Lighting
[Lighting]

The script functionality related to the Advanced Lghting system. More...

Enumerations

enum  ShadowFilterMode {
  None,
  SoftShadow,
  SoftShadowHighQuality
}
 

The shadow filtering modes for Advanced Lighting shadows.

More...
enum  ShadowType {
  Spot,
  PSSM,
  Paraboloid,
  DualParaboloidSinglePass,
  DualParaboloid,
  CubeMap
}

Variables

float $pref::PSSM::detailAdjustScale
 Scales the model LOD when rendering into the PSSM shadow. Use this to reduce the draw calls when rendering the shadow by having meshes LOD out nearer to the camera than normal.
bool $Shadows::disable
 Used by the editor to disable all shadow rendering.
bool $pref::Shadows::disable
 Used to disable all shadow rendering.
ShadowFilterMode $pref::shadows::filterMode
 The filter mode to use for shadows.
bool $AL::PSSMDebugRender
 Enables debug rendering of the PSSM shadows.
float $pref::PSSM::smallestVisiblePixelSize
 The smallest pixel size an object can be and still be rendered into the PSSM shadow. Use this to force culling of small objects which contribute little to the final shadow.
float $pref::Shadows::textureScalar
 Used to scale the shadow texture sizes. This can reduce the shadow quality and texture memory overhead or increase them.
bool $AL::UseSSAOMask
 Used by the SSAO PostEffect to toggle the sampling of ssaomask texture by the light shaders.

Detailed Description

The script functionality related to the Advanced Lghting system.


Enumeration Type Documentation

The shadow filtering modes for Advanced Lighting shadows.

Enumerator:
None 

Simple point sampled filtering. This is the fastest and lowest quality mode.

SoftShadow 

A variable tap rotated poisson disk soft shadow filter. It performs 4 taps to classify the point as in shadow, out of shadow, or along a shadow edge. Samples on the edge get an additional 8 taps to soften them.

SoftShadowHighQuality 

A 12 tap rotated poisson disk soft shadow filter. It performs all the taps for every point without any early rejection.

enum ShadowType
Enumerator:
Spot 
PSSM 
Paraboloid 
DualParaboloidSinglePass 
DualParaboloid 
CubeMap 

Variable Documentation

float $pref::PSSM::detailAdjustScale

Scales the model LOD when rendering into the PSSM shadow. Use this to reduce the draw calls when rendering the shadow by having meshes LOD out nearer to the camera than normal.

See also:
$pref::TS::detailAdjust
bool $Shadows::disable

Used by the editor to disable all shadow rendering.

bool $pref::Shadows::disable

Used to disable all shadow rendering.

ShadowFilterMode $pref::shadows::filterMode

The filter mode to use for shadows.

bool $AL::PSSMDebugRender

Enables debug rendering of the PSSM shadows.

float $pref::PSSM::smallestVisiblePixelSize

The smallest pixel size an object can be and still be rendered into the PSSM shadow. Use this to force culling of small objects which contribute little to the final shadow.

See also:
$pref::TS::smallestVisiblePixelSize
float $pref::Shadows::textureScalar

Used to scale the shadow texture sizes. This can reduce the shadow quality and texture memory overhead or increase them.

bool $AL::UseSSAOMask

Used by the SSAO PostEffect to toggle the sampling of ssaomask texture by the light shaders.



Copyright © GarageGames, LLC. All Rights Reserved.