Skip to main content

ImageMetadata

Struct ImageMetadata 

Source
pub struct ImageMetadata<'a> { /* private fields */ }
Expand description

Image metadata (ICC, EXIF, XMP, tone mapping) to embed in the JXL file.

Implementations§

Source§

impl<'a> ImageMetadata<'a>

Source

pub fn new() -> Self

Create empty metadata.

Source

pub fn with_icc_profile(self, data: &'a [u8]) -> Self

Attach an ICC color profile.

Source

pub fn with_exif(self, data: &'a [u8]) -> Self

Attach EXIF data.

Source

pub fn with_xmp(self, data: &'a [u8]) -> Self

Attach XMP data.

Source

pub fn icc_profile(&self) -> Option<&[u8]>

Get the ICC color profile, if set.

Source

pub fn exif(&self) -> Option<&[u8]>

Get the EXIF data, if set.

Source

pub fn xmp(&self) -> Option<&[u8]>

Get the XMP data, if set.

Source

pub fn with_intensity_target(self, nits: f32) -> Self

Set the peak display luminance in nits (cd/m²) for HDR content.

Written to the JXL codestream ToneMapping.intensity_target field. Default is 255.0 (SDR). Set to e.g. 4000.0 or 10000.0 for HDR.

Source

pub fn with_min_nits(self, nits: f32) -> Self

Set the minimum display luminance in nits.

Written to the JXL codestream ToneMapping.min_nits field. Default is 0.0.

Source

pub fn intensity_target(&self) -> Option<f32>

Get the intensity target, if set.

Source

pub fn min_nits(&self) -> Option<f32>

Get the min nits, if set.

Source

pub fn with_intrinsic_size(self, width: u32, height: u32) -> Self

Set the intrinsic display size.

When set, the image should be rendered at this (width, height) rather than the coded dimensions. Written to the JXL codestream intrinsic_size field.

Source

pub fn intrinsic_size(&self) -> Option<(u32, u32)>

Get the intrinsic size, if set.

Trait Implementations§

Source§

impl<'a> Clone for ImageMetadata<'a>

Source§

fn clone(&self) -> ImageMetadata<'a>

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<'a> Debug for ImageMetadata<'a>

Source§

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

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

impl<'a> Default for ImageMetadata<'a>

Source§

fn default() -> ImageMetadata<'a>

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

Auto Trait Implementations§

§

impl<'a> Freeze for ImageMetadata<'a>

§

impl<'a> RefUnwindSafe for ImageMetadata<'a>

§

impl<'a> Send for ImageMetadata<'a>

§

impl<'a> Sync for ImageMetadata<'a>

§

impl<'a> Unpin for ImageMetadata<'a>

§

impl<'a> UnsafeUnpin for ImageMetadata<'a>

§

impl<'a> UnwindSafe for ImageMetadata<'a>

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.