image
▼
Project version
v0.59.3
v0.59.2
v0.59.1
v0.59.0
v0.58.0
v0.57.0
v0.56.1
v0.56.0
v0.55.2
v0.55.1
v0.55.0
v0.54.4
v0.54.3
v0.54.2
v0.54.1
v0.54.0
v0.53.0
v0.52.3
v0.52.2
v0.52.1
v0.52.0
v0.51.0
v0.50.0
v0.49.0
v0.48.1
v0.48.0
v0.47.0
v0.46.0
v0.45.0
v0.44.0
v0.43.2
v0.43.1
v0.43.0
v0.42.0
v0.41.0
v0.40.0
v0.39.3
v0.39.2
v0.39.1
v0.39.0
v0.38.4
v0.38.3
v0.38.2
v0.38.1
v0.38.0
v0.37.0
v0.36.2
v0.36.1
v0.36.0
v0.35.0
v0.34.0
v0.33.0
v0.32.0
v0.31.1
v0.31.0
v0.30.0
v0.29.0
v0.28.2
v0.28.1
v0.28.0
v0.27.0
v0.26.0
v0.25.1
v0.25.0
v0.24.1
v0.24.0
v0.23.2
v0.23.1
v0.23.0
v0.22.1
v0.22.0
v0.21.0
v0.20.0
v0.19.0
v0.18.1
v0.18.0
v0.17.0
v0.16.0
v0.15.0
v0.14.4
v0.14.2
v0.14.1
v0.14.0
v0.13.1
v0.13.0
v0.12.0
v0.11.0
v0.10.0
v0.10.0-rc.0
v0.9.0
v0.8.0
v0.7.0
v0.6.0
v0.5.0
v0.4.0
v0.3.0
v0.2.0
v0.1.0
Guides
Modules
API Reference
Modules
Image Install & Configure
Installation
Configuring Libvips
Library packaging future
Security Considerations
Thumbnailing
Edge Masking
Introduction
Open the base image
Edge Detection
Refining the selection
Creating an image outline
Compositing the outline and the mask
Summary
Color Clustering and Dominant Colors
Choose an image
Dominant Colors
Color Sorting
Color Difference
Color Clustering (K-Means)
Color Reduction
Segment Anything Model (SAM) using Ortex
Recap
Loading the models
Getting the image
Prompt encoding & mask generation
License
Changelog
Image 0.59.3
Image 0.59.2
Image 0.59.1
Image 0.59.0
Image 0.58.0
Image 0.57.0
Image 0.56.1
Image 0.56.0
Image 0.55.2
Image 0.55.1
Image 0.55.0
Image 0.54.4
Image 0.54.3
Image 0.54.2
Image 0.54.1
Image 0.54.0
Image 0.53.0
Image 0.52.3
Image 0.52.2
Image 0.52.1
Image 0.52.0
Image 0.51.0
Image 0.50.0
Image 0.49.0
Image 0.48.1
Image 0.48.0
Image 0.47.0
Image 0.46.0
Image 0.45.0
Image 0.44.0
Image 0.43.2
Image 0.43.1
Image 0.43.0
Image 0.42.0
Image 0.41.0
Image 0.40.0
Image 0.39.3
Image 0.39.2
Image 0.39.1
Image 0.39.0
Image 0.38.5
Image 0.38.4
Image 0.38.3
Image 0.38.2
Image 0.38.1
Image 0.38.0
Image 0.37.0
Image 0.36.2
Image 0.36.1
Image 0.36.0
Image 0.35.0
Image 0.34.0
Image 0.33.0
Image 0.32.0
Image 0.31.1
Image 0.31.0
Image 0.30.0
Image 0.29.0
Image 0.28.2
Image 0.28.1
Image 0.28.0
Image 0.27.1
Image 0.27.0
Image 0.26.0
Image 0.25.1
Image 0.25.0
Image 0.24.1
Image 0.24.0
Image 0.23.2
Image 0.23.1
Image 0.23.0
Image 0.22.1
Image 0.22.0
Image 0.21.0
Image 0.20.0
Image 0.19.0
Image 0.18.1
Image 0.18.0
Image 0.17.0
Image 0.16.0
Image 0.15.1
Image 0.15.0
Image 0.14.4
Image 0.14.3
Image 0.14.2
Image 0.14.1
Image 0.14.0
Image 0.13.1
Image 0.13.0
Image 0.12.0
Image 0.11.0
Image 0.10.0
Image 0.9.0
Image 0.8.0
Image 0.7.0
Image 0.6.0
Image 0.5.0
Image 0.4.0
Image 0.3.0
Image 0.2.0
Image 0.1.0
Image
Summary
Files and streams
from_binary/2
from_binary!/2
from_svg/2
from_svg!/2
new/1
new/2
new/3
new!/1
new!/2
new!/3
open/2
open!/2
stream!/2
write/3
write!/3
Basic Adjustments
apply_tone_curve/2
apply_tone_curve!/2
brightness/2
brightness!/2
contrast/2
contrast!/2
equalize/2
equalize!/2
invert/1
invert!/1
local_contrast/2
modulate/2
modulate!/2
saturation/2
saturation!/2
Operations
add_alpha/2
add_alpha!/2
autorotate/1
autorotate!/1
blur/2
blur!/2
cast/2
cast!/2
chroma_color/1
chroma_key/2
chroma_key!/2
compare/3
compose/3
compose!/3
dilate/2
dilate!/2
embed!/4
erode/2
erode!/2
extract_pages/1
feather/2
feather!/2
flatten/2
flatten!/2
flip/2
flip!/2
get_pixel/3
get_pixel!/3
hamming_distance/3
if_then_else/4
if_then_else!/3
local_contrast!/2
map/3
map_join_pages/2
mutate/2
pixelate/2
pixelate!/2
reduce_noise/2
reduce_noise!/2
ripple/1
ripple!/1
rotate/3
rotate!/3
sharpen/2
sharpen!/2
split_alpha/1
to_polar_coordinates/1
to_polar_coordinates!/1
to_rectangular_coordinates/1
to_rectangular_coordinates!/1
vibrance/3
vibrance!/3
with_band_format/3
with_colorspace/3
without_alpha_band/2
Resize
embed/4
find_trim/2
find_trim!/2
resize/3
resize!/3
thumbnail/3
thumbnail!/3
trim/2
trim!/2
Crop
center_crop/3
center_crop!/3
crop/2
crop/5
crop!/2
crop!/5
Transforms
avatar/2
avatar!/2
linear_gradient/1
linear_gradient!/1
meme/3
meme!/3
radial_gradient/3
radial_gradient!/3
squircle/2
Distortion
distort/3
straighten_perspective/3
straighten_perspective!/3
transform_matrix/3
warp_perspective/4
warp_perspective!/4
Split & Join
alpha_band/1
join_bands/1
join_bands!/1
split_bands/1
Color
replace_color/2
replace_color!/2
to_colorspace/2
to_colorspace!/2
Introspection
aspect/2
band_format/1
bands/1
colorspace/1
dominant_color/2
dominant_color!/2
filename/1
has_alpha?/1
height/1
pages/1
range/1
shape/1
width/1
Histogram
logistic_curve_rhs/1
Clusters
histogram/1
k_means/2
k_means!/2
reduce_colors/2
reduce_colors!/2
Color Difference
delta_e/3
delta_e!/3
Masks
chroma_mask/2
chroma_mask!/2
circle/2
circle!/2
convert_alpha_to_mask/1
convert_alpha_to_mask!/1
rounded/2
rounded!/2
squircle!/2
Metadata
dhash/2
exif/1
minimize_metadata/1
minimize_metadata!/1
remove_metadata/2
remove_metadata!/2
xmp/1
Nx & Evision
from_evision/1
from_nx/1
from_nx!/1
to_evision/2
to_nx/2
to_nx!/2
Preview
p/1
preview/1
Kino
to_kino/1
Guards
is_box/4
is_multiplier/1
is_percent/1
is_pixel/1
is_positive_percent/1
is_rectangle/4
is_size/1
libvips Configuration
get_concurrency/0
put_concurrency/1
vips_version/0
Types
aspect/0
bounding_box/0
composition/0
composition_list/0
error_message/0
format/0
image_data/0
image_hash/0
image_or_color/0
kino_image/0
pixel/0
point/0
quadrilateral/0
render_intent/0
transparency/0
x_location/0
y_location/0
Functions
average/1
average!/1
from_kino/2
from_kino!/2
is_image/1
join/2
join!/2
linear_gradient/2
linear_gradient/3
linear_gradient!/2
linear_gradient!/3
Image.Blurhash
Summary
Operations
decode/3
encode/2
Image.Classification
Summary
Functions
classifier/1
classify/2
labels/2
Image.Color
Summary
Types
icc_profile/0
rgb_color/0
t/0
transparency/0
Functions
color_map/0
convert/4
convert!/4
greyscale_color_map/0
hex_to_rgb/1
inbuilt_profiles/0
is_color/1
is_inbuilt_profile/1
known_icc_profile?/1
max_rgb/0
rgb_color/1
rgb_color!/1
rgb_to_hex/1
sort/2
validate_color/1
validate_transparency/1
Image.Draw
Summary
Types
box/0
Functions
circle/5
circle!/5
flood/4
flood!/4
image/5
image!/5
is_circle/3
is_point/2
line/6
line!/6
mask/5
point/4
point!/4
rect/6
rect!/6
smudge/6
Image.Generation
Summary
Functions
generator/2
text_to_image/2
Image.Histogram
Summary
Histogram
as_image/2
as_image!/2
as_svg/2
as_svg!/2
Image.Math
Summary
Functions
&&&/2
**/2
*/2
+/2
-/1
-/2
//2
!=/2
</2
<<</2
<=/2
==/2
>/2
>=/2
>>>/2
abs/1
abs!/1
add/2
add!/2
boolean_and/2
boolean_and!/2
boolean_lshift/2
boolean_lshift!/2
boolean_or/2
boolean_or!/2
boolean_rshift/2
boolean_rshift!/2
boolean_xor/2
boolean_xor!/2
cos/1
cos!/1
divide/2
divide!/2
equal/2
equal!/2
exp/1
exp!/1
greater_than/2
greater_than!/2
greater_than_or_equal/2
greater_than_or_equal!/2
is_pixel/1
less_than/2
less_than!/2
less_than_or_equal/2
less_than_or_equal!/2
max/1
max!/1
maxpos/2
min/1
min!/1
minpos/2
multiply/2
multiply!/2
not_equal/2
not_equal!/2
pow/2
pow!/2
sin/1
sin!/1
subtract/2
subtract!/2
|||/2
Image.QRcode
Summary
Functions
decode/1
encode/2
Image.Scholar
Summary
Functions
k_means/2
unique_colors/1
Image.Shape
Summary
Types
path/0
point/0
Functions
circle/2
circle!/2
ellipse/3
ellipse!/3
line/5
line!/5
polygon/2
polygon!/2
rect/3
rect!/3
star/2
star!/2
Image.Social
Summary
Types
image_usage/0
platform/0
Functions
default_image_usage/1
image_usages/1
known_platforms/0
media_sizes/0
resize/3
resize!/3
Image.Text
Summary
Functions
add_background/2
add_background!/2
add_background_border/2
add_background_border!/2
add_background_padding/2
add_background_padding!/2
simple_text/2
simple_text!/2
text/2
text!/2
Image.Video
Summary
Guards
is_frame/2
is_stream/1
is_valid_millis/3
Types
seek_options/0
stream_id/0
Functions
available_backend?/1
available_backends/0
close/1
close!/1
image_from_video/2
image_from_video!/2
known_backend?/1
known_backends/0
open/2
open!/1
scrub/2
seek/2
seek!/2
stream!/2
with_video/2
Image.YUV
Summary
Types
yuv_colorspace/0
yuv_encoding/0
yuv_list/0
Functions
decode/4
encode/2
new_from_binary/5
new_from_file/5
to_rgb/2
to_rgb/5
to_yuv/3
write_to_binary/3
write_to_file/4
Exif
Image.Exif
Summary
Types
context/0
t/0
value/0
Functions
extract_exif/1
field/1
read_exif/2
Xmp
Image.Xmp
Summary
Functions
extract_xmp/1
Kino
Image.Kino
Summary
Functions
show/2
Options
Image.Options.Avatar
Summary
Types
avatar_option/0
avatar_options/0
Functions
validate_options/1
Image.Options.Blur
Summary
Types
blur_option/0
blur_options/0
Functions
validate_options/1
Image.Options.Blurhash
Summary
Types
blurhash_option/0
blurhash_options/0
Functions
validate_options/2
Image.Options.ChromaKey
Summary
Types
chroma_key_options/0
Functions
validate_options/1
Image.Options.Compare
Summary
Types
compare_option/0
compare_options/0
Functions
validate_options/1
Image.Options.Compose
Summary
Types
composition_option/0
t/0
Functions
default_composit_options/0
Image.Options.Crop
Summary
Types
crop_focus/0
crop_options/0
Functions
validate_options/1
Image.Options.Draw
Summary
Types
circle/0
flood/0
image/0
line/0
mask/0
point/0
rect/0
smudge/0
Functions
validate_options/2
Image.Options.Embed
Summary
Types
embed_option/0
embed_options/0
extend_mode/0
Functions
validate_options/4
Image.Options.Equalize
Summary
Types
equalize_option/0
Functions
validate_options/1
Image.Options.Histogram
Summary
Types
histogram_option/0
histogram_options/0
Functions
validate_options/1
Image.Options.Join
Summary
Types
join_option/0
join_options/0
Functions
validate_options/1
Image.Options.LinearGradient
Summary
Types
linear_gradient_option/0
linear_gradient_options/0
Functions
validate_options/1
Image.Options.LocalContrast
Summary
Types
local_contrast_option/0
local_contrast_options/0
Functions
validate_options/1
Image.Options.Meme
Summary
Types
font_weight/0
meme_options/0
text_transform/0
Functions
default_margin/1
no_such_font_file/1
validate_options/1
validate_options/2
Image.Options.Modulate
Summary
Types
modulate_option/0
modulate_options/0
Functions
validate_options/1
Image.Options.New
Summary
Types
t/0
Functions
default_options/0
set_default_bands/1
validate_options/1
Image.Options.Open
Summary
Types
fail_on/0
file_access/0
gif_open_options/0
image_open_options/0
jpeg_open_options/0
other_open_options/0
pages/0
png_open_options/0
tiff_open_options/0
webp_open_options/0
Functions
validate_option/2
validate_options/1
Image.Options.RadialGradient
Summary
Types
radial_gradient_option/0
radial_gradient_options/0
Functions
validate_options/1
Image.Options.Resize
Summary
Types
resize_options/0
Functions
validate_options/1
Image.Options.Rotate
Summary
Types
rotation_options/0
Functions
validate_options/1
Image.Options.Sharpen
Summary
Types
sharpen_option/0
sharpen_options/0
Functions
validate_options/1
Image.Options.Text
Summary
Types
t/0
Functions
default_options/0
validate_options/1
Image.Options.Thumbnail
Summary
Types
resize_dimension/0
thumbnail_options/0
Functions
validate_options/1
Image.Options.ToneCurve
Summary
Types
positive_percent/0
set_point/0
tone_adjustment/0
tone_curve_option/0
tone_curve_options/0
Functions
is_set_point/1
is_tone_adjustment/1
validate_options/1
Image.Options.Trim
Summary
Types
trim_options/0
Functions
validate_options/1
Image.Options.Vibrance
Summary
Types
vibrance_option/0
vibrance_options/0
Functions
validate_options/1
Image.Options.Video
Summary
Types
backend/0
open_options/0
Functions
known_backends/0
validate_open_options/1
validate_stream_options/2
validate_stream_options!/2
Image.Options.WarpPerspective
Summary
Types
extend_mode/0
t/0
warp_perspective_option/0
Functions
validate_options/2
Image.Options.Write
Summary
Types
gif_write_option/0
heif_compression/0
heif_write_option/0
image_write_options/0
jpeg_write_option/0
png_write_option/0
stream_write_option/0
tiff_write_option/0
webp_write_option/0
Functions
validate_options/2
Enums
Image.BandFormat
Summary
Types
t/0
Functions
image_format_from_nx/1
known_band_formats/0
nx_format/1
nx_format!/1
validate/1
Image.BlendMode
Summary
Types
t/0
Functions
default_blend_mode/0
known_blend_modes/0
validate_blend_mode/1
Image.CombineMode
Summary
Types
t/0
Functions
validate/1
Image.ExtendMode
Summary
Types
t/0
Functions
known_extend_modes/0
validate_extend/1
Image.Interpretation
Summary
Types
t/0
Functions
known_interpretations/0
validate_interpretation/1
Image.Kernel
Summary
Types
t/0
Functions
known_kernel/0
validate_kernel/1
Search documentation of image
Settings
Image.Xmp
(image v0.59.3)
View Source
Functions to extract and interpret image XMP data.
Summary
Functions
extract_xmp(xmp)
Functions
extract_xmp(xmp)