vgl 1.0.0
Virtual Globe Library: API reference
Loading...
Searching...
No Matches
vgl_disk_cache_create_info Struct Reference

#include <vgl/defaults.h>

Public Attributes

uint32_t struct_size
 
uint32_t reserved
 
const char * directory
 
const vgl_io_interface * source
 
uint64_t budget
 
vgl_thread_pool * pool
 
const vgl_allocator_interface * allocator
 

Member Data Documentation

◆ struct_size

uint32_t vgl_disk_cache_create_info::struct_size

◆ reserved

uint32_t vgl_disk_cache_create_info::reserved

◆ directory

const char* vgl_disk_cache_create_info::directory

The directory, UTF-8; created if missing. Required.

◆ source

const vgl_io_interface* vgl_disk_cache_create_info::source

The interface whose reads are cached. Required. The table is copied; the object behind its user_data must stay valid until the cache is destroyed and its reads have completed. With a pool, the cache may call its read from the pool's threads (when an entry on the disk cannot be read), so it must accept reads from any thread.

◆ budget

uint64_t vgl_disk_cache_create_info::budget

Bytes the entries may take on disk. 0 selects 1 GiB.

◆ pool

vgl_thread_pool* vgl_disk_cache_create_info::pool

Optional. Reads and writes the disk on the pool's threads. Null does it in vgl_io_interface.read and on the thread that completes the source's reads.

◆ allocator

const vgl_allocator_interface* vgl_disk_cache_create_info::allocator

Optional. Allocator for the cache and its reads; must be thread-safe.


The documentation for this struct was generated from the following file: