suica/jxl/image does not have a README file

    AnimationHeader

    pub(all) struct AnimationHeader {
    tps_numerator : Int
    tps_denominator : Int
    num_loops : UInt
    have_timecodes : Bool
    } derive(
    Debug
    )

    Animation information.

    TPS (ticks per second) is computed as tps_numerator / tps_denominator, which means tps_denominator / tps_numerator seconds per tick.

    BitDepth

    pub(all) enum BitDepth {
    IntegerSample(bits_per_sample~ : Int)
    FloatSample(bits_per_sample~ : Int, exp_bits~ : Int)
    } derive(Eq,
    Debug
    )

    Bit depth information.

    BitDepth::bits_per_sample

    fn BitDepth::bits_per_sample(self : BitDepth) -> Int

    BitDepth::default

    fn BitDepth::default() -> BitDepth

    BitDepth::parse_integer_sample

    fn BitDepth::parse_integer_sample(self : BitDepth, sample : Int) -> Float

    Parses the given Modular image sample to a Float. Note: This function can return non-finite values.

    ColourEncoding

    pub(all) enum ColourEncoding {
    Enum(EnumColourEncoding)
    IccProfile(ColourSpace)
    } derive(Eq,
    Debug
    )

    Color encoding, either represented by enum values, or a signal of existence of ICC profile.

    ColourEncoding::cicp

    fn ColourEncoding::cicp(self : ColourEncoding) -> FixedArray[Int]?

    Returns the CICP tag which represents this ColourEncoding.

    ColourEncoding::clone

    An independent copy (Rust Clone).

    ColourEncoding::colour_space

    fn ColourEncoding::colour_space(self : ColourEncoding) -> ColourSpace

    ColourEncoding::default

    ColourEncoding::is_srgb

    fn ColourEncoding::is_srgb(self : ColourEncoding) -> Bool

    Returns whether this ColourEncoding represents the sRGB colorspace.

    ColourEncoding::is_srgb_gamut

    fn ColourEncoding::is_srgb_gamut(self : ColourEncoding) -> Bool

    ColourEncoding::want_icc

    fn ColourEncoding::want_icc(self : ColourEncoding) -> Bool

    ColourSpace

    pub(all) enum ColourSpace {
    Rgb
    Grey
    Xyb
    Unknown
    } derive(Eq,
    Debug
    )

    Color space type.

    ColourSpace::default

    fn ColourSpace::default() -> ColourSpace

    ColourSpace::from_raw

    ColourSpace::to_raw

    fn ColourSpace::to_raw(self : ColourSpace) -> Int

    Customxy

    pub(all) struct Customxy {
    x : Int
    y : Int
    } derive(Eq,
    Debug
    )

    Custom xy-chromaticity coordinate.

    Coordinate values are scaled by 1e6 (1_000_000).

    Customxy::as_float

    fn Customxy::as_float(self : Customxy) -> FixedArray[Float]

    Returns the xy-chromaticity coordinate as floating point values.

    EnumColourEncoding

    pub(all) struct EnumColourEncoding {
    colour_space : ColourSpace
    white_point : WhitePoint
    primaries : Primaries
    tf : TransferFunction
    rendering_intent : RenderingIntent
    } derive(Eq,
    Debug
    )

    "Enum color encoding" represented by JPEG XL enum values.

    EnumColourEncoding::bt2100_hlg

    fn EnumColourEncoding::bt2100_hlg(rendering_intent : RenderingIntent) -> EnumColourEncoding

    Creates a BT.2100 color encoding with hybrid log-gamma transfer function.

    EnumColourEncoding::bt2100_pq

    fn EnumColourEncoding::bt2100_pq(rendering_intent : RenderingIntent) -> EnumColourEncoding

    Creates a BT.2100 color encoding with PQ transfer function.

    EnumColourEncoding::bt709

    fn EnumColourEncoding::bt709(rendering_intent : RenderingIntent) -> EnumColourEncoding

    Creates a BT.709 color encoding.

    EnumColourEncoding::cicp

    fn EnumColourEncoding::cicp(self : EnumColourEncoding) -> FixedArray[Int]?

    Returns the CICP tag which represents this color encoding.

    EnumColourEncoding::clone

    An independent copy (Rust Clone).

    EnumColourEncoding::dci_p3

    fn EnumColourEncoding::dci_p3(rendering_intent : RenderingIntent) -> EnumColourEncoding

    Creates a DCI-P3 color encoding.

    EnumColourEncoding::default

    EnumColourEncoding::display_p3

    fn EnumColourEncoding::display_p3(rendering_intent : RenderingIntent) -> EnumColourEncoding

    Creates a Display P3 color encoding.

    EnumColourEncoding::display_p3_pq

    fn EnumColourEncoding::display_p3_pq(rendering_intent : RenderingIntent) -> EnumColourEncoding

    Creates a Display P3 color encoding with PQ transfer function.

    EnumColourEncoding::gray_gamma22

    fn EnumColourEncoding::gray_gamma22(rendering_intent : RenderingIntent) -> EnumColourEncoding

    Creates a grayscale color encoding with white point of D65 and gamma of 2.2.

    EnumColourEncoding::gray_srgb

    fn EnumColourEncoding::gray_srgb(rendering_intent : RenderingIntent) -> EnumColourEncoding

    Creates a grayscale color encoding with white point of D65 and sRGB transfer curve.

    EnumColourEncoding::is_hdr

    fn EnumColourEncoding::is_hdr(self : EnumColourEncoding) -> Bool

    Returns whether transfer function of the color encoding is capable of encoding HDR signals.

    EnumColourEncoding::is_srgb

    fn EnumColourEncoding::is_srgb(self : EnumColourEncoding) -> Bool

    Returns whether the color encoding represents the sRGB colorspace.

    EnumColourEncoding::is_srgb_gamut

    fn EnumColourEncoding::is_srgb_gamut(self : EnumColourEncoding) -> Bool

    Returns whether color gamut of the color encoding equals to sRGB (BT.709), and white point equals to D65.

    EnumColourEncoding::srgb

    fn EnumColourEncoding::srgb(rendering_intent : RenderingIntent) -> EnumColourEncoding

    Creates an sRGB color encoding.

    EnumColourEncoding::srgb_gamma22

    fn EnumColourEncoding::srgb_gamma22(rendering_intent : RenderingIntent) -> EnumColourEncoding

    Creates an sRGB color encoding with gamma of 2.2 (instead of sRGB transfer curve).

    EnumColourEncoding::srgb_linear

    fn EnumColourEncoding::srgb_linear(rendering_intent : RenderingIntent) -> EnumColourEncoding

    Creates an sRGB color encoding with linear transfer (instead of sRGB transfer curve).

    EnumColourEncoding::xyb

    Creates an XYB color encoding.

    Extensions

    pub(all) struct Extensions {
    extension_bits : UInt64
    } derive(
    Debug
    )

    ExtraChannelInfo

    pub(all) struct ExtraChannelInfo {
    ty : ExtraChannelType
    bit_depth : BitDepth
    dim_shift : Int
    name : String
    } derive(
    Debug
    )

    Information about an extra channel.

    ExtraChannelInfo::alpha_associated

    fn ExtraChannelInfo::alpha_associated(self : ExtraChannelInfo) -> Bool?

    Returns whether the alpha channel has premultiplied semantics.

    ExtraChannelInfo::default

    ExtraChannelInfo::is_alpha

    fn ExtraChannelInfo::is_alpha(self : ExtraChannelInfo) -> Bool

    Returns whether this is an alpha channel.

    ExtraChannelInfo::is_black

    fn ExtraChannelInfo::is_black(self : ExtraChannelInfo) -> Bool

    Returns whether this is a black channel of a CMYK image.

    ExtraChannelType

    pub(all) enum ExtraChannelType {
    Alpha(alpha_associated~ : Bool)
    Depth
    SpotColour(red~ : Float, green~ : Float, blue~ : Float, solidity~ : Float)
    SelectionMask
    Black
    Cfa(cfa_channel~ : Int)
    Thermal
    NonOptional
    Optional
    } derive(Eq,
    Debug
    )

    Type of an extra channel.

    ExtraChannelType::default

    ImageHeader

    pub(all) struct ImageHeader {
    size : SizeHeader
    metadata : ImageMetadata
    } derive(
    Debug
    )

    JPEG XL image header.

    ImageHeader::height_with_orientation

    fn ImageHeader::height_with_orientation(self : ImageHeader) -> Int

    Returns the image height with orientation applied.

    ImageHeader::width_with_orientation

    fn ImageHeader::width_with_orientation(self : ImageHeader) -> Int

    Returns the image width with orientation applied.

    ImageMetadata

    pub(all) struct ImageMetadata {
    all_default : Bool
    extra_fields : Bool
    orientation : Int
    have_intr_size : Bool
    intrinsic_size : SizeHeader?
    have_preview : Bool
    preview : PreviewHeader?
    have_animation : Bool
    animation : AnimationHeader?
    bit_depth : BitDepth
    modular_16bit_buffers : Bool
    num_extra : Int
    ec_info : Array[ExtraChannelInfo]
    xyb_encoded : Bool
    colour_encoding : ColourEncoding
    tone_mapping : ToneMapping
    extensions : Extensions
    default_m : Bool
    opsin_inverse_matrix : OpsinInverseMatrix
    cw_mask : Int
    up2_weight : FixedArray[Float]
    up4_weight : FixedArray[Float]
    up8_weight : FixedArray[Float]
    } derive(
    Debug
    )

    Image metadata.

    ImageMetadata::alpha

    fn ImageMetadata::alpha(self : ImageMetadata) -> Int?

    Returns the index of the first alpha channel in the image.

    ImageMetadata::apply_orientation

    fn ImageMetadata::apply_orientation(self : ImageMetadata, width : Int, height : Int, left : Int, top : Int, inverse : Bool) -> (Int, Int, Int, Int)

    Returns where the given coordinate will be placed after the orientation is applied.

    ImageMetadata::default

    fn ImageMetadata::default() -> ImageMetadata

    ImageMetadata with every field at its default value.

    ImageMetadata::grayscale

    fn ImageMetadata::grayscale(self : ImageMetadata) -> Bool

    Returns whether the image is grayscale.

    OpsinInverseMatrix

    pub(all) struct OpsinInverseMatrix {
    all_default : Bool
    inv_mat : FixedArray[FixedArray[Float]]
    opsin_bias : FixedArray[Float]
    quant_bias : FixedArray[Float]
    quant_bias_numerator : Float
    } derive(
    Debug
    )

    Opsin inverse metadata.

    OpsinInverseMatrix::default

    PreviewHeader

    pub(all) struct PreviewHeader {
    div8 : Bool
    h_div8 : Int
    height : Int
    ratio : Int
    w_div8 : Int
    width : Int
    } derive(
    Debug
    )

    Primaries

    pub(all) enum Primaries {
    Srgb
    Custom(red~ : Customxy, green~ : Customxy, blue~ : Customxy)
    Bt2100
    P3
    } derive(Eq,
    Debug
    )

    RGB primaries.

    Primaries::cicp

    fn Primaries::cicp(self : Primaries) -> Int?

    Returns the CICP value of the primaries, if there is any.

    Primaries::default

    fn Primaries::default() -> Primaries

    RenderingIntent

    pub(all) enum RenderingIntent {
    Perceptual
    Relative
    Saturation
    Absolute
    } derive(Eq,
    Debug
    )

    Rendering intent, defined by ICC specification.

    RenderingIntent::default

    RenderingIntent::from_raw

    RenderingIntent::to_raw

    fn RenderingIntent::to_raw(self : RenderingIntent) -> Int

    The numeric value (as u8).

    SizeHeader

    pub(all) struct SizeHeader {
    div8 : Bool
    h_div8 : Int
    height : Int
    ratio : Int
    w_div8 : Int
    width : Int
    } derive(
    Debug
    )

    Image size information.

    SizeHeader::default

    fn SizeHeader::default() -> SizeHeader

    ToneMapping

    pub(all) struct ToneMapping {
    all_default : Bool
    intensity_target : Float
    min_nits : Float
    relative_to_max_display : Bool
    linear_below : Float
    } derive(
    Debug
    )

    HDR tone mapping metadata.

    ToneMapping::default

    fn ToneMapping::default() -> ToneMapping

    TransferFunction

    pub(all) enum TransferFunction {
    Gamma(g~ : Int, inverted~ : Bool)
    Bt709
    Unknown
    Linear
    Srgb
    Pq
    Dci
    Hlg
    } derive(Eq,
    Debug
    )

    Transfer function (tone curve).

    TransferFunction::cicp

    fn TransferFunction::cicp(self : TransferFunction) -> Int?

    Returns the CICP value of transfer function, if there is any.

    TransferFunction::default

    TransferFunction::from_raw

    WhitePoint

    pub(all) enum WhitePoint {
    D65
    Custom(Customxy)
    E
    Dci
    } derive(Eq,
    Debug
    )

    White point.

    WhitePoint::default

    fn WhitePoint::default() -> WhitePoint