Project

General

Profile

SO3Engine
Viewport

Functions

int SO3ViewportCreate (mmachine m)
 SO3ViewportCreate : create a new SO3_VIEWPORT object. More...
 
int SO3ViewportDestroy (mmachine m)
 SO3ViewportDestroy : destroy a SO3_VIEWPORT object. More...
 
int SO3ViewportResize (mmachine m)
 SO3ViewportResize : resize a given viewport. More...
 
int SO3ViewportGetTriangleCount (mmachine m)
 SO3ViewportGetTriangleCount : get the number of triangles rendered in last viewport update. More...
 
int SO3ViewportGetBatchCount (mmachine m)
 SO3ViewportGetBatchCount : get the number of batch rendered in last viewport update. More...
 
int SO3ViewportGetPriority (mmachine m)
 SO3ViewportGetPriority : get the priority (z order) of a given viewport. More...
 
int SO3ViewportGetShadowEnabled (mmachine m)
 SO3ViewportGetShadowEnabled : get the shadow state of a given viewport. More...
 
int SO3ViewportSetPositionSize (mmachine m)
 SO3ViewportSetPositionSize : set Position and size on a given viewport. More...
 
int SO3ViewportSetShadowEnabled (mmachine m)
 SO3ViewportSetShadowEnabled : set shadows enable state on a given viewport. More...
 
int SO3ViewportSetDeferredEnabled (mmachine m)
 SO3ViewportSetDeferredEnabled : set deffered render enable state on a given viewport. More...
 
int SO3ViewportGetDeferredEnabled (mmachine m)
 SO3ViewportGetDeferredEnabled : get the deferred state of a given viewport. More...
 
int SO3ViewportSetHDREnabled (mmachine m)
 SO3ViewportSetHDREnabled : set HDR enable state on a given viewport. More...
 
int SO3ViewportGetHDREnabled (mmachine m)
 SO3ViewportGetHDREnabled : get the HDR state of a given viewport. More...
 
int SO3ViewportSetHDRBlurAmount (mmachine m)
 SO3ViewportSetHDRBlurAmount : set the HDR blur amount on a given viewport. More...
 
int SO3ViewportSetHDREffectAmount (mmachine m)
 SO3ViewportSetHDREffectAmount : set the HDR shaft effect amount on a given viewport. More...
 
int SO3ViewportSetHDRGamma (mmachine m)
 SO3ViewportSetHDRGamma : set the HDR gamma correction on a given viewport. More...
 
int SO3ViewportSetSSAOEnabled (mmachine m)
 SO3ViewportSetSSAOEnabled : set SSAO enable state on a given viewport SSAO is an automated ambient occlusion method. More...
 
int SO3ViewportGetSSAOEnabled (mmachine m)
 SO3ViewportGetSSAOEnabled : get the SSAO state of a given viewport. More...
 
int SO3ViewportGetDeferredAntiAliasingMode (mmachine m)
 SO3ViewportGetDeferredAntiAliasingMode : get deffered Anti aliasing method used on a given viewport. More...
 
int SO3ViewportSetDeferredAntiAliasingMode (mmachine m)
 SO3ViewportSetDeferredAntiAliasingMode : set deffered anti aliasing method on a given viewport. More...
 
int SO3ViewportGetDeferredDebugMode (mmachine m)
 SO3ViewportGetDeferredDebugMode : get deffered debug visualization on a given viewport. More...
 
int SO3ViewportSetDeferredDebugMode (mmachine m)
 SO3ViewportSetDeferredDebugMode : set deffered debug visualization on a given viewport. More...
 
int SO3ViewportGetPositionSize (mmachine m)
 SO3ViewportGetPositionSize : Get Position and Size of on a given viewport, relative to the window. More...
 
int SO3ViewportGetPixelPositionSize (mmachine m)
 SO3ViewportGetPixelPositionSize : Get Position and Size in pixels of on a given viewport. More...
 
int SO3ViewportGetCamera (mmachine m)
 SO3ViewportGetCamera : Get the camera attached to a given viewport. More...
 
int SO3ViewportSetBackgroundColor (mmachine m)
 SO3ViewportSetBackgroundColor : defines background color on a given viewport. More...
 
int SO3ViewportGetBackgroundColor (mmachine m)
 SO3ViewportGetBackgroundColor : Get the background color on a given viewport. More...
 
int SO3ViewportSetClearDepth (mmachine m)
 SO3ViewportSetClearDepth : defines if the viewport clear the depth buffer or not. More...
 
int SO3ViewportGetClearDepth (mmachine m)
 SO3ViewportGetClearDepth : Get if the viewport clear the depth buffer or not. More...
 
int SO3ViewportSetClearColor (mmachine m)
 SO3ViewportSetClearColor : defines if the viewport clear the color buffer or not. More...
 
int SO3ViewportGetClearColor (mmachine m)
 SO3ViewportGetClearColor : Get if the viewport clear the color buffer or not. More...
 
int SO3ViewportAddCompositor (mmachine m)
 SO3ViewportAddCompositor : Add a compositor on a given viewport. More...
 
int SO3ViewportSetMaterialScheme (mmachine m)
 SO3ViewportSetMaterialScheme : Set a material scheme on a given viewport. More...
 
int SO3ViewportGetMaterialScheme (mmachine m)
 SO3ViewportGetMaterialScheme : Get the material scheme which the viewport should use. More...
 
