mirx 0.45.0

MIRX binary image format — flat & chunk-based container for ahead-of-time UI assets
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

//! IMAGE surface vocabulary independent of byte coding.
//!
//! Logical dimensions remain unchanged when a backend needs padded storage:
//!
//! ```
//! use mirx::{types::ByteAlignment, image::{ColorDescription, SampleLayout, SurfaceDescriptor, SurfaceRequirements}};
//!
//! let surface = SurfaceDescriptor::new(
//!     319, 181, SampleLayout::RGBA8888, ColorDescription::SRGB,
//! ).unwrap();
//! let plan = surface.memory_plan(
//!     SurfaceRequirements::new()
//!         .with_base_alignment(ByteAlignment::new(64).unwrap())
//!         .with_plane_alignment(ByteAlignment::new(64).unwrap())
//!         .with_width_multiple(64)
//!         .with_stride_multiple(64),
//! ).unwrap();
//! let plane = plan.plane(0).unwrap();
//! assert_eq!(surface.width(), 319);
//! assert_eq!(plane.allocation_width(), 320);
//! assert_eq!(plane.stride(), 1280);
//! assert_eq!(plan.buffer_requirements().base_alignment(), 64);
//! ```
//!
//! Borrowed surfaces can be inspected before serialization:
//!
//! ```
//! use mirx::image::{ColorDescription, RawImageAsset, SampleLayout, SurfaceDescriptor};
//!
//! let surface = SurfaceDescriptor::new(
//!     2, 2, SampleLayout::NV12, ColorDescription::BT709_YUV_LIMITED,
//! ).unwrap();
//! let y = [16; 4];
//! let uv = [128; 2];
//! let view = RawImageAsset::new(surface, &[&y, &uv]).view().unwrap();
//! assert_eq!(view.plane(0).unwrap().bytes(), y);
//! assert_eq!(view.plane(1).unwrap().memory().stride(), 2);
//! let bytes = view.encode().unwrap();
//! assert!(view.matches_payload(&bytes).unwrap());
//! ```

#[cfg(test)]
pub(crate) mod test_support;

pub use crate::error::ImageAccessError;
pub use crate::format::ColorFormat;
pub use crate::media::index::{UnitIndex, UnitIndexError, UnitRanges};
pub use crate::media::selection::{SelectedUnits, UnitSelection, UnitSelectionError};
pub use crate::payload::image::{ImageAsset, ImageAssetEncodeError, ImagePayloadError, ImageView};

mod access;
mod atlas;
mod borrowed;
mod color;
mod color_table;
pub(crate) use color_table::ColorTableError;
mod coverage;
mod encode;
mod encoded;
mod execution;
pub(crate) use encoded::Preflight as RasterPreflight;
pub(crate) use encoded::StoragePlan as EncodedStoragePlan;
pub(crate) use encoded::{CodingRecords, EncodedSections, GroupRecords, GroupSource};
mod grid;
mod layout;
mod memory;
mod plan;
mod reference;
mod region;
pub(crate) mod samples;
mod surface;
mod units;
mod view;

pub use access::AccessCapabilities;
pub(crate) use atlas::ATLAS_REGION_LEN;
pub use atlas::{AtlasMap, AtlasMapError, AtlasRegions};
pub use borrowed::{
    ImageSource, PlaneAccessError, PlaneRows, SurfaceCopyError, SurfacePlanes, SurfaceView,
};
pub use color::{
    ChromaSiting, ColorDescription, ColorDescriptionError, ColorMatrix, ColorPrimaries, ColorRange,
    TransferFunction,
};
pub use coverage::{CoverageBudget, CoverageError};
pub use encode::{ImageEncodeError, RawImageAsset};
pub(crate) use encoded::Preflight;
pub use encoded::{
    DecodeError, EncodedImageAsset, EncodedImageError, EncodedImageView, ImageDecodePlan,
    ImageGroupIter, ImageGroups,
};
pub use execution::{
    CacheSync, DecodeExecution, DecodeRequest, DecodeRequestError, MemoryPlacement,
};
pub use grid::{Region, RegionError, TileGrid, TileGridError, Tiles};
pub use layout::{PlaneGeometries, PlaneGeometry, PlaneRole, SampleLayout};
pub(crate) use memory::PLANE_RECORD_LEN;
pub use memory::{
    PlaneMemoryBuilder, PlaneMemoryError, PlaneMemoryFlags, PlaneMemoryLayout,
    PlaneMemoryRecordError,
};
pub use plan::{
    BufferRequirementError, BufferRequirements, SurfaceMemoryPlan, SurfaceMemoryPlanes,
    SurfacePlanError, SurfaceRequirements,
};
pub use reference::{ImageReadError, ImageRef};
pub use region::RegionMemoryPlan;
pub(crate) use surface::SURFACE_RECORD_LEN;
pub use surface::{SurfaceDescriptor, SurfaceError, SurfaceFlags, SurfaceRecordError};
pub(crate) use units::ScalarProfile;
pub use units::{
    DecodeUnitRef, DecodeUnits, DecodedUnit, EncodedGroupError, GroupPlanes, ReferenceMode,
    RegionUnits, UnitDecodeError, UnitDecodePlan, UnitGroup, UnitGroupBuilder, UnitGroupError,
    UnitMemoryPlan, UnitPlane, UnitPlanes,
};
pub(crate) use units::{GroupSelection, UNIT_GROUP_RECORD_LEN, UnitGroupRecord};
pub use view::{RawImagePlanes, RawImageView, RawImageViewError, SurfacePlane};