Skip to main content

LosslessConfig

Struct LosslessConfig 

Source
pub struct LosslessConfig { /* private fields */ }
Expand description

Lossless (modular) encoding configuration.

Has a sensible Default — lossless has no quality ambiguity.

Implementations§

Source§

impl LosslessConfig

Source

pub fn new() -> Self

Create a new lossless config with defaults.

Source

pub fn with_effort(self, effort: u8) -> Self

Set effort level (1–10). Higher = slower, better compression.

Source

pub fn with_ans(self, enable: bool) -> Self

Enable/disable ANS entropy coding (default: true).

Source

pub fn with_squeeze(self, enable: bool) -> Self

Enable/disable squeeze (Haar wavelet) transform (default: false).

Source

pub fn with_tree_learning(self, enable: bool) -> Self

Enable/disable content-adaptive tree learning (default: false).

Source

pub fn with_lz77(self, enable: bool) -> Self

Enable/disable LZ77 backward references (default: false).

Source

pub fn with_lz77_method(self, method: Lz77Method) -> Self

Set LZ77 method (default: Greedy). Only effective when LZ77 is enabled.

Source

pub fn effort(&self) -> u8

Current effort level.

Source

pub fn ans(&self) -> bool

Whether ANS entropy coding is enabled.

Source

pub fn squeeze(&self) -> bool

Whether squeeze (Haar wavelet) transform is enabled.

Source

pub fn tree_learning(&self) -> bool

Whether content-adaptive tree learning is enabled.

Source

pub fn lz77(&self) -> bool

Whether LZ77 backward references are enabled.

Source

pub fn lz77_method(&self) -> Lz77Method

Current LZ77 method.

Source

pub fn encode_request( &self, width: u32, height: u32, layout: PixelLayout, ) -> EncodeRequest<'_>

Create an encode request for an image with this config.

Use this when you need to attach metadata, limits, or cancellation.

Source

pub fn encode( &self, pixels: &[u8], width: u32, height: u32, layout: PixelLayout, ) -> Result<Vec<u8>>

Encode pixels directly with this config. Shortcut for simple cases.

let jxl = jxl_encoder::LosslessConfig::new()
    .encode(&pixels, 100, 100, jxl_encoder::PixelLayout::Rgb8)?;
Source

pub fn encode_into( &self, pixels: &[u8], width: u32, height: u32, layout: PixelLayout, out: &mut Vec<u8>, ) -> Result<()>

Encode pixels, appending to an existing buffer.

Source

pub fn encode_animation( &self, width: u32, height: u32, layout: PixelLayout, animation: &AnimationParams, frames: &[AnimationFrame<'_>], ) -> Result<Vec<u8>>

Encode a multi-frame animation as a lossless JXL.

Each frame must have the same dimensions and pixel layout. Returns the complete JXL codestream bytes.

Trait Implementations§

Source§

impl Clone for LosslessConfig

Source§

fn clone(&self) -> LosslessConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for LosslessConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for LosslessConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.