int SO3ViewportListEnabledCompositors (mmachine m)
 SO3ViewportListEnabledCompositors : List compositors name on a given viewport. More...
 
int SO3ViewportRemoveCompositor (mmachine m)
 SO3ViewportRemoveCompositor : Remove a compositor from a given viewport. More...
 
int SO3CompositorSetEnable (mmachine m)
 SO3CompositorSetEnable : Set Compositor state on a given viewport. More...
 
int SO3CompositorGetEnable (mmachine m)
 SO3CompositorGetEnable : Get Compositor state on a given viewport. More...
 
int SO3CompositorGetNumTechniques (mmachine m)
 SO3CompositorGetNumTechniques : More...
 
int SO3CompositorGetNumTargets (mmachine m)
 SO3CompositorGetNumTargets : More...
 
int SO3CompositorGetNumPasses (mmachine m)
 SO3CompositorGetNumPasses : More...
 
int SO3CompositorGetPassType (mmachine m)
 SO3CompositorGetPassType : More...
 
int SO3CompositorGetMaterial (mmachine m)
 SO3CompositorGetMaterial : More...
 
int SO3ViewportSetSkyEnable (mmachine m)
 SO3ViewportSetSkyEnable : Set the skies visibility state on a given viewport. More...
 
int SO3ViewportGetSkyEnable (mmachine m)
 SO3ViewportGetSkyEnable : Get the skies visibility state on a given viewport. More...
 
int SO3ViewportSetOverlayEnable (mmachine m)
 SO3ViewportSetOverlayEnable : Set the overlay visibility state on a given viewport. More...
 
int SO3ViewportGetOverlayEnable (mmachine m)
 SO3ViewportGetOverlayEnable : Get the overlay visibility state on a given viewport. More...
 
int SO3ViewportSetVisibilityMask (mmachine m)
 SO3ViewportSetVisibilityMask : Set the viewport visibility mask for exclude some objects from the render. More...
 
int SO3ViewportGetVisibilityMask (mmachine m)
 SO3ViewportGetVisibilityMask : Get the current viewport visibility flag. More...
 
int SO3ViewportSetVisibilityMaskIndexEnable (mmachine m)
 SO3ViewportSetVisibilityMaskIndexEnable : BLABLA. More...
 
int SO3ViewportGetVisibilityMaskIndexEnable (mmachine m)
 SO3ViewportGetVisibilityMaskIndexEnable : BLABLA. More...
 
int SO3ViewportGetPixelPositionFromWorldPos (mmachine m)
 SO3ViewportGetPixelPositionFromWorldPos : Get the pixel position of a 3D world position return NIL if the coords are out of the camera. More...
 
int SO3ViewportGetWorldPosFromPixelPosition (mmachine m)
 SO3ViewportGetWorldPosFromPixelPosition : Get the world position of a 2D pixel position. More...
 
int SO3ViewportSetSSAOTechnique (mmachine m)
 SO3ViewportSetSSAOTechnique : Sets the SSAO technique to use. More...
 
int SO3ViewportGetSSAOTechnique (mmachine m)
 SO3ViewportGetSSAOTechnique : Retrieves the current SSAO technique in use. More...
 
int SO3ViewportSetSSAOTechniqueParameters (mmachine m)
 SO3ViewportSetSSAOTechniqueParameters : Sets all parameter for the given SSAO technique. WARNING: Every viewport that uses this SSAO technique will take those parameters in count! More...
 
int SO3ViewportGetSSAOTechniqueParameters (mmachine m)
 SO3ViewportGetSSAOTechniqueParameters : Retrieves every parameter for the given SSAO technique. More...
 
int SO3ViewportSetSSAOTechniqueParameterValue (mmachine m)
 SO3ViewportSetSSAOTechniqueParameterValue : Retrieves a parameter's value for the given SSAO technique. More...
 
int SO3ViewportGetSSAOTechniqueParameterValue (mmachine m)
 SO3ViewportGetSSAOTechniqueParameterValue : Retrieves a parameter's value for the given SSAO technique. More...
 
int SO3ViewportSetSSAOFilter (mmachine m)
 SO3ViewportSetSSAOFilter : Sets the SSAO filter to use. More...
 
int SO3ViewportGetSSAOFilter (mmachine m)
 SO3ViewportGetSSAOFilter : Retrieves the current SSAO filter in use. More...
 
int SO3ViewportSetSSAODebugMode (mmachine m)
 SO3ViewportSetSSAODebugMode : Sets the SSAO debug vizualization to use. More...
 
int SO3ViewportGetSSAODebugMode (mmachine m)
 SO3ViewportGetSSAODebugMode : Retrieves the current SSAO debug visualization mode in use. More...
 

Detailed Description

Scol functions definition

Function Documentation

◆ SO3CompositorGetEnable()

int SO3CompositorGetEnable ( mmachine  m)

SO3CompositorGetEnable : Get Compositor state on a given viewport.

Prototype: fun [SO3_VIEWPORT S] I

Parameters
SO3_VIEWPORT: current viewport
S: name of the compositor
Returns
I : 1 for enable, 0 for disable, NIL otherwise

Definition at line 1674 of file SCOLViewport.cpp.

◆ SO3CompositorGetMaterial()

int SO3CompositorGetMaterial ( mmachine  m)

SO3CompositorGetMaterial :

