diff --git a/Makefile b/Makefile index ee07b4e..67f6988 100644 --- a/Makefile +++ b/Makefile @@ -6,4 +6,4 @@ benchmark: .PHONY: docs docs: - crystal doc src/cr-image.cr + crystal doc src/docs.cr --project-name="Crystal Image" --source-refname=$(shell git rev-parse HEAD) diff --git a/README.md b/README.md index 359a971..e4127b2 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,9 @@ require "cr-image" require "cr-image/jpeg" require "cr-image/png" require "cr-image/webp" + +# Or, alternatively +require "cr-image/all_formats" ``` ### Example @@ -66,6 +69,34 @@ Yields this image: [See documentation](http://troy.sornson.io/cr-image/) for more examples. +### (Pluto)[https://github.com/phenopolis/pluto] and (Stumpy)[https://github.com/stumpycr/stumpy_core] Conversion + +If your library or application already uses Pluto or Stumpy and you want to use +some of the functionality of this library, CrImage also provides some optional +conversion methods: + +```crystal +require "cr-image/pluto" +pluto_image # => Pluto::ImageRGBA +pluto_image_rgba.to_crimage # => CrImage::RGBAImage + +cr_image # => CrImage::RGBAImage +cr_image.to_pluto # => Pluto::ImageRGBA +``` + +```crystal +require "cr-image/stumpy" +stumpy_canvas # => StumpyCore::Canvas +stumpy_canvas.to_crimage # => CrImage::RGBAImage + +cr_image # => CrImage::RGBAImage +cr_image.to_stumpy # => StumpyCore::Canvas +``` + +*NOTE:* Stumpy uses `UInt16` for its underlying raw image storage per channel per pixel, while Pluto and +CrImage uses `UInt8`. Converting from a Stumpy `Canvas` object to `RGBAImage` may lose quality if the original +image used 16 bit color channels (i.e. 16-bit PNG). Most image formats tend to use 8-bit color channels. + ## Development This requires `libwebp`, `libspng`, and `libturbojpeg` to run. Then: diff --git a/docs/404.html b/docs/404.html index cea4ff8..a27f97d 100644 --- a/docs/404.html +++ b/docs/404.html @@ -4,16 +4,16 @@ - - + + - - cr-image master + + Crystal Image master-dev @@ -34,12 +34,12 @@

- cr-image + Crystal Image

- master + master-dev
@@ -51,117 +51,142 @@

@@ -51,117 +51,142 @@

@@ -51,117 +51,142 @@

@@ -438,7 +488,7 @@


- [View source] + [View source]
@@ -454,7 +504,7 @@


- [View source] + [View source]
@@ -470,7 +520,7 @@


- [View source] + [View source]
@@ -486,7 +536,7 @@


- [View source] + [View source]
diff --git a/docs/CrImage/Color.html b/docs/CrImage/Color.html index 0cbdfb8..3d84dc3 100644 --- a/docs/CrImage/Color.html +++ b/docs/CrImage/Color.html @@ -4,16 +4,16 @@ - - + + - - CrImage::Color - cr-image master + + CrImage::Color - Crystal Image master-dev @@ -34,12 +34,12 @@

- cr-image + Crystal Image

- master + master-dev
@@ -51,117 +51,142 @@

@@ -434,7 +484,7 @@


- [View source] + [View source]
@@ -455,7 +505,7 @@


- [View source] + [View source]
@@ -485,7 +535,7 @@


- [View source] + [View source]
@@ -506,7 +556,7 @@


- [View source] + [View source]
@@ -522,7 +572,7 @@


- [View source] + [View source]
@@ -538,7 +588,7 @@


- [View source] + [View source]
@@ -559,7 +609,7 @@


- [View source] + [View source]
@@ -575,7 +625,7 @@


- [View source] + [View source]
@@ -591,7 +641,7 @@


- [View source] + [View source]
diff --git a/docs/CrImage/Exception.html b/docs/CrImage/Exception.html index c028f7f..62cef44 100644 --- a/docs/CrImage/Exception.html +++ b/docs/CrImage/Exception.html @@ -4,16 +4,16 @@ - - + + - - CrImage::Exception - cr-image master + + CrImage::Exception - Crystal Image master-dev @@ -34,12 +34,12 @@

- cr-image + Crystal Image

- master + master-dev
@@ -51,117 +51,142 @@

