README
Tr
Image
Tr
RGBA64Image
- ::alpha_atAlpha::alpha_at
- ::newAlpha::new
- ::new_emptyAlpha::new_empty
- ::op_getAlpha::op_get
- ::op_setAlpha::op_set
- ::rgba64_atAlpha::rgba64_at
- ::set_alphaAlpha::set_alpha
- ::set_rgba64Alpha::set_rgba64
- ::alpha16_atAlpha16::alpha16_at
- ::newAlpha16::new
- ::new_emptyAlpha16::new_empty
- ::op_getAlpha16::op_get
- ::op_setAlpha16::op_set
- ::rgba64_atAlpha16::rgba64_at
- ::set_alpha16Alpha16::set_alpha16
- ::set_rgba64Alpha16::set_rgba64
- ::cmyk_atCMYK::cmyk_at
- ::newCMYK::new
- ::new_emptyCMYK::new_empty
- ::op_getCMYK::op_get
- ::rgba64_atCMYK::rgba64_at
- ::set_cmykCMYK::set_cmyk
- ::set_rgba64CMYK::set_rgba64
- ::new_emptyConfig::new_empty
- ::gray_atGray::gray_at
- ::newGray::new
- ::new_emptyGray::new_empty
- ::op_getGray::op_get
- ::op_setGray::op_set
- ::rgba64_atGray::rgba64_at
- ::set_grayGray::set_gray
- ::set_rgba64Gray::set_rgba64
- ::gray16_atGray16::gray16_at
- ::newGray16::new
- ::new_emptyGray16::new_empty
- ::op_getGray16::op_get
- ::op_setGray16::op_set
- ::rgba64_atGray16::rgba64_at
- ::set_gray16Gray16::set_gray16
- ::set_rgba64Gray16::set_rgba64
- ::newNRGBA::new
- ::new_emptyNRGBA::new_empty
- ::nrgba_atNRGBA::nrgba_at
- ::op_getNRGBA::op_get
- ::op_setNRGBA::op_set
- ::rgba64_atNRGBA::rgba64_at
- ::set_nrgbaNRGBA::set_nrgba
- ::set_rgba64NRGBA::set_rgba64
- ::newNRGBA64::new
- ::new_emptyNRGBA64::new_empty
- ::nrgba64_atNRGBA64::nrgba64_at
- ::op_getNRGBA64::op_get
- ::op_setNRGBA64::op_set
- ::rgba64_atNRGBA64::rgba64_at
- ::set_nrgba64NRGBA64::set_nrgba64
- ::set_rgba64NRGBA64::set_rgba64
- ::newPaletted::new
- ::new_emptyPaletted::new_empty
- ::op_getPaletted::op_get
- ::op_setPaletted::op_set
- ::rgba64_atPaletted::rgba64_at
- ::set_color_indexPaletted::set_color_index
- ::set_rgba64Paletted::set_rgba64
- ::divPoint::div
- ::is_inPoint::is_in
- ::modPoint::mod
- ::mulPoint::mul
- ::to_stringPoint::to_string
- ::newRGBA::new
- ::new_emptyRGBA::new_empty
- ::op_getRGBA::op_get
- ::op_setRGBA::op_set
- ::rgba64_atRGBA::rgba64_at
- ::rgba_atRGBA::rgba_at
- ::set_rgbaRGBA::set_rgba
- ::set_rgba64RGBA::set_rgba64
- ::newRGBA64::new
- ::new_emptyRGBA64::new_empty
- ::op_getRGBA64::op_get
- ::op_setRGBA64::op_set
- ::rgba64_atRGBA64::rgba64_at
- ::set_rgba64RGBA64::set_rgba64
- ::addRectangle::add
- ::canonRectangle::canon
- ::copyRectangle::copy
- ::dxRectangle::dx
- ::dyRectangle::dy
- ::emptyRectangle::empty
- ::insetRectangle::inset
- ::intersectRectangle::intersect
- ::is_inRectangle::is_in
- ::newRectangle::new
- ::overlapsRectangle::overlaps
- ::rgba64_atRectangle::rgba64_at
- ::sizeRectangle::size
- ::subRectangle::sub
- ::to_stringRectangle::to_string
- ::unionRectangle::union
T
SizeError
- ::emptyImage::empty
- ::new_emptyImage::new_empty
V
add2_non_neg
V
mul3_non_neg
V
pt
V
rect

image

MoonBit image: simple image representation.

image

color

moonbit

Download zip

Author

gmlewis

Version

0.16.17

License

Apache-2.0

Repository

github.com/gmlewis/moonbit-image

Last updated

last year

Downloads

#gmlewis/image

This is a simple image representation based on Go's implementation: https://cs.opensource.google/go/go/+/refs/tags/go1.23.3:src/image/image.go which has the copyright notice:

// Copyright 2009 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

#Status

The code has been updated to support compiler:

$ moon version --all
moon 0.1.20250704 (608fa55 2025-07-04) ~/.moon/bin/moon
moonc v0.6.20 ~/.moon/bin/moonc
moonrun 0.1.20250704 (608fa55 2025-07-04) ~/.moon/bin/moonrun

Image

source

