Cleanup documentation

This commit is contained in:
A. Molzer committed 2025-11-27 23:56:57 +01:00
1 parent 6fe21da979
commit c3882b252c
2 files changed
+11 -18

No files matched your search

+10 -9
View File
@@ -29,15 +29,6 @@ pub(crate) struct TileAttributes {
pub tile_length: usize,
}
pub(crate) struct PlaneLayout {
/// The underlying readout layout.
pub readout: ReadoutLayout,
/// Buffer offset from one plane of output to the next.
pub plane_offsets: Vec<usize>,
/// Total number of bytes for all planes in given order.
pub total_bytes: usize,
}
impl TileAttributes {
pub fn tiles_across(&self) -> usize {
self.image_width.div_ceil(self.tile_width)
@@ -132,6 +123,16 @@ pub(crate) struct ReadoutLayout {
pub chunks_per_plane: u32,
}
/// A `ReadoutLayout` with pre-calculated plane information.
pub(crate) struct PlaneLayout {
/// The underlying readout layout.
pub readout: ReadoutLayout,
/// Buffer offset from one plane of output to the next.
pub plane_offsets: Vec<usize>,
/// Total number of bytes for all planes in given order.
pub total_bytes: usize,
}
impl Image {
pub fn from_reader<R: Read + Seek>(
decoder: &mut ValueReader<R>,