Pyramid.Dataset

Description

Name

class Tinman.Pyramid.Dataset

Derived from

Pyramid

A pyramid that uses a file-based dataset for storing its tile pixels.

Fields / Required

path

Type

path

Constraint

# != null

Path to the dataset file.

Fields / Optional

mode

Type

Dataset.Mode

Default

Dataset.Mode.Open

The mode to use for accessing the dataset file.


cube

Type

bool

Default

true

Create a cubemap dataset?


size

Type

number

Constraint

# >= 0

Default

0

Full size of the pyramid.


tile

Type

number

Constraint

# > 0

Default

256

Tile size of the pyramid.


pad

Type

number

Constraint

# >= 0

Default

0

Tile pad of the pyramid.


flags

Type

Pyramid.Flags[]

Default

[]

The pyramid flags of the dataset.


georef

Type

Tinman.Georef

Default

null

geo-referencing information to attach to dataset.


metadata

Type

Dataset.Info

Default

null

Metadata information to store in dataset.


format

Type

PixelFormat[]

Default

[Truecolor, Alpha, SixteenBits]

The pixel format hint to use for optimizing storage space.


guid

Type

string

Default

null

The dataset identifier to use. If empty, a random identifier will be generated.

Fields / External

id

Type

Dataset.Id

Returns a unique identifier for this dataset.


info

Holds detail information about this pixel pyramid.