
© Next Limit Technologies 2010
Maxwell Render 2.5 User Manual
Chapter 17. Appendix IV. Scripting References | 139
• Function: int launchProcess (string execPath, array arguments);
• Description: Launches a detached process and returns the control immediately,
without waiting for the process to nish.
• Parameters: -string execPath: Absolute path of the executable. -array arguments:
list of command line arguments.
• Returned INT: 0 if the process was started successfully and 1 if not.
• Function: bool saveLog (string path);
• Description: Saves the console log to the given path.
• Parameters: string path: path of the saved log .
• Returned Value: Bool: TRUE if the log is properly saved. FALSE if not.
• Function: void clearConsole ();
• Description: Clears the console
• Parameters: Nothing.
• Returned Value: Nothing.
• Function: void printError (string message);
• Description: Prints an error message in the console.
• Parameters: string message: message to print.
• Returned Value: Nothing.
• Function: string getOS ();
• Description: Returns the operating system currently used.
• Parameters: Nothing.
• Returned Value: String: OS.
• Function: void saveMxi( string path );
• Description: Saves the current image buffer displayed in the GUI in the given MXI
path.
• Parameters: path: Path of the MXI le.
• Returned Value: Nothing.
• Function: void saveChannel( int channelIndex, string path, int depth);
• Description: Saves the channel with the given index to disk.
• Parameters: int channelIndex: Index of the channel / path: Path were the channel
will be saved. int depth: bits depth of the saved channel (depths supported are 8,
16 and 32)
Channels indexes are:
CHANNEL_RENDER = 0,
CHANNEL_ALPHA = 1,
CHANNEL_SHADOW = 2,
CHANNEL_ID_MATERIAL = 3,
CHANNEL_ID_OBJECT = 4,
CHANNEL_ZBUFFER = 5,
CHANNEL_MOTION = 6 ,
CHANNEL_ROUGHNESS = 7,
CHANNEL_FRESNEL = 8,
• Returned Value: Nothing.
• Function: void mergeMxis( stringlist paths, string output );
• Description: Merges the given list of MXI les and writes the merged MXI in the
given output.
• Parameters: stringlist paths: Path of the MXI le. / string output: Path of the merged
MXI le.
• Returned Value: Nothing.
• Function: void startRender( void );
• Description: Renders the scene that is currently loaded. The function does not wait
until the render nishes.
• Parameters: No parameters.
• Returned Value: Nothing.
• Function: bool isRendering( void );
• Description: Returns True if the application is rendering and False if it is not
rendering.
• Parameters: No parameters.
• Returned Value: Bool (True if the application is rendering and False if it is not
rendering).
Kommentare zu diesen Handbüchern