Skip to main content
Script Cache Plugin        
1
Page actions
Print

Introduction

Script Cache

The Script Cache plugin attempts to speed up the time taken to parse resource script (like *.material, *.program etc). This is done by caching the binary representation of the compiled script (in memory) to disk, when the application is run the first time. Then on subsequent runs, the scripts would no longer be re-compiled again since their binary representation is already present in the cache. However, if the script is modified by the user, the cache would automatically be discarded and the modified version would be compiled and cached again.

Shader Cache

Ogre 1.8 introduced a new feature called ShaderCache. The plugin automatically uses the ShaderCache feature if compiled with Ogre 1.8+. The plugin would not use ShaderCache for Ogre 1.7 and below

Compiling

Download the latest code from here:
http://code.google.com/p/ogre-script-serializer/source/checkout

Use CMake to create the build system

Build the plugin. You should see the following modules:

  • Plugin_ScriptSerializer (Release mode)
  • Plugin_ScriptSerializer_d (Debug Mode)

Setup

  • After you have compiled your plugin, copy it over to your plugins folder (e.g. along side RenderSystem_OpenGL, Plugin_ParticleFX etc)
  • Open plugins.cfg and add an new entry for this new plugin.
    Copy to clipboard
    Plugin=Plugin_ScriptSerializer
  • Create a new config file for this plugin named ScriptCache.cfg in your executable folder with the following contents
    Copy to clipboard
    [ScriptCache]
extension=.sbin
location=./ScriptCache
searchExtensions=program material particle compositor os pu

[ShaderCache]
filename=Shaders.cache
    • ScriptCache.extension: The extension to use when saving the compiled binary script
    • ScriptCache.location: The directory where the script cache should be saved. If this directory is unavailable, the plugin would attempt to create this directory. If it fails to create this directory, or if the directory is read-only, then the plugin would log a warning and disable itself. This path can have absolute or relative addressing
    • ScriptCache.searchExtensions:
    • ShaderCache.filename: The filename to use for the shader cache. This file would be saved in the location specified in ScriptCache.location. Provide only the filename here and not the path
  • If the above config file is not present, the plugin would use default values (same as the above mentioned config file)
  • Run your application. The first time, the plugin should create the cache directory and fill it with the compiled scripts. You should be able to notice performance improvements after the first run


Note: The Script Cache directory should not be added to your resources.cfg if you include your plain-text scripts. However, if you wish to deploy only the binary scripts, then remove the references to your plain-text scripts and add the Script Cache directory to resources.cfg.

Benchmark

Here is the time it took to compile the scripts and startup the sample browser:
Image
Image

Advantages

  • ScriptCache Reduces the script compilation time in Debug Mode significantly
  • Ogre's built in ShaderCache reduces the shader compilation time in both Debug and Release mode

Drawbacks

  • ScriptCache has no noticeable performance gain in Release mode. However ShaderCache boosts the speed considerably in Release mode

License

Released under MIT licence, similar to OGRE

References

Tracking Thread: http://www.ogre3d.org/forums/viewtopic.php?f=11&t=62487
Download Code: http://code.google.com/p/ogre-script-serializer/

History Source