Prototype: fun [SO3_VIEWPORT S I I I] I

Parameters
SO3_VIEWPORT: viewport
S: name of the compositor
I: compositor technique
I: compositor target
I: compositor pass
Returns
I : Number of passes of the compositor target, NIL on error.

Definition at line 1939 of file SCOLViewport.cpp.

◆ SO3CompositorGetNumPasses()

int SO3CompositorGetNumPasses ( mmachine  m)

SO3CompositorGetNumPasses :

Prototype: fun [SO3_VIEWPORT S I I] I

Parameters
SO3_VIEWPORT: viewport
S: name of the compositor
I: compositor technique
I: compositor target
Returns
I : Number of passes of the compositor target, NIL on error.

Definition at line 1811 of file SCOLViewport.cpp.

◆ SO3CompositorGetNumTargets()

int SO3CompositorGetNumTargets ( mmachine  m)

SO3CompositorGetNumTargets :

Prototype: fun [SO3_VIEWPORT S I] I

Parameters
SO3_VIEWPORT: viewport
S: name of the compositor
I: compositor technique
Returns
I : Number of targets of the compositor technique, NIL on error.

Definition at line 1761 of file SCOLViewport.cpp.

◆ SO3CompositorGetNumTechniques()

int SO3CompositorGetNumTechniques ( mmachine  m)

SO3CompositorGetNumTechniques :

Prototype: fun [SO3_VIEWPORT S] I

Parameters
SO3_VIEWPORT: viewport
S: name of the compositor
Returns
I : Number of technique of the compositor, NIL on error.

Definition at line 1719 of file SCOLViewport.cpp.

◆ SO3CompositorGetPassType()

int SO3CompositorGetPassType ( mmachine  m)

SO3CompositorGetPassType :

Prototype: fun [SO3_VIEWPORT S I I I] I

Parameters
SO3_VIEWPORT: viewport
S: name of the compositor
I: compositor technique
I: compositor target
I: compositor pass
Returns
I : Pass type, NIL on error. SO3_COMPOSITOR_PASS_CLEAR SO3_COMPOSITOR_PASS_STENCIL SO3_COMPOSITOR_PASS_RENDERSCENE SO3_COMPOSITOR_PASS_RENDERQUAD SO3_COMPOSITOR_PASS_RENDER_CUSTOM

Definition at line 1874 of file SCOLViewport.cpp.

◆ SO3CompositorSetEnable()

int SO3CompositorSetEnable ( mmachine  m)

SO3CompositorSetEnable : Set Compositor state on a given viewport.

Prototype: fun [SO3_VIEWPORT S I] I

Parameters
SO3_VIEWPORT: current viewport
S: name of the compositor
I: 1 for enable, 0 for disable
Returns
I : 1 if success , NIL otherwise

Definition at line 1629 of file SCOLViewport.cpp.

◆ SO3ViewportAddCompositor()

int SO3ViewportAddCompositor ( mmachine  m)

SO3ViewportAddCompositor : Add a compositor on a given viewport.

Prototype: fun [SO3_VIEWPORT S S] I

Parameters
SO3_VIEWPORT: target viewport
S: name of the compositor
S: name of the scheme mask
Returns
I : 1 if success , NIL otherwise

Definition at line 1402 of file SCOLViewport.cpp.

◆ SO3ViewportCreate()

int SO3ViewportCreate ( mmachine  m)

SO3ViewportCreate : create a new SO3_VIEWPORT object.

Prototype: fun [Chn SO3_BUFFER SO3_OBJECT F F F F I] SO3_VIEWPORT

Parameters
SO3_BUFFER: current buffer
SO3_OBJECT: current camera
F: x position
F: y position
F: width
F: height
I: z order
Returns
SO3_VIEWPORT : viewport object created if success, NIL otherwise

Definition at line 83 of file SCOLViewport.cpp.

◆ SO3ViewportDestroy()

int SO3ViewportDestroy ( mmachine  m)

SO3ViewportDestroy : destroy a SO3_VIEWPORT object.

Prototype: fun [SO3_VIEWPORT] I

Parameters
SO3_VIEWPORT: current viewport
Returns
I : 0 if success , NIL otherwise

Definition at line 173 of file SCOLViewport.cpp.

◆ SO3ViewportGetBackgroundColor()

int SO3ViewportGetBackgroundColor ( mmachine  m)

SO3ViewportGetBackgroundColor : Get the background color on a given viewport.

Prototype: fun [SO3_VIEWPORT] I

Parameters
SO3_VIEWPORT: current viewport
Returns
I : The background color if success , NIL otherwise

Definition at line 1210 of file SCOLViewport.cpp.

◆ SO3ViewportGetBatchCount()

int SO3ViewportGetBatchCount ( mmachine  m)

SO3ViewportGetBatchCount : get the number of batch rendered in last viewport update.

Prototype: fun [SO3_VIEWPORT] I

Parameters
SO3_VIEWPORT: current viewport
Returns
I : number of batch if success , NIL otherwise

Definition at line 286 of file SCOLViewport.cpp.

◆ SO3ViewportGetCamera()

int SO3ViewportGetCamera ( mmachine  m)

SO3ViewportGetCamera : Get the camera attached to a given viewport.

Prototype: fun [SO3_VIEWPORT] SO3_OBJECT

