pngleam

Types

BinaryRowData

pub type BinaryRowData =
  List(BitArray)

ColorInfo

opaque </>

pub opaque type ColorInfo

ColorType

</>

pub type ColorType {
  Greyscale
  Color
  Indexed
  GreyscaleWithAlpha
  ColorWithAlpha
}

Constructors

```
Greyscale
```
```
Color
```
```
Indexed
```
```
GreyscaleWithAlpha
```
```
ColorWithAlpha
```

ColorValue

</>

pub type ColorValue =
  #(Int, Int, Int)

ColorWithAlphaValue

</>

pub type ColorWithAlphaValue =
  #(Int, Int, Int, Int)

CompressionLevel

</>

pub type CompressionLevel =
  gzlib.CompressionLevel

FilterType

</>

pub type FilterType {
  None
  Sub
  Up
  Average
  Paeth
}

Constructors

```
None
```
```
Sub
```
```
Up
```
```
Average
```
```
Paeth
```

GreyscaleValue

</>

pub type GreyscaleValue =
  Int

GreyscaleWithAlphaValue

</>

pub type GreyscaleWithAlphaValue =
  #(Int, Int)

Grid

</>

pub type Grid(a) =
  List(List(a))

PaletteColor

</>

pub type PaletteColor =
  #(Int, Int, Int)

PaletteColors

</>

pub type PaletteColors =
  List(PaletteColor)

PalleteIndex

</>

pub type PalleteIndex =
  Int

ParseError

</>

pub type ParseError {
  InvalidSignature
  InvalidChunkTag
  ChecksumMismatch
  InvalidChunkOrder
  MissingHeaderChunk
  InvalidChunkData
  InvalidColorType
  InvalidBitDepth
  InvalidCompressionType
  InvalidFilterMethod
  InvalidInterlaceMethod
  UnsupportedInterlaceMethod
  InvalidRowFilterType
  InvalidRowData
}

Constructors

```
InvalidSignature
```
```
InvalidChunkTag
```
```
ChecksumMismatch
```
```
InvalidChunkOrder
```
```
MissingHeaderChunk
```
```
InvalidChunkData
```
```
InvalidColorType
```
```
InvalidBitDepth
```
```
InvalidCompressionType
```
```
InvalidFilterMethod
```
```
InvalidInterlaceMethod
```
```
UnsupportedInterlaceMethod
```
```
InvalidRowFilterType
```
```
InvalidRowData
```

PixelData

</>

pub type PixelData {
  GreyscaleData(Grid(GreyscaleValue))
  ColorData(Grid(ColorValue))
  IndexedData(Grid(PalleteIndex))
  GreyscaleWithAlphaData(Grid(GreyscaleWithAlphaValue))
  ColorWithAlphaData(Grid(ColorWithAlphaValue))
}

Constructors

```
GreyscaleData(Grid(GreyscaleValue))
```
```
ColorData(Grid(ColorValue))
```
```
IndexedData(Grid(PalleteIndex))
```

GreyscaleWithAlphaData(Grid(GreyscaleWithAlphaValue))

ColorWithAlphaData(Grid(ColorWithAlphaValue))

PngBitArrayData

</>

pub type PngBitArrayData =
  PngData(RawPalette, BinaryRowData)

PngData

</>

pub type PngData(p, i) {
  PngData(
    metadata: PngMetadata,
    palette: option.Option(p),
    image_data: i,
  )
}

Constructors

PngData(
  metadata: PngMetadata,
  palette: option.Option(p),
  image_data: i,
)

PngMetadata

</>

pub type PngMetadata {
  PngMetadata(width: Int, height: Int, color_info: ColorInfo)
}

Constructors

PngMetadata(width: Int, height: Int, color_info: ColorInfo)

PngPixelData

</>

pub type PngPixelData =
  PngData(PaletteColors, PixelData)

RawPalette

</>

pub type RawPalette =
  BitArray

Constants

compression_level

</>

pub const compression_level: fn(Int) ->
  Result(CompressionLevel, Nil)

default_compression

</>

pub const default_compression: CompressionLevel

greyscale_8bit

</>

pub const greyscale_8bit: ColorInfo

max_compression

</>

pub const max_compression: CompressionLevel

min_compression

</>

pub const min_compression: CompressionLevel

no_compression

</>

pub const no_compression: CompressionLevel

rgb_16bit

</>

pub const rgb_16bit: ColorInfo

rgb_8bit

</>

pub const rgb_8bit: ColorInfo

rgba_16bit

</>

pub const rgba_16bit: ColorInfo

rgba_8bit

</>

pub const rgba_8bit: ColorInfo

Functions

color_info

</>

pub fn color_info(
  color_type color_type: ColorType,
  bit_depth bit_depth: Int,
) -> Result(ColorInfo, Nil)

color_info_bits

</>

pub fn color_info_bits(color_info: ColorInfo) -> Int

filter_type_to_int

</>

pub fn filter_type_to_int(filter_type: FilterType) -> Int

from_packed

</>

pub fn from_packed(
  row_data row_data: List(BitArray),
  width width: Int,
  height height: Int,
  color_info color_info: ColorInfo,
  compression_level compression_level: CompressionLevel,
) -> BitArray

int_to_filter_type

</>

pub fn int_to_filter_type(
  filter_type: Int,
) -> Result(FilterType, Nil)

parse_metadata

</>

pub fn parse_metadata(
  data: BitArray,
) -> Result(PngMetadata, ParseError)

parse_to_bit_arrays

</>

pub fn parse_to_bit_arrays(
  data: BitArray,
) -> Result(PngData(BitArray, List(BitArray)), ParseError)

parse_to_pixel_data

</>

pub fn parse_to_pixel_data(
  data: BitArray,
) -> Result(
  PngData(List(#(Int, Int, Int)), PixelData),
  ParseError,
)