pub(open) trait Image {
  color_model(Self) -> @gmlewis/image/color.Model
Model
  bounds(Self) -> Rectangle
  at(Self, Int, Int) -> @gmlewis/image/color.Color
Color
  opaque_(Self) -> Bool
  set(Self, Int, Int, @gmlewis/image/color.Color
Color) -> Unit
  sub_image(Self, Rectangle) -> Image
  raw_data(Self) -> @gmlewis/io.Slice
Slice[Byte]
  get_bytes_per_pixel(Self) -> Int
  get_stride(Self) -> Int
  pix_offset(Self, Int, Int) -> Int
  color_index_at(Self, Int, Int) -> Byte
}

Image is a finite rectangular grid of [color.Color] values taken from a color model.

RGBA64Image

source

pub(open) trait RGBA64Image {
  rgba64_at(Self, Int, Int) -> @gmlewis/image/color.RGBA64
RGBA64
  color_model(Self) -> @gmlewis/image/color.Model
Model
  bounds(Self) -> Rectangle
  at(Self, Int, Int) -> @gmlewis/image/color.Color
Color
}

RGBA64Image is an [Image] whose pixels can be converted directly to a color.RGBA64.

Alpha

source

pub(all) struct Alpha {
  pix : @gmlewis/io.Slice
Slice[Byte]
  stride : Int
  rect : Rectangle
}

Alpha is an in-memory image whose At method returns [color.Alpha] values.

impl Image for Alpha

fn at(self : Alpha, x : Int, y : Int) -> @gmlewis/image/color.Color
Color

source

fn bounds(self : Alpha) -> Rectangle

source

fn color_index_at(_self : Alpha, _x : Int, _y : Int) -> Byte

source

fn color_model(_self : Alpha) -> @gmlewis/image/color.Model
Model

source

fn get_bytes_per_pixel(_self : Alpha) -> Int

source

fn get_stride(self : Alpha) -> Int

source

fn opaque_(self : Alpha) -> Bool

source

opaque scans the entire image and reports whether it is fully opaque.

fn pix_offset(self : Alpha, x : Int, y : Int) -> Int

source

pix_offset returns the index of the first element of pix that corresponds to the pixel at (x, y).

fn raw_data(self : Alpha) -> @gmlewis/io.Slice
Slice[Byte]

source

fn set(self : Alpha, x : Int, y : Int, c : @gmlewis/image/color.Color
Color) -> Unit

source

fn sub_image(self : Alpha, r : Rectangle) -> Image

source

sub_image returns an image representing the portion of the image p visible through r. The returned value shares pixels with the original image.

Alpha::alpha_at

source

fn Alpha::alpha_at(self : Alpha, x : Int, y : Int) -> @gmlewis/image/color.Alpha
Alpha

Alpha::new

source

fn Alpha::new(r : Rectangle) -> Alpha raise SizeError

Alpha::new returns a new [Alpha] image with the given bounds.

Alpha::new_empty

source

fn Alpha::new_empty() -> Alpha

Alpha::op_get

source

fn Alpha::op_get(self : Alpha, p : Point) -> @gmlewis/image/color.Color
Color

Alpha::op_set

source

fn Alpha::op_set(self : Alpha, p : Point, c : @gmlewis/image/color.Color
Color) -> Unit

Alpha::rgba64_at

source

fn Alpha::rgba64_at(self : Alpha, x : Int, y : Int) -> @gmlewis/image/color.RGBA64
RGBA64

Alpha::set_alpha

source

fn Alpha::set_alpha(self : Alpha, x : Int, y : Int, c : @gmlewis/image/color.Alpha
Alpha) -> Unit

Alpha::set_rgba64

source

fn Alpha::set_rgba64(self : Alpha, x : Int, y : Int, c : @gmlewis/image/color.RGBA64
RGBA64) -> Unit

Alpha16

source

pub(all) struct Alpha16 {
  pix : @gmlewis/io.Slice
Slice[Byte]
  stride : Int
  rect : Rectangle
}

Alpha16 is an in-memory image whose At method returns [color.Alpha16] values.

impl Image for Alpha16

fn at(self : Alpha16, x : Int, y : Int) -> @gmlewis/image/color.Color
Color

source

fn bounds(self : Alpha16) -> Rectangle

source

fn color_index_at(_self : Alpha16, _x : Int, _y : Int) -> Byte

source

fn color_model(_self : Alpha16) -> @gmlewis/image/color.Model
Model

source

fn get_bytes_per_pixel(_self : Alpha16) -> Int

source

fn get_stride(self : Alpha16) -> Int

source

fn opaque_(self : Alpha16) -> Bool

source

opaque scans the entire image and reports whether it is fully opaque.

fn pix_offset(self : Alpha16, x : Int, y : Int) -> Int

source

pix_offset returns the index of the first element of pix that corresponds to the pixel at (x, y).

fn raw_data(self : Alpha16) -> @gmlewis/io.Slice
Slice[Byte]

source

fn set(self : Alpha16, x : Int, y : Int, c : @gmlewis/image/color.Color
Color) -> Unit

source

fn sub_image(self : Alpha16, r : Rectangle) -> Image

source

sub_image returns an image representing the portion of the image p visible through r. The returned value shares pixels with the original image.

Alpha16::alpha16_at

source

fn Alpha16::alpha16_at(self : Alpha16, x : Int, y : Int) -> @gmlewis/image/color.Alpha16
Alpha16

Alpha16::new

source

fn Alpha16::new(r : Rectangle) -> Alpha16 raise SizeError

Alpha16::new returns a new [Alpha16] image with the given bounds.

