←Select platform

TiledThreshold Property

Summary

Gets or sets a value that specifies the minimum amount of free memory required to allow the allocation of conventional images.

Syntax

WinRT C#

C++

public int TiledThreshold {get; set;}

Public Property TiledThreshold As Integer

public int TiledThreshold {get; set;}

  
get_TiledThreshold(); 
set_TiledThreshold(value); 
Object.defineProperty('TiledThreshold');

public: 
property int TiledThreshold { 
   int get(); 
   void set (    int ); 
}

Property Value

An integer value that specifies the minimum amount of free memory required to allow the allocation of conventional images. Default value is 0.

Remarks

If the amount of free memory falls below this threshold, all images will be allocated as tiled. The exception is when the image size is smaller than the tile size - in this case, the image will be allocated in conventional memory.

Values less than -100 are not allowed.

If the TiledThreshold value is < 0, it represents the required number of free bytes.

If the TiledThreshold value is 0, then there is no minimum requirement for free memory, all images are allocated as conventional if there is enough memory.

Tiled images use a combination of memory tiles and disk tiles. When an image is allocated, LEADTOOLS decides how many conventional memory tiles and how many disk tiles should be allocated. The TiledThreshold value influences the number of conventional tiles allocated as follows: the toolkit will not allocate any more conventional tiles when the amount of memory falls below TiledThreshold. When the amount of memory falls below TiledThreshold, disk tiles will be allocated and several swap buffers might back these disk tiles. For each image there will be at least one swap tile.

If the TiledThreshold value is > 0, then it represents a percentage of free memory out of the total memory. For example, when you pass -20, tiled images will be used when the amount of free physical and swap memory will drop below 20 percent of the total memory.

Example

For an example, refer to RasterDefaults.

Requirements

Target Platforms