Viewport

Functions

int SO3ViewportCreate (mmachine m)
 main include
int SO3ViewportDestroy (mmachine m)
 SO3ViewportDestroy : destroy a SO3_VIEWPORT object.
int SO3ViewportResize (mmachine m)
 SO3ViewportResize : resize a given viewport.
int SO3ViewportGetPriority (mmachine m)
 SO3ViewportGetPriority : get the priority (z order) of a given viewport.
int SO3ViewportGetShadowEnabled (mmachine m)
 SO3ViewportGetShadowEnabled : get the shadow state of a given viewport.
int SO3ViewportSetPositionSize (mmachine m)
 SO3ViewportSetPositionSize : set Position and size on a given viewport.
int SO3ViewportSetShadowEnabled (mmachine m)
 SO3ViewportSetShadowEnabled : set shadows enable state on a given viewport.
int SO3ViewportGetPositionSize (mmachine m)
 SO3ViewportGetPositionSize : Get Position and Size of on a given viewport, relative to the window.
int SO3ViewportGetPixelPositionSize (mmachine m)
 SO3ViewportGetPixelPositionSize : Get Position and Size in pixels of on a given viewport.
int SO3ViewportGetCamera (mmachine m)
 SO3ViewportGetCamera : Get the camera attached to a given viewport.
int SO3ViewportSetBackgroundColor (mmachine m)
 SO3ViewportSetBackgroundColor : defines background color on a given viewport.
int SO3ViewportGetBackgroundColor (mmachine m)
 SO3ViewportGetBackgroundColor : Get the background color on a given viewport.
int SO3ViewportSetClearDepth (mmachine m)
 SO3ViewportSetClearDepth : defines if the viewport clear the depth buffer or not.
int SO3ViewportGetClearDepth (mmachine m)
 SO3ViewportGetClearDepth : Get if the viewport clear the depth buffer or not.
int SO3ViewportSetClearColor (mmachine m)
 SO3ViewportSetClearColor : defines if the viewport clear the color buffer or not.
int SO3ViewportGetClearColor (mmachine m)
 SO3ViewportGetClearColor : Get if the viewport clear the color buffer or not.
int SO3ViewportAddCompositor (mmachine m)
 SO3ViewportAddCompositor : Add a compositor on a given viewport.
int SO3ViewportSetMaterialScheme (mmachine m)
 SO3ViewportSetMaterialScheme : Set a material scheme on a given viewport.
int SO3ViewportGetMaterialScheme (mmachine m)
 SO3ViewportGetMaterialScheme : Get the material scheme which the viewport should use.
int SO3ViewportListEnabledCompositors (mmachine m)
 SO3ViewportListEnabledCompositors : List compositors name on a given viewport.
int SO3ViewportRemoveCompositor (mmachine m)
 SO3ViewportRemoveCompositor : Remove a compositor from a given viewport.
int SO3CompositorSetEnable (mmachine m)
 SO3CompositorSetEnable : Set Compositor state on a given viewport.
int SO3CompositorGetEnable (mmachine m)
 SO3CompositorGetEnable : Get Compositor state on a given viewport.
int SO3ViewportSetSkyEnable (mmachine m)
 SO3ViewportSetSkyEnable : Set the skies visibility state on a given viewport.
int SO3ViewportGetSkyEnable (mmachine m)
 SO3ViewportGetSkyEnable : Get the skies visibility state on a given viewport.
int SO3ViewportSetOverlayEnable (mmachine m)
 SO3ViewportSetOverlayEnable : Set the overlay visibility state on a given viewport.
int SO3ViewportGetOverlayEnable (mmachine m)
 SO3ViewportGetOverlayEnable : Get the overlay visibility state on a given viewport.
int SO3ViewportSetVisibilityMask (mmachine m)
 SO3ViewportSetVisibilityMask : Set the viewport visibility mask for exclude some objects from the render.
int SO3ViewportGetVisibilityMask (mmachine m)
 SO3ViewportGetVisibilityMask : Get the current viewport visibility flag.

Detailed Description

Scol functions definition

Function Documentation

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 1031 of file SCOLViewport.cpp.

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 986 of file SCOLViewport.cpp.

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 766 of file SCOLViewport.cpp.

int SO3ViewportCreate ( mmachine  m  ) 

main include

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 67 of file SCOLViewport.cpp.

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 155 of file SCOLViewport.cpp.

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 574 of file SCOLViewport.cpp.

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 492 of file SCOLViewport.cpp.

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 728 of file SCOLViewport.cpp.

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 650 of file SCOLViewport.cpp.

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 847 of file SCOLViewport.cpp.

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 1199 of file SCOLViewport.cpp.

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 446 of file SCOLViewport.cpp.

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 397 of file SCOLViewport.cpp.

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 235 of file SCOLViewport.cpp.

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 270 of file SCOLViewport.cpp.

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 1117 of file SCOLViewport.cpp.

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 1280 of file SCOLViewport.cpp.

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 884 of file SCOLViewport.cpp.

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 944 of file SCOLViewport.cpp.

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 193 of file SCOLViewport.cpp.

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 538 of file SCOLViewport.cpp.

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 688 of file SCOLViewport.cpp.

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 610 of file SCOLViewport.cpp.

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 compositor
Returns:
I : 1 if success , NIL otherwise

Definition at line 808 of file SCOLViewport.cpp.

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 1157 of file SCOLViewport.cpp.

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 313 of file SCOLViewport.cpp.

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 356 of file SCOLViewport.cpp.

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 1075 of file SCOLViewport.cpp.

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 1238 of file SCOLViewport.cpp.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Mon Oct 31 14:42:34 2011 for SO3Engine by  doxygen 1.6.3