OptionalbackgroundOptionalblurRadius of a blur filter (approximate gaussian). Maximum supported radius is 250.
OptionalborderAdds a border around the image. The border is added after resizing. Border width takes dpr into account, and can be specified either using a single width property, or individually for each side.
OptionalbottomOptionalbrightnessIncrease brightness by a factor. A value of 1.0 equals no change, a value of 0.5 equals half brightness, and a value of 2.0 equals twice as bright. 0 is ignored.
OptionalcompositeHow to combine the foreground and backdrop pixels to create the result
OptionalcontrastIncrease contrast by a factor. A value of 1.0 equals no change, a value of 0.5 equals low contrast, and a value of 2.0 equals high contrast. 0 is ignored.
OptionaldprDevice Pixel Ratio. Default 1. Multiplier for width/height that makes it
easier to specify higher-DPI sizes in .
OptionalfitResizing mode as a string. It affects interpretation of width and height options:
OptionalflipFlips the images horizontally, vertically, or both. Flipping is applied before rotation, so if you apply flip=h,rotate=90 then the image will be flipped horizontally, then rotated by 90 degrees.
OptionalgammaIncrease exposure by a factor. A value of 1.0 equals no change, a value of 0.5 darkens the image, and a value of 2.0 lightens the image. 0 is ignored.
OptionalgravityWhen cropping with fit: "cover", this defines the side or point that should be left uncropped. The value is either a string "left", "right", "top", "bottom", "auto", or "center" (the default), or an object {x, y} containing focal point coordinates in the original image expressed as fractions ranging from 0.0 (top or left) to 1.0 (bottom or right), 0.5 being the center. {fit: "cover", gravity: "top"} will crop bottom or left and right sides as necessary, but won’t crop anything from the top. {fit: "cover", gravity: {x:0.5, y:0.2}} will crop each side to preserve as much as possible around a point at 20% of the height of the source image.
OptionalheightMaximum height in image pixels. The value must be an integer.
OptionalleftOptionalopacityFloating-point number between 0 (transparent) and 1 (opaque). For example, opacity: 0.5 makes overlay semitransparent.
OptionalrepeatOptionalrightOptionalrotateNumber of degrees (90, 180, 270) to rotate the image by. width and height options refer to axes after rotation.
OptionalsaturationIncrease contrast by a factor. A value of 1.0 equals no change, a value of 0.5 equals low contrast, and a value of 2.0 equals high contrast. 0 is ignored.
OptionalsegmentImage segmentation using artificial intelligence models. Sets pixels not within selected segment area to transparent e.g "foreground" sets every background pixel as transparent.
OptionalsharpenStrength of sharpening filter to apply to the image. Floating-point number between 0 (no sharpening, default) and 10 (maximum). 1.0 is a recommended value for downscaled images.
OptionaltopPosition of the overlay image relative to a given edge. Each property is an offset in pixels. 0 aligns exactly to the edge. For example, left: 10 positions left side of the overlay 10 pixels from the left edge of the image it's drawn over. bottom: 0 aligns bottom of the overlay with bottom of the background image.
Setting both left & right, or both top & bottom is an error.
If no position is specified, the image will be centered.
OptionaltrimAllows you to trim your image. Takes dpr into account and is performed before resizing or rotation.
It can be used as:
OptionalupscaleControls the algorithm used when an image needs to be enlarged. This
parameter works with any fit mode that upscales, such as contain,
cover, and scale-up. It has no effect when fit=scale-down or when
the target dimensions are smaller than the source.
upscale is not specified.Absolute URL of the image file to use for the drawing. It can be any of the supported file formats. For drawing of watermarks or non-rectangular overlays we recommend using PNG or WebP images.
OptionalwidthMaximum width in image pixels. The value must be an integer.
OptionalzoomSpecifies how closely the image is cropped toward detected faces when combined with the gravity=face option. Accepts a valid range between 0.0 (includes as much of the background as possible) and 1.0 (crops the image as closely to the face as possible). The default is 0.
Background color to add underneath the image. Applies only to images with transparency (such as PNG). Accepts any CSS color (#RRGGBB, rgba(…), hsl(…), etc.)