Project

General

Profile

SO3Engine
Lighting management

Functions

int SO3SceneSetShadowColor (mmachine m)
 SO3SceneSetShadowColor : function to defines shadow color of the scene. More...
 
int SO3SceneGetShadowColor (mmachine m)
 SO3SceneGetShadowColor : function to get the shadow color of the scene. More...
 
int SO3SceneSetSelfShadowTexture (mmachine m)
 SO3SceneSetSelfShadowTexture : function to defines self shadow texture. More...
 
int SO3SceneGetSelfShadowTexture (mmachine m)
 SO3SceneGetSelfShadowTexture : function to get the self shadow texture. More...
 
int SO3SceneSetShadowTextureSize (mmachine m)
 SO3SceneSetShadowTextureSize : function to defines shadow texture size. More...
 
int SO3SceneGetShadowTextureSize (mmachine m)
 SO3SceneGetShadowTextureSize : function to get the shadow texture size. More...
 
int SO3SceneSetShadowPreset (mmachine m)
 SO3SceneSetShadowPreset : function to defines a preset shadow subsystem to use. More...
 
int SO3SceneGetShadowPreset (mmachine m)
 SO3SceneGetShadowPreset : function to get the shadow subsystem in use. More...
 
int SO3SceneGetShadowLightingTechnique (mmachine m)
 SO3SceneGetShadowLightingTechnique : function to get technique for shadows. More...
 
int SO3SceneSetShadowLightingTechnique (mmachine m)
 SO3SceneSetShadowLightingTechnique : function to set the shadows technique. More...
 
int SO3SceneSetShadowQuality (mmachine m)
 SO3SceneSetShadowQuality : function to defines shadow quality to use with current shadow technique This works only with texture shadows presets. More...
 
int SO3SceneGetShadowQuality (mmachine m)
 SO3SceneGetShadowQuality : function to get the shadow quality in use This works only with texture shadows presets. More...
 
int SO3SceneSetShadowTextureCount (mmachine m)
 SO3SceneSetShadowTextureCount : function to defines shadow texture count in the scene. More...
 
int SO3SceneSetDefaultShadowCamera (mmachine m)
 SO3SceneSetDefaultShadowCamera : function to defines default shadow camera. More...
 
int SO3SceneSetFocusedShadowCamera (mmachine m)
 SO3SceneSetFocusedShadowCamera : function to set focused shadow camera. More...
 
int SO3SceneSetLISPSMShadowCamera (mmachine m)
 SO3SceneSetLISPSMShadowCamera : function to set LISPSM shadow camera. More...
 
int SO3SceneSetPlaneShadowCamera (mmachine m)
 SO3SceneSetPlaneShadowCamera : function to set Plane shadow camera. More...
 
int SO3SceneSetShadowDirectionalLightExtrusionDistance (mmachine m)
 SO3SceneSetShadowDirectionalLightExtrusionDistance : function to defines shadow directional light extrusion distance. More...
 
int SO3SceneSetShadowFarDistance (mmachine m)
 SO3SceneSetShadowFarDistance : function to defines distance maximum for shadows. More...
 
int SO3SceneSetShadowTextureFadeStart (mmachine m)
 SO3SceneSetShadowTextureFadeStart : function to defines fade start distance for shadows. More...
 
int SO3SceneGetShadowTextureFadeStart (mmachine m)
 SO3SceneGetShadowTextureFadeStart : function to get the shadows fade start distance. More...
 
int SO3SceneSetShadowTextureFadeEnd (mmachine m)
 SO3SceneSetShadowTextureFadeEnd : function to defines fade end distance for shadows. More...
 
int SO3SceneGetShadowTextureFadeEnd (mmachine m)
 SO3SceneGetShadowTextureFadeEnd : function to get the shadows fade end distance. More...
 
int SO3SceneGetShadowTechnique (mmachine m)
 SO3SceneGetShadowTechnique : function to defines technique for shadows. More...
 
int SO3SceneSetShadowDirLightTextureOffset (mmachine m)
 SO3SceneSetShadowDirLightTextureOffset : function to defines texture offset. More...
 