@@ -393,7 +443,7 @@


- [View source] + [View source]
@@ -409,7 +459,7 @@


- [View source] + [View source]
@@ -439,7 +489,7 @@


- [View source] + [View source]
diff --git a/docs/CrImage/Format.html b/docs/CrImage/Format.html index 9628e2e..7ae9ecd 100644 --- a/docs/CrImage/Format.html +++ b/docs/CrImage/Format.html @@ -4,16 +4,16 @@ - - + + - - CrImage::Format - cr-image master + + CrImage::Format - Crystal Image master-dev @@ -34,12 +34,12 @@

- cr-image + Crystal Image

- master + master-dev
@@ -51,117 +51,142 @@

@@ -51,57 +51,57 @@

diff --git a/docs/CrImage/Format/Open.html b/docs/CrImage/Format/Open.html index 4685cdf..e68f667 100644 --- a/docs/CrImage/Format/Open.html +++ b/docs/CrImage/Format/Open.html @@ -4,16 +4,16 @@ - - + + - - CrImage::Format::Open - cr-image master + + CrImage::Format::Open - Crystal Image master-dev @@ -34,12 +34,12 @@

- cr-image + Crystal Image

- master + master-dev
@@ -51,117 +51,142 @@

diff --git a/docs/CrImage/Format/PNG.html b/docs/CrImage/Format/PNG.html index 7cc5337..649dad8 100644 --- a/docs/CrImage/Format/PNG.html +++ b/docs/CrImage/Format/PNG.html @@ -4,16 +4,16 @@ - - + + - - CrImage::Format::PNG - cr-image master + + CrImage::Format::PNG - Crystal Image master-dev @@ -34,12 +34,12 @@

- cr-image + Crystal Image

- master + master-dev
@@ -51,57 +51,57 @@

diff --git a/docs/CrImage/Format/PPM.html b/docs/CrImage/Format/PPM.html index b7472a3..bb4d49d 100644 --- a/docs/CrImage/Format/PPM.html +++ b/docs/CrImage/Format/PPM.html @@ -4,16 +4,16 @@ - - + + - - CrImage::Format::PPM - cr-image master + + CrImage::Format::PPM - Crystal Image master-dev @@ -34,12 +34,12 @@

- cr-image + Crystal Image

- master + master-dev
@@ -51,117 +51,142 @@

diff --git a/docs/CrImage/Format/Save.html b/docs/CrImage/Format/Save.html index acfacd3..d80ae01 100644 --- a/docs/CrImage/Format/Save.html +++ b/docs/CrImage/Format/Save.html @@ -4,16 +4,16 @@ - - + + - - CrImage::Format::Save - cr-image master + + CrImage::Format::Save - Crystal Image master-dev @@ -34,12 +34,12 @@

- cr-image + Crystal Image

- master + master-dev
@@ -51,117 +51,142 @@

diff --git a/docs/CrImage/Format/WebP.html b/docs/CrImage/Format/WebP.html index 28097cb..c4c4981 100644 --- a/docs/CrImage/Format/WebP.html +++ b/docs/CrImage/Format/WebP.html @@ -4,16 +4,16 @@ - - + + - - CrImage::Format::WebP - cr-image master + + CrImage::Format::WebP - Crystal Image master-dev @@ -34,12 +34,12 @@

- cr-image + Crystal Image

- master + master-dev
@@ -51,57 +51,57 @@

diff --git a/docs/CrImage/GrayscaleImage.html b/docs/CrImage/GrayscaleImage.html index 1995e41..1050cad 100644 --- a/docs/CrImage/GrayscaleImage.html +++ b/docs/CrImage/GrayscaleImage.html @@ -4,16 +4,16 @@ - - + + - - CrImage::GrayscaleImage - cr-image master + + CrImage::GrayscaleImage - Crystal Image master-dev @@ -34,12 +34,12 @@

- cr-image + Crystal Image

- master + master-dev
@@ -51,117 +51,142 @@

@@ -1102,6 +1409,22 @@

Instance Method Detail

+
+
+ + def [](x : Int32, y : Int32) : Pixel + + # +
+ +
+
+ + [View source] + +
+
+
@@ -1118,7 +1441,7 @@


- [View source] + [View source]

@@ -1142,7 +1465,7 @@


- [View source] + [View source]

@@ -1163,7 +1486,7 @@


