Struct EncodeCapabilities

Source

#[non_exhaustive]
pub struct EncodeCapabilities { /* private fields */ }

Expand description

Describes what an encoder supports.

Returned by EncoderConfig::capabilities() as a &'static reference. Uses getter methods so fields can be added without breaking changes.

§Example

use zencodec::encode::EncodeCapabilities;

static CAPS: EncodeCapabilities = EncodeCapabilities::new()
    .with_icc(true)
    .with_exif(true)
    .with_xmp(true)
    .with_stop(true)
    .with_native_gray(true);

assert!(CAPS.icc());
assert!(CAPS.native_gray());

Implementations§

Source §

impl EncodeCapabilities

Source

pub const EMPTY: Self

Empty capabilities (everything disabled, single-threaded).

Source

pub const fn new() -> Self

Create capabilities with everything disabled.

Source

pub const fn icc(&self) -> bool

Whether the encoder embeds ICC color profiles from with_metadata.

Source

pub const fn exif(&self) -> bool

Whether the encoder embeds EXIF data from with_metadata.

Source

pub const fn xmp(&self) -> bool

Whether the encoder embeds XMP data from with_metadata.

Source

pub const fn cicp(&self) -> bool

Whether the encoder embeds CICP color description from with_metadata.

Source

pub const fn stop(&self) -> bool

Whether with_stop on encode jobs is respected (not a no-op).

Source

pub const fn animation(&self) -> bool

Whether the codec supports encoding animation (multiple frames).

Source

pub const fn push_rows(&self) -> bool

Whether push_rows() / finish() work (row-level encode).

Source

pub const fn encode_from(&self) -> bool

Whether encode_from() works (pull-from-source encode).

Source

pub const fn lossy(&self) -> bool

Whether the codec supports lossy encoding.

Source

pub const fn lossless(&self) -> bool

Whether the codec supports mathematically lossless encoding.

Source

pub const fn hdr(&self) -> bool

Whether the codec supports HDR content.

Source

pub const fn gain_map(&self) -> bool

Whether the codec supports gain map (HDR/SDR) embedding.

Source

pub const fn native_gray(&self) -> bool

Whether the codec supports grayscale natively.

Source

pub const fn native_16bit(&self) -> bool

Whether the codec supports 16-bit per channel natively.

Source

pub const fn native_f32(&self) -> bool

Whether the codec handles f32 pixel data natively.

Source

pub const fn native_alpha(&self) -> bool

Whether the codec handles alpha channel natively.

Source

pub const fn enforces_max_pixels(&self) -> bool

Whether the codec enforces max_pixels limits.

Source

pub const fn enforces_max_memory(&self) -> bool

Whether the codec enforces max_memory_bytes limits.

Source

pub const fn effort_range(&self) -> Option<[i32; 2]>

Meaningful effort range [min, max].

None means the codec has no effort tuning.

Source

pub const fn quality_range(&self) -> Option<[f32; 2]>

Meaningful quality range [min, max] on the calibrated 0.0–100.0 scale.

None means the codec is lossless-only.

Source

pub const fn threads_supported_range(&self) -> (u16, u16)

Supported thread count range (min, max).

(1, 1) means single-threaded only. (1, 16) means the encoder can use 1 to 16 threads.

Source

pub const fn supports(&self, op: UnsupportedOperation) -> bool

Check whether this encoder supports a given operation.

Returns true if the capability flag corresponding to op is set. Returns false for decode-only operations or PixelFormat (which depends on the specific format, not a static flag).

§Example

use zencodec::UnsupportedOperation;
use zencodec::encode::EncodeCapabilities;

static CAPS: EncodeCapabilities = EncodeCapabilities::new()
    .with_animation(true)
    .with_push_rows(true);

assert!(CAPS.supports(UnsupportedOperation::AnimationEncode));
assert!(CAPS.supports(UnsupportedOperation::RowLevelEncode));
assert!(!CAPS.supports(UnsupportedOperation::PullEncode));
assert!(!CAPS.supports(UnsupportedOperation::DecodeInto));

Source