int SO3SceneGetShadowCameraSetup (mmachine m)
 SO3SceneGetShadowCameraSetup : function to get the shadow camera setup mode. More...
 
int SO3SceneGetShadowDirectionalLightExtrusionDistance (mmachine m)
 SO3SceneGetShadowDirectionalLightExtrusionDistance : function to get the shadows direction light extrusion distance. More...
 
int SO3SceneGetShadowFarDistance (mmachine m)
 SO3SceneGetShadowFarDistance : function to get the shadows far distance. More...
 
int SO3SceneGetShadowDirLightTextureOffset (mmachine m)
 SO3SceneGetShadowDirLightTextureOffset : function to get the shadows direction light texture offset. More...
 
int SO3SceneGetShadowTextureCount (mmachine m)
 SO3SceneGetShadowTextureCount : function to get the shadows texture count. More...
 
int SO3SceneSetShadowTechnique (mmachine m)
 SO3SceneSetShadowTechnique : function to get the shadows technique. More...
 
int SO3SceneSetShadowCaster (mmachine m)
 SO3SceneSetShadowCaster : function to defines shadows caster. More...
 
int SO3SceneSetShadowReceiver (mmachine m)
 SO3SceneSetShadowReceiver : function to defines shadows receiver. More...
 
int SO3SceneGetShadowCaster (mmachine m)
 SO3SceneGetShadowCaster : function to retrieve shadows caster material name. More...
 
int SO3SceneGetShadowReceiver (mmachine m)
 SO3SceneGetShadowReceiver : function to retrieve shadows receiver. More...
 

Detailed Description

Scol functions definition

Function Documentation

◆ SO3SceneGetSelfShadowTexture()

int SO3SceneGetSelfShadowTexture ( mmachine  m)

SO3SceneGetSelfShadowTexture : function to get the self shadow texture.

Prototype: fun [SO3_SCENE] I

Parameters
SO3_SCENE: current scene
Returns
I : 1 enable/0 disable if success, NIL otherwise

Definition at line 188 of file SCOLLighting.cpp.

◆ SO3SceneGetShadowCameraSetup()

int SO3SceneGetShadowCameraSetup ( mmachine  m)

SO3SceneGetShadowCameraSetup : function to get the shadow camera setup mode.

Prototype: fun [SO3_SCENE] I

Parameters
SO3_SCENE: current scene
Returns
I : shadow camera setup mode if success, NIL otherwise

DEPRECATED

Definition at line 1150 of file SCOLLighting.cpp.

◆ SO3SceneGetShadowCaster()

int SO3SceneGetShadowCaster ( mmachine  m)

SO3SceneGetShadowCaster : function to retrieve shadows caster material name.

Prototype: fun [SO3_SCENE] S

Parameters
SO3_SCENE: current scene
Returns
S : name for shadow caster material if success, NIL otherwise

Definition at line 1503 of file SCOLLighting.cpp.

◆ SO3SceneGetShadowColor()

int SO3SceneGetShadowColor ( mmachine  m)

SO3SceneGetShadowColor : function to get the shadow color of the scene.

Prototype: fun [SO3_SCENE] I

Parameters
SO3_SCENE: current scene
Returns
I : color (rgba) if success, NIL otherwise

Definition at line 108 of file SCOLLighting.cpp.

◆ SO3SceneGetShadowDirectionalLightExtrusionDistance()

int SO3SceneGetShadowDirectionalLightExtrusionDistance ( mmachine  m)

SO3SceneGetShadowDirectionalLightExtrusionDistance : function to get the shadows direction light extrusion distance.

Prototype: fun [SO3_SCENE] F

Parameters
SO3_SCENE: current scene
Returns
F : distance if success, NIL otherwise

Definition at line 1182 of file SCOLLighting.cpp.

◆ SO3SceneGetShadowDirLightTextureOffset()

int SO3SceneGetShadowDirLightTextureOffset ( mmachine  m)

SO3SceneGetShadowDirLightTextureOffset : function to get the shadows direction light texture offset.