Parameters
SO3_VIEWPORT: current viewport
SO3_SCENE: current scene
Returns
SO3_OBJECT : camera if success , NIL otherwise

Definition at line 1122 of file SCOLViewport.cpp.

◆ SO3ViewportGetClearColor()

int SO3ViewportGetClearColor ( mmachine  m)

SO3ViewportGetClearColor : Get if the viewport clear the color buffer or not.

Prototype: fun [SO3_VIEWPORT] I

Parameters
SO3_VIEWPORT: current viewport
Returns
I : 1 if enable, 0 if disable, NIL otherwise

Definition at line 1364 of file SCOLViewport.cpp.

◆ SO3ViewportGetClearDepth()

int SO3ViewportGetClearDepth ( mmachine  m)

SO3ViewportGetClearDepth : Get if the viewport clear the depth buffer or not.

Prototype: fun [SO3_VIEWPORT] I

Parameters
SO3_VIEWPORT: current viewport
Returns
I : 1 if enable, 0 if disable, NIL otherwise

Definition at line 1286 of file SCOLViewport.cpp.

◆ SO3ViewportGetDeferredAntiAliasingMode()

int SO3ViewportGetDeferredAntiAliasingMode ( mmachine  m)

SO3ViewportGetDeferredAntiAliasingMode : get deffered Anti aliasing method used on a given viewport.

Prototype: fun [SO3_VIEWPORT] I

Parameters
SO3_VIEWPORT: current viewport
Returns
I : The current anti aliasing mode used by deferred renderer if success , NIL otherwise

Definition at line 845 of file SCOLViewport.cpp.

◆ SO3ViewportGetDeferredDebugMode()

int SO3ViewportGetDeferredDebugMode ( mmachine  m)

SO3ViewportGetDeferredDebugMode : get deffered debug visualization on a given viewport.

Prototype: fun [SO3_VIEWPORT] I

Parameters
SO3_VIEWPORT: current viewport
Returns
I : The desired visualization mode if success , NIL otherwise

Definition at line 933 of file SCOLViewport.cpp.

◆ SO3ViewportGetDeferredEnabled()

int SO3ViewportGetDeferredEnabled ( mmachine  m)

SO3ViewportGetDeferredEnabled : get the deferred state of a given viewport.

Prototype: fun [SO3_VIEWPORT] I

Parameters
SO3_VIEWPORT: current viewport
Returns
I : Deferred state if success , NIL otherwise

Definition at line 519 of file SCOLViewport.cpp.

◆ SO3ViewportGetHDREnabled()

int SO3ViewportGetHDREnabled ( mmachine  m)

SO3ViewportGetHDREnabled : get the HDR state of a given viewport.

Prototype: fun [SO3_VIEWPORT] I

Parameters
SO3_VIEWPORT: current viewport
Returns
I : HDR state if success , NIL otherwise

Definition at line 602 of file SCOLViewport.cpp.

◆ SO3ViewportGetMaterialScheme()

int SO3ViewportGetMaterialScheme ( mmachine  m)

SO3ViewportGetMaterialScheme : Get the material scheme which the viewport should use.

Prototype: fun [SO3_VIEWPORT] S

Parameters
SO3_VIEWPORT: current viewport
Returns
S : Name of the material scheme if success , NIL otherwise

Definition at line 1483 of file SCOLViewport.cpp.

◆ SO3ViewportGetOverlayEnable()

int SO3ViewportGetOverlayEnable ( mmachine  m)

SO3ViewportGetOverlayEnable : Get the overlay visibility state on a given viewport.

Prototype: fun [SO3_VIEWPORT] I

Parameters
SO3_VIEWPORT: current viewport
Returns
I : 1 for enable, 0 for disable, NIL otherwise

Definition at line 2135 of file SCOLViewport.cpp.

◆ SO3ViewportGetPixelPositionFromWorldPos()

int SO3ViewportGetPixelPositionFromWorldPos ( mmachine  m)

SO3ViewportGetPixelPositionFromWorldPos : Get the pixel position of a 3D world position return NIL if the coords are out of the camera.

Prototype: fun [SO3_VIEWPORT [F F F]] [I I]

Parameters
SO3_VIEWPORT: current viewport
[FF F] : world position
Returns
[I I] : position if success , NIL otherwise
  • left position in pixel
  • top position in pixel

Definition at line 2331 of file SCOLViewport.cpp.

◆ SO3ViewportGetPixelPositionSize()

int SO3ViewportGetPixelPositionSize ( mmachine  m)

SO3ViewportGetPixelPositionSize : Get Position and Size in pixels of on a given viewport.

Prototype: fun [SO3_VIEWPORT] [I I I I]

Parameters
SO3_VIEWPORT: current viewport
Returns
[I I I I] : position/size if success , NIL otherwise
  • left position in pixel
  • top position in pixel
  • width in pixel
  • height in pixel

Definition at line 1076 of file SCOLViewport.cpp.

◆ SO3ViewportGetPositionSize()

int SO3ViewportGetPositionSize ( mmachine  m)

SO3ViewportGetPositionSize : Get Position and Size of on a given viewport, relative to the window.

Prototype: fun [SO3_VIEWPORT] [F F F F]

Parameters
SO3_VIEWPORT: current viewport
Returns
[F F F F] : position/size if success , NIL otherwise
  • left position
  • top position
  • width
  • height

Definition at line 1027 of file SCOLViewport.cpp.

