Composite Imaging - Usage with layers
background-color can be used with and without addressing a specific, named layer.
However, based on the operations performed on the implicit
base layer,
background-color's behaviour can help achieve additional effects in the composite images.
Certain operations can introduce transparent pixels (padding,
see fit) beyond the bounds of the image that forms the
base layer. In such cases, specifying
background-color without any layer qualifier allows specifying the color to apply to the padding.
More concretely:
background-color=rgb,ff0000: apply saturated red to the background of the base layer, including padding beyond the bounding-box of the base layer.
background-color[base]=rgb,ff0000: apply saturated red to the background of the base layer, but only within the bounding-box of the base layer and exclude any padding from being affected by the operation.
Examples without layer name:
- `background-color=gray,7F` - Gray color
- `background-color=graya,7FFF` - Gray color with alpha
- `background-color=rgb,808080` - RGB color
- `background-color=rgba,32808080` - RGB color with alpha
Examples with layer name:
- `background-color[layerName]=gray,7F` - Gray color for specific layer
- `background-color[layerName]=graya,7FFF` - Gray color with alpha for specific layer
- `background-color[layerName]=rgb,808080` - RGB color for specific layer
- `background-color[layerName]=rgba,32808080` - RGB color with alpha for specific layer
explode: false
style: form
schema:
oneOf:
- $ref: '#/components/schemas/ColorFormatString'
- type: object
properties:
layerName:
$ref: '#/components/schemas/ColorFormatString'
ForegroundColor:
in: query
name: foreground-color
description: |
Specifies the foreground color for the image or selected layer.
This operation takes following parameter values:
|Parameter|Description|
|---|---|
|`colorspace` (Mandatory)|One of the supported colorspaces, with or without alpha|
|`color-value` (Mandatory)|A color value corresponding to the specified colorspace, specified in hexadecimal|
Defaults to fully transparent.
Examples without layer name:
- `foreground-color=gray,7F` - Gray color
- `foreground-color=graya,7FFF` - Gray color with alpha
- `foreground-color=rgb,808080` - RGB color
- `foreground-color=rgba,32808080` - RGB color with alpha
Examples with layer name:
- `foreground-color[layerName]=gray,7F` - Gray color for specific layer
- `foreground-color[layerName]=graya,7FFF` - Gray color with alpha for specific layer
- `foreground-color[layerName]=rgb,808080` - RGB color for specific layer
- `foreground-color[layerName]=rgba,32808080` - RGB color with alpha for specific layer
explode: false
style: form
schema:
oneOf:
- $ref: '#/components/schemas/ColorFormatString'
- type: object
properties:
layerName:
$ref: '#/components/schemas/ColorFormatString'
AutoFormat:
in: query
name: auto-format
description: |
Controls the behaviour of browser format conversion for Smart Imaging capabilities. When `auto-format` is `true`, the requested `format` is ignored and a web-optimized format based on image-characteristics, browser capabilities, and [license-entitlement](https://experienceleague.adobe.com/en/docs/experience-manager-cloud-service/content/assets/dynamicmedia/dm-prime-ultimate) is selected automatically.
The default value is `true`, which enables automatic format conversion. This can be disabled by specifying `auto-format` as `false`, in which case the requested output-format will be returned.
For example,
- When `true`, an `avif` output is delivered (if the browser supports `avif` and the license-entitlements allow it), even when the requested format is `jpeg`.
- When `true`, a `webp` output is delivered if the browser doesn't support `avif`, but does support `webp`, even when the requested format is `jpeg`.
- When `true`, a `jpeg` output is delivered if the browser doesn't support `avif` or `webp` and the image doesn't have an alpha channel (transparency), even when the requested format is `avif`.
- When `false`, a `jpeg` output is delivered (irrespective of the browser capabilities and license-entitlements) when the requested format is `jpeg`.
Examples:
- `auto-format=true` - Enable browser format conversion (default)
- `auto-format=false` - Disable browser format conversion
schema:
type: boolean
UnsharpMask:
in: query
name: unsharp-mask
description: |
Applies an