Rendering and Buffer

Functions

int SO3BufferCreate (mmachine m)
 SO3BufferCreate : This function create a new SO3_BUFFER Object.
int SO3BufferSetProperties (mmachine m)
 SO3BufferSetProperties : This function defines properties of a SO3_BUFFER Object.
int SO3BufferSetStereoVision (mmachine m)
 SO3BufferSetStereoVision : This function defines stereo vision mode on a SO3_BUFFER Object.
int SO3BufferGetStereoVisionProperties (mmachine m)
 SO3BufferGetStereoVisionProperties : Get stereo vision properties.
int SO3GetAPIVersion (mmachine m)
 SO3GetAPIVersion : Get the SO3 plugin API version.
int SO3GetGeneralInfo (mmachine m)
 SO3GetGeneralInfo : Get general informations about the user system.
int SO3GetFullscreenVideoMode (mmachine m)
 SO3GetFullscreenVideoMode : Get fullscreen video mode supported by user.
int SO3GetMultisamplingMode (mmachine m)
 SO3GetMultisamplingMode : Get multi sampling mode supported by user.
int SO3BufferGetFSAA (mmachine m)
 SO3BufferGetFSAA : Get multi sampling mode setted.
int SO3GetRendererInfo (mmachine m)
 SO3GetRendererInfo : get rendering informations DEPRECATED FUNCTION Prototype: fun [] [S S].
int SO3GetRendererList (mmachine m)
 SO3GetRendererList : get renderers list DEPRECATED FUNCTION Prototype: fun [] [S r1].
int SO3GetActiveRenderer (mmachine m)
 SO3GetActiveRenderer : get active renderer DEPRECATED FUNCTION Prototype: fun [] S.
int SO3BufferGetAverageFPS (mmachine m)
 SO3BufferGetAverageFPS : get the average FPS.
int SO3BufferGetBestFPS (mmachine m)
 SO3BufferGetBestFPS : get the best FPS.
int SO3BufferGetWorstFPS (mmachine m)
 SO3BufferGetWorstFPS : get the worst FPS.
int SO3BufferGetBestFrametime (mmachine m)
 SO3BufferGetBestFrametime : get the best frametime.
int SO3BufferGetWorstFrametime (mmachine m)
 SO3BufferGetWorstFrametime : get the worst frametime.
int SO3BufferGetTriangleCount (mmachine m)
 SO3BufferGetTriangleCount : get the number of triangle displayed in a SO3_BUFFER.
int SO3BufferGetBatchCount (mmachine m)
 SO3BufferGetBatchCount : get the batch count displayed in a SO3_BUFFER.
int SO3OverlayCreate (mmachine m)
 SO3OverlayCreate : Create an SO3_OVERLAY DEPRECATED Prototype: fun [Chn S] SO3_OVERLAY.
int SO3DebugDisplayProperties (mmachine m)
 SO3DebugDisplayProperties : Create an overlay to print debug text.
int SO3DebugSetText (mmachine m)
 SO3DebugSetText : Set Debug Text on a Viewport.
int SO3DebugSetEnable (mmachine m)
 SO3DebugSetEnable : Set Debug Text enable/disable on a Viewport.
int SO3DebugGetEnable (mmachine m)
 SO3DebugGetEnable : Get the debug overlay state on a buffer.
int SO3DestroyBuffer (mmachine m)
 SO3DestroyBuffer : Scol function to destroy a SO3_BUFFER.
int SO3BufferUpdate (mmachine m)
 SO3BufferUpdate : function to update a SO3_BUFFER.
int SO3CbBufferPreRender (mmachine m)
 SO3CbBufferPreRender : defines callback for pre render event.
int SO3CbBufferPostRender (mmachine m)
 SO3CbBufferPostRender : defines callback for post render event.

Detailed Description

Scol functions definition

Function Documentation

int SO3BufferCreate ( mmachine  m  ) 

SO3BufferCreate : This function create a new SO3_BUFFER Object.

Prototype: fun [Chn ObjWin I I I I] SO3_BUFFER

Parameters:
Chn : the current channel
ObjWin : the current parent window
I : x position
I : y position
I : w size
I : h size
Returns:
SO3_BUFFER : The Buffer Object

Definition at line 1171 of file SO3SCOL.cpp.

int SO3BufferGetAverageFPS ( mmachine  m  ) 

SO3BufferGetAverageFPS : get the average FPS.

Prototype: fun [SO3_BUFFER] F

Parameters:
SO3_BUFFER : current SO3_BUFFER
Returns:
F : average FPS if success, NIL otherwise

Definition at line 1786 of file SO3SCOL.cpp.

int SO3BufferGetBatchCount ( mmachine  m  ) 

SO3BufferGetBatchCount : get the batch count displayed in a SO3_BUFFER.

Prototype: fun [SO3_BUFFER] I

Parameters:
SO3_BUFFER : current SO3_BUFFER
Returns:
I : batch count if success, NIL otherwise

Definition at line 1984 of file SO3SCOL.cpp.

int SO3BufferGetBestFPS ( mmachine  m  ) 