Prototype: fun [SO3_SCENE] F

Parameters
SO3_SCENE: current scene
Returns
F : offset if success, NIL otherwise

Definition at line 1262 of file SCOLLighting.cpp.

◆ SO3SceneGetShadowFarDistance()

int SO3SceneGetShadowFarDistance ( mmachine  m)

SO3SceneGetShadowFarDistance : function to get the shadows far distance.

Prototype: fun [SO3_SCENE] F

Parameters
SO3_SCENE: current scene
Returns
F : distance if success, NIL otherwise

Definition at line 1225 of file SCOLLighting.cpp.

◆ SO3SceneGetShadowLightingTechnique()

int SO3SceneGetShadowLightingTechnique ( mmachine  m)

SO3SceneGetShadowLightingTechnique : function to get technique for shadows.

Prototype: fun [SO3_SCENE] I

Parameters
SO3_SCENE: current scene
Returns
I : shadow technique if success, NIL otherwise

For shadow techniques, values are :

  • SO3_ADDITIVE_SHADOWS_PRESET_TECHNIQUE
  • SO3_MODULATIVE_SHADOWS_PRESET_TECHNIQUE

Definition at line 415 of file SCOLLighting.cpp.

◆ SO3SceneGetShadowPreset()

int SO3SceneGetShadowPreset ( mmachine  m)

SO3SceneGetShadowPreset : function to get the shadow subsystem in use.

Prototype: fun [SO3_SCENE] I

Parameters
SO3_SCENE: current scene
Returns
I : shadow subsystem in use if success, NIL otherwise Possible values:
  • SO3_SHADOWS_PRESET_NONE
  • SO3_SHADOWS_PRESET_STENCIL
  • SO3_SHADOWS_PRESET_LISPSM
  • SO3_SHADOWS_PRESET_CSM
  • SO3_SHADOWS_PRESET_PSSM
  • SO3_SHADOWS_PRESET_DEFERRED

Definition at line 378 of file SCOLLighting.cpp.

◆ SO3SceneGetShadowQuality()

int SO3SceneGetShadowQuality ( mmachine  m)

SO3SceneGetShadowQuality : function to get the shadow quality in use This works only with texture shadows presets.

Prototype: fun [SO3_SCENE] I

Parameters
SO3_SCENE: current scene
Returns
I : shadow quality if success, NIL otherwise Possible values:
  • SO3_SHADOWS_QUALITY_VERYLOW
  • SO3_SHADOWS_QUALITY_LOW
  • SO3_SHADOWS_QUALITY_MEDIUM
  • SO3_SHADOWS_QUALITY_HIGH
  • SO3_SHADOWS_QUALITY_VERYHIGH

Definition at line 554 of file SCOLLighting.cpp.

◆ SO3SceneGetShadowReceiver()

int SO3SceneGetShadowReceiver ( mmachine  m)

SO3SceneGetShadowReceiver : function to retrieve shadows receiver.

Prototype: fun [SO3_SCENE] S

Parameters
SO3_SCENE: current scene
Returns
S : name for shadow receiver material if success, NIL otherwise

Definition at line 1544 of file SCOLLighting.cpp.

◆ SO3SceneGetShadowTechnique()

int SO3SceneGetShadowTechnique ( mmachine  m)

SO3SceneGetShadowTechnique : function to defines technique for shadows.

Prototype: fun [SO3_SCENE] I

Parameters
SO3_SCENE: current scene
Returns
I : shadow technique if success, NIL otherwise

For shadow techniques, values are :

  • SO3_SHADOWTYPE_NONE
  • SO3_SHADOWDETAILTYPE_ADDITIVE
  • SO3_SHADOWDETAILTYPE_MODULATIVE
  • SO3_SHADOWDETAILTYPE_INTEGRATED
  • SO3_SHADOWDETAILTYPE_STENCIL
  • SO3_SHADOWDETAILTYPE_TEXTURE
  • SO3_SHADOWTYPE_STENCIL_MODULATIVE
  • SO3_SHADOWTYPE_STENCIL_ADDITIVE
  • SO3_SHADOWTYPE_TEXTURE_MODULATIVE
  • SO3_SHADOWTYPE_TEXTURE_ADDITIVE
  • SO3_SHADOWTYPE_TEXTURE_ADDITIVE_INTEGRATED
  • SO3_SHADOWTYPE_TEXTURE_MODULATIVE_INTEGRATED

