API referencestd/image

std/image/color

Public declarations, types, methods, and source contracts for std/image/color.

On this page

Library guide · API index and notation

This page is generated from the bundled library in this checkout. Signatures and adjacent source comments are reproduced below; the linked guide explains usage, storage, failures, and platform support.

import "std/image/color"

Names used in signatures

Unqualified names denote this package’s types (including other source files in the same package), language built-ins, or generic parameters such as T. Qualified names use the import aliases below. These aliases belong to the library source; import a dependency yourself to use its alias in your program.

This package has no source imports.

PRIMARIES_BT709

Constant · Source

Color primaries (H.273 table 2).

pub const PRIMARIES_BT709: u8 = 1

PRIMARIES_UNSPECIFIED

Constant · Source

pub const PRIMARIES_UNSPECIFIED: u8 = 2

PRIMARIES_BT470M

Constant · Source

pub const PRIMARIES_BT470M: u8 = 4

PRIMARIES_BT470BG

Constant · Source

pub const PRIMARIES_BT470BG: u8 = 5

PRIMARIES_BT601

Constant · Source

pub const PRIMARIES_BT601: u8 = 6

PRIMARIES_SMPTE240

Constant · Source

pub const PRIMARIES_SMPTE240: u8 = 7

PRIMARIES_FILM

Constant · Source

pub const PRIMARIES_FILM: u8 = 8

PRIMARIES_BT2020

Constant · Source

pub const PRIMARIES_BT2020: u8 = 9

PRIMARIES_XYZ

Constant · Source

pub const PRIMARIES_XYZ: u8 = 10

PRIMARIES_DCI_P3

Constant · Source

pub const PRIMARIES_DCI_P3: u8 = 11

PRIMARIES_DISPLAY_P3

Constant · Source

pub const PRIMARIES_DISPLAY_P3: u8 = 12

PRIMARIES_EBU3213

Constant · Source

pub const PRIMARIES_EBU3213: u8 = 22

TRANSFER_BT709

Constant · Source

Transfer characteristics (H.273 table 3).

pub const TRANSFER_BT709: u8 = 1

TRANSFER_UNSPECIFIED

Constant · Source

pub const TRANSFER_UNSPECIFIED: u8 = 2

TRANSFER_GAMMA22

Constant · Source

pub const TRANSFER_GAMMA22: u8 = 4

TRANSFER_GAMMA28

Constant · Source

pub const TRANSFER_GAMMA28: u8 = 5

TRANSFER_BT601

Constant · Source

pub const TRANSFER_BT601: u8 = 6

TRANSFER_SMPTE240

Constant · Source

pub const TRANSFER_SMPTE240: u8 = 7

TRANSFER_LINEAR

Constant · Source

pub const TRANSFER_LINEAR: u8 = 8

TRANSFER_LOG100

Constant · Source

pub const TRANSFER_LOG100: u8 = 9

TRANSFER_LOG316

Constant · Source

pub const TRANSFER_LOG316: u8 = 10

TRANSFER_XVYCC

Constant · Source

pub const TRANSFER_XVYCC: u8 = 11

TRANSFER_BT1361

Constant · Source

pub const TRANSFER_BT1361: u8 = 12

TRANSFER_SRGB

Constant · Source

pub const TRANSFER_SRGB: u8 = 13

TRANSFER_BT2020_10

Constant · Source

pub const TRANSFER_BT2020_10: u8 = 14

TRANSFER_BT2020_12

Constant · Source

pub const TRANSFER_BT2020_12: u8 = 15

TRANSFER_PQ

Constant · Source

pub const TRANSFER_PQ: u8 = 16

TRANSFER_SMPTE428

Constant · Source

pub const TRANSFER_SMPTE428: u8 = 17

TRANSFER_HLG

Constant · Source

pub const TRANSFER_HLG: u8 = 18

MATRIX_IDENTITY

Constant · Source

Matrix coefficients (H.273 table 4). Decoded images are always RGB or gray, so this records what the file used, normally MATRIX_IDENTITY.

pub const MATRIX_IDENTITY: u8 = 0

MATRIX_BT709

Constant · Source

pub const MATRIX_BT709: u8 = 1

MATRIX_UNSPECIFIED

Constant · Source

pub const MATRIX_UNSPECIFIED: u8 = 2

MATRIX_FCC

Constant · Source

pub const MATRIX_FCC: u8 = 4

MATRIX_BT470BG

Constant · Source

pub const MATRIX_BT470BG: u8 = 5

MATRIX_BT601

Constant · Source

pub const MATRIX_BT601: u8 = 6

MATRIX_SMPTE240

Constant · Source

pub const MATRIX_SMPTE240: u8 = 7

MATRIX_YCGCO

Constant · Source

pub const MATRIX_YCGCO: u8 = 8

MATRIX_BT2020_NCL

Constant · Source

pub const MATRIX_BT2020_NCL: u8 = 9

MATRIX_BT2020_CL

Constant · Source

pub const MATRIX_BT2020_CL: u8 = 10

MATRIX_ICTCP

Constant · Source

pub const MATRIX_ICTCP: u8 = 14

ICC_NONE

Constant · Source

How an embedded ICC profile is stored at icc_offset.

pub const ICC_NONE: u8 = 0

ICC_RAW

Constant · Source

The profile bytes themselves.

pub const ICC_RAW: u8 = 1

ICC_ZLIB

Constant · Source

A zlib stream (PNG iCCP).

pub const ICC_ZLIB: u8 = 2

ICC_JXL

Constant · Source

Entropy-coded inside a JPEG XL codestream; image.icc() decodes it.

