Structs§
- Color
Encoding - CICP-style colour encoding: the primaries + transfer + matrix the image is
authored in, plus the sample range. Drives both the HEIF
colr(nclx) box and the HEVC VUI signalling. - Content
Light Level - HDR content light level (CTA-861.3 / ISOBMFF
clli): the maximum content light level (MaxCLL) and maximum frame-average light level (MaxFALL), both in cd/m² (nits). Written as theContentLightLevelBox. - Encode
Config - Encoder configuration shared by all entry points.
- Metadata
- All optional metadata passed to the encoder, threaded through
crate::EncodeConfig. - Yuv
- Planar YCbCr image
Enums§
- BitDepth
- Chroma
Format - Chroma subsampling mode.
- Color
Metadata - How the output colour space is described in the file. Either an enumerated CICP
encoding (compact
nclx) or an embedded ICC profile (prof). - Encode
Error - Matrix
Coefficients - CICP matrix coefficients for RGB→YCbCr (ISO/IEC 23091-2 Table 4).
- Orientation
- Primaries
- CICP colour primaries (ISO/IEC 23091-2 Table 2).
- Transfer
Function - CICP transfer characteristics (ISO/IEC 23091-2 Table 3).
Functions§
- encode_
gray8 - Encode a packed 8-bit greyscale image to HEIC (monochrome, no chroma).
- encode_
gray10 - Encode a 10-bit greyscale image to HEIC.
- encode_
gray12 - Encode a 12-bit greyscale image to HEIC.
- encode_
gray_ alpha8 - Encode a packed 8-bit greyscale + alpha image to HEIC. Alpha is discarded.
Use
encode_gray_alpha8_with_alphato preserve it. - encode_
gray_ alpha8_ with_ alpha - Encode a packed 8-bit greyscale + alpha image to HEIC with a separate alpha auxiliary image per ISO/IEC 23008-12.
- encode_
gray_ alpha10 - Encode a 10-bit greyscale + alpha image to HEIC. Alpha is discarded.
- encode_
gray_ alpha12 - Encode a 12-bit greyscale + alpha image to HEIC. Alpha is discarded.
- encode_
gray_ alpha10_ with_ alpha - Encode a 10-bit greyscale + alpha image to HEIC with a separate alpha auxiliary image.
- encode_
gray_ alpha12_ with_ alpha - Encode a 12-bit greyscale + alpha image to HEIC with a separate alpha auxiliary image.
- encode_
rgb8 - Encode a packed 8-bit RGB image to HEIC.
- encode_
rgb10 - Encode a 10-bit RGB image to HEIC.
- encode_
rgb12 - Encode a 12-bit RGB image to HEIC.
- encode_
rgba8 - Encode a packed 8-bit RGBA image to HEIC. Alpha is discarded.
Use
encode_rgba8_with_alphato preserve it. - encode_
rgba8_ with_ alpha - Encode a packed 8-bit RGBA image to HEIC, writing alpha as a separate monochrome auxiliary image per ISO/IEC 23008-12.
- encode_
rgba10 - Encode a 10-bit RGBA image to HEIC. Alpha is discarded.
- encode_
rgba12 - Encode a 12-bit RGBA image to HEIC. Alpha is discarded.
- encode_
rgba10_ with_ alpha - Encode a 10-bit RGBA image to HEIC with a separate alpha auxiliary image.
- encode_
rgba12_ with_ alpha - Encode a 12-bit RGBA image to HEIC with a separate alpha auxiliary image.
- encode_
yuv - Encode pre-converted planar YCbCr directly, skipping the RGB→YCbCr step.