Writer

Description

Name

abstract class Tinman.Image.Writer

Extended by

BMP / PNG / PXB / TGA

Used by

Write.writer

Writer image data to a file, using a specific file format and settings.

The formatAnd and formatOr fields can be used to reduce or extend the output pixel format. First, the intersection of the pixel format flags of the input image and the flags of formatAnd is computed. Then, the union of the resulting flags and formatOr is computed. The final flags are used to hint the image writer, which may choose a different bit-depth or color mode, for example.

Fields / Required

path

Type

path

Constraint

# != null

The output file path.

Fields / Optional

srgb

Type

number

Default

0

Write compressed sRGB color channel values (> 0), linear sRGB color channel values (< 0) or let the image writer choose automatically (0)?


formatAnd

Type

PixelFormat[]

Default

[Truecolor, Alpha, Precision]

Controls the format of the written image, by giving a hint to the output pixel format.


formatOr

Type

PixelFormat[]

Default

[]

Controls the format of the written image, by giving a hint to the output pixel format.

Fields / External

geo

Type

bool

Can this writer output geo-referencing information?