Alpha16::new_empty

source

fn Alpha16::new_empty() -> Alpha16

Alpha16::op_get

source

fn Alpha16::op_get(self : Alpha16, p : Point) -> @gmlewis/image/color.Color
Color

Alpha16::op_set

source

fn Alpha16::op_set(self : Alpha16, p : Point, c : @gmlewis/image/color.Color
Color) -> Unit

Alpha16::rgba64_at

source

fn Alpha16::rgba64_at(self : Alpha16, x : Int, y : Int) -> @gmlewis/image/color.RGBA64
RGBA64

Alpha16::set_alpha16

source

fn Alpha16::set_alpha16(self : Alpha16, x : Int, y : Int, c : @gmlewis/image/color.Alpha16
Alpha16) -> Unit

Alpha16::set_rgba64

source

fn Alpha16::set_rgba64(self : Alpha16, x : Int, y : Int, c : @gmlewis/image/color.RGBA64
RGBA64) -> Unit

CMYK

source

pub(all) struct CMYK {
  pix : @gmlewis/io.Slice
Slice[Byte]
  stride : Int
  rect : Rectangle
}

CMYK is an in-memory image whose At method returns [color.CMYK] values.

impl Image for CMYK

fn at(self : CMYK, x : Int, y : Int) -> @gmlewis/image/color.Color
Color

source

fn bounds(self : CMYK) -> Rectangle

source

fn color_index_at(_self : CMYK, _x : Int, _y : Int) -> Byte

source

fn color_model(_self : CMYK) -> @gmlewis/image/color.Model
Model

source

fn get_bytes_per_pixel(_self : CMYK) -> Int

source

fn get_stride(self : CMYK) -> Int

source

fn opaque_(_self : CMYK) -> Bool

source

opaque scans the entire image and reports whether it is fully opaque.

fn pix_offset(self : CMYK, x : Int, y : Int) -> Int

source

pix_offset returns the index of the first element of pix that corresponds to the pixel at (x, y).

fn raw_data(self : CMYK) -> @gmlewis/io.Slice
Slice[Byte]

source

fn set(self : CMYK, x : Int, y : Int, c : @gmlewis/image/color.Color
Color) -> Unit

source

fn sub_image(self : CMYK, r : Rectangle) -> Image

source

sub_image returns an image representing the portion of the image p visible through r. The returned value shares pixels with the original image.

CMYK::cmyk_at

source

fn CMYK::cmyk_at(self : CMYK, x : Int, y : Int) -> @gmlewis/image/color.CMYK
CMYK

CMYK::new

source

fn CMYK::new(r : Rectangle) -> CMYK raise SizeError

CMYK::new returns a new CMYK image with the given bounds.

CMYK::new_empty

source

fn CMYK::new_empty() -> CMYK

CMYK::op_get

source

fn CMYK::op_get(self : CMYK, p : Point) -> @gmlewis/image/color.Color
Color

CMYK::rgba64_at

source

fn CMYK::rgba64_at(self : CMYK, x : Int, y : Int) -> @gmlewis/image/color.RGBA64
RGBA64

CMYK::set_cmyk

source

fn CMYK::set_cmyk(self : CMYK, x : Int, y : Int, c : @gmlewis/image/color.CMYK
CMYK) -> Unit

CMYK::set_rgba64

source

fn CMYK::set_rgba64(self : CMYK, x : Int, y : Int, c : @gmlewis/image/color.RGBA64
RGBA64) -> Unit

Config

source

pub(all) struct Config {
  color_model : @gmlewis/image/color.Model
Model
  width : Int
  height : Int
}

Config holds an image's color model and dimensions.

Config::new_empty

source

fn Config::new_empty() -> Config

Gray

source

pub(all) struct Gray {
  pix : @gmlewis/io.Slice
Slice[Byte]
  stride : Int
  rect : Rectangle
}

Gray is an in-memory image whose At method returns [color.Gray] values.

impl Image for Gray

fn at(self : Gray, x : Int, y : Int) -> @gmlewis/image/color.Color
Color

source

fn bounds(self : Gray) -> Rectangle

source

fn color_index_at(_self : Gray, _x : Int, _y : Int) -> Byte

source

fn color_model(_self : Gray) -> @gmlewis/image/color.Model
Model

source

fn get_bytes_per_pixel(_self : Gray) -> Int

source

fn get_stride(self : Gray) -> Int

source

fn opaque_(_self : Gray) -> Bool

source

opaque scans the entire image and reports whether it is fully opaque.

fn pix_offset(self : Gray, x : Int, y : Int) -> Int

source

pix_offset returns the index of the first element of pix that corresponds to the pixel at (x, y).

fn raw_data(self : Gray) -> @gmlewis/io.Slice
Slice[Byte]

source

fn set(self : Gray, x : Int, y : Int, c : @gmlewis/image/color.Color
Color) -> Unit

source

fn sub_image(self : Gray, r : Rectangle) -> Image

source

sub_image returns an image representing the portion of the image p visible through r. The returned value shares pixels with the original image.

Gray::gray_at

source

fn Gray::gray_at(self : Gray, x : Int, y : Int) -> @gmlewis/image/color.Gray
Gray

Gray::new

source

fn Gray::new(r : Rectangle) -> Gray raise SizeError

Gray::new returns a new [Gray] image with the given bounds.

Gray::new_empty

source