◆ SO3ViewportGetPriority()

int SO3ViewportGetPriority ( mmachine  m)

SO3ViewportGetPriority : get the priority (z order) of a given viewport.

Prototype: fun [SO3_VIEWPORT] I

Parameters
SO3_VIEWPORT: current viewport
Returns
I : Z Order if success , NIL otherwise

Definition at line 320 of file SCOLViewport.cpp.

◆ SO3ViewportGetShadowEnabled()

int SO3ViewportGetShadowEnabled ( mmachine  m)

SO3ViewportGetShadowEnabled : get the shadow state of a given viewport.

Prototype: fun [SO3_VIEWPORT] I

Parameters
SO3_VIEWPORT: current viewport
Returns
I : shadows state if success , NIL otherwise

Definition at line 355 of file SCOLViewport.cpp.

◆ SO3ViewportGetSkyEnable()

int SO3ViewportGetSkyEnable ( mmachine  m)

SO3ViewportGetSkyEnable : Get the skies visibility state on a given viewport.

Prototype: fun [SO3_VIEWPORT] I

Parameters
SO3_VIEWPORT: current viewport
Returns
I : 1 for enable, 0 for disable, NIL otherwise

Definition at line 2053 of file SCOLViewport.cpp.

◆ SO3ViewportGetSSAODebugMode()

int SO3ViewportGetSSAODebugMode ( mmachine  m)

SO3ViewportGetSSAODebugMode : Retrieves the current SSAO debug visualization mode in use.

Prototype: fun [SO3_VIEWPORT] I

Parameters
SO3_VIEWPORT: target viewport
Returns
I : SSAO debug visualization mode if succes, NIL otherwise.

Valid SSAO debug vizualization mode are :

  • SO3_SSAO_DEBUG_MODE_NONE
  • SO3_SSAO_DEBUG_MODE_DEPTH
  • SO3_SSAO_DEBUG_MODE_NORMAL // Do not work with every SSAO techniques!
  • SO3_SSAO_DEBUG_MODE_POSITION // Do not work with every SSAO techniques!
  • SO3_SSAO_DEBUG_MODE_SSAO_ONLY

Definition at line 3095 of file SCOLViewport.cpp.

◆ SO3ViewportGetSSAOEnabled()

int SO3ViewportGetSSAOEnabled ( mmachine  m)

SO3ViewportGetSSAOEnabled : get the SSAO state of a given viewport.

Prototype: fun [SO3_VIEWPORT] I

Parameters
SO3_VIEWPORT: current viewport
Returns
I : SSAO state if success , NIL otherwise

Definition at line 807 of file SCOLViewport.cpp.

◆ SO3ViewportGetSSAOFilter()

int SO3ViewportGetSSAOFilter ( mmachine  m)

SO3ViewportGetSSAOFilter : Retrieves the current SSAO filter in use.

Prototype: fun [SO3_VIEWPORT] I

Parameters
SO3_VIEWPORT: target viewport
Returns
I : SSAO filter if succes, NIL otherwise.

Valid SSAO filters are :

  • SO3_SSAO_FILTER_NONE
  • SO3_SSAO_FILTER_BOX
  • SO3_SSAO_FILTER_BOX_SMART

Definition at line 2980 of file SCOLViewport.cpp.

◆ SO3ViewportGetSSAOTechnique()

int SO3ViewportGetSSAOTechnique ( mmachine  m)

SO3ViewportGetSSAOTechnique : Retrieves the current SSAO technique in use.

Prototype: fun [SO3_VIEWPORT] I

Parameters
SO3_VIEWPORT: target viewport
Returns
I : SSAO technique if succes, NIL otherwise.

Valids SSAO technique are :

  • SO3_SSAO_TECHNIQUE_CRYTEK
  • SO3_SSAO_TECHNIQUE_HEMISPHERIC
  • SO3_SSAO_TECHNIQUE_CREASE_SHADING

Definition at line 2559 of file SCOLViewport.cpp.

◆ SO3ViewportGetSSAOTechniqueParameters()

int SO3ViewportGetSSAOTechniqueParameters ( mmachine  m)

SO3ViewportGetSSAOTechniqueParameters : Retrieves every parameter for the given SSAO technique.

Prototype: fun [SO3_VIEWPORT I] [[S [S F F F]] r1]

Parameters
SO3_VIEWPORT: target viewport
I: SSAO technique for which we wish to get the parameters.
Returns
[[S [S F F F]] r1] : A recursive list containing a tuple, composed of the name of the parameter and a second tuple containing parameter display name, minimum and maximum value for this parameter, and the current value.

Valid SSAO technique are :

  • SO3_SSAO_TECHNIQUE_CRYTEK
  • SO3_SSAO_TECHNIQUE_HEMISPHERIC
  • SO3_SSAO_TECHNIQUE_CREASE_SHADING

Definition at line 2689 of file SCOLViewport.cpp.

◆ SO3ViewportGetSSAOTechniqueParameterValue()

int SO3ViewportGetSSAOTechniqueParameterValue ( mmachine  m)

SO3ViewportGetSSAOTechniqueParameterValue : Retrieves a parameter's value for the given SSAO technique.

Prototype: fun [SO3_VIEWPORT I S] F

Parameters
SO3_VIEWPORT: target viewport
I: SSAO technique for which we wish to get the parameters.
S: Parameter name.
Returns
F : Parameter value, NIL if error occurs.