- [View source] + [View source]
@@ -1179,7 +1502,7 @@


- [View source] + [View source]
@@ -1200,7 +1523,7 @@


- [View source] + [View source]
@@ -1221,7 +1544,7 @@


- [View source] + [View source]
@@ -1242,7 +1565,7 @@


- [View source] + [View source]
@@ -1258,7 +1581,7 @@


- [View source] + [View source]
@@ -1274,7 +1597,7 @@


- [View source] + [View source]
@@ -1295,7 +1618,7 @@


- [View source] + [View source]
@@ -1320,7 +1643,7 @@


- [View source] + [View source]
@@ -1336,7 +1659,7 @@


- [View source] + [View source]
@@ -1360,7 +1683,7 @@


- [View source] + [View source]
@@ -1384,7 +1707,7 @@


- [View source] + [View source]
@@ -1414,7 +1737,7 @@


- [View source] + [View source]
@@ -1435,7 +1758,7 @@


- [View source] + [View source]
@@ -1456,7 +1779,7 @@


- [View source] + [View source]
@@ -1485,7 +1808,7 @@


- [View source] + [View source]
@@ -1506,7 +1829,7 @@


- [View source] + [View source]
@@ -1528,7 +1851,23 @@


- [View source] + [View source] + +
+ + +
+
+ + def to_stumpy : StumpyCore::Canvas + + # +
+ +
+
+ + [View source]
@@ -1553,7 +1892,7 @@


- [View source] + [View source]
@@ -1569,7 +1908,7 @@


- [View source] + [View source]
diff --git a/docs/CrImage/GrayscaleImage/Pixel.html b/docs/CrImage/GrayscaleImage/Pixel.html new file mode 100644 index 0000000..9e0d2eb --- /dev/null +++ b/docs/CrImage/GrayscaleImage/Pixel.html @@ -0,0 +1,510 @@ + + + + + + + + + + + + + + + + CrImage::GrayscaleImage::Pixel - Crystal Image master-dev + + + + + + + + +
+

+ + struct CrImage::GrayscaleImage::Pixel + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + + cr-image/grayscale_image.cr + + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + +

+ + + + Instance Method Summary +

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(gray : UInt8, alpha : UInt8) + + # +
+ +
+
+ + [View source] + +
+
+ + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def alpha : UInt8 + + # +
+ +
+
+ +
+
+ +
+
+ + def clone + + # +
+ +
+
+ + [View source] + +
+
+ +
+
+ + def copy_with(gray _gray = @gray, alpha _alpha = @alpha) + + # +
+ +
+
+ + [View source] + +
+
+ +
+
+ + def gray : UInt8 + + # +
+ +
+
+ +
+
+ + + + + +
+ + + diff --git a/docs/CrImage/Image.html b/docs/CrImage/Image.html index 1f93cab..d07980d 100644 --- a/docs/CrImage/Image.html +++ b/docs/CrImage/Image.html @@ -4,16 +4,16 @@ - - + + - - CrImage::Image - cr-image master + + CrImage::Image - Crystal Image master-dev @@ -34,12 +34,12 @@

- cr-image + Crystal Image

- master + master-dev
@@ -51,117 +51,142 @@

@@ -469,7 +519,7 @@


- [View source] + [View source]
@@ -490,7 +540,7 @@


- [View source] + [View source]
@@ -511,7 +561,7 @@


- [View source] + [View source]
@@ -532,7 +582,7 @@


- [View source] + [View source]
@@ -553,7 +603,7 @@


- [View source] + [View source]
@@ -574,7 +624,7 @@


- [View source] + [View source]
@@ -595,7 +645,7 @@


- [View source] + [View source]
@@ -616,7 +666,7 @@


- [View source] + [View source]
@@ -637,7 +687,7 @@


- [View source] + [View source]
@@ -665,7 +715,7 @@


- [View source] + [View source]
diff --git a/docs/CrImage/Mask.html b/docs/CrImage/Mask.html index 32fdf60..6640260 100644 --- a/docs/CrImage/Mask.html +++ b/docs/CrImage/Mask.html @@ -4,16 +4,16 @@ - - + + - - CrImage::Mask - cr-image master + + CrImage::Mask - Crystal Image master-dev @@ -34,12 +34,12 @@

- cr-image + Crystal Image

- master + master-dev
@@ -51,117 +51,142 @@

