| *NEW* Garbage Collector: Fixed crash during creation of minimal environment. |
| *NEW* mkscript( ) & _script( ): Fixed crash occuring while using an "empty" Comm. |
| *NEW* _on( ): Avoided _channel destruction that occured with specific messages. |
| Scol console & log: Fixed GDI memory flow. |
| _appendpack( ): "Fixed" "cannot write file" error. |
| _loadS( ): The function is no more based on temporary files at all. [$IRI : is it better ?] |
| nth_char( ): Fixed returned value. |
| zip( ): Fixed a buffer overflow problem. |
| unzip( ): Fixed a buffer overflow problem. |
| *NEW* _CRfont( ): New FF_HOLLOW flag. This lets you draw hollow (not plain) text with _SDRAWtext( ) 3D API function.
|
| *NEW* _CRfont( ): New FF_CLEARTYPE flag for smooth rendering. Default behaviour is now No Antialiasing, not the system one. This results on better rendering of small fonts. Set flag for bigger fonts.
|
| Windows: Windows can now react to middle mouse button (wheel). For Click/Unclick/DblClick, this button has a value of 16.
|
| Windows: Windows can now react to System Keys (like F10) which were not recognized for example by KeyDown events.
|
| _CRwindow( ): New WN_TOPMOST flag (Always on Top).
|
| _CRwindow( ): New WN_NOSCOL flag that removes the "(Scol)" word in windows titles.
|
| _SETwindowName( ): The function is compatible with the new WN_NOSCOL flag.
|
| _BlendBitmap2Surface [ObjSurface I I ObjBitmap I I I I I I I] ObjSurface:
A new parameter (the one just before the last one) has been added to allow background color transparency customization (0 to 255).
Note: The transparency color uses BGR format.
This supersedes the description in the "New functions" chapter (v4.6a1). |
| _BlendSurface2Surface [ObjSurface I I ObjBitmap I I I I I I I] ObjSurface:
A new parameter (the one just before the last one) has been added to allow background color transparency customization (0 to 255).
Note: The transparency color uses BGR format.
This supersedes the description in the "New functions" chapter (v4.6a1). |
| _DLGOpenDir[Chn ObjWin S S] OpenDirBox: The new 4th parameter lets you choose/localize the selection box's message. |
| *NEW* API's objects creation: OBJ_CONTAINER_ALLEVENTS - New filter flag (Activates all nodes' event forwardings: clicks, keys, wheel, move). |
| *NEW* CompChecks: CompChecks can now react to clicks & unclicks from all mouse buttons. However, the left one only has the possibility to interact with the control.
|
| *NEW* CompRollOvers: CompRollOvers can now react to clicks & unclicks from all mouse buttons. However, the left one only has the possibility to interact with the control.
|
| Containers: Containers can now react to middle mouse button (wheel) clicks. For Click/Unclick/DblClick, this button has a value of 16 (MBUTTON).
|
| Containers: Containers can now react to System Keys (like F10) which were not recognized for example by KeyDown events.
|
| _CRcontainerFromObjWin( ) & _CRcontainerFromObjCont( ): New CO_TOPMOST (always on top) flag. |
| _SETcontainerCursor( ): The function now accepts a nil parameter which restores the system arrow cursor. |
| _CRcontainerFromObjWin( ): New CO_NOSCOL flag that removes the "(Scol)" word in containers titles.
|
| _SETcontainerName( ): The function is compatible with the new CO_NOSCOL flag.
|
| M3blitTexture16( ):
- Accepted texture dimensions that require no stretching are: 64, 128, 256, 512 and 1024.
- Optimized stretching and pure blitting: up to 25% performance saving. |
| MX3renderEx( ) and all other rendering functions:
These functions are now able to detect Sprites. Returned data, when possible, include Mesh, Material and Integer distance between Sprite and Camera (not the z data as described in Rendering documentation).
Note: Have a look at the New Functions for Sprite detection. |
| M3textureGetType( ), M3textureSetType( ), M3textureSetGeneralDefaultType( ), M3textureGetGeneralDefaultType( ) and M3createTexture( ):
All these functions now accept texture distance filtering Parameters ranging from 0 to 3 (instead of values 0 - in fact 1 - or 2).
Note: For upward compatibility, open the Dms/3d/C3d3/C3d3EngineExtension and modify the '0' parameter of the first function to '1'.
Note: M3filter( ), which is applied on Bitmaps, hasn't been updated regarding this kind of OpenGL hardware filter.
Note: Basic texture filtering, i.e. M3createTexture( ), accepts a new additional 'On' filter, with n ranging from 0 to3 being the OpenGL texture distance filtering. |
| For VM developers only: I introduced a ZBLG_ObjSpr class and modified many functions to implement clickable Sprites. Have a look at the _blg.txt file related to the ZooEngine (3D) API. |
| _Surface2Surface( ): Optimized. 10% performance saving. |
| *NEW* strmd5 [S] S: signs a character string using MD5 algorythm. |
| *NEW* _filemd5 [P] S: signs a file using MD5 algorythm. |
| *NEW* New set of String management functions:
General notes:
- These functions were designed to speed up the reception of files downloaded from a Scol server, more especially the management of received data chunks.
- You can use them whenever you need to perform multiple strcat( ) and that you know the size of the final resulting string.
strcatinit [ I ] S:
Initializes a string of given length. You have to call this function before using the other ones. Memory is allocated but string appears as empty. A strlen( ) will return the size of the allocated buffer.
Parameters: I Length of the string you want to initialize.
Returns: S Allocated string.
strcatblit [ S S ] S:
Blits the content of a classic string at the end of an allocated one.
Parameters:
S Allocated string.
S Classic string.
Returns: S Allocated string.
strcatlen [ S ] I:
Returns the length of an allocated string (what is used from the initial buffer).
Parameters: S Allocated string.
Returns: I Its size.
|
| *NEW* minf [ F F ] F: Same as min( ) but for Floats. |
| *NEW* maxf [ F F ] F: Same as max( ) but for Floats. |
| Implementation of UPnP API:
General notes:
- This API allows you to discover UPnP compliant Internet Gateway Devices (Routers/Boxes) on the network and dynamically manage their ports.
- Requirements:
- Windows XP or above.
- UPnP compliant Internet Gateway Device.
- TCP port 2869 or UDP port 1900 being opened on Firewall if any.
- Note: All functions are synchronous and wait response from the device. During that time, the application is frozen.
_UPNP_Connect is the worst freezing function (3-5 seconds), the others work much faster if the device responds immediately (which is not always the case).
- API functions:
_UPNP_Connect [Chn] I:
Tries to find a UPnP compliant device on network (precisely an Internet Gateway Device) and connects to it.
This function should be called once before using any other one.
It will freeze the application during a few seconds (3-5).
Parameters: Chn Channel, usually _channel.
Returns: 1 or nil if it fails (or doesn't find anything).
_UPNP_Disconnect [ ] I:
Closes the link with the Internet Gateway Device.
Parameters: -
Returns: 1.
_UPNP_OpenPort [S S I I I] I:
Opens a port on the Internet Gateway Device.
Parameters:
S Name, like Application Name.
S IP address of the PC to which messages should be routed. Ex: _hostIP().
I Port number (0-65535, ports categories: 0-1023:WellKnown, 1024-49151:Registered, 49152-65535:Dynamic&Private).
I Protocol, should be either UPNP_TCP or UPNP_UDP.
I Mode, should be either UPNP_SAFE or UPNP_FORCE. The second one will overwrite any existing similar port mapping (Port+Protocol).
Returns: Port number if successful, nil if it fails.
_UPNP_ClosePort [I I] I:
Removes a port on the Internet Gateway Device.
Parameters:
I Port number.
I Protocol.
Returns: Port number if successful, nil if it fails.
_UPNP_IsPortUsed [I I] I:
Checks if a port is already used on the Internet Gateway Device.
Parameters:
I Port number.
I Protocol.
Returns: 1 if port is already defined, 0 if it's free to use.
_UPNP_GetExternalIP [ ] S:
Returns the external IP address of the Internet Gateway Device.
Parameters: -
Returns: S External IP address.
|
| _versiondate [ ] I: Returns the Build number of the VM, in fact the compilation date of its last code update. |
| _trimmemory [ ] I: Performs a Windows GC for your current application / scol.exe process. Returns 0 or nil if a problem occured. |
| Implementation of Windows Registry Access API:
General notes:
- Registry access is limited to HKEY_LOCAL_MACHINE\SOFTWARE\Scol-Technologies\ and below.
- All access paths are relative to this registry key.
- Note that management of Values is accepted directly at the above Scol root Key (relative path coded as "").
But we recommend you to create your own personal/application SubKeys and to work with your own Values in these SubKeys.
- For Windows compatibility issues, we recommend to limit the size of Key or Value names to 255 characters, and the content of Values to 2048 characters. This last limit is hardcoded. As explained in MSDN, bigger content should be stored in files and the file names stored in the registry.
- Most new functions return a I value: 0 if the action was successful, NIL otherwise.
_winreg_createkey [S] I:
Parameters: Key name
Example: _winreg_createkey "Kyrien\\Scol-Voyager\\Infos\\ToDel\\SubKey";
_winreg_deletekey [S] I:
Parameters: Key name
Example: _winreg_deletekey "Kyrien\\Scol-Voyager\\Infos\\ToDel";
_winreg_setvalue [S S I S] I:
Parameters: Key name, Value name and then Value content (I or S, other one set to NIL)
Example: _winreg_setvalue "Kyrien\\Scol-Voyager\\Infos" "INT" 0xffff00 nil;
Example: _winreg_setvalue "Kyrien\\Scol-Voyager\\Infos" "STR" nil "0xffffff";
_winreg_getvalue [S S] [I S]:
Parameters: Key name, Value name
Returns: Tuple if successful, NIL otherwise. The tuple contains the content of the Value (I or S, other tuple member set to NIL)
Example: let _winreg_getvalue "Kyrien\\Scol-Voyager\\Infos" "INT" -> val in let val -> [int str] in ...
_winreg_delvalue [S S] I:
Parameters: Key name, Value name
Example: _winreg_delvalue "Kyrien\\Scol-Voyager\\Infos" "STR";
|
| _isCacheActivated [ ] I: Returns 1 if Cache is activated, 0 if not. |
| _gettimerscapabilities [ ] [I I]: Retrieves the minimum and maximum periods accepted by the client system. |
| _settimerperiod [Timer I] I: Dynamically updates a Timer's period. Returns 0 or NIL if problem occured. |
| ftoa5d [F] S, ftoa4d [F] S, ftoa3d [F] S, ftoa2d [F] S and ftoa1d [F] S:
As ftoa( ) but with chosen precision (number of digits behind '.') and no rounding up for last digit. |
| _fooId [I] S: As _fooI( ) but with decimal output. The output is limited to 9 characters (not including '-' sign) as for other _foo( ) functions. |
| *NEW* _GETwindowMap fun [ObjBitmap ObjWin ObjWin] ObjBitmap: Retrieves the graphic content of a Window (even if hidden).
Parameters: Target bitmap, window to capture, window hosting an ActiveX if any (can be the same than captured window or child).
|
| *NEW* Implementation of Scol windows Control API:
General notes:
- This API allows you to trigger mouse moves and clicks, as well as keydown and keyup events in Scol windows.
- API functions:
_MOUSEMOVEwindow fun [ObjWin ObjWin I I I] ObjWin:
Forces a MouseMove in a window.
Parameters:
ObjWin Window to mouse move in
ObjWin ActiveX hosting window if any (can be the same than first ObjWin or child)
I I I Mouse coordinates and button.
Returns: Mouse moved window.
_CLICKwindow fun [ObjWin ObjWin I I I] ObjWin:
Forces a Click in a window.
Parameters:
ObjWin Window to click in
ObjWin ActiveX hosting window if any (can be the same than first ObjWin or child)
I I I Mouse coordinates and button.
Returns: Clicked window.
_UNCLICKwindow fun [ObjWin ObjWin I I I] ObjWin:
Forces a UnClick in a window.
Parameters:
ObjWin Window to unclick in
ObjWin ActiveX hosting window if any (can be the same than first ObjWin or child)
I I I Mouse coordinates and button.
Returns: Unclicked window.
_DBLCLICKwindow fun [ObjWin ObjWin I I I] ObjWin:
Forces a DoubleClick in a window.
Parameters:
ObjWin Window to doubleclick in
ObjWin ActiveX hosting window if any (can be the same than first ObjWin or child)
I I I Mouse coordinates and button.
Returns: Doubleclicked window.
_KEYDOWNwindow fun [ObjWin ObjWin I I] ObjWin:
Forces a KeyDown in a window.
Parameters:
ObjWin Window to doubleclick in
ObjWin ActiveX hosting window if any (can be the same than first ObjWin or child)
I I Key and vkey.
Returns: Keydowned window.
_KEYUPwindow fun [ObjWin ObjWin I] ObjWin:
Forces a KeyUp in a window.
Parameters:
ObjWin Window to doubleclick in
ObjWin ActiveX hosting window if any (can be the same than first ObjWin or child)
I Key.
Returns: Keyupped window.
|
| *NEW* Mouse: Buttons are now named (MB_LBUTTON, MB_RBUTTON & MB_MBUTTON).
Note: Per conveniency, you may prefer to use the names from the 2D Graphic API (LBUTTON, RBUTTON & MBUTTON) which are fully compatible. |
| *NEW* Implementation of Remote Control API:
General notes:
- This API allows you to simulate and trigger mouse moves and clicks, as well as keydown events. The API is different from the Scol windows Control API and doesn't depend on Scol windows.
- Requirements:
- Windows XP or above.
- API functions:
_RMTCTRL_MouseMove fun [I I I] I:
Simulates a mouse move.
Parameters:
I Delta_x: x-axis displacement (in pixels)
I Delta_y: y-axis displacement (in pixels)
I Mode: should be RMTCTRL_RELATIVEMOVE (default) or RMTCTRL_ABSOLUTEMOVE
RMTCTRL_RELATIVEMOVE: delta values are from last cursor position
RMTCTRL_ABSOLUTEMOVE: delta values are from upper-left corner of screen
Returns: 0.
_RMTCTRL_MouseClick fun [I] I:
Simulates a mouse click.
Parameters: I Mouse button.
Returns: 0 or NIL if problem occured.
Note: You're responsible for handling the related UnClick.
_RMTCTRL_MouseUnClick fun [I] I:
Simulates a mouse unclick.
Parameters: I Mouse button.
Returns: 0 or NIL if problem occured.
_RMTCTRL_MouseDClick fun [I] I:
Simulates a mouse double click.
Parameters: I Mouse button.
Returns: 0 or NIL if problem occured.
Note: You're responsible for handling the related UnClick.
_RMTCTRL_KeybdKeyDown fun [I] I:
Simulates a keydown event.
Parameters: I char (ascii code, per as nth_char() Scol function).
Returns: 0 or NIL if problem occured.
|
| _GETbitmapFromObjWin [ObjBitmap ObjWin] ObjBitmap: Retrieves the graphic content of a Window (the part of the screen corresponding to window's client area). |
| _TOPMOSTwindow [ObjWin I I] ObjWin: Sets the display level of a window.
Parameters:
- ObjWin
- I: Display level
- 0: Bottom Window is moved to background
- 1: NoTopMost Window loses its TopMost status
- 2: Top Window is brought to top
- 3: TopMost TopMost (Always on top) status
- I: Focus
- 0: Window doesn't get the focus
- 1: Window gets the focus (except in Bottom status)
|
| _joystickExt [I] [I I I I I]: This function, compatible with old (3 axis) joysticks, lets you retrieve the values for X,Y,Z and R axis (recent 4 axis joysticks, pads...). Last returned value is the buttons' status. Parameter of the function is the joystick number (usually 0). |
| _CBcompRollOverUnClick [CompRollOver fun [CompRollOver u0 I I I I] u1 u0] CompRollOver: Standard UnClick callback. |
| _CBcompCheckUnClick [CompCheck fun [CompCheck u0 I I I I] u1 u0] CompCheck: Standard UnClick callback. |
| _SETcontainerBackgroundColor [ObjContainer I I] ObjContainer: Dynamically modifies a container's background color.
Parameters:
- ObjContainer
- I: New background color (BGR)
- I: Repaint flag (set to 1 for immediate repaint)
Returns: ObjContainer
|
| _CRcontainer: A few undocumented functions have been uncovered for virtual containers (aka offscreen containers) which are created through this function.
These functions, when called, trigger the corresponding classic callbacks. You can thus simulate mouse or keyboard actions (for example) on the virtual containers.
Most of these functions use the parameters that are received by the callbacks, so they are not re-explained there.
The following table lists the "new" functions, their prototypes, their related callbacks and parameters' exceptions if any:
|
| _TOPMOSTcontainer [ObjContainer I I] ObjContainer: Allows control of containers' display level.
Parameters:
- ObjContainer
- I: Display level
- 0: Bottom - Container is moved to background
- 1: NoTopMost - Container loses its TopMost status
- 2: Top - Container is brought to top
- 3: TopMost - TopMost (Always on top) status
- I: Focus
- 0: Container doesn't get the focus
- 1: Container gets the focus (except in Bottom status)
|
| _CBcompTextClick [CompText fun[CompText u0 I I I I] u1] u0] CompText: Classic CompClick callback definition.
Works only for CT_LABEL CompTexts (without CT_SELECT).
|
| _CBcompTextCursorMoveIn [CompText fun[CompText u0 I I I] u1] u0] CompText: Classic CompMoveIn callback definition.
Works only for CT_LABEL CompTexts (without CT_SELECT).
|
| _CBcompTextCursorMoveOut [CompText fun[CompText u0 I I I] u1] u0] CompText: Classic CompMoveOut callback definition.
Works only for CT_LABEL CompTexts (without CT_SELECT).
|
| _FORCEcompCheckROverDisplay [CompCheck I I] I: Forces RollOver aspect display for a CompCheck.
- Parameters:
- CompCheck
- Aspect: Normal (CHK_DSPL_RO_NO) or RollOver (CHK_DSPL_RO_YES)
- Protect RollOver aspect (CHK_DSPL_RO_FRC) or not (CHK_DSPL_RO_NO): Protected RO aspect, lets this aspect displayed when a mouse cursor leaves the CompCheck. The protected aspect has to be removed manually.
- Returns: 0, or nil if error.
- Examples:
- Forcing normal aspect & removing protection:
_FORCEcompCheckROverDisplay cchkCChk CHK_DSPL_RO_NO CHK_DSPL_RO_NO;
- Forcing rollover aspect:
_FORCEcompCheckROverDisplay cchkCChk CHK_DSPL_RO_YES CHK_DSPL_RO_NO;
- Forcing & protecting rollover aspect:
_FORCEcompCheckROverDisplay cchkCChk CHK_DSPL_RO_YES CHK_DSPL_RO_FRC;
|
| *NEW* M3setMaterialShininess [S3d HMat3d I] I: Sets material's shininess (0-100). Returns 0. |
| *NEW* M3getMaterialShininess [S3d HMat3d] I: Returns material's shininess (0-100). |
| *NEW* M3multiSamplingSupported [S3d] [I I]: Checks multisampling availability for anti-aliasing. Returns 1 if available (0 if not) as well as the number of possible passes. |
| *NEW* M3enableMultiSampling [S3d] I: Activates multisampling. Returns 1 if OK (0 if error). |
| *NEW* M3disableMultiSampling [S3d] I: De-activates multisampling. Returns 1 if OK (0 if error). |
| *NEW* M3shaderIsEnable [S3d] I: Checks avatars' skinning shader availability. Returns 1 if available (0 if not).
This function is linked to Bones implementation. This process is underway, so functionalities are highly subject to changes. |
| *NEW* M3loadAnimationWithSKL [S3d S H3d] I: Loads an animation file (S) and links the anim to a skeleton (H3d). Returns 0.
This function is linked to Bones implementation. This process is underway, so functionalities are highly subject to changes. |
| *NEW* M3attachMeshWithSKL [S3d H3d H3d] I: Attach mesh(1st H3d) with skeleton(2nd H3d) (Main bone is brother of mesh). Returns 0.
This function is linked to Bones implementation. This process is underway, so functionalities are highly subject to changes. |
| *NEW* M3setSKLAnimKey [S3d H3d H3d I] I: Sets skeleton(1st H3d)/mesh(2nd H3d)'s anim frame(I). Returns 0.
This function is linked to Bones implementation. This process is underway, so functionalities are highly subject to changes. |
| *NEW* M3getH3dType [S3d H3d] I: Returns H3d's type. Types: 0:Mesh, 1:Camera, 2:Light, 3:Shell, 4:Collision(OBB), 5:Sprite, 6:Animation, 7:Particle, 8:Sound, 9:Bone, 10:Unknown. |
| M3shiftTextureBisXY [S3d H3d HMat3d I I] I: Same as M3shiftTextureXY. |
| M3shiftTextureBisXYF [S3d H3d HMat3d F F] I: Same as M3shiftTextureXYF. |
| M3setSpriteClickability [S3d H3d I] I: Sets Sprite clickability: 0 if not clickable (default status), 1 (or any other value different from 0) if clickable. |
| M3getSpriteClickability [S3d H3d] I: Returns 0 if the Sprite isn't clickable, 1 if it is. |
| M3isExtensionSupported [S] I: Allows you to check if an OpenGL Extension is available or not on client. Returns 0 or 1 if the extension is available. |
| M3getTextureSize [S3d HTx3d] [I I]: Returns the dimensions of a stored texture (not the ones from the original bitmap). |
| _BlendBitmap2Surface [ObjSurface I I ObjBitmap I I I I I I] ObjSurface: As _Bitmap2Surface, but a transparency factor (Last and added parameter: 0-255) is applied to the blitted bitmap. Note: The "former" (100%) transparency color parameter is applied too. |
| _BlendSurface2Surface [ObjSurface I I ObjSurface I I I I I I] ObjSurface: As _Surface2Surface, but a transparency factor (Last and added parameter: 0-255) is applied to the blitted surface. Note: The "former" (100%) transparency color parameter is applied too. |
| M3blitSurface2Texture [S3d HTx3d ObjSurface] I: As _Surface2Bitmap( ) followed by M3blitTexture16( ). Performance saving isn't really significant. |
| _CRforcedSurface [Chn I I] ObjSurface: As _CRsurface but without control for existing fullscreen surface. |
| _CRforcedFullscreenSurface [Chn I I] ObjSurface: As _CRfullscreenSurface but without control for existing windowed surfaces. |
| Note: These two functions were adapted for specific and concurrent use, for Example with _BlendSurface2Surface( ) in fullscreen mode. Both of them can only be used in hardware rendering mode. However, this seems to bring some rendering problems on different configurations. To use with care or on tested PCs. |
Up