Wrap

Description

Name

class Tinman.Pyramid.Wrap

Derived from

Pyramid

Wraps the given heightmap in a pixel pyramid.

Fields / Required

source

Type

Heightmap

Constraint

# != null

The source heightmap.


layer

Type

Pixel

The pixel layer to use for creating pyramid tiles from heightmap data.

Fields / Optional

tile

Type

number

Constraint

# > 0

Default

256

The tile size, in pixels. Will be round up to the next power of two.


pad

Type

number

Constraint

# >= 0

Default

0

The tile pad of the pyramid.


levels

Type

number

Constraint

# >= 0

Default

0

Defines how many pyramid levels (starting at the bottom-most level) shall contain data. The heightmap sample step is 1 for the bottommost level and is multiplied by two for each parent level. If 0, all pyramid levels will contain data.


flags

Type

Pyramid.Flags[]

Default

[]

The pyramid flags.

Fields / External

info

Holds detail information about this pixel pyramid.