SO3BufferGetBestFPS : get the best FPS.

Prototype: fun [SO3_BUFFER] F

Parameters:
SO3_BUFFER : current SO3_BUFFER
Returns:
F : Best FPS if success, NIL otherwise

Definition at line 1819 of file SO3SCOL.cpp.

int SO3BufferGetBestFrametime ( mmachine  m  ) 

SO3BufferGetBestFrametime : get the best frametime.

Prototype: fun [SO3_BUFFER] F

Parameters:
SO3_BUFFER : current SO3_BUFFER
Returns:
F : Best FrameTime if success, NIL otherwise

Definition at line 1885 of file SO3SCOL.cpp.

int SO3BufferGetFSAA ( mmachine  m  ) 

SO3BufferGetFSAA : Get multi sampling mode setted.

Prototype: fun [SO3_BUFFER] I

Parameters:
SO3_BUFFER : current SO3_BUFFER
Returns:
I : multisampling mode if success , NIL otherwise

Definition at line 1683 of file SO3SCOL.cpp.

int SO3BufferGetStereoVisionProperties ( mmachine  m  ) 

SO3BufferGetStereoVisionProperties : Get stereo vision properties.

Prototype: fun [SO3_BUFFER] [I F F]

Parameters:
SO3_BUFFER : Current Buffer
Returns:
[I F F] : mode, eyes spacing and focal length if success, NIL otherwise

For stereoscopic mode, values are :

  • SO3_SM_ANAGLYPH_RC
  • SO3_SM_ANAGLYPH_YB
  • SO3_SM_DUALOUTPUT
  • SO3_SM_INTERLACED_V
  • SO3_SM_INTERLACED_H
  • SO3_SM_INTERLACED_CB
  • SO3_SM_NONE

Definition at line 1391 of file SO3SCOL.cpp.

int SO3BufferGetTriangleCount ( mmachine  m  ) 

SO3BufferGetTriangleCount : get the number of triangle displayed in a SO3_BUFFER.

Prototype: fun [SO3_BUFFER] I

Parameters:
SO3_BUFFER : current SO3_BUFFER
Returns:
I : Number of triangle if success, NIL otherwise

Definition at line 1951 of file SO3SCOL.cpp.

int SO3BufferGetWorstFPS ( mmachine  m  ) 

SO3BufferGetWorstFPS : get the worst FPS.

Prototype: fun [SO3_BUFFER] F

Parameters:
SO3_BUFFER : current SO3_BUFFER
Returns:
F : Worst FPS if success, NIL otherwise

Definition at line 1852 of file SO3SCOL.cpp.

int SO3BufferGetWorstFrametime ( mmachine  m  ) 

SO3BufferGetWorstFrametime : get the worst frametime.

Prototype: fun [SO3_BUFFER] F

Parameters:
SO3_BUFFER : current SO3_BUFFER
Returns:
F : Worst FrameTime if success, NIL otherwise

Definition at line 1918 of file SO3SCOL.cpp.

int SO3BufferSetProperties ( mmachine  m  ) 

SO3BufferSetProperties : This function defines properties of a SO3_BUFFER Object.

Prototype: fun [SO3_BUFFER I I I] I

Parameters:
SO3_BUFFER : the current buffer
I : w size
I : h size
I : boolean for fullsceen mode
Returns:
1 if success , NIL otherwise

Definition at line 1251 of file SO3SCOL.cpp.

int SO3BufferSetStereoVision ( mmachine  m  ) 

SO3BufferSetStereoVision : This function defines stereo vision mode on a SO3_BUFFER Object.

Prototype: fun [SO3_BUFFER I F F] I

Parameters:
SO3_BUFFER : the current buffer
I : the current mode
F : the current eyes spacing
F : the current focal length

For stereoscopic mode, values are :

  • SO3_SM_ANAGLYPH_RC
  • SO3_SM_ANAGLYPH_YB
  • SO3_SM_DUALOUTPUT
  • SO3_SM_INTERLACED_V
  • SO3_SM_INTERLACED_H
  • SO3_SM_INTERLACED_CB
  • SO3_SM_NONE
Returns:
I : 1 if success, NIL otherwise

Definition at line 1323 of file SO3SCOL.cpp.

int SO3BufferUpdate ( mmachine  m  ) 

SO3BufferUpdate : function to update a SO3_BUFFER.

Prototype: fun [SO3_BUFFER] I

Parameters:
SO3_BUFFER : given buffer object
Returns:
I : 1 if success, NIL otherwise

Definition at line 2273 of file SO3SCOL.cpp.

int SO3CbBufferPostRender ( mmachine  m  ) 

SO3CbBufferPostRender : defines callback for post render event.

Prototype: fun [SO3_BUFFER fun [SO3_BUFFER u0] u1 u0] SO3_BUFFER

Parameters:
SO3_BUFFER : given buffer object
fun [SO3_BUFFER u0] u1 : function scol to call
u0 : user parameter
Returns:
SO3_BUFFER : buffer object if success

Definition at line 2577 of file SO3SCOL.cpp.

int SO3CbBufferPreRender ( mmachine  m  ) 