fn Gray::new_empty() -> Gray

Gray::op_get

source

fn Gray::op_get(self : Gray, p : Point) -> @gmlewis/image/color.Color
Color

Gray::op_set

source

fn Gray::op_set(self : Gray, p : Point, c : @gmlewis/image/color.Color
Color) -> Unit

Gray::rgba64_at

source

fn Gray::rgba64_at(self : Gray, x : Int, y : Int) -> @gmlewis/image/color.RGBA64
RGBA64

Gray::set_gray

source

fn Gray::set_gray(self : Gray, x : Int, y : Int, c : @gmlewis/image/color.Gray
Gray) -> Unit

Gray::set_rgba64

source

fn Gray::set_rgba64(self : Gray, x : Int, y : Int, c : @gmlewis/image/color.RGBA64
RGBA64) -> Unit

Gray16

source

pub(all) struct Gray16 {
  pix : @gmlewis/io.Slice
Slice[Byte]
  stride : Int
  rect : Rectangle
}

Gray16 is an in-memory image whose At method returns [color.Gray16] values.

impl Image for Gray16

fn at(self : Gray16, x : Int, y : Int) -> @gmlewis/image/color.Color
Color

source

fn bounds(self : Gray16) -> Rectangle

source

fn color_index_at(_self : Gray16, _x : Int, _y : Int) -> Byte

source

fn color_model(_self : Gray16) -> @gmlewis/image/color.Model
Model

source

fn get_bytes_per_pixel(_self : Gray16) -> Int

source

fn get_stride(self : Gray16) -> Int

source

fn opaque_(_self : Gray16) -> Bool

source

opaque scans the entire image and reports whether it is fully opaque.

fn pix_offset(self : Gray16, x : Int, y : Int) -> Int

source

pix_offset returns the index of the first element of pix that corresponds to the pixel at (x, y).

fn raw_data(self : Gray16) -> @gmlewis/io.Slice
Slice[Byte]

source

fn set(self : Gray16, x : Int, y : Int, c : @gmlewis/image/color.Color
Color) -> Unit

source

fn sub_image(self : Gray16, r : Rectangle) -> Image

source

sub_image returns an image representing the portion of the image p visible through r. The returned value shares pixels with the original image.

Gray16::gray16_at

source

fn Gray16::gray16_at(self : Gray16, x : Int, y : Int) -> @gmlewis/image/color.Gray16
Gray16

Gray16::new

source

fn Gray16::new(r : Rectangle) -> Gray16 raise SizeError

Gray16::new returns a new [Gray16] image with the given bounds.

Gray16::new_empty

source

fn Gray16::new_empty() -> Gray16

Gray16::op_get

source

fn Gray16::op_get(self : Gray16, p : Point) -> @gmlewis/image/color.Color
Color

Gray16::op_set

source

fn Gray16::op_set(self : Gray16, p : Point, c : @gmlewis/image/color.Color
Color) -> Unit

Gray16::rgba64_at

source

fn Gray16::rgba64_at(self : Gray16, x : Int, y : Int) -> @gmlewis/image/color.RGBA64
RGBA64

Gray16::set_gray16

source

fn Gray16::set_gray16(self : Gray16, x : Int, y : Int, c : @gmlewis/image/color.Gray16
Gray16) -> Unit

Gray16::set_rgba64

source

fn Gray16::set_rgba64(self : Gray16, x : Int, y : Int, c : @gmlewis/image/color.RGBA64
RGBA64) -> Unit

NRGBA

source

pub(all) struct NRGBA {
  pix : @gmlewis/io.Slice
Slice[Byte]
  stride : Int
  rect : Rectangle
}

NRGBA is an in-memory image whose At method returns [color.NRGBA] values.

impl Image for NRGBA

fn at(self : NRGBA, x : Int, y : Int) -> @gmlewis/image/color.Color
Color

source

fn bounds(self : NRGBA) -> Rectangle

source

fn color_index_at(_self : NRGBA, _x : Int, _y : Int) -> Byte

source

fn color_model(_self : NRGBA) -> @gmlewis/image/color.Model
Model

source

fn get_bytes_per_pixel(_self : NRGBA) -> Int

source

fn get_stride(self : NRGBA) -> Int

source

fn opaque_(self : NRGBA) -> Bool

source

opaque scans the entire image and reports whether it is fully opaque.

fn pix_offset(self : NRGBA, x : Int, y : Int) -> Int

source

pix_offset returns the index of the first element of pix that corresponds to the pixel at (x, y).

fn raw_data(self : NRGBA) -> @gmlewis/io.Slice
Slice[Byte]

source

fn set(self : NRGBA, x : Int, y : Int, c : @gmlewis/image/color.Color
Color) -> Unit

source

fn sub_image(self : NRGBA, r : Rectangle) -> Image

source

sub_image returns an image representing the portion of the image p visible through r. The returned value shares pixels with the original image.

NRGBA::new

source

fn NRGBA::new(r : Rectangle) -> NRGBA raise SizeError

NRGBA::new returns a new [NRGBA] image with the given bounds.

NRGBA::new_empty

source

fn NRGBA::new_empty() -> NRGBA

NRGBA::nrgba_at

source

fn NRGBA::nrgba_at(self : NRGBA, x : Int, y : Int) -> @gmlewis/image/color.NRGBA
NRGBA

NRGBA::op_get

source