Definition at line 1057 of file SCOLLighting.cpp.

◆ SO3SceneGetShadowTextureCount()

int SO3SceneGetShadowTextureCount ( mmachine  m)

SO3SceneGetShadowTextureCount : function to get the shadows texture count.

Prototype: fun [SO3_SCENE] I

Parameters
SO3_SCENE: current scene
Returns
I : texture count if success, NIL otherwise

Definition at line 1295 of file SCOLLighting.cpp.

◆ SO3SceneGetShadowTextureFadeEnd()

int SO3SceneGetShadowTextureFadeEnd ( mmachine  m)

SO3SceneGetShadowTextureFadeEnd : function to get the shadows fade end distance.

Prototype: fun [SO3_SCENE] F

Parameters
SO3_SCENE: current scene
Returns
F : fade end if success, NIL otherwise

Definition at line 1005 of file SCOLLighting.cpp.

◆ SO3SceneGetShadowTextureFadeStart()

int SO3SceneGetShadowTextureFadeStart ( mmachine  m)

SO3SceneGetShadowTextureFadeStart : function to get the shadows fade start distance.

Prototype: fun [SO3_SCENE] F

Parameters
SO3_SCENE: current scene
Returns
F : fade start if success, NIL otherwise

Definition at line 928 of file SCOLLighting.cpp.

◆ SO3SceneGetShadowTextureSize()

int SO3SceneGetShadowTextureSize ( mmachine  m)

SO3SceneGetShadowTextureSize : function to get the shadow texture size.

Prototype: fun [SO3_SCENE] I

Parameters
SO3_SCENE: current scene
Returns
I : shadow texture size

Definition at line 275 of file SCOLLighting.cpp.

◆ SO3SceneSetDefaultShadowCamera()

int SO3SceneSetDefaultShadowCamera ( mmachine  m)

SO3SceneSetDefaultShadowCamera : function to defines default shadow camera.

Prototype: fun [SO3_SCENE I] I

Parameters
SO3_SCENE: current scene
Returns
I : 1 if success, NIL otherwise

Definition at line 630 of file SCOLLighting.cpp.

◆ SO3SceneSetFocusedShadowCamera()

int SO3SceneSetFocusedShadowCamera ( mmachine  m)

SO3SceneSetFocusedShadowCamera : function to set focused shadow camera.

Prototype: fun [SO3_SCENE] I

Parameters
SO3_SCENE: current scene
Returns
I : 1 if success, NIL otherwise

Definition at line 664 of file SCOLLighting.cpp.

◆ SO3SceneSetLISPSMShadowCamera()

int SO3SceneSetLISPSMShadowCamera ( mmachine  m)

SO3SceneSetLISPSMShadowCamera : function to set LISPSM shadow camera.

Prototype: fun [SO3_SCENE] I

Parameters
SO3_SCENE: current scene
Returns
I : 1 if success, NIL otherwise

Definition at line 706 of file SCOLLighting.cpp.

◆ SO3SceneSetPlaneShadowCamera()

int SO3SceneSetPlaneShadowCamera ( mmachine  m)

SO3SceneSetPlaneShadowCamera : function to set Plane shadow camera.

Prototype: fun [SO3_SCENE [F F F] F] I

Parameters
SO3_SCENE: current scene
[FF F] : vector which defines normal
F: distance
Returns
I : 1 if success, NIL otherwise

Definition at line 750 of file SCOLLighting.cpp.

◆ SO3SceneSetSelfShadowTexture()

int SO3SceneSetSelfShadowTexture ( mmachine  m)

SO3SceneSetSelfShadowTexture : function to defines self shadow texture.

Prototype: fun [SO3_SCENE I] I