Definition at line 2858 of file SCOLViewport.cpp.

◆ SO3ViewportGetTriangleCount()

int SO3ViewportGetTriangleCount ( mmachine  m)

SO3ViewportGetTriangleCount : get the number of triangles rendered in last viewport update.

Prototype: fun [SO3_VIEWPORT] I

Parameters
SO3_VIEWPORT: current viewport
Returns
I : number of triangles if success , NIL otherwise

Definition at line 252 of file SCOLViewport.cpp.

◆ SO3ViewportGetVisibilityMask()

int SO3ViewportGetVisibilityMask ( mmachine  m)

SO3ViewportGetVisibilityMask : Get the current viewport visibility flag.

Prototype: fun [SO3_VIEWPORT] I

Parameters
SO3_VIEWPORT: current viewport
Returns
I : current flag, NIL otherwise

Definition at line 2214 of file SCOLViewport.cpp.

◆ SO3ViewportGetVisibilityMaskIndexEnable()

int SO3ViewportGetVisibilityMaskIndexEnable ( mmachine  m)

SO3ViewportGetVisibilityMaskIndexEnable : BLABLA.

Prototype: fun [SO3_VIEWPORT I] I

Parameters
SO3_VIEWPORT: current viewport
I: flag index. Flag index range is from 0 to 31 (which means that 32 different visibility layers are possible)
Returns
I : 1 if flag is enable, false if disable, NIL on error

Definition at line 2289 of file SCOLViewport.cpp.

◆ SO3ViewportGetWorldPosFromPixelPosition()

int SO3ViewportGetWorldPosFromPixelPosition ( mmachine  m)

SO3ViewportGetWorldPosFromPixelPosition : Get the world position of a 2D pixel position.

Prototype: fun [SO3_VIEWPORT I I F] [[F F F] [F F F]]

Parameters
SO3_VIEWPORT: current viewport
I: X position
I: Y position
F: Distance from camera
Returns
[[F F F] [F F F]] : world position and direction if success , NIL otherwise

Definition at line 2398 of file SCOLViewport.cpp.

◆ SO3ViewportListEnabledCompositors()

int SO3ViewportListEnabledCompositors ( mmachine  m)

SO3ViewportListEnabledCompositors : List compositors name on a given viewport.

Prototype: fun [SO3_VIEWPORT] [S r1]

Parameters
SO3_VIEWPORT: current viewport
Returns
[S r1] : compositors list if success , NIL otherwise

Definition at line 1520 of file SCOLViewport.cpp.

◆ SO3ViewportRemoveCompositor()

int SO3ViewportRemoveCompositor ( mmachine  m)

SO3ViewportRemoveCompositor : Remove a compositor from a given viewport.

Prototype: fun [SO3_VIEWPORT S] I

Parameters
SO3_VIEWPORT: current viewport
S: name of the compositor
Returns
I : 1 if success , NIL otherwise

Definition at line 1580 of file SCOLViewport.cpp.

◆ SO3ViewportResize()

int SO3ViewportResize ( mmachine  m)

SO3ViewportResize : resize a given viewport.

Prototype: fun [SO3_VIEWPORT I I] I

Parameters
SO3_VIEWPORT: current viewport
I: new viewport width, in pixels
I: new viewport height, in pixels
Returns
I : 0 if success , NIL otherwise

Definition at line 211 of file SCOLViewport.cpp.

◆ SO3ViewportSetBackgroundColor()

int SO3ViewportSetBackgroundColor ( mmachine  m)

SO3ViewportSetBackgroundColor : defines background color on a given viewport.

Prototype: fun [SO3_VIEWPORT I] I

Parameters
SO3_VIEWPORT: current viewport
I: background color (rgba)
Returns
I : 1 if success , NIL otherwise

Definition at line 1174 of file SCOLViewport.cpp.

◆ SO3ViewportSetClearColor()

int SO3ViewportSetClearColor ( mmachine  m)

SO3ViewportSetClearColor : defines if the viewport clear the color buffer or not.

Prototype: fun [SO3_VIEWPORT I] I

Parameters
SO3_VIEWPORT: current viewport
I: 1 to enable 0 otherwise
Returns
I : 1 if success , NIL otherwise

Definition at line 1324 of file SCOLViewport.cpp.

◆ SO3ViewportSetClearDepth()

int SO3ViewportSetClearDepth ( mmachine  m)

SO3ViewportSetClearDepth : defines if the viewport clear the depth buffer or not.

Prototype: fun [SO3_VIEWPORT I] I

Parameters
SO3_VIEWPORT: current viewport
I: 1 to enable 0 otherwise
Returns
I : 1 if success , NIL otherwise

Definition at line 1246 of file SCOLViewport.cpp.

◆ SO3ViewportSetDeferredAntiAliasingMode()

int SO3ViewportSetDeferredAntiAliasingMode ( mmachine  m)

SO3ViewportSetDeferredAntiAliasingMode : set deffered anti aliasing method on a given viewport.

Prototype: fun [SO3_VIEWPORT I] I

Parameters
SO3_VIEWPORT: current viewport
I: The desired anti aliasing mode
Returns
I : 1 if success , NIL otherwise

Definition at line 886 of file SCOLViewport.cpp.

◆ SO3ViewportSetDeferredDebugMode()