fn NRGBA::op_get(self : NRGBA, p : Point) -> @gmlewis/image/color.Color
Color

NRGBA::op_set

source

fn NRGBA::op_set(self : NRGBA, p : Point, c : @gmlewis/image/color.Color
Color) -> Unit

NRGBA::rgba64_at

source

fn NRGBA::rgba64_at(self : NRGBA, x : Int, y : Int) -> @gmlewis/image/color.RGBA64
RGBA64

NRGBA::set_nrgba

source

fn NRGBA::set_nrgba(self : NRGBA, x : Int, y : Int, c : @gmlewis/image/color.NRGBA
NRGBA) -> Unit

NRGBA::set_rgba64

source

fn NRGBA::set_rgba64(self : NRGBA, x : Int, y : Int, c : @gmlewis/image/color.RGBA64
RGBA64) -> Unit

NRGBA64

source

pub(all) struct NRGBA64 {
  pix : @gmlewis/io.Slice
Slice[Byte]
  stride : Int
  rect : Rectangle
}

NRGBA64 is an in-memory image whose At method returns [color.NRGBA64] values.

impl Image for NRGBA64

fn at(self : NRGBA64, x : Int, y : Int) -> @gmlewis/image/color.Color
Color

source

fn bounds(self : NRGBA64) -> Rectangle

source

fn color_index_at(_self : NRGBA64, _x : Int, _y : Int) -> Byte

source

fn color_model(_self : NRGBA64) -> @gmlewis/image/color.Model
Model

source

fn get_bytes_per_pixel(_self : NRGBA64) -> Int

source

fn get_stride(self : NRGBA64) -> Int

source

fn opaque_(self : NRGBA64) -> Bool

source

opaque scans the entire image and reports whether it is fully opaque.

fn pix_offset(self : NRGBA64, x : Int, y : Int) -> Int

source

pix_offset returns the index of the first element of pix that corresponds to the pixel at (x, y).

fn raw_data(self : NRGBA64) -> @gmlewis/io.Slice
Slice[Byte]

source

fn set(self : NRGBA64, x : Int, y : Int, c : @gmlewis/image/color.Color
Color) -> Unit

source

fn sub_image(self : NRGBA64, r : Rectangle) -> Image

source

sub_image returns an image representing the portion of the image p visible through r. The returned value shares pixels with the original image.

NRGBA64::new

source

fn NRGBA64::new(r : Rectangle) -> NRGBA64 raise SizeError

NRGBA64::new returns a new [NRGBA64] image with the given bounds.

NRGBA64::new_empty

source

fn NRGBA64::new_empty() -> NRGBA64

NRGBA64::nrgba64_at

source

fn NRGBA64::nrgba64_at(self : NRGBA64, x : Int, y : Int) -> @gmlewis/image/color.NRGBA64
NRGBA64

NRGBA64::op_get

source

fn NRGBA64::op_get(self : NRGBA64, p : Point) -> @gmlewis/image/color.Color
Color

NRGBA64::op_set

source

fn NRGBA64::op_set(self : NRGBA64, p : Point, c : @gmlewis/image/color.Color
Color) -> Unit

NRGBA64::rgba64_at

source

fn NRGBA64::rgba64_at(self : NRGBA64, x : Int, y : Int) -> @gmlewis/image/color.RGBA64
RGBA64

NRGBA64::set_nrgba64

source

fn NRGBA64::set_nrgba64(self : NRGBA64, x : Int, y : Int, c : @gmlewis/image/color.NRGBA64
NRGBA64) -> Unit

NRGBA64::set_rgba64

source

fn NRGBA64::set_rgba64(self : NRGBA64, x : Int, y : Int, c : @gmlewis/image/color.RGBA64
RGBA64) -> Unit

Paletted

source

pub(all) struct Paletted {
  pix : @gmlewis/io.Slice
Slice[Byte]
  stride : Int
  rect : Rectangle
  palette : @gmlewis/image/color.Palette
Palette
}

Paletted is an in-memory image of Byte indices into a given palette.

impl Image for Paletted

fn at(self : Paletted, x : Int, y : Int) -> @gmlewis/image/color.Color
Color

source

fn bounds(self : Paletted) -> Rectangle

source

fn color_index_at(self : Paletted, x : Int, y : Int) -> Byte

source

fn color_model(self : Paletted) -> @gmlewis/image/color.Model
Model

source

fn get_bytes_per_pixel(_self : Paletted) -> Int

source

fn get_stride(self : Paletted) -> Int

source

fn opaque_(self : Paletted) -> Bool

source

opaque scans the entire image and reports whether it is fully opaque.

fn pix_offset(self : Paletted, x : Int, y : Int) -> Int

source

pix_offset returns the index of the first element of pix that corresponds to the pixel at (x, y).

fn raw_data(self : Paletted) -> @gmlewis/io.Slice
Slice[Byte]

source

fn set(self : Paletted, x : Int, y : Int, c : @gmlewis/image/color.Color
Color) -> Unit

source

fn sub_image(self : Paletted, r : Rectangle) -> Image

source

sub_image returns an image representing the portion of the image p visible through r. The returned value shares pixels with the original image.

Paletted::new

source

fn Paletted::new(r : Rectangle, p : @gmlewis/image/color.Palette
Palette) -> Paletted raise SizeError

Paletted::new returns a new [Paletted] image with the given width, height and palette.

