Skip to content

Controlling Memory Usage

Code#

var factory = new LocalTinyFfrFactory(
    factoryConfig: new LocalTinyFfrFactoryConfig {  
        MemoryUsageRubric = MemoryUsageRubric.UseLessMemory // (1)!
    }
);
  1. Change this value to one of the following according to your desired behaviour: Standard, UseLessMemory, UseSignificantlyLessMemory

Explanation#

By default, TinyFFR uses more RAM to increase performance of your application. However, in some cases you may wish to reduce that memory usage instead, at the potential cost of framerate/performance.

  • MemoryUsageRubric.Standard is the default setting. TinyFFR will use a larger amount of RAM to create internal buffers to speed up rendering performance.
  • MemoryUsageRubric.UseLessMemory can be used to force TinyFFR to reduce its RAM usage. The tradeoff is you might see reduced performance on more complex or demanding scenes.
  • MemoryUsageRubric.UseSignificantlyLessMemory should be used if you're only using TinyFFR to display very simple scenes (e.g. as a model viewer or similar). Attempting to create complex scenes with this option may result in artifacting as frame buffer data must be swapped out more often. However, this setting significantly reduces RAM usage.

Further Actions#

You can further reduce memory usage by lowering the maximum asset size permitted by the asset loader: 

var factory = new LocalTinyFfrFactory(
    factoryConfig: new LocalTinyFfrFactoryConfig {  
        MemoryUsageRubric = MemoryUsageRubric.UseLessMemory
    },
    // The following halves the max asset size of various assets, reducing RAM allocated to internal buffers. 
    // Note that trying to load any assets with sizes greater than these new limits will result in an exception being thrown.
    // It's recommended to tailor these values to your specific application's needs.
    assetLoaderConfig: new LocalAssetLoaderConfig {
        MaxAssetVertexIndexBufferSizeBytes = LocalAssetLoaderConfig.DefaultMaxAssetVertexIndexBufferSizeBytes / 2,
        MaxKtxFileBufferSizeBytes = LocalAssetLoaderConfig.DefaultMaxKtxFileBufferSizeBytes / 2,
        MaxEmbeddedAssetTextureFileSizeBytes = LocalAssetLoaderConfig.DefaultMaxEmbeddedAssetTextureFileSizeBytes / 2
    },
);

Comments