int SO3ViewportSetDeferredDebugMode ( mmachine  m)

SO3ViewportSetDeferredDebugMode : set deffered debug visualization on a given viewport.

Prototype: fun [SO3_VIEWPORT I] I

Parameters
SO3_VIEWPORT: current viewport
I: The desired visualization mode
Returns
I : 1 if success , NIL otherwise

Definition at line 976 of file SCOLViewport.cpp.

◆ SO3ViewportSetDeferredEnabled()

int SO3ViewportSetDeferredEnabled ( mmachine  m)

SO3ViewportSetDeferredEnabled : set deffered render enable state on a given viewport.

Prototype: fun [SO3_VIEWPORT I] I

Parameters
SO3_VIEWPORT: current viewport
I: boolean for deferred state
Returns
I : 1 if success , NIL otherwise

Definition at line 479 of file SCOLViewport.cpp.

◆ SO3ViewportSetHDRBlurAmount()

int SO3ViewportSetHDRBlurAmount ( mmachine  m)

SO3ViewportSetHDRBlurAmount : set the HDR blur amount on a given viewport.

Prototype: fun [SO3_VIEWPORT F] I

Parameters
SO3_VIEWPORT: current viewport
F: blur amount 0 to 1
Returns
I : 1 if success , NIL otherwise

Definition at line 641 of file SCOLViewport.cpp.

◆ SO3ViewportSetHDREffectAmount()

int SO3ViewportSetHDREffectAmount ( mmachine  m)

SO3ViewportSetHDREffectAmount : set the HDR shaft effect amount on a given viewport.

Prototype: fun [SO3_VIEWPORT F] I

Parameters
SO3_VIEWPORT: current viewport
F: effect amount 0 to 1
Returns
I : 1 if success , NIL otherwise

Definition at line 684 of file SCOLViewport.cpp.

◆ SO3ViewportSetHDREnabled()

int SO3ViewportSetHDREnabled ( mmachine  m)

SO3ViewportSetHDREnabled : set HDR enable state on a given viewport.

Prototype: fun [SO3_VIEWPORT I] I

Parameters
SO3_VIEWPORT: current viewport
I: boolean for HDR state
Returns
I : 1 if success , NIL otherwise

Definition at line 563 of file SCOLViewport.cpp.

◆ SO3ViewportSetHDRGamma()

int SO3ViewportSetHDRGamma ( mmachine  m)

SO3ViewportSetHDRGamma : set the HDR gamma correction on a given viewport.

Prototype: fun [SO3_VIEWPORT F] I

Parameters
SO3_VIEWPORT: current viewport
F: gamma correction (default 1.0)
Returns
I : 1 if success , NIL otherwise

Definition at line 727 of file SCOLViewport.cpp.

◆ SO3ViewportSetMaterialScheme()

int SO3ViewportSetMaterialScheme ( mmachine  m)

SO3ViewportSetMaterialScheme : Set a material scheme on a given viewport.

Prototype: fun [SO3_VIEWPORT S] I

Parameters
SO3_VIEWPORT: current viewport
S: name of the material scheme
Returns
I : 1 if success , NIL otherwise

Definition at line 1444 of file SCOLViewport.cpp.

◆ SO3ViewportSetOverlayEnable()

int SO3ViewportSetOverlayEnable ( mmachine  m)

SO3ViewportSetOverlayEnable : Set the overlay visibility state on a given viewport.

Prototype: fun [SO3_VIEWPORT I] I

Parameters
SO3_VIEWPORT: current viewport
I: 1 for enable, 0 for disable
Returns
I : 1 if success , NIL otherwise

Definition at line 2093 of file SCOLViewport.cpp.

◆ SO3ViewportSetPositionSize()

int SO3ViewportSetPositionSize ( mmachine  m)

SO3ViewportSetPositionSize : set Position and size on a given viewport.

Prototype: fun [SO3_VIEWPORT F F F F] I

Parameters
SO3_VIEWPORT: current viewport
F: new x position
F: new y position
F: new w size
F: new h size
Returns
I : 1 if success , NIL otherwise

Definition at line 398 of file SCOLViewport.cpp.

◆ SO3ViewportSetShadowEnabled()

int SO3ViewportSetShadowEnabled ( mmachine  m)

SO3ViewportSetShadowEnabled : set shadows enable state on a given viewport.

Prototype: fun [SO3_VIEWPORT I] I

Parameters
SO3_VIEWPORT: current viewport
I: boolean for shadow state
Returns
I : 1 if success , NIL otherwise

Definition at line 441 of file SCOLViewport.cpp.

◆ SO3ViewportSetSkyEnable()

int SO3ViewportSetSkyEnable ( mmachine  m)

SO3ViewportSetSkyEnable : Set the skies visibility state on a given viewport.

Prototype: fun [SO3_VIEWPORT I] I

Parameters
SO3_VIEWPORT: current viewport
I: 1 for enable, 0 for disable
Returns
I : 1 if success , NIL otherwise

Definition at line 2011 of file SCOLViewport.cpp.

◆ SO3ViewportSetSSAODebugMode()

int SO3ViewportSetSSAODebugMode ( mmachine  m)

SO3ViewportSetSSAODebugMode : Sets the SSAO debug vizualization to use.

Prototype: fun [SO3_VIEWPORT I] I