SO3CbBufferPreRender : defines callback for pre render event.

Prototype: fun [SO3_BUFFER fun [SO3_BUFFER u0] u1 u0] SO3_BUFFER

Parameters:
SO3_BUFFER : given buffer object
fun [SO3_BUFFER u0] u1 : function scol to call
u0 : user parameter
Returns:
SO3_BUFFER : buffer object if success

Definition at line 2557 of file SO3SCOL.cpp.

int SO3DebugDisplayProperties ( mmachine  m  ) 

SO3DebugDisplayProperties : Create an overlay to print debug text.

Prototype: fun [SO3_SCENE SO3_VIEWPORT SO3_MATERIAL I [I I] [I I] I] I

Parameters:
SO3_SCENE : current scene
SO3_VIEWPORT : current viewport
SO3_MATERIAL : material for font display
I : given color
[I I] : given dimensions
[I I] : given positions
I : given char Height
Returns:
I : 1 if success, NIL otherwise

Definition at line 2057 of file SO3SCOL.cpp.

int SO3DebugGetEnable ( mmachine  m  ) 

SO3DebugGetEnable : Get the debug overlay state on a buffer.

Prototype: fun [SO3_VIEWPORT] I

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

Definition at line 2208 of file SO3SCOL.cpp.

int SO3DebugSetEnable ( mmachine  m  ) 

SO3DebugSetEnable : Set Debug Text enable/disable on a Viewport.

Prototype: fun [SO3_VIEWPORT I] I

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

Definition at line 2161 of file SO3SCOL.cpp.

int SO3DebugSetText ( mmachine  m  ) 

SO3DebugSetText : Set Debug Text on a Viewport.

Prototype: fun [SO3_VIEWPORT S] I

Parameters:
SO3_VIEWPORT : current viewport
S : Text to set
Returns:
I : 1 if success, NIL otherwise

Definition at line 2116 of file SO3SCOL.cpp.

int SO3DestroyBuffer ( mmachine  m  ) 

SO3DestroyBuffer : Scol function to destroy a SO3_BUFFER.

Prototype: fun [SO3_BUFFER] I

Parameters:
SO3_BUFFER : current buffer window
Returns:
I : 1 if success, NIL otherwise

Definition at line 2245 of file SO3SCOL.cpp.

int SO3GetActiveRenderer ( mmachine  m  ) 

SO3GetActiveRenderer : get active renderer DEPRECATED FUNCTION Prototype: fun [] S.

Returns:
S : Active renderder if success, NIL otherwise

Definition at line 1767 of file SO3SCOL.cpp.

int SO3GetAPIVersion ( mmachine  m  ) 

SO3GetAPIVersion : Get the SO3 plugin API version.

Prototype: fun [] [S S]

Returns:
[S S] : scol VM version and Ogre3d version if success, NIL otherwise

Definition at line 1437 of file SO3SCOL.cpp.

int SO3GetFullscreenVideoMode ( mmachine  m  ) 

SO3GetFullscreenVideoMode : Get fullscreen video mode supported by user.

Prototype: fun [] [S r1]

Returns:
[S r1] : video mode

Definition at line 1581 of file SO3SCOL.cpp.

int SO3GetGeneralInfo ( mmachine  m  ) 

SO3GetGeneralInfo : Get general informations about the user system.

Prototype: fun [] [S S S S S S S S]

Returns:
[S S S S S S S S] : Genral Informations
  • Vendor CPU Name;
  • CPU Name;
  • Number of processors;
  • RAM;
  • OS version;
  • Graphic device;
  • Graphic driver;
  • DirectX version;

Definition at line 1469 of file SO3SCOL.cpp.

int SO3GetMultisamplingMode ( mmachine  m  ) 

SO3GetMultisamplingMode : Get multi sampling mode supported by user.

Prototype: fun [I] [S r1]

Parameters:
I : SO3_DIRECTX9_RENDERER, SO3_DIRECTX11_RENDERER or SO3_OPENGL_RENDERER
Returns:
[S r1] : multisampling mode

Definition at line 1631 of file SO3SCOL.cpp.

int SO3GetRendererInfo ( mmachine  m  ) 

SO3GetRendererInfo : get rendering informations DEPRECATED FUNCTION Prototype: fun [] [S S].

Returns:
[S S] : Rendering Informations
  • current render system
  • list of rendering system supported

Definition at line 1719 of file SO3SCOL.cpp.

int SO3GetRendererList ( mmachine  m  ) 

SO3GetRendererList : get renderers list DEPRECATED FUNCTION Prototype: fun [] [S r1].

Returns:
[S r1] : Renderer list

Definition at line 1738 of file SO3SCOL.cpp.

int SO3OverlayCreate ( mmachine  m  ) 

SO3OverlayCreate : Create an SO3_OVERLAY DEPRECATED Prototype: fun [Chn S] SO3_OVERLAY.

Parameters:
Chn : current channel
S : given name
Returns:
SO3_OVERLAY : the overlay object if success, NIL otherwise

Definition at line 2018 of file SO3SCOL.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