Paletted::new_empty

source

fn Paletted::new_empty() -> Paletted

Paletted::op_get

source

fn Paletted::op_get(self : Paletted, p : Point) -> @gmlewis/image/color.Color
Color

Paletted::op_set

source

fn Paletted::op_set(self : Paletted, p : Point, c : @gmlewis/image/color.Color
Color) -> Unit

Paletted::rgba64_at

source

fn Paletted::rgba64_at(self : Paletted, x : Int, y : Int) -> @gmlewis/image/color.RGBA64
RGBA64

Paletted::set_color_index

source

fn Paletted::set_color_index(self : Paletted, x : Int, y : Int, index : Byte) -> Unit

Paletted::set_rgba64

source

fn Paletted::set_rgba64(self : Paletted, x : Int, y : Int, c : @gmlewis/image/color.RGBA64
RGBA64) -> Unit

Point

source

pub(all) struct Point {
  x : Int
  y : Int
}

A Point is an X, Y coordinate pair. The axes increase right and down.

impl Add for Point

impl Eq for Point

impl Show for Point

impl Sub for Point

Point::div

source

fn Point::div(self : Point, k : Int) -> Point

div returns the vector p/k.

Point::is_in

source

fn Point::is_in(self : Point, r : Rectangle) -> Bool

is_in reports whether p is in r.

Point::mod

source

fn Point::mod(self : Point, r : Rectangle) -> Point

mod returns the point q in r such that p.X-q.X is a multiple of r's width and p.Y-q.Y is a multiple of r's height.

Point::mul

source

fn Point::mul(self : Point, k : Int) -> Point

mul returns the vector p*k.

Point::to_string

source

fn Point::to_string(self : Point) -> String

to_string returns a string representation of p like "(3,4)".

RGBA

source

pub(all) struct RGBA {
  pix : @gmlewis/io.Slice
Slice[Byte]
  stride : Int
  rect : Rectangle
}

RGBA is an in-memory image whose At method returns [color.RGBA] values.

impl Image for RGBA

fn at(self : RGBA, x : Int, y : Int) -> @gmlewis/image/color.Color
Color

source

fn bounds(self : RGBA) -> Rectangle

source

fn color_index_at(_self : RGBA, _x : Int, _y : Int) -> Byte

source

fn color_model(_self : RGBA) -> @gmlewis/image/color.Model
Model

source

fn get_bytes_per_pixel(_self : RGBA) -> Int

source

fn get_stride(self : RGBA) -> Int

source

fn opaque_(self : RGBA) -> Bool

source

opaque scans the entire image and reports whether it is fully opaque.

fn pix_offset(self : RGBA, x : Int, y : Int) -> Int

source

pix_offset returns the index of the first element of pix that corresponds to the pixel at (x, y).

fn raw_data(self : RGBA) -> @gmlewis/io.Slice
Slice[Byte]

source

fn set(self : RGBA, x : Int, y : Int, c : @gmlewis/image/color.Color
Color) -> Unit

source

fn sub_image(self : RGBA, r : Rectangle) -> Image

source

sub_image returns an image representing the portion of the image p visible through r. The returned value shares pixels with the original image.

RGBA::new

source

fn RGBA::new(r : Rectangle) -> RGBA raise SizeError

RGBA::new returns a new [RGBA] image with the given bounds.

RGBA::new_empty

source

fn RGBA::new_empty() -> RGBA

RGBA::op_get

source

fn RGBA::op_get(self : RGBA, p : Point) -> @gmlewis/image/color.Color
Color

RGBA::op_set

source

fn RGBA::op_set(self : RGBA, p : Point, c : @gmlewis/image/color.Color
Color) -> Unit

RGBA::rgba64_at

source

fn RGBA::rgba64_at(self : RGBA, x : Int, y : Int) -> @gmlewis/image/color.RGBA64
RGBA64

RGBA::rgba_at

source

fn RGBA::rgba_at(self : RGBA, x : Int, y : Int) -> @gmlewis/image/color.RGBA
RGBA

RGBA::set_rgba

source

fn RGBA::set_rgba(self : RGBA, x : Int, y : Int, c : @gmlewis/image/color.RGBA
RGBA) -> Unit

RGBA::set_rgba64

source

fn RGBA::set_rgba64(self : RGBA, x : Int, y : Int, c : @gmlewis/image/color.RGBA64
RGBA64) -> Unit

RGBA64

source

pub(all) struct RGBA64 {
  pix : @gmlewis/io.Slice
Slice[Byte]
  stride : Int
  rect : Rectangle
}

RGBA64 is an in-memory image whose At method returns [color.RGBA64] values.

impl Image for RGBA64

fn at(self : RGBA64, x : Int, y : Int) -> @gmlewis/image/color.Color
Color

source

fn bounds(self : RGBA64) -> Rectangle

source

fn color_index_at(_self : RGBA64, _x : Int, _y : Int) -> Byte

source

fn color_model(_self : RGBA64) -> @gmlewis/image/color.Model
Model

source

fn get_bytes_per_pixel(_self : RGBA64) -> Int

source

fn get_stride(self : RGBA64) -> Int

source

fn opaque_(self : RGBA64) -> Bool

source

opaque scans the entire image and reports whether it is fully opaque.

fn pix_offset(self : RGBA64, x : Int, y : Int) -> Int

source

pix_offset returns the index of the first element of pix that corresponds to the pixel at (x, y).

