VertexBufferCache

Description

sealed class Tinman.Terrain.Rendering.VertexBufferCache

An LRU cache for blocks of vertices in an IVertexBuffer.

public constructor VertexBufferCache → (2)

buffer ⁱⁿ : IVertexBuffer: [not-null]
The vertex buffer to use for caching data.
blockSize ^opt : int32 = 1024: [>0]
The block size, in vertices.

Creates a new instance of VertexBufferCache.

public method BlockId → (1)

Returns the block ID for the given block index.

public method BlockIndex → (2)

blockId ⁱⁿ : int64: The user-defined block ID.
loadIfNecessary ⁱⁿ : bool: Load the block into the cache, if necessary?
returns → int32: The return value R can be interpreted as follows:
>= 0 : The block is present in the cache, R is the block index.
= -1 : The block is not present in the cache and loadIfNecessary ⁱⁿ is false.
<=-2 : The block is not present in the cache and -2-R is the block index to use for loading its data.

Fetches a block from the cache.

public method Buffer → (2)

index ⁱⁿ : int32: The block index, see return value of BlockIndex.
count ^opt : int32 = 0: [0..VertexBufferCache.BlockSize]
Optional buffer limit, in vertices. If 0, the block size will be used.
returns → ByteBuffer: The write buffer.

Returns the write buffer for loading a block.

_2 overloads

public method Clear¹ → ()

Clears all blocks from the cache.

public method Clear² → (1)

Clears the given block from the cache.

public attribute BlockCount → (get)

Returns the block count.

public attribute BlockSize → (get)

Returns the block size.

public attribute VertexBuffer → (get)

Returns the backing vertex buffer.