Struct Frame

pub struct Frame { /* private fields */ }

JPEG XL frame.

A frame represents a single unit of image that can be displayed or referenced by other frames.

Implementations

impl Frame

pub fn alloc_tracker(&self) -> Option<&AllocTracker>

pub fn image_header(&self) -> &ImageHeader

pub fn clone_image_header(&self) -> Arc<ImageHeader>

pub fn header(&self) -> &FrameHeader

Returns the frame header.

pub fn toc(&self) -> &Toc

Returns the TOC.

See the documentation of Toc for details.

pub fn pass_shifts(&self) -> &BTreeMap<u32, (i32, i32)>

pub fn data(&self, group: TocGroupKind) -> Option<&[u8]>

impl Frame

pub fn feed_bytes<'buf>(&mut self, buf: &'buf [u8]) -> &'buf [u8]

pub fn is_loading_done(&self) -> bool

impl Frame

pub fn try_parse_lf_global<S>(&self) -> Option<Result<LfGlobal<S>, Error>>

where S: Sample,

pub fn try_parse_lf_group<S>( &self, lf_global_vardct: Option<&LfGlobalVarDct>, global_ma_config: Option<&MaConfig>, mlf_group: Option<TransformedModularSubimage<'_, S>>, lf_group_idx: u32, ) -> Option<Result<LfGroup<S>, Error>>

where S: Sample,

pub fn try_parse_hf_global<S>( &self, cached_lf_global: Option<&LfGlobal<S>>, ) -> Option<Result<HfGlobal, Error>>

where S: Sample,

pub fn pass_group_bitstream( &self, pass_idx: u32, group_idx: u32, ) -> Option<Result<PassGroupBitstream<'_>, Error>>

impl Frame

pub fn adjust_region(&self, _: &mut (u32, u32, u32, u32))

Adjusts the cropping region of the image to the actual decoding region of the frame.

The cropping region of the image needs to be adjusted to be used in a frame, for a few reasons:

• A frame may be blended to the canvas with offset, which makes the image and the frame have different coordinates.
• Some filters reference other samples, which requires padding to the region.

This method takes care of those and adjusts the given region appropriately.

Trait Implementations

impl Bundle<FrameContext<'_>> for Frame

type Error = Error

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

Parses a value from the bitstream with the given context.

impl Debug for Frame

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

Formats the value using the given formatter.