pub const ICC_JXL: u8 = 3

INTENT_PERCEPTUAL

Constant · Source

Rendering intents (PNG sRGB chunk, ICC header).

pub const INTENT_PERCEPTUAL: u8 = 0

INTENT_RELATIVE

Constant · Source

pub const INTENT_RELATIVE: u8 = 1

INTENT_SATURATION

Constant · Source

pub const INTENT_SATURATION: u8 = 2

INTENT_ABSOLUTE

Constant · Source

pub const INTENT_ABSOLUTE: u8 = 3

ColorInfo

Struct · Source

pub struct ColorInfo {
    pub primaries: u8
    pub transfer: u8
    pub matrix: u8
    pub full_range: bool
    // True when the file described its colors (a color chunk, CICP, ICC or
    // a JPEG XL color encoding). Untagged images default to sRGB.
    pub tagged: bool
    // Nonzero when the file gives only a power-law curve (PNG gAMA without
    // sRGB, JPEG XL custom gamma): the encoding exponent times 100000, so
    // 45455 is the usual 1/2.2. transfer is then TRANSFER_UNSPECIFIED unless
    // the gamma is one CICP names.
    pub gamma: u32
    // Custom chromaticities times 100000 (PNG cHRM, JPEG XL custom
    // primaries), meaningful when custom_primaries is true; primaries is
    // then PRIMARIES_UNSPECIFIED unless they match a named set.
    pub custom_primaries: bool
    pub white_x: u32
    pub white_y: u32
    pub red_x: u32
    pub red_y: u32
    pub green_x: u32
    pub green_y: u32
    pub blue_x: u32
    pub blue_y: u32
    pub intent: u8
    // The embedded ICC profile: a byte range of the input and its encoding.
    pub icc_encoding: u8
    pub icc_offset: usize
    pub icc_length: usize
    // Peak display luminance in nits the image is graded for (JPEG XL
    // intensity target, PNG cLLi); zero when unknown.
    pub intensity_target: u32
}

ColorInfo.srgb

Function · Source

Untagged sRGB, the assumption for files without color information.

pub fn srgb() -> ColorInfo

ColorInfo.linear

Function · Source

Untagged linear-light sRGB primaries (QOI colorspace 1).

pub fn linear() -> ColorInfo

ColorInfo.clone

Function · Source

pub fn clone(&self) -> ColorInfo

ColorInfo.is_srgb

Function · Source

True when samples are sRGB-encoded with BT.709 primaries, or the file says nothing and sRGB is assumed. An ICC profile makes this false: the profile, not CICP, then defines the colors.

pub fn is_srgb(&self) -> bool

ColorInfo.is_linear

Function · Source

pub fn is_linear(&self) -> bool

ColorInfo.is_hdr

Function · Source

Perceptual-quantizer or hybrid-log-gamma content.

pub fn is_hdr(&self) -> bool

ColorInfo.has_icc

Function · Source

pub fn has_icc(&self) -> bool

ColorInfo.set_gamma

Function · Source

Set the curve from a PNG-style gamma (encoding exponent x 100000), naming sRGB-compatible and linear values where CICP can.

pub fn set_gamma(&mut self, gamma: u32)

ColorInfo.set_chromaticities

Function · Source

Set custom chromaticities (x 100000), naming BT.709, BT.2020 and the P3 sets when every coordinate is within 0.001.

pub fn set_chromaticities(&mut self, white_x: u32, white_y: u32, red_x: u32, red_y: u32, green_x: u32, green_y: u32, blue_x: u32, blue_y: u32)

Orientation

Enum · Source

How stored pixels must be transformed for display (EXIF orientation tag, also used by JPEG XL). Names describe the transform to apply.

pub enum Orientation {
    // EXIF 1: as stored.
    Identity,
    // EXIF 2: mirror left-right.
    FlipHorizontal,
    // EXIF 3.
    Rotate180,
    // EXIF 4: mirror top-bottom.
    FlipVertical,
    // EXIF 5: mirror along the top-left to bottom-right diagonal.
    Transpose,
    // EXIF 6: rotate 90 degrees clockwise.
    Rotate90,
    // EXIF 7: mirror along the top-right to bottom-left diagonal.
    Transverse,
    // EXIF 8: rotate 270 degrees clockwise (90 counter-clockwise).
    Rotate270
}

orientation_from_exif

Function · Source

The orientation for an EXIF value; values outside 1..8 mean Identity.

pub fn orientation_from_exif(value: u32) -> Orientation

exif_value

Function · Source

pub fn exif_value(orientation: &Orientation) -> u32

clone_orientation

Function · Source

pub fn clone_orientation(orientation: &Orientation) -> Orientation

swaps_axes

Function · Source

True when displaying swaps width and height (EXIF 5 through 8).

pub fn swaps_axes(orientation: &Orientation) -> bool

srgb_to_linear16

Function · Source

An sRGB-encoded 16-bit sample in linear light, from a 256-knot table that is exact for 8-bit values (v = k * 257) and interpolated between them.

pub fn srgb_to_linear16(value: u16) -> u16

linear_to_srgb16

Function · Source

A linear-light 16-bit sample sRGB-encoded, from a 4097-knot table.

pub fn linear_to_srgb16(value: u16) -> u16

srgb8_to_linear16

Function · Source

An 8-bit sRGB value in linear light, exactly rounded to 16 bits.

pub fn srgb8_to_linear16(value: u8) -> u16

linear16_to_srgb8

Function · Source

A linear 16-bit value as 8-bit sRGB.

pub fn linear16_to_srgb8(value: u16) -> u8

Search every guide, reference page, and API declaration.