Parameters
SO3_SCENE: current scene
I: boolean (1 enable/0 disable)
Returns
I : 1 if success, NIL otherwise

Definition at line 147 of file SCOLLighting.cpp.

◆ SO3SceneSetShadowCaster()

int SO3SceneSetShadowCaster ( mmachine  m)

SO3SceneSetShadowCaster : function to defines shadows caster.

Prototype: fun [SO3_SCENE S] I

Parameters
SO3_SCENE: current scene
S: name for shadow caster material
Returns
I : 1 if success, NIL otherwise

Definition at line 1404 of file SCOLLighting.cpp.

◆ SO3SceneSetShadowColor()

int SO3SceneSetShadowColor ( mmachine  m)

SO3SceneSetShadowColor : function to defines shadow color of the scene.

Prototype: fun [SO3_SCENE I] I

Parameters
SO3_SCENE: current scene
I: color (rgba)
Returns
I : 1 if success, NIL otherwise

Definition at line 70 of file SCOLLighting.cpp.

◆ SO3SceneSetShadowDirectionalLightExtrusionDistance()

int SO3SceneSetShadowDirectionalLightExtrusionDistance ( mmachine  m)

SO3SceneSetShadowDirectionalLightExtrusionDistance : function to defines shadow directional light extrusion distance.

Prototype: fun [SO3_SCENE F] I

Parameters
SO3_SCENE: current scene
F: distance of extrusion light
Returns
I : 1 if success, NIL otherwise

Definition at line 812 of file SCOLLighting.cpp.

◆ SO3SceneSetShadowDirLightTextureOffset()

int SO3SceneSetShadowDirLightTextureOffset ( mmachine  m)

SO3SceneSetShadowDirLightTextureOffset : function to defines texture offset.

Prototype: fun [SO3_SCENE F] I

Parameters
SO3_SCENE: current scene
F: offset
Returns
I : 1 if success, NIL otherwise

Definition at line 1114 of file SCOLLighting.cpp.

◆ SO3SceneSetShadowFarDistance()

int SO3SceneSetShadowFarDistance ( mmachine  m)

SO3SceneSetShadowFarDistance : function to defines distance maximum for shadows.

Prototype: fun [SO3_SCENE F] I

Parameters
SO3_SCENE: current scene
F: distance
Returns
I : 1 if success, NIL otherwise

Definition at line 851 of file SCOLLighting.cpp.

◆ SO3SceneSetShadowLightingTechnique()

int SO3SceneSetShadowLightingTechnique ( mmachine  m)

SO3SceneSetShadowLightingTechnique : function to set the shadows technique.

Prototype: fun [SO3_SCENE I] I

Parameters
SO3_SCENE: current scene
I: shadow technique

For shadow techniques, values are :

  • SO3_ADDITIVE_SHADOWS_PRESET_TECHNIQUE
  • SO3_MODULATIVE_SHADOWS_PRESET_TECHNIQUE
Returns
I : 1 if success, NIL otherwise

Definition at line 458 of file SCOLLighting.cpp.

◆ SO3SceneSetShadowPreset()

int SO3SceneSetShadowPreset ( mmachine  m)

SO3SceneSetShadowPreset : function to defines a preset shadow subsystem to use.

Prototype: fun [SO3_SCENE I] I

Parameters
SO3_SCENE: current scene
I: shadow subsystem to use Possible values:
  • SO3_SHADOWS_PRESET_NONE
  • SO3_SHADOWS_PRESET_STENCIL
  • SO3_SHADOWS_PRESET_LISPSM
  • SO3_SHADOWS_PRESET_CSM
  • SO3_SHADOWS_PRESET_PSSM
  • SO3_SHADOWS_PRESET_DEFERRED
Returns
I : 1 if success, NIL otherwise

Definition at line 324 of file SCOLLighting.cpp.

◆ SO3SceneSetShadowQuality()

int SO3SceneSetShadowQuality ( mmachine  m)

SO3SceneSetShadowQuality : function to defines shadow quality to use with current shadow technique This works only with texture shadows presets.