fn raw_data(self : RGBA64) -> @gmlewis/io.Slice
Slice[Byte]

source

fn set(self : RGBA64, x : Int, y : Int, c : @gmlewis/image/color.Color
Color) -> Unit

source

fn sub_image(self : RGBA64, r : Rectangle) -> Image

source

sub_image returns an image representing the portion of the image p visible through r. The returned value shares pixels with the original image.

RGBA64::new

source

fn RGBA64::new(r : Rectangle) -> RGBA64 raise SizeError

RGBA64::new returns a new [RGBA64] image with the given bounds.

RGBA64::new_empty

source

fn RGBA64::new_empty() -> RGBA64

RGBA64::op_get

source

fn RGBA64::op_get(self : RGBA64, p : Point) -> @gmlewis/image/color.Color
Color

RGBA64::op_set

source

fn RGBA64::op_set(self : RGBA64, p : Point, c : @gmlewis/image/color.Color
Color) -> Unit

RGBA64::rgba64_at

source

fn RGBA64::rgba64_at(self : RGBA64, x : Int, y : Int) -> @gmlewis/image/color.RGBA64
RGBA64

RGBA64::set_rgba64

source

fn RGBA64::set_rgba64(self : RGBA64, x : Int, y : Int, c : @gmlewis/image/color.RGBA64
RGBA64) -> Unit

Rectangle

source

pub(all) struct Rectangle {
  min : Point
  max : Point
}

A Rectangle contains the points with Min.X <= X < Max.X, Min.Y <= Y < Max.Y. It is well-formed if Min.X <= Max.X and likewise for Y. Points are always well-formed. A rectangle's methods always return well-formed outputs for well-formed inputs.

A Rectangle is also an [Image] whose bounds are the rectangle itself. At returns color.Opaque for points in the rectangle and color.Transparent otherwise.

impl Image for Rectangle

fn at(self : Rectangle, x : Int, y : Int) -> @gmlewis/image/color.Color
Color

source

at implements the [Image] trait.

fn bounds(self : Rectangle) -> Rectangle

source

bounds implements the [Image] trait.

fn color_index_at(_self : Rectangle, _x : Int, _y : Int) -> Byte

source

fn color_model(_self : Rectangle) -> @gmlewis/image/color.Model
Model

source

color_model implements the [Image] trait.

fn get_bytes_per_pixel(_self : Rectangle) -> Int

source

fn get_stride(_self : Rectangle) -> Int

source

fn opaque_(_self : Rectangle) -> Bool

source

fn pix_offset(_self : Rectangle, _x : Int, _y : Int) -> Int

source

fn raw_data(_self : Rectangle) -> @gmlewis/io.Slice
Slice[Byte]

source

fn set(_self : Rectangle, _x : Int, _y : Int, _c : @gmlewis/image/color.Color
Color) -> Unit

source

fn sub_image(self : Rectangle, _o : Rectangle) -> Image

source

impl Eq for Rectangle

impl Show for Rectangle

Rectangle::add

source

fn Rectangle::add(self : Rectangle, p : Point) -> Rectangle

add returns the rectangle r translated by p.

Rectangle::canon

source

fn Rectangle::canon(self : Rectangle) -> Rectangle

canon returns the canonical version of r. The returned rectangle has minimum and maximum coordinates swapped if necessary so that it is well-formed.

Rectangle::copy

source

fn Rectangle::copy(self : Rectangle) -> Rectangle

copy makes a copy of the provided rectangle without changing it.

Rectangle::dx

source

fn Rectangle::dx(self : Rectangle) -> Int

dx returns r's width.

Rectangle::dy

source

fn Rectangle::dy(self : Rectangle) -> Int

dy returns r's height.

Rectangle::empty

source

fn Rectangle::empty(self : Rectangle) -> Bool

empty reports whether the rectangle contains no points.

Rectangle::inset

source

fn Rectangle::inset(self : Rectangle, n : Int) -> Rectangle

inset returns the rectangle r inset by n, which may be negative. If either of r's dimensions is less than 2*n then an empty rectangle near the center of r will be returned.

Rectangle::intersect

source

fn Rectangle::intersect(self : Rectangle, s : Rectangle) -> Rectangle

intersect returns the largest rectangle contained by both r and s. If the two rectangles do not overlap then the zero rectangle will be returned.

Rectangle::is_in

source

fn Rectangle::is_in(self : Rectangle, s : Rectangle) -> Bool

is_in reports whether every point in r is in s.

Rectangle::new

source

fn Rectangle::new() -> Rectangle

Rectangle::new returns an empty (all zeros) rectangle.

Rectangle::overlaps

source

fn Rectangle::overlaps(self : Rectangle, s : Rectangle) -> Bool

overlaps reports whether r and s have a non-empty intersection.

Rectangle::rgba64_at

source

fn Rectangle::rgba64_at(self : Rectangle, x : Int, y : Int) -> @gmlewis/image/color.RGBA64
RGBA64

rgba64_at implements the [RGBA64Image] trait.

Rectangle::size

source

fn Rectangle::size(self : Rectangle) -> Point

size returns r's width and height.

Rectangle::sub

source

fn Rectangle::sub(self : Rectangle, p : Point) -> Rectangle

sub returns the rectangle r translated by -p.

Rectangle::to_string

source

fn Rectangle::to_string(self : Rectangle) -> String