@@ -599,7 +649,7 @@


- [View source] + [View source]
@@ -623,7 +673,7 @@


- [View source] + [View source]
@@ -644,7 +694,7 @@


- [View source] + [View source]
@@ -665,7 +715,7 @@


- [View source] + [View source]
@@ -686,7 +736,7 @@


- [View source] + [View source]
@@ -716,7 +766,7 @@


- [View source] + [View source]
@@ -737,7 +787,7 @@


- [View source] + [View source]
@@ -758,7 +808,7 @@


- [View source] + [View source]
@@ -779,7 +829,7 @@


- [View source] + [View source]
@@ -801,7 +851,7 @@


- [View source] + [View source]
@@ -826,7 +876,7 @@


- [View source] + [View source]
@@ -851,7 +901,7 @@


- [View source] + [View source]
@@ -876,7 +926,7 @@


- [View source] + [View source]
@@ -901,7 +951,7 @@


- [View source] + [View source]
@@ -922,7 +972,7 @@


- [View source] + [View source]
@@ -943,7 +993,7 @@


- [View source] + [View source]
@@ -964,7 +1014,7 @@


- [View source] + [View source]
@@ -980,7 +1030,7 @@


- [View source] + [View source]
@@ -1001,7 +1051,7 @@


- [View source] + [View source]
@@ -1017,7 +1067,7 @@


- [View source] + [View source]
@@ -1038,7 +1088,7 @@


- [View source] + [View source]
@@ -1062,7 +1112,7 @@


- [View source] + [View source]
@@ -1088,7 +1138,7 @@


- [View source] + [View source]
@@ -1133,7 +1183,7 @@


- [View source] + [View source]
@@ -1154,7 +1204,7 @@


- [View source] + [View source]
@@ -1175,7 +1225,7 @@


- [View source] + [View source]
@@ -1196,7 +1246,7 @@


- [View source] + [View source]
@@ -1217,7 +1267,7 @@


- [View source] + [View source]
@@ -1233,7 +1283,7 @@


- [View source] + [View source]
diff --git a/docs/CrImage/Operation.html b/docs/CrImage/Operation.html index a6585e9..49c2c00 100644 --- a/docs/CrImage/Operation.html +++ b/docs/CrImage/Operation.html @@ -4,16 +4,16 @@ - - + + - - CrImage::Operation - cr-image master + + CrImage::Operation - Crystal Image master-dev @@ -34,12 +34,12 @@

- cr-image + Crystal Image

- master + master-dev
@@ -51,117 +51,142 @@

@@ -51,117 +51,142 @@

@@ -380,7 +430,7 @@


- [View source] + [View source]
diff --git a/docs/CrImage/Operation/BoxBlur.html b/docs/CrImage/Operation/BoxBlur.html index ad10853..8436aa1 100644 --- a/docs/CrImage/Operation/BoxBlur.html +++ b/docs/CrImage/Operation/BoxBlur.html @@ -4,16 +4,16 @@ - - + + - - CrImage::Operation::BoxBlur - cr-image master + + CrImage::Operation::BoxBlur - Crystal Image master-dev @@ -34,12 +34,12 @@

- cr-image + Crystal Image

- master + master-dev
@@ -51,117 +51,142 @@

@@ -365,7 +415,7 @@


- [View source] + [View source]
diff --git a/docs/CrImage/Operation/Brightness.html b/docs/CrImage/Operation/Brightness.html index a42dc8c..c7ea586 100644 --- a/docs/CrImage/Operation/Brightness.html +++ b/docs/CrImage/Operation/Brightness.html @@ -4,16 +4,16 @@ - - + + - - CrImage::Operation::Brightness - cr-image master + + CrImage::Operation::Brightness - Crystal Image master-dev @@ -34,12 +34,12 @@

- cr-image + Crystal Image

- master + master-dev
@@ -51,117 +51,142 @@

@@ -363,7 +413,7 @@


- [View source] + [View source]
diff --git a/docs/CrImage/Operation/ChannelSwap.html b/docs/CrImage/Operation/ChannelSwap.html index 67a5e95..620c881 100644 --- a/docs/CrImage/Operation/ChannelSwap.html +++ b/docs/CrImage/Operation/ChannelSwap.html @@ -4,16 +4,16 @@ - - + + - - CrImage::Operation::ChannelSwap - cr-image master + + CrImage::Operation::ChannelSwap - Crystal Image master-dev @@ -34,12 +34,12 @@

