rename storage to pixels and fix some documentation

Author: johannesvollmer

examples/1_rgb_exr_to_png.rs

@@ -46,7 +46,7 @@ fn main() {
     };
 
     // save the png buffer to a png file
-    let png_buffer = &image.layer_data.channel_data.storage;
+    let png_buffer = &image.layer_data.channel_data.pixels;
     png_buffer.save("tests/images/out/rgb.png").unwrap();
     println!("created image rgb.png")
 }

examples/2_rgba_exposure_adjust.rs

@@ -45,7 +45,7 @@ fn main() {
     let exposure_multiplier = 2.0;
 
     {   // increase exposure of all pixels
-        for line in &mut image.layer_data.channel_data.storage.lines {
+        for line in &mut image.layer_data.channel_data.pixels.lines {
             for (r,g,b,_) in line {
                 // you should probably check the color space and white points
                 // for high quality color adjustments

examples/4_specific_read.rs

@@ -38,7 +38,7 @@ fn main() {
 
     // output a random color of each channel of each layer
     for layer in &image.layer_data {
-        let (alpha, luma, luma_right) = layer.channel_data.storage.first().unwrap().first().unwrap();
+        let (alpha, luma, luma_right) = layer.channel_data.pixels.first().unwrap().first().unwrap();
 
         println!(
             "bottom left color of layer `{}`: (a, y, yr) = {:?}",

src/image/crop.rs

@@ -200,7 +200,7 @@ impl<'c, Channels> ChannelsWriter for CroppedWriter<Channels> where Channels: Ch
 impl<Samples, Channels> InspectSample for Layer<SpecificChannels<Samples, Channels>> where Samples: GetPixel {
     type Sample = Samples::Pixel;
     fn inspect_sample(&self, local_index: Vec2<usize>) -> Samples::Pixel {
-        self.channel_data.storage.get_pixel(local_index)
+        self.channel_data.pixels.get_pixel(local_index)
     }
 }
 

src/image/mod.rs

@@ -80,15 +80,15 @@ pub struct Image<Layers> {
     pub layer_data: Layers,
 }
 
-/// A list of layers. `Channels` can be `RgbaChannels` or `AnyChannels`.
+/// A list of layers. `Channels` can be `SpecificChannels` or `AnyChannels`.
 pub type Layers<Channels> = SmallVec<[Layer<Channels>; 2]>;
 
 /// A single Layer, including fancy attributes and compression settings.
-/// `Channels` can be either `RgbaChannels` or `AnyChannels`
+/// `Channels` can be either `SpecificChannels` or `AnyChannels`
 #[derive(Debug, Clone, PartialEq)]
 pub struct Layer<Channels> {
 
-    /// The actual pixel data. Either `RgbaChannels` or `AnyChannels`
+    /// The actual pixel data. Either `SpecificChannels` or `AnyChannels`
     pub channel_data: Channels,
 
     /// Attributes that apply to this layer.
@@ -142,23 +142,23 @@ pub enum Blocks {
 }
 
 
-/// A grid of rgba pixels. The pixels are written to your custom pixel storage.
+/// A grid of pixels. The pixels are written to your custom pixel storage.
 /// `PixelStorage` can be anything, from a flat `Vec<f16>` to `Vec<Vec<AnySample>>`, as desired.
-/// In order to write this image to a file, your `PixelStorage` must implement [`GetRgbaPixel`].
+/// In order to write this image to a file, your `PixelStorage` must implement [`GetPixel`].
 #[derive(Debug, Clone, PartialEq, Eq)]
-pub struct SpecificChannels<PixelStorage, ChannelsDescription> {
+pub struct SpecificChannels<Pixels, ChannelsDescription> {
 
     /// A description of the channels in the file, as opposed to the channels in memory.
     /// Should always be a tuple containing `ChannelDescription`s, one description for each channel.
     pub channels: ChannelsDescription, // TODO this is awkward. can this be not a type parameter please? maybe vec<option<chan_info>> ??
 
-    /// Your custom rgba pixel storage
-    // TODO should also support `Levels<YourStorage>`, where rgba levels are desired!
-    pub storage: PixelStorage, // TODO rename to "pixels"?
+    /// Your custom pixel storage
+    // TODO should also support `Levels<YourStorage>`, where levels are desired!
+    pub pixels: Pixels, // TODO rename to "pixels"?
 }
 
 
-/// A full list of arbitrary channels, not just rgba.
+/// A dynamic list of arbitrary channels.
 /// `Samples` can currently only be `FlatSamples` or `Levels<FlatSamples>`.
 #[derive(Debug, Clone, PartialEq)]
 pub struct AnyChannels<Samples> {
@@ -257,7 +257,7 @@ pub enum DeepAndFlatSamples {
 ///
 /// Since this is close to the pixel layout in the byte file,
 /// this will most likely be the fastest storage.
-/// Using a different storage, for example `RgbaChannels`,
+/// Using a different storage, for example `SpecificChannels`,
 /// will probably be slower.
 #[derive(Clone, PartialEq)] // debug is implemented manually
 pub enum FlatSamples {
@@ -313,7 +313,7 @@ impl<SampleStorage, Channels> SpecificChannels<SampleStorage, Channels> {
             Channels: Sync + Clone + IntoRecursive,
             <Channels as IntoRecursive>::Recursive: WritableChannelsDescription<<SampleStorage::Pixel as IntoRecursive>::Recursive>,
     {
-        SpecificChannels { channels, storage: source_samples }
+        SpecificChannels { channels, pixels: source_samples }
     }
 }
 
@@ -409,7 +409,7 @@ impl<RecursiveChannels: CheckDuplicates, RecursivePixel> SpecificChannelsBuilder
     {
         SpecificChannels {
             channels: self.channels,
-            storage: get_pixel
+            pixels: get_pixel
         }
     }
 
@@ -426,7 +426,7 @@ impl<RecursiveChannels: CheckDuplicates, RecursivePixel> SpecificChannelsBuilder
     {
         SpecificChannels {
             channels: self.channels,
-            storage: get_pixel
+            pixels: get_pixel
         }
     }
 }
@@ -853,7 +853,7 @@ impl<C> ContainsNaN for AnyChannel<C> where C: ContainsNaN {
 
 impl<S, T> ContainsNaN for SpecificChannels<S, T> where S: ContainsNaN {
     fn contains_nan_pixels(&self) -> bool {
-        self.storage.contains_nan_pixels()
+        self.pixels.contains_nan_pixels()
     }
 }
 

src/image/read/layers.rs

@@ -55,15 +55,15 @@ pub trait ReadChannels<'s> {
 
 /// Processes pixel blocks from a file and accumulates them into a list of layers.
 /// For example, `ChannelsReader` can be
-/// [`RgbaChannelsReader`] or [`AnyChannelsReader<FlatSamplesReader>`].
+/// [`SpecificChannelsReader`] or [`AnyChannelsReader<FlatSamplesReader>`].
 #[derive(Debug, Clone, PartialEq)]
 pub struct AllLayersReader<ChannelsReader> {
     layer_readers: SmallVec<[LayerReader<ChannelsReader>; 2]>, // TODO unpack struct?
 }
 
 /// Processes pixel blocks from a file and accumulates them into a single layers, using only the first.
 /// For example, `ChannelsReader` can be
-/// `RgbaChannelsReader` or `AnyChannelsReader<FlatSamplesReader>`.
+/// `SpecificChannelsReader` or `AnyChannelsReader<FlatSamplesReader>`.
 #[derive(Debug, Clone, PartialEq)]
 pub struct FirstValidLayerReader<ChannelsReader> {
     layer_reader: LayerReader<ChannelsReader>,
@@ -72,7 +72,7 @@ pub struct FirstValidLayerReader<ChannelsReader> {
 
 /// Processes pixel blocks from a file and accumulates them into a single layers.
 /// For example, `ChannelsReader` can be
-/// `RgbaChannelsReader` or `AnyChannelsReader<FlatSamplesReader>`.
+/// `SpecificChannelsReader` or `AnyChannelsReader<FlatSamplesReader>`.
 #[derive(Debug, Clone, PartialEq)]
 pub struct LayerReader<ChannelsReader> {
     channels_reader: ChannelsReader,

src/image/read/specific_channels.rs

@@ -214,7 +214,7 @@ ChannelsReader for SpecificChannelsReader<PixelStorage, SetPixel, PxReader, Pixe
     }
 
     fn into_channels(self) -> Self::Channels {
-        SpecificChannels { channels: self.pixel_reader.get_descriptions().into_non_recursive(), storage: self.pixel_storage }
+        SpecificChannels { channels: self.pixel_reader.get_descriptions().into_non_recursive(), pixels: self.pixel_storage }
     }
 }
 

src/image/write/channels.rs

@@ -202,7 +202,7 @@ for SpecificChannelsWriter<'channels, PxWriter, Storage, Channels>
         for (y, line_bytes) in byte_lines.enumerate() {
             pixel_line.clear();
             pixel_line.extend((0 .. width).map(|x|
-                self.channels.storage.get_pixel(block_index.pixel_position + Vec2(x,y)).into_recursive()
+                self.channels.pixels.get_pixel(block_index.pixel_position + Vec2(x, y)).into_recursive()
             ));
 
             self.recursive_channel_writer.write_pixels(line_bytes, pixel_line.as_slice(), |px| px);

tests/roundtrip.rs

@@ -235,8 +235,8 @@ fn roundtrip_unusual_2() -> UnitResult {
 
     // custom compare function: considers nan equal to nan
     assert_eq!(image.layer_data.size, size, "test is buggy");
-    let pixels1 = &image.layer_data.channel_data.storage;
-    let pixels2 = &image2.layer_data.channel_data.storage;
+    let pixels1 = &image.layer_data.channel_data.pixels;
+    let pixels2 = &image2.layer_data.channel_data.pixels;
 
     assert_eq!(pixels1.pixels, pixels2.pixels);
 
@@ -302,8 +302,8 @@ fn roundtrip_unusual_7() -> UnitResult {
 
     // custom compare function: considers nan equal to nan
     assert_eq!(image.layer_data.size, size, "test is buggy");
-    let pixels1 = &image.layer_data.channel_data.storage;
-    let pixels2 = &image2.layer_data.channel_data.storage;
+    let pixels1 = &image.layer_data.channel_data.pixels;
+    let pixels2 = &image2.layer_data.channel_data.pixels;
 
     assert_eq!(pixels1.pixels, pixels2.pixels);