Parameters
SO3_VIEWPORT: target viewport
I: SSAO debug vizualisation mode to use. If NIL, then SO3_SSAO_DEBUG_MODE_NONE will be applied.
Returns
I : 1 if succes, NIL otherwise.

Valid SSAO debug vizualization mode are :

  • SO3_SSAO_DEBUG_MODE_NONE
  • SO3_SSAO_DEBUG_MODE_DEPTH
  • SO3_SSAO_DEBUG_MODE_NORMAL // Do not work with every SSAO techniques!
  • SO3_SSAO_DEBUG_MODE_POSITION // Do not work with every SSAO techniques!
  • SO3_SSAO_DEBUG_MODE_SSAO_ONLY

Definition at line 3032 of file SCOLViewport.cpp.

◆ SO3ViewportSetSSAOEnabled()

int SO3ViewportSetSSAOEnabled ( mmachine  m)

SO3ViewportSetSSAOEnabled : set SSAO enable state on a given viewport SSAO is an automated ambient occlusion method.

Prototype: fun [SO3_VIEWPORT I] I

Parameters
SO3_VIEWPORT: current viewport
I: boolean for SSAO state
Returns
I : 1 if success , NIL otherwise

Definition at line 768 of file SCOLViewport.cpp.

◆ SO3ViewportSetSSAOFilter()

int SO3ViewportSetSSAOFilter ( mmachine  m)

SO3ViewportSetSSAOFilter : Sets the SSAO filter to use.

Prototype: fun [SO3_VIEWPORT I] I

Parameters
SO3_VIEWPORT: target viewport
I: SSAO filter to use. If NIL, then SO3_SSAO_FILTER_NONE will be applied.
Returns
I : 1 if succes, NIL otherwise.

Valid SSAO filters are :

  • SO3_SSAO_FILTER_NONE
  • SO3_SSAO_FILTER_BOX
  • SO3_SSAO_FILTER_BOX_SMART

Definition at line 2919 of file SCOLViewport.cpp.

◆ SO3ViewportSetSSAOTechnique()

int SO3ViewportSetSSAOTechnique ( mmachine  m)

SO3ViewportSetSSAOTechnique : Sets the SSAO technique to use.

Prototype: fun [SO3_VIEWPORT I] I

Parameters
SO3_VIEWPORT: target viewport
I: SSAO technique to use.
Returns
I : 1 if succes, NIL otherwise.

Valid SSAO technique are :

  • SO3_SSAO_TECHNIQUE_NONE
  • SO3_SSAO_TECHNIQUE_CRYTEK
  • SO3_SSAO_TECHNIQUE_HEMISPHERIC
  • SO3_SSAO_TECHNIQUE_CREASE_SHADING

Definition at line 2499 of file SCOLViewport.cpp.

◆ SO3ViewportSetSSAOTechniqueParameters()

int SO3ViewportSetSSAOTechniqueParameters ( mmachine  m)

SO3ViewportSetSSAOTechniqueParameters : Sets all parameter for the given SSAO technique. WARNING: Every viewport that uses this SSAO technique will take those parameters in count!

Prototype: fun [SO3_VIEWPORT I [[S F] r1]] I

Parameters
SO3_VIEWPORT: target viewport
I: SSAO technique for which we wish to change the parameters.
[[SF] r1] : A recursive list containing a tuple, composed of the name of the parameter to change (not the display name!), and the new value of this parameter.
Returns
I : 1 if succes, NIL otherwise.

Valid SSAO technique are :

  • SO3_SSAO_TECHNIQUE_CRYTEK
  • SO3_SSAO_TECHNIQUE_HEMISPHERIC
  • SO3_SSAO_TECHNIQUE_CREASE_SHADING

Definition at line 2611 of file SCOLViewport.cpp.

◆ SO3ViewportSetSSAOTechniqueParameterValue()

int SO3ViewportSetSSAOTechniqueParameterValue ( mmachine  m)

SO3ViewportSetSSAOTechniqueParameterValue : Retrieves a parameter's value for the given SSAO technique.

Prototype: fun [SO3_VIEWPORT I S F] I

Parameters
SO3_VIEWPORT: target viewport
I: SSAO technique for which we wish to set the parameters.
S: Parameter name.
F: New value of the parameter
Returns
I : 1 if success, NIL otherwise.

Definition at line 2799 of file SCOLViewport.cpp.

◆ SO3ViewportSetVisibilityMask()

int SO3ViewportSetVisibilityMask ( mmachine  m)

SO3ViewportSetVisibilityMask : Set the viewport visibility mask for exclude some objects from the render.

Prototype: fun [SO3_VIEWPORT I] I

Parameters
SO3_VIEWPORT: current viewport
I: mask
Returns
I : 1 if success , NIL otherwise

Definition at line 2174 of file SCOLViewport.cpp.

◆ SO3ViewportSetVisibilityMaskIndexEnable()

int SO3ViewportSetVisibilityMaskIndexEnable ( mmachine  m)

SO3ViewportSetVisibilityMaskIndexEnable : BLABLA.

Prototype: fun [SO3_VIEWPORT I I] I

Parameters
SO3_VIEWPORT: current viewport
I: flag index. Flag index range is from 0 to 31 (which means that 32 different visibility layers are possible)
I: 1 to enable, 0 or NIL to disable.
Returns
I : 1 if success , NIL otherwise

Definition at line 2251 of file SCOLViewport.cpp.