Heightmap.Copy

Description

Name

class Tinman.Heightmap.Copy

Derived from

Operation

Copies samples from the source heightmap to a new heightmap dataset.

Fields / Required

source

Type

Heightmap

Constraint

# != null

The source heightmap to copy from.


target

Type

path

Constraint

# != null

Path to output dataset.

Fields / Optional

format

Type

PixelFormat[]

Default

[Truecolor, Alpha, SixteenBits]

The pixel format to use for choosing the output heightmap format. This parameter is ignored when the source heightmap is a HGT dataset: in this case, the source heightmap format will be used.


info

Type

Dataset.Info

Default

null

Optional dataset metadata to use. If null, metadata will be copied from the source dataset if create is true; otherwise, the current metadata of target is retained.


op

Type

Copy.Op

Default

null

Optional operation to perform on the source samples, before writing the target samples. If null, the source samples will be copied without modification.


create

Type

bool

Default

true

Set to true to create a new dataset or false to update an existing dataset.


guid

Type

string

Default

null

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