- cr-image + Crystal Image

- master + master-dev
@@ -51,117 +51,142 @@

@@ -363,7 +413,7 @@


- [View source] + [View source]
diff --git a/docs/CrImage/Operation/Contrast.html b/docs/CrImage/Operation/Contrast.html index 4ca93a8..a355f2c 100644 --- a/docs/CrImage/Operation/Contrast.html +++ b/docs/CrImage/Operation/Contrast.html @@ -4,16 +4,16 @@ - - + + - - CrImage::Operation::Contrast - cr-image master + + CrImage::Operation::Contrast - Crystal Image master-dev @@ -34,12 +34,12 @@

- cr-image + Crystal Image

- master + master-dev
@@ -51,117 +51,142 @@

@@ -363,7 +413,7 @@


- [View source] + [View source]
diff --git a/docs/CrImage/Operation/Crop.html b/docs/CrImage/Operation/Crop.html index af14de2..217e39a 100644 --- a/docs/CrImage/Operation/Crop.html +++ b/docs/CrImage/Operation/Crop.html @@ -4,16 +4,16 @@ - - + + - - CrImage::Operation::Crop - cr-image master + + CrImage::Operation::Crop - Crystal Image master-dev @@ -34,12 +34,12 @@

- cr-image + Crystal Image

- master + master-dev
@@ -51,117 +51,142 @@

@@ -380,7 +430,7 @@


- [View source] + [View source]
@@ -396,7 +446,7 @@


- [View source] + [View source]
@@ -412,7 +462,7 @@


- [View source] + [View source]
@@ -428,7 +478,7 @@


- [View source] + [View source]
diff --git a/docs/CrImage/Operation/Draw.html b/docs/CrImage/Operation/Draw.html index 6592823..e574f54 100644 --- a/docs/CrImage/Operation/Draw.html +++ b/docs/CrImage/Operation/Draw.html @@ -4,16 +4,16 @@ - - + + - - CrImage::Operation::Draw - cr-image master + + CrImage::Operation::Draw - Crystal Image master-dev @@ -34,12 +34,12 @@

- cr-image + Crystal Image

- master + master-dev
@@ -51,117 +51,142 @@

@@ -400,7 +450,7 @@


- [View source] + [View source]
@@ -421,7 +471,7 @@


- [View source] + [View source]
@@ -437,7 +487,7 @@


- [View source] + [View source]
@@ -453,7 +503,7 @@


- [View source] + [View source]
@@ -469,7 +519,7 @@


- [View source] + [View source]
@@ -485,7 +535,7 @@


- [View source] + [View source]
diff --git a/docs/CrImage/Operation/GaussianBlur.html b/docs/CrImage/Operation/GaussianBlur.html index 795cec0..99f3f5e 100644 --- a/docs/CrImage/Operation/GaussianBlur.html +++ b/docs/CrImage/Operation/GaussianBlur.html @@ -4,16 +4,16 @@ - - + + - - CrImage::Operation::GaussianBlur - cr-image master + + CrImage::Operation::GaussianBlur - Crystal Image master-dev @@ -34,12 +34,12 @@

- cr-image + Crystal Image

- master + master-dev
@@ -51,117 +51,142 @@

@@ -365,7 +415,7 @@


- [View source] + [View source]
diff --git a/docs/CrImage/Operation/HistogramEqualize.html b/docs/CrImage/Operation/HistogramEqualize.html index 0488bfa..c142b5f 100644 --- a/docs/CrImage/Operation/HistogramEqualize.html +++ b/docs/CrImage/Operation/HistogramEqualize.html @@ -4,16 +4,16 @@ - - + + - - CrImage::Operation::HistogramEqualize - cr-image master + + CrImage::Operation::HistogramEqualize - Crystal Image master-dev @@ -34,12 +34,12 @@

- cr-image + Crystal Image

- master + master-dev
@@ -51,117 +51,142 @@

@@ -374,7 +424,7 @@


- [View source] + [View source]
@@ -390,7 +440,7 @@


