# ol.vips.enums

Generated enum descriptors for normalized libvips enum ids.

Use [`registry`](#registry) or the generated enum vars to inspect enum metadata. Use [`ol.vips/encode-enum`](api/ol-vips.adoc#encode-enum) and [`ol.vips/decode-enum`](api/ol-vips.adoc#decode-enum) to convert between keywords and the underlying libvips integer values.

## registry

Generated registry of libvips enum descriptors keyed by normalized enum id.

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L11-L54)

---

## access

Generated enum descriptor for `VipsAccess`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:random`
- `:sequential`
- `:sequential-unbuffered`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L56-L65)

---

## align

Generated enum descriptor for `VipsAlign`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:centre`
- `:high`
- `:low`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L67-L76)

---

## angle

Generated enum descriptor for `VipsAngle`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:d0`
- `:d180`
- `:d270`
- `:d90`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L78-L88)

---

## angle45

Generated enum descriptor for `VipsAngle45`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:d0`
- `:d135`
- `:d180`
- `:d225`
- `:d270`
- `:d315`
- `:d45`
- `:d90`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L90-L104)

---

## band-format

Generated enum descriptor for `VipsBandFormat`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:char`
- `:complex`
- `:double`
- `:dpcomplex`
- `:float`
- `:int`
- `:notset`
- `:short`
- `:uchar`
- `:uint`
- `:ushort`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L106-L123)

---

## blend-mode

Generated enum descriptor for `VipsBlendMode`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:add`
- `:atop`
- `:clear`
- `:colour-burn`
- `:colour-dodge`
- `:darken`
- `:dest`
- `:dest-atop`
- `:dest-in`
- `:dest-out`
- `:dest-over`
- `:difference`
- `:exclusion`
- `:hard-light`
- `:in`
- `:lighten`
- `:multiply`
- `:out`
- `:over`
- `:overlay`
- `:saturate`
- `:screen`
- `:soft-light`
- `:source`
- `:xor`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L125-L156)

---

## coding

Generated enum descriptor for `VipsCoding`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:error`
- `:labq`
- `:none`
- `:rad`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L158-L168)

---

## combine

Generated enum descriptor for `VipsCombine`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:max`
- `:min`
- `:sum`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L170-L179)

---

## combine-mode

Generated enum descriptor for `VipsCombineMode`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:add`
- `:set`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L181-L189)

---

## compass-direction

Generated enum descriptor for `VipsCompassDirection`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:centre`
- `:east`
- `:north`
- `:north-east`
- `:north-west`
- `:south`
- `:south-east`
- `:south-west`
- `:west`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L191-L206)

---

## direction

Generated enum descriptor for `VipsDirection`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:horizontal`
- `:vertical`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L208-L216)

---

## extend

Generated enum descriptor for `VipsExtend`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:background`
- `:black`
- `:copy`
- `:mirror`
- `:repeat`
- `:white`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L218-L230)

---

## fail-on

Generated enum descriptor for `VipsFailOn`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:error`
- `:none`
- `:truncated`
- `:warning`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L232-L242)

---

## foreign-dz-container

Generated enum descriptor for `VipsForeignDzContainer`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:fs`
- `:szi`
- `:zip`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L244-L253)

---

## foreign-dz-depth

Generated enum descriptor for `VipsForeignDzDepth`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:one`
- `:onepixel`
- `:onetile`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L255-L264)

---

## foreign-dz-layout

Generated enum descriptor for `VipsForeignDzLayout`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:dz`
- `:google`
- `:iiif`
- `:iiif3`
- `:zoomify`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L266-L277)

---

## foreign-heif-compression

Generated enum descriptor for `VipsForeignHeifCompression`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:av1`
- `:avc`
- `:hevc`
- `:jpeg`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L279-L289)

---

## foreign-heif-encoder

Generated enum descriptor for `VipsForeignHeifEncoder`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:aom`
- `:auto`
- `:rav1e`
- `:svt`
- `:x265`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L291-L302)

---

## foreign-subsample

Generated enum descriptor for `VipsForeignSubsample`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:auto`
- `:off`
- `:on`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L304-L313)

---

## foreign-tiff-compression

Generated enum descriptor for `VipsForeignTiffCompression`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:ccittfax4`
- `:deflate`
- `:jp2k`
- `:jpeg`
- `:lzw`
- `:none`
- `:packbits`
- `:webp`
- `:zstd`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L315-L330)

---

## foreign-tiff-predictor

Generated enum descriptor for `VipsForeignTiffPredictor`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:float`
- `:horizontal`
- `:none`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L332-L341)

---

## foreign-tiff-resunit

Generated enum descriptor for `VipsForeignTiffResunit`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:cm`
- `:inch`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L343-L351)

---

## foreign-webp-preset

Generated enum descriptor for `VipsForeignWebpPreset`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:default`
- `:drawing`
- `:icon`
- `:photo`
- `:picture`
- `:text`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L353-L365)

---

## intent

Generated enum descriptor for `VipsIntent`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:absolute`
- `:auto`
- `:perceptual`
- `:relative`
- `:saturation`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L367-L378)

---

## interesting

Generated enum descriptor for `VipsInteresting`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:all`
- `:attention`
- `:centre`
- `:entropy`
- `:high`
- `:low`
- `:none`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L380-L393)

---

## interpretation

Generated enum descriptor for `VipsInterpretation`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:b-w`
- `:cmc`
- `:cmyk`
- `:error`
- `:fourier`
- `:grey16`
- `:histogram`
- `:hsv`
- `:lab`
- `:labq`
- `:labs`
- `:lch`
- `:matrix`
- `:multiband`
- `:rgb`
- `:rgb16`
- `:scrgb`
- `:srgb`
- `:xyz`
- `:yxy`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L395-L421)

---

## kernel

Generated enum descriptor for `VipsKernel`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:cubic`
- `:lanczos2`
- `:lanczos3`
- `:linear`
- `:mitchell`
- `:mks2013`
- `:mks2021`
- `:nearest`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L423-L437)

---

## operation-boolean

Generated enum descriptor for `VipsOperationBoolean`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:and`
- `:eor`
- `:lshift`
- `:or`
- `:rshift`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L439-L450)

---

## operation-complex

Generated enum descriptor for `VipsOperationComplex`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:conj`
- `:polar`
- `:rect`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L452-L461)

---

## operation-complex2

Generated enum descriptor for `VipsOperationComplex2`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:cross-phase`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L463-L470)

---

## operation-complexget

Generated enum descriptor for `VipsOperationComplexget`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:imag`
- `:real`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L472-L480)

---

## operation-math

Generated enum descriptor for `VipsOperationMath`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:acos`
- `:acosh`
- `:asin`
- `:asinh`
- `:atan`
- `:atanh`
- `:cos`
- `:cosh`
- `:exp`
- `:exp10`
- `:log`
- `:log10`
- `:sin`
- `:sinh`
- `:tan`
- `:tanh`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L482-L504)

---

## operation-math2

Generated enum descriptor for `VipsOperationMath2`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:atan2`
- `:pow`
- `:wop`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L506-L515)

---

## operation-morphology

Generated enum descriptor for `VipsOperationMorphology`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:dilate`
- `:erode`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L517-L525)

---

## operation-relational

Generated enum descriptor for `VipsOperationRelational`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:equal`
- `:less`
- `:lesseq`
- `:more`
- `:moreeq`
- `:noteq`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L527-L539)

---

## operation-round

Generated enum descriptor for `VipsOperationRound`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:ceil`
- `:floor`
- `:rint`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L541-L550)

---

## pcs

Generated enum descriptor for `VipsPCS`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:lab`
- `:xyz`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L552-L560)

---

## precision

Generated enum descriptor for `VipsPrecision`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:approximate`
- `:float`
- `:integer`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L562-L571)

---

## region-shrink

Generated enum descriptor for `VipsRegionShrink`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:max`
- `:mean`
- `:median`
- `:min`
- `:mode`
- `:nearest`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L573-L585)

---

## sdf-shape

Generated enum descriptor for `VipsSdfShape`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:box`
- `:circle`
- `:line`
- `:rounded-box`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L587-L597)

---

## size

Generated enum descriptor for `VipsSize`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:both`
- `:down`
- `:force`
- `:up`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L599-L609)

---

## text-wrap

Generated enum descriptor for `VipsTextWrap`.

Use this value directly or look it up in [`registry`](#registry) when you want the generated enum map.

Known values:
- `:char`
- `:none`
- `:word`
- `:word-char`

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L611-L621)

---

## enums

```clojure
(enums)
```

Lists the generated libvips enum ids.

[source,window=_blank](https://github.com/outskirtslabs/vips/blob/main/src/ol/vips/enums.clj#L623-L623)
