Skip to main content

Module prelude

Module prelude 

Source
Expand description

Convenience re-exports of the most commonly used types and functions.

Import everything at once with use rawshift::prelude::*;.

§Contents

  • coreRawImage, RgbImage, Size, Rect, Point, CfaPattern, ImageMetadata, ColorSpace, BitDepth, CodecInfo, the generic metadata model (MetadataValue, MetadataKey, MetadataNamespace, MetadataEntry), and related structs.
  • data — Camera color-calibration database (CameraCalibration, get_camera_calibration, all_cameras).
  • errorRawError, ParseError, FormatError, ProcessingError, EncodeError, and RawResult.
  • formatsRawFile, RawFormat, StandardFormat, decode_standard_image, detect_standard_format, read_standard_image_metadata, DngExportConfig, EncodeOptions, CommonEncodeOptions, OutputFormat, and the per-backend encode configs.
  • processingProcessingOptions and demosaicing types.
  • tiffTiffParser, TiffTag, TiffValue, and related TIFF types.
  • transformsapply_black_level, apply_white_balance, apply_white_balance_raw, apply_color_matrix, apply_tone_reproduction, apply_tonemap, compute_camera_to_srgb, ColorSpaceTransform, and more.

Re-exports§

pub use crate::core::IccProfile;
pub use crate::data::cameras::find_camera_calibration;
pub use crate::data::cameras::CameraCalibration;
pub use crate::data::cameras::all_cameras;
pub use crate::data::cameras::get_camera_calibration;Deprecated
pub use crate::error::EncodeError;
pub use crate::error::FormatError;
pub use crate::error::ParseError;
pub use crate::error::ProcessingError;
pub use crate::error::RawError;
pub use crate::error::RawResult;
pub use crate::formats::export::CommonEncodeOptions;
pub use crate::formats::export::EncodeOptions;
pub use crate::formats::export::JpegEncEncodeConfig;
pub use crate::formats::export::LibjxlColorTransform;
pub use crate::formats::export::LibjxlEncodeConfig;
pub use crate::formats::export::LibjxlModular;
pub use crate::formats::export::LibwebpEncodeConfig;
pub use crate::formats::export::OutputFormat;
pub use crate::formats::export::RavifEncodeConfig;
pub use crate::formats::export::WebPMode;
pub use crate::formats::export::ZuneJxlEncodeConfig;
pub use crate::formats::export::ZunePngEncodeConfig;
pub use crate::formats::DecodeOptions;
pub use crate::formats::GifDecodeConfig;
pub use crate::formats::ImageAvifDecodeConfig;
pub use crate::formats::ImageProbe;
pub use crate::formats::JxlOxideDecodeConfig;
pub use crate::formats::LibheifDecodeConfig;
pub use crate::formats::LibwebpDecodeConfig;
pub use crate::formats::ResvgDecodeConfig;
pub use crate::formats::StandardFormat;
pub use crate::formats::TiffDecodeConfig;
pub use crate::formats::ZuneJpegDecodeConfig;
pub use crate::formats::ZunePngDecodeConfig;
pub use crate::formats::available_decoders;
pub use crate::formats::available_encoders;
pub use crate::formats::decode_standard_image;
pub use crate::formats::decode_standard_image_with;
pub use crate::formats::detect_standard_format;
pub use crate::formats::encode_rgb_image;
pub use crate::formats::encode_rgb_image_to_vec;
pub use crate::formats::encode_rgb_image_to_writer;
pub use crate::formats::probe_standard_image;
pub use crate::formats::read_standard_image_metadata;
pub use crate::formats::decode_jxl_partial;
pub use crate::formats::RawFile;
pub use crate::formats::RawFormat;
pub use crate::formats::HeicAuxImage;
pub use crate::formats::HeicAuxKind;
pub use crate::formats::HeicFile;
pub use crate::formats::DngExportConfig;
pub use crate::formats::export_dng;
pub use crate::processing::BayerAlgorithm;
pub use crate::processing::Demosaic;
pub use crate::processing::DemosaicMethod;
pub use crate::processing::ProcessingOptions;
pub use crate::processing::XTransAlgorithm;
pub use crate::tiff::ByteOrder;
pub use crate::tiff::Ifd;
pub use crate::tiff::IfdEntry;
pub use crate::tiff::Rational;
pub use crate::tiff::SRational;
pub use crate::tiff::TiffParser;
pub use crate::tiff::TiffTag;
pub use crate::tiff::TiffValue;
pub use crate::tiff::TiffWriter;
pub use crate::transforms::BadPixelCorrectionMode;
pub use crate::transforms::ColorSpaceTransform;
pub use crate::transforms::ColorTemperature;
pub use crate::transforms::apply_bad_pixel_correction;
pub use crate::transforms::apply_bilateral_filter;
pub use crate::transforms::apply_black_level;
pub use crate::transforms::apply_ca_correction;
pub use crate::transforms::apply_color_matrix;
pub use crate::transforms::apply_crop;
pub use crate::transforms::apply_gains_rgb;
pub use crate::transforms::apply_gaussian_blur;
pub use crate::transforms::apply_matrix_rgb;
pub use crate::transforms::apply_orientation;
pub use crate::transforms::apply_tone_reproduction;
pub use crate::transforms::apply_tonemap;
pub use crate::transforms::apply_white_balance;
pub use crate::transforms::apply_white_balance_raw;
pub use crate::transforms::compute_camera_to_srgb;
pub use crate::transforms::convert_to_srgb;
pub use crate::transforms::correct_bad_pixels;
pub use crate::transforms::detect_bad_pixels;
pub use crate::transforms::estimate_cct_from_as_shot_neutral;
pub use crate::transforms::flip_horizontal;
pub use crate::transforms::flip_vertical;
pub use crate::transforms::interpolate_color_matrix;
pub use crate::transforms::rotate_90_ccw;
pub use crate::transforms::rotate_90_cw;
pub use crate::transforms::rotate_180;
pub use crate::transforms::subtract_black_level_uniform;