- [View source] + [View source]
diff --git a/docs/CrImage/Operation/HistogramEqualize/Histogram.html b/docs/CrImage/Operation/HistogramEqualize/Histogram.html index 6d55e93..f4fc7af 100644 --- a/docs/CrImage/Operation/HistogramEqualize/Histogram.html +++ b/docs/CrImage/Operation/HistogramEqualize/Histogram.html @@ -4,16 +4,16 @@ - - + + - - CrImage::Operation::HistogramEqualize::Histogram - cr-image master + + CrImage::Operation::HistogramEqualize::Histogram - Crystal Image master-dev @@ -34,12 +34,12 @@

- cr-image + Crystal Image

- master + master-dev
@@ -51,117 +51,142 @@

@@ -415,7 +465,7 @@


- [View source] + [View source]
@@ -436,7 +486,7 @@


- [View source] + [View source]
@@ -457,7 +507,7 @@


- [View source] + [View source]
@@ -478,7 +528,7 @@


- [View source] + [View source]
diff --git a/docs/CrImage/Operation/HorizontalBlur.html b/docs/CrImage/Operation/HorizontalBlur.html index 7fb8fab..fc7c924 100644 --- a/docs/CrImage/Operation/HorizontalBlur.html +++ b/docs/CrImage/Operation/HorizontalBlur.html @@ -4,16 +4,16 @@ - - + + - - CrImage::Operation::HorizontalBlur - cr-image master + + CrImage::Operation::HorizontalBlur - Crystal Image master-dev @@ -34,12 +34,12 @@

- cr-image + Crystal Image

- master + master-dev
@@ -51,117 +51,142 @@

@@ -365,7 +415,7 @@


- [View source] + [View source]
diff --git a/docs/CrImage/Operation/MaskApply.html b/docs/CrImage/Operation/MaskApply.html index 2174747..c991f42 100644 --- a/docs/CrImage/Operation/MaskApply.html +++ b/docs/CrImage/Operation/MaskApply.html @@ -4,16 +4,16 @@ - - + + - - CrImage::Operation::MaskApply - cr-image master + + CrImage::Operation::MaskApply - Crystal Image master-dev @@ -34,12 +34,12 @@

- cr-image + Crystal Image

- master + master-dev
@@ -51,117 +51,142 @@

@@ -416,7 +466,7 @@


- [View source] + [View source]
@@ -437,7 +487,7 @@


- [View source] + [View source]
@@ -453,7 +503,7 @@


- [View source] + [View source]
@@ -474,7 +524,7 @@


- [View source] + [View source]
@@ -490,7 +540,7 @@


- [View source] + [View source]
diff --git a/docs/CrImage/Operation/VerticalBlur.html b/docs/CrImage/Operation/VerticalBlur.html index 07b14e1..b9335d6 100644 --- a/docs/CrImage/Operation/VerticalBlur.html +++ b/docs/CrImage/Operation/VerticalBlur.html @@ -4,16 +4,16 @@ - - + + - - CrImage::Operation::VerticalBlur - cr-image master + + CrImage::Operation::VerticalBlur - Crystal Image master-dev @@ -34,12 +34,12 @@

- cr-image + Crystal Image

- master + master-dev
@@ -51,117 +51,142 @@

@@ -365,7 +415,7 @@


- [View source] + [View source]
diff --git a/docs/CrImage/RGBAImage.html b/docs/CrImage/RGBAImage.html index 0e67811..afeabfa 100644 --- a/docs/CrImage/RGBAImage.html +++ b/docs/CrImage/RGBAImage.html @@ -4,16 +4,16 @@ - - + + - - CrImage::RGBAImage - cr-image master + + CrImage::RGBAImage - Crystal Image master-dev @@ -34,12 +34,12 @@

- cr-image + Crystal Image

- master + master-dev
@@ -51,117 +51,142 @@

@@ -1114,7 +1437,7 @@


- [View source] + [View source]
@@ -1130,7 +1453,7 @@


- [View source] + [View source]
@@ -1151,7 +1474,7 @@


- [View source] + [View source]
@@ -1172,7 +1495,7 @@


- [View source] + [View source]
@@ -1197,7 +1520,7 @@


- [View source] + [View source]
@@ -1213,7 +1536,7 @@


- [View source] + [View source]
@@ -1238,7 +1561,7 @@


- [View source] + [View source]
@@ -1254,7 +1577,7 @@


- [View source] + [View source]
@@ -1279,7 +1602,7 @@


- [View source] + [View source]
@@ -1295,7 +1618,7 @@