Prototype: fun [SO3_SCENE I] I

Parameters
SO3_SCENE: current scene
I: shadow quality Possible values:
  • SO3_SHADOWS_QUALITY_VERYLOW
  • SO3_SHADOWS_QUALITY_LOW
  • SO3_SHADOWS_QUALITY_MEDIUM
  • SO3_SHADOWS_QUALITY_HIGH
  • SO3_SHADOWS_QUALITY_VERYHIGH
Returns
I : 1 if success, NIL otherwise

Definition at line 504 of file SCOLLighting.cpp.

◆ SO3SceneSetShadowReceiver()

int SO3SceneSetShadowReceiver ( mmachine  m)

SO3SceneSetShadowReceiver : function to defines shadows receiver.

Prototype: fun [SO3_SCENE S] I

Parameters
SO3_SCENE: current scene
S: name for shadow receiver material
Returns
I : 1 if success, NIL otherwise

Definition at line 1453 of file SCOLLighting.cpp.

◆ SO3SceneSetShadowTechnique()

int SO3SceneSetShadowTechnique ( mmachine  m)

SO3SceneSetShadowTechnique : function to get the shadows technique.

Prototype: fun [SO3_SCENE I] I

Parameters
SO3_SCENE: current scene
I: shadow technique

For shadow techniques, values are :

  • SO3_SHADOWTYPE_NONE
  • SO3_SHADOWDETAILTYPE_ADDITIVE
  • SO3_SHADOWDETAILTYPE_MODULATIVE
  • SO3_SHADOWDETAILTYPE_INTEGRATED
  • SO3_SHADOWDETAILTYPE_STENCIL
  • SO3_SHADOWDETAILTYPE_TEXTURE
  • SO3_SHADOWTYPE_STENCIL_MODULATIVE
  • SO3_SHADOWTYPE_STENCIL_ADDITIVE
  • SO3_SHADOWTYPE_TEXTURE_MODULATIVE
  • SO3_SHADOWTYPE_TEXTURE_ADDITIVE
  • SO3_SHADOWTYPE_TEXTURE_ADDITIVE_INTEGRATED
  • SO3_SHADOWTYPE_TEXTURE_MODULATIVE_INTEGRATED
Returns
I : 1 if success, NIL otherwise

Definition at line 1342 of file SCOLLighting.cpp.

◆ SO3SceneSetShadowTextureCount()

int SO3SceneSetShadowTextureCount ( mmachine  m)

SO3SceneSetShadowTextureCount : function to defines shadow texture count in the scene.

Prototype: fun [SO3_SCENE I] I

Parameters
SO3_SCENE: current scene
I: number of shadow textures
Returns
I : 1 if success, NIL otherwise

Definition at line 588 of file SCOLLighting.cpp.

◆ SO3SceneSetShadowTextureFadeEnd()

int SO3SceneSetShadowTextureFadeEnd ( mmachine  m)

SO3SceneSetShadowTextureFadeEnd : function to defines fade end distance for shadows.

Prototype: fun [SO3_SCENE F] I

Parameters
SO3_SCENE: current scene
F: distance
Returns
I : 1 if success, NIL otherwise

Definition at line 967 of file SCOLLighting.cpp.

◆ SO3SceneSetShadowTextureFadeStart()

int SO3SceneSetShadowTextureFadeStart ( mmachine  m)

SO3SceneSetShadowTextureFadeStart : function to defines fade start distance for shadows.

Prototype: fun [SO3_SCENE F] I

Parameters
SO3_SCENE: current scene
F: distance
Returns
I : 1 if success, NIL otherwise

Definition at line 890 of file SCOLLighting.cpp.

◆ SO3SceneSetShadowTextureSize()

int SO3SceneSetShadowTextureSize ( mmachine  m)

SO3SceneSetShadowTextureSize : function to defines shadow texture size.

Prototype: fun [SO3_SCENE I] I

Parameters
SO3_SCENE: current scene
I: shadow texture size
Returns
I : 1 if success, NIL otherwise

Definition at line 228 of file SCOLLighting.cpp.