Structs§

CameraInfo
Camera identification information.
CodecId
A stable identifier for one codec implementation, in "{format}/{impl}" form.
CodecInfo
Identity and version of one compiled-in codec implementation.
DateTimeInfo
Date/time information.
DngCalibrationInfo
DNG calibration and noise data.
DngColorInfo
DNG color calibration data.
DngProfileInfo
DNG profile data.
ExifInfo
EXIF exposure and capture settings.
GpsInfo
GPS geolocation data.
ImageInfo
Image-level metadata.
ImageMetadata
Complete image metadata — unified superset of all supported formats.
MetadataEmbedOptions
Controls which metadata blocks an encoder embeds into its output container.
MetadataEntry
One entry in the generic metadata table (ImageMetadata::extra).
MetadataKey
Fully-qualified key into ImageMetadata::extra.
RawImage
Raw image data container.
Rect
A rectangular region.
Rgb
An RGB pixel with three components.
RgbImage
A simple container for RGB image data.
Rgba
An RGBA pixel with four components.
Size
Image dimensions.
XTransPattern
X-Trans CFA pattern (6x6 repeating tile).

Enums§

BitDepth
Bits per pixel sample of an encoded image.
CfaPattern
CFA (Color Filter Array) pattern.
CodecDirection
Whether a codec encodes or decodes.
ColorSpace
The color space a set of RGB samples is encoded in.
MetadataNamespace
Namespace identifying the origin of a generic metadata tag.
MetadataValue
A typed, format-agnostic metadata value.

Traits§

FromF32
Conversion trait from f32 to a sample type.
MetadataExtractor
Trait for extracting unified metadata from format-specific structures.
Sample
Trait for scalar sample values used in image processing.

Type Aliases§

Rgb8
Convenience type aliases for common pixel representations.
Rgb16
RgbF32
Rgba8
Rgba16
RgbaF32