Struct FrameInfo 

#[non_exhaustive]
pub struct FrameInfo {

    pub width: u32,
    pub height: u32,
    pub cpp: u32,
    pub bits_per_sample: u8,
    pub sample_format: SampleFormat,
    pub cfa: Option<CfaPattern>,
    pub layout: SensorLayout,
    pub active_area: Rect,
    pub crop: Rect,
    pub masked_areas: Vec<Rect>,
    pub black_level: BlackLevel,
    pub black_from_masked: bool,
    pub white_level: WhiteLevel,
    pub white_balance: Option<WhiteBalance>,
    pub white_balance_applied: bool,
    pub color_matrices: ColorMatrices,
    pub orientation: Orientation,
    pub pixel_aspect: f32,
    pub compression: Compression,
    pub opcodes: Option<Arc<OpcodeLists>>,
}

Geometry and calibration of the decoded sensor buffer.

Everything here is known after parsing, before any pixel is decoded.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

width: u32

Full decoded buffer width (including masked areas).

height: u32

Full decoded buffer height (including masked areas).

cpp: u32

Samples per pixel.

bits_per_sample: u8

Significant bits per sample (e.g. 12 or 14).

sample_format: SampleFormat

Numeric format of the decoded samples.

cfa: Option<CfaPattern>

Colour filter pattern anchored at buffer (0, 0); None for monochrome and multi-sample (linear, Foveon) data.

layout: SensorLayout

How samples are arranged on the sensor.

active_area: Rect

Region of valid image pixels (excludes optical black / masked borders).

crop: Rect

Recommended default crop (DNG DefaultCrop or vendor equivalent); inside active_area.

masked_areas: Vec<Rect>

Masked (optical black) regions usable for black-level estimation.

black_level: BlackLevel

Black level (see also black_from_masked).

black_from_masked: bool

When true, black_level is a fallback: the actual per-CFA-colour black is measured from masked_areas after decoding (done by the high-level API).

white_level: WhiteLevel

Saturation level of the stored samples.

white_balance: Option<WhiteBalance>

As-shot white balance; None when the file records none.

white_balance_applied: bool

True when the camera already applied white_balance to the stored samples (Sony lossless YCbCr M/S, Nikon sNEF): developing them needs unit multipliers, and white_balance (still the as-shot multipliers) only serves to change the balance.

color_matrices: ColorMatrices

Colour calibration (file or camera database).

orientation: Orientation

Orientation to apply for display.

pixel_aspect: f32

Pixel aspect ratio (width / height of a sensor site); 1.0 for almost all cameras.

compression: Compression

Payload compression scheme.

opcodes: Option<Arc<OpcodeLists>>

DNG opcode lists carried by the file (applied by the high-level API).

Implementations

impl FrameInfo

pub fn new(width: u32, height: u32, bits: u8) -> Self

A default description for a width x height CFA buffer; formats fill in the rest.

pub fn sanitize(&mut self)

Clamp active_area/crop/masked areas into the buffer so later stages can trust them.

Trait Implementations

impl Clone for FrameInfo

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrameInfo

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

Formats the value using the given formatter.

impl PartialEq for FrameInfo

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for FrameInfo