to_string returns a string representation of r like "(3,4)-(6,5)".

Rectangle::union

source

fn Rectangle::union(self : Rectangle, s : Rectangle) -> Rectangle

union returns the smallest rectangle that contains both r and s.

SizeError

source

type SizeError

impl Eq for SizeError

impl Show for SizeError

Image

Image::empty

source

fn Image::empty(self : Image) -> Bool

Image::new_empty

source

fn Image::new_empty() -> Image

add2_non_neg

source

fn add2_non_neg(x : Int, y : Int) -> Int

add2_non_neg returns (x + y), unless at least one argument is negative or if the computation overflows the int type, in which case it returns -1.

mul3_non_neg

source

fn mul3_non_neg(x : Int, y : Int, z : Int) -> Int

mul3_non_neg returns (x * y * z), unless at least one argument is negative or if the computation overflows the int type, in which case it returns -1.

pt

source

fn pt(x : Int, y : Int) -> Point

pt is shorthand for [Point]{X, Y}.

rect

source

fn rect(x0 : Int, y0 : Int, x1 : Int, y1 : Int) -> Rectangle

rect is shorthand for [Rectangle]{Pt(x0, y0), [Pt](x1, y1)}. The returned rectangle has minimum and maximum coordinates swapped if necessary so that it is well-formed.

Source Files

Site source Report issue Packages Build queue Skills Statistics

image

#gmlewis/image

#Status

#Image

#RGBA64Image

#Alpha

#Alpha::alpha_at

#Alpha::new

#Alpha::new_empty

#Alpha::op_get

#Alpha::op_set

#Alpha::rgba64_at

#Alpha::set_alpha

#Alpha::set_rgba64

#Alpha16

#Alpha16::alpha16_at

#Alpha16::new

#Alpha16::new_empty

#Alpha16::op_get

#Alpha16::op_set

#Alpha16::rgba64_at

#Alpha16::set_alpha16

#Alpha16::set_rgba64

#CMYK

#CMYK::cmyk_at

#CMYK::new

#CMYK::new_empty

#CMYK::op_get

#CMYK::rgba64_at

#CMYK::set_cmyk

#CMYK::set_rgba64

#Config

#Config::new_empty

#Gray

#Gray::gray_at

#Gray::new

#Gray::new_empty

#Gray::op_get

#Gray::op_set

#Gray::rgba64_at

#Gray::set_gray

#Gray::set_rgba64

#Gray16

#Gray16::gray16_at

#Gray16::new

#Gray16::new_empty

#Gray16::op_get

#Gray16::op_set

#Gray16::rgba64_at

#Gray16::set_gray16

#Gray16::set_rgba64

#NRGBA

#NRGBA::new

#NRGBA::new_empty

#NRGBA::nrgba_at

#NRGBA::op_get

#NRGBA::op_set

#NRGBA::rgba64_at

#NRGBA::set_nrgba

#NRGBA::set_rgba64

#NRGBA64

#NRGBA64::new

#NRGBA64::new_empty

#NRGBA64::nrgba64_at

#NRGBA64::op_get

#NRGBA64::op_set

#NRGBA64::rgba64_at

#NRGBA64::set_nrgba64

#NRGBA64::set_rgba64

#Paletted

#Paletted::new

#Paletted::new_empty

#Paletted::op_get

#Paletted::op_set

#Paletted::rgba64_at

#Paletted::set_color_index

#Paletted::set_rgba64

#Point

#Point::div

#Point::is_in

Image

RGBA64Image

Alpha

Alpha::alpha_at

Alpha::new

Alpha::new_empty

Alpha::op_get

Alpha::op_set

Alpha::rgba64_at

Alpha::set_alpha

Alpha::set_rgba64

Alpha16

Alpha16::alpha16_at

Alpha16::new

Alpha16::new_empty

Alpha16::op_get

Alpha16::op_set

Alpha16::rgba64_at

Alpha16::set_alpha16

Alpha16::set_rgba64

CMYK

CMYK::cmyk_at

CMYK::new

CMYK::new_empty

CMYK::op_get

CMYK::rgba64_at

CMYK::set_cmyk

CMYK::set_rgba64

Config

Config::new_empty

Gray

Gray::gray_at

Gray::new

Gray::new_empty

Gray::op_get

Gray::op_set

Gray::rgba64_at

Gray::set_gray

Gray::set_rgba64

Gray16

Gray16::gray16_at

Gray16::new

Gray16::new_empty

Gray16::op_get

Gray16::op_set

Gray16::rgba64_at

Gray16::set_gray16

Gray16::set_rgba64

NRGBA

NRGBA::new

NRGBA::new_empty

NRGBA::nrgba_at

NRGBA::op_get

NRGBA::op_set

NRGBA::rgba64_at

NRGBA::set_nrgba

NRGBA::set_rgba64

NRGBA64

NRGBA64::new

NRGBA64::new_empty

NRGBA64::nrgba64_at

NRGBA64::op_get

NRGBA64::op_set

NRGBA64::rgba64_at

NRGBA64::set_nrgba64

NRGBA64::set_rgba64

Paletted

Paletted::new

Paletted::new_empty

Paletted::op_get

Paletted::op_set

Paletted::rgba64_at

Paletted::set_color_index

Paletted::set_rgba64

Point

Point::div

Point::is_in

Point::mod

Point::mul

Point::to_string