←Select platform

ConventionalBuffers Property

Summary

Gets or sets a value that specifies the number of buffers in conventional memory that will cache the disk tiles.

Syntax

WinRT C#

C++

public int ConventionalBuffers {get; set;}

Public Property ConventionalBuffers As Integer

public int ConventionalBuffers {get; set;}

  
get_ConventionalBuffers(); 
set_ConventionalBuffers(value); 
Object.defineProperty('ConventionalBuffers');

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

Property Value

An integer value that specifies the number of buffers in conventional memory that will cache the disk tiles. Default is 1 (one swap buffer will be used to cache the disk tiles).

Remarks

ConventionalBuffers is used when working with tiled images which have disk tiles. The swap buffers will greatly improve the access to these disk tiles.

If the ConventionalBuffers value is > 0, ConventionalBuffers indicates the number of swap buffers.

If the ConventionalBuffers value is < 0, -ConventionalBuffers indicates the percentage of the total of disk tiles. For example, -50 means the number of buffers is half of the disk tiles will be used.

If the ConventionalBuffers value is 0, no swap buffers will be used. This uses the least amount of memory.

It is useful to have more than one swap buffer when you have an algorithm that constantly reads data going up and down. Usually, the data is read in one direction (from top to bottom or bottom to top) - in this case, one swap buffer will be enough. Also, if you only view a certain portion of the image, you might benefit from having enough swap buffers to cache the visible portion of the image (or the image's region).

The buffers are dynamic: when data is being read/written to a disk tile, a cache buffer is created (if permitted and there is enough memory). If the maximum number of cache buffers for that image has been reached, the cache buffer for the last used tile will be deleted and used for the new tile.

Example

For an example, refer to RasterDefaults.

Requirements

Target Platforms