Struct jxl_image::ImageMetadata

pub struct ImageMetadata {

    pub orientation: u32,
    pub intrinsic_size: Option<SizeHeader>,
    pub preview: Option<PreviewHeader>,
    pub animation: Option<AnimationHeader>,
    pub bit_depth: BitDepth,
    pub modular_16bit_buffers: bool,
    pub ec_info: Vec<ExtraChannelInfo>,
    pub xyb_encoded: bool,
    pub colour_encoding: ColourEncoding,
    pub tone_mapping: ToneMapping,
    pub extensions: Extensions,
    pub opsin_inverse_matrix: OpsinInverseMatrix,
    pub up2_weight: [f32; 15],
    pub up4_weight: [f32; 55],
    pub up8_weight: [f32; 210],
    /* private fields */
}

Image metadata.

Fields

orientation: u32

Value representing image orientation.

intrinsic_size: Option<SizeHeader>

Recommended size to display the image.

preview: Option<PreviewHeader>

Size information of the preview frame, if there is any.

animation: Option<AnimationHeader>

Information about the animation such as TPS, if the image is animated.

bit_depth: BitDepth

Bit depth information, which is used to parse Modular image samples.

modular_16bit_buffers: bool

Whether 16-bit buffer is sufficient to correctly parse Modular images.

ec_info: Vec<ExtraChannelInfo>

Information about extra channels, such as alpha and black channels.

xyb_encoded: bool

Whether the image is encoded in XYB color space.

colour_encoding: ColourEncoding

Color encoding of the image.

If xyb_encoded is true, this is a suggestion of the color space to present the decoded image. If it’s not, the decoded image is in the color space represented by this field.

tone_mapping: ToneMapping

Tone mapping information, which is used to map HDR images to SDR.

extensions: Extensions

opsin_inverse_matrix: OpsinInverseMatrix

Opsin inverse matrix, which is used to transform XYB encoded image to sRGB color space.

up2_weight: [f32; 15]

2x upsampling weights.

up4_weight: [f32; 55]

4x upsampling weights.

up8_weight: [f32; 210]

8x upsampling weights.

Implementations

impl ImageMetadata

pub fn grayscale(&self) -> bool

Returns whether the image is grayscale.

pub fn encoded_color_channels(&self) -> usize

Returns the number of channels actually encoded in the image.

pub fn alpha(&self) -> Option<usize>

Returns the index of the first alpha channel in the image.

pub fn apply_orientation( &self, width: u32, height: u32, left: i32, top: i32, inverse: bool ) -> (u32, u32, i32, i32)

Returns where the given coordinate will be placed after the orientation is applied.

Trait Implementations

impl<Ctx: Copy> Bundle<Ctx> for ImageMetadata

type Error = Error

fn parse(bitstream: &mut Bitstream<'_>, ctx: Ctx) -> Result<Self, Self::Error>

where Self: Sized,

Parses a value from the bitstream with the given context.

impl<Ctx: Copy> BundleDefault<Ctx> for ImageMetadata

fn default_with_context(_ctx: Ctx) -> Self

where Self: Sized,

Creates a default value with the given context.

impl Debug for ImageMetadata

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.