- [View source] + [View source]
@@ -1316,7 +1639,7 @@


- [View source] + [View source]
@@ -1340,7 +1663,23 @@


- [View source] + [View source] + +
+ + +
+
+ + def to_stumpy : StumpyCore::Canvas + + # +
+ +
+
+ + [View source]
@@ -1365,7 +1704,7 @@


- [View source] + [View source]
@@ -1381,7 +1720,7 @@


- [View source] + [View source]
diff --git a/docs/CrImage/RGBAImage/Pixel.html b/docs/CrImage/RGBAImage/Pixel.html new file mode 100644 index 0000000..cac6f5e --- /dev/null +++ b/docs/CrImage/RGBAImage/Pixel.html @@ -0,0 +1,548 @@ + + + + + + + + + + + + + + + + CrImage::RGBAImage::Pixel - Crystal Image master-dev + + + + + + + + +
+

+ + struct CrImage::RGBAImage::Pixel + +

+ + + + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + + cr-image/rgba_image.cr + + +
+ + + + + + +

+ + + + Constructors +

+ + + + + + +

+ + + + Instance Method Summary +

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

+ + + + Constructor Detail +

+ +
+
+ + def self.new(red : UInt8, green : UInt8, blue : UInt8, alpha : UInt8) + + # +
+ +
+
+ + [View source] + +
+
+ + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def alpha : UInt8 + + # +
+ +
+
+ +
+
+ +
+
+ + def blue : UInt8 + + # +
+ +
+
+ +
+
+ +
+
+ + def clone + + # +
+ +
+
+ + [View source] + +
+
+ +
+
+ + def copy_with(red _red = @red, green _green = @green, blue _blue = @blue, alpha _alpha = @alpha) + + # +
+ +
+
+ + [View source] + +
+
+ +
+
+ + def green : UInt8 + + # +
+ +
+
+ +
+
+ +
+
+ + def red : UInt8 + + # +
+ +
+
+ +
+
+ + + + + +
+ + + diff --git a/docs/CrImage/Region.html b/docs/CrImage/Region.html index 9a25163..cdef1b4 100644 --- a/docs/CrImage/Region.html +++ b/docs/CrImage/Region.html @@ -4,16 +4,16 @@ - - + + - - CrImage::Region - cr-image master + + CrImage::Region - Crystal Image master-dev @@ -34,12 +34,12 @@

- cr-image + Crystal Image

- master + master-dev
@@ -51,117 +51,142 @@

@@ -435,7 +485,7 @@


- [View source] + [View source]
@@ -470,7 +520,7 @@


- [View source] + [View source]
@@ -486,7 +536,7 @@


- [View source] + [View source]
@@ -502,7 +552,7 @@


- [View source] + [View source]
@@ -523,7 +573,7 @@


- [View source] + [View source]
@@ -558,7 +608,7 @@


- [View source] + [View source]
diff --git a/docs/Pluto.html b/docs/Pluto.html new file mode 100644 index 0000000..a3a9a6e --- /dev/null +++ b/docs/Pluto.html @@ -0,0 +1,331 @@ + + + + + + + + + + + + + + + + Pluto - cr-image master-dev + + + + + + + + +
+

+ + module Pluto + +

+ + + + + + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + lib/pluto/src/pluto.cr + +
+ + + lib/pluto/src/pluto/channel_type.cr + +
+ + + pluto.cr + +
+ + + + + + + + + + + + + + +
+ +
+ + + + + + + + + +
+ + + diff --git a/docs/Pluto/ImageGA.html b/docs/Pluto/ImageGA.html new file mode 100644 index 0000000..fbb1866 --- /dev/null +++ b/docs/Pluto/ImageGA.html @@ -0,0 +1,567 @@ + + + + + + + + + + + + + + + + Pluto::ImageGA - cr-image master-dev + + + + + + + + +
+

+ + class Pluto::ImageGA + +

+ + + + + + + + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + lib/pluto/src/pluto/image_ga.cr + +
+ + + pluto.cr + +
+ + + + + + + + + + +

+ + + + Instance Method Summary +

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def to_crimage : CrImage::GrayscaleImage + + # +
+ +
+
+ +
+
+ + + + + +
+ + + diff --git a/docs/Pluto/ImageRGBA.html b/docs/Pluto/ImageRGBA.html new file mode 100644 index 0000000..249189a --- /dev/null +++ b/docs/Pluto/ImageRGBA.html @@ -0,0 +1,567 @@ + + + + + + + + + + + + + + + + Pluto::ImageRGBA - cr-image master-dev + + + + + + + + +
+

+ + class Pluto::ImageRGBA + +

+ + + + + + + + + + + +

+ + + + Included Modules +

+ + + + + + + + + + + +

+ + + + Defined in: +

+ + + lib/pluto/src/pluto/image_rgba.cr + +
+ + + pluto.cr + +
+ + + + + + + + + + +

+ + + + Instance Method Summary +

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def to_crimage : CrImage::RGBAImage + + # +
+ +
+
+ +
+
+ + + + + +
+ + + diff --git a/docs/StumpyCore.html b/docs/StumpyCore.html new file mode 100644 index 0000000..4052d27 --- /dev/null +++ b/docs/StumpyCore.html @@ -0,0 +1,414 @@ + + + + + + + + + + + + + + + + StumpyCore - Crystal Image master-dev + + + + + + + + +
+

+ + module StumpyCore + +

+ + + + + +

+ + + + Overview +

+ +

A module owned by StumpyCr

+ + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + + lib/stumpy_core/src/stumpy_core/canvas.cr + + +
+ + + + lib/stumpy_core/src/stumpy_core/rgba.cr + + +
+ + + + lib/stumpy_core/src/stumpy_core/rgba/css_constants.cr + + +
+ + + + lib/stumpy_core/src/stumpy_core/rgba/from_grayscale.cr + + +
+ + + + lib/stumpy_core/src/stumpy_core/rgba/from_hex.cr + + +
+ + + + lib/stumpy_core/src/stumpy_core/rgba/from_hsl_hsv.cr + + +
+ + + + lib/stumpy_core/src/stumpy_core/rgba/from_relative.cr + + +
+ + + + lib/stumpy_core/src/stumpy_core/rgba/from_rgba.cr + + +
+ + + + lib/stumpy_core/src/stumpy_core/rgba/mixing.cr + + +
+ + + + lib/stumpy_core/src/stumpy_core/utils.cr + + +
+ + + + stumpy.cr + + +
+ + + + + + + + + + + + + + +
+ +
+ + + + + + + + + +
+ + + diff --git a/docs/StumpyCore/Canvas.html b/docs/StumpyCore/Canvas.html new file mode 100644 index 0000000..693f0e3 --- /dev/null +++ b/docs/StumpyCore/Canvas.html @@ -0,0 +1,429 @@ + + + + + + + + + + + + + + + + StumpyCore::Canvas - Crystal Image master-dev + + + + + + + + +
+

+ + class StumpyCore::Canvas + +

+ + + + + + + +

+ + + + Overview +

+ +

A canvas is 2D array of RGBA pixels

+

To create a canvas of size 400 x 200

+
canvas = StumpyCore::Canvas.new(400, 200)
+

The default background color is transparent, +but it can be passed in as a parameter or as a block +that returns the color value for each {x, y} pair.

+
canvas2 = StumpyCore::Canvas.new(400, 200, RGBA::WHITE)
+
canvas3 = StumpyCore::Canvas.new(256, 256) do |x, y|
+  RGBA.from_rgb_n(x, y, 255, 8)
+end
+

image

+

Because of the way pixels are stored in a Slice, +Canvases are limited to Int32::MAX = 2147483647 pixels in total, +e.g. a maximal size of 46340x46340 for a square image.

+ + + + + + + + + + + + + + +

+ + + + Defined in: +

+ + + + lib/stumpy_core/src/stumpy_core/canvas.cr + + +
+ + + + stumpy.cr + + +
+ + + + + + + + + + +

+ + + + Instance Method Summary +

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +

+ + + + Instance Method Detail +

+ +
+
+ + def to_crimage : CrImage::RGBAImage + + # +
+ +
+
+ + [View source] + +
+
+ + + + + +
+ + + diff --git a/docs/index.html b/docs/index.html index 618f1f7..cac858f 100644 --- a/docs/index.html +++ b/docs/index.html @@ -4,16 +4,16 @@ - - + + - - cr-image master + + Crystal Image master-dev @@ -34,12 +34,12 @@

- cr-image + Crystal Image

- master + master-dev
@@ -51,117 +51,142 @@