imgproxy Pro

imgproxy Pro is the paid edition of imgproxy. The library builds the URL for every option, whichever edition you run. What imgproxy does with a Pro option on the open-source edition is up to imgproxy: it may ignore the option or answer with an error. Check the edition before you depend on one.

How the docs mark Pro

• A Pro badge in the sidebar and in the lists marks an option that needs Pro as a whole.
• Partly Pro marks an option that works on both editions, with a value or an argument that needs Pro.
• Every option page has an Availability row.

Pro values of other options

Where	Value	Notes
Format, Url::build()	best	Lets imgproxy pick the best format.
Watermark	position ch	Chessboard pattern.
Gravity	types obj and objw	Use GravityObject and GravityObjectWeight.
EncryptionMasker	the whole masker	Encrypted source URLs.

Pro options

Sizing

Class	imgproxy	Description
ResizingAlgorithm Pro	ra	Sets the algorithm used to resample the image.

Cropping

Class	imgproxy	Description
CropAspectRatio Pro	car	Adjusts the crop area to an aspect ratio.
CropObjects Pro	c_obj	Crops the image to the objects detected by imgproxy’s object detection.
Gravity Partly Pro	g	Sets the anchor for cropping and extending.
GravityObject Pro	g	Gravity on the objects of the given classes, as detected by imgproxy’s object detection.
GravityObjectWeight Pro	g	Gravity on detected objects, with a weight for each class.
ObjectsPosition Pro	op	Positions the detected objects within the resulting image.

Effects

Class	imgproxy	Description
Adjust Pro	a	Sets brightness, contrast and saturation in one option.
BackgroundAlpha Pro	bga	Adds an alpha channel to the background color.
BlurAreas Pro	ba	Blurs rectangular areas of the image.
BlurDetections Pro	bd	Blurs the objects found by imgproxy’s object detection.
Brightness Pro	br	Adjusts the brightness of the image.
Colorize Pro	col	Overlays a color on the image.
Contrast Pro	co	Adjusts the contrast of the image.
DrawDetections Pro	dd	Draws boxes, classes and confidences of detected objects onto the image.
Duotone Pro	dt	Converts the image to two tones, mapping dark and light areas to two colors.
Gradient Pro	gr	Overlays a gradient that fades from transparent to a color.
Monochrome Pro	mc	Converts the image to monochrome.
Saturation Pro	sa	Adjusts the saturation of the image.
UnsharpMasking Pro	ush	Applies unsharp masking.

Output

Class	imgproxy	Description
AutoQuality Pro	aq	Picks the quality automatically by encoding the image several times.
AvifOptions Pro	avifo	Sets AVIF encoder options.
ColorProfile Pro	cp	Converts the image to a color profile and embeds it.
DisableAnimation Pro	da	Treats animated images as static, using the first frame.
Dpi Pro	dpi	Replaces the DPI metadata of the image.
Format Partly Pro	f	Sets the output format as a processing option.
JpegOptions Pro	jpgo	Sets JPEG encoder options.
PngOptions Pro	pngo	Sets PNG encoder options.
WebpOptions Pro	webpo	Sets WebP encoder options.

Source

Class	imgproxy	Description
FallbackImageUrl Pro	fiu	Sets an image that is served when the source cannot be loaded.
Hashsum Pro	hs	Verifies the checksum of the source.
Page Pro	pg	Selects the page or frame of a multi-page or animated source.
Pages Pro	pgs	Sets the number of pages that are stacked vertically in the result.
Style Pro	st	Injects CSS into SVG sources.
VideoThumbnailAnimation Pro	vta	Generates an animation from video frames.
VideoThumbnailKeyframes Pro	vtk	Restricts video thumbnails to keyframes.
VideoThumbnailSecond Pro	vts	Sets the second of a video that is used for the thumbnail.
VideoThumbnailTile Pro	vtt	Generates a sprite of video thumbnails.

Watermark

Class	imgproxy	Description
Watermark Partly Pro	wm	Places the watermark that is configured in imgproxy on the image.
WatermarkRotate Pro	wmr	Rotates the watermark clockwise.
WatermarkShadow Pro	wmsh	Adds a shadow to the watermark.
WatermarkSize Pro	wms	Sets the size of the watermark.
WatermarkText Pro	wmt	Renders a text as the watermark.
WatermarkUrl Pro	wmu	Sets the image that is used as the watermark.