Media & Canvas
Media & Canvas operators create, modify, and optimize 2D image and vector resources directly within the runtime engine pipeline.
Background Removal Operator for Image Cutouts#
1. Functional Overview
The Background Removal operator automates transparency mask generation. It accepts an input image payload, executes background removal AI calculations to isolate foreground subjects, and dispatches an alpha-channel cut PNG to showcase custom product photos.
Background Removal
BACKGROUND_REMOVALDATA_MEDIA_ITEMBackground Removal Properties Details
| Property & Type | Display Name | System Type | Default |
|---|---|---|---|
optimizedFor: string | Optimized For | STRINGDROPDOWN | "PORTRAIT" |
returnMask: boolean | Return Mask | BOOLTOGGLE | false |
cropResult: boolean | Crop Result | BOOLTOGGLE | false |
cropPaddingPercent: float | Crop Padding (%) | FLOATRANGE SLIDER | 0 |
cropToAspectRatio: boolean | Crop To Aspect Ratio | BOOLTOGGLE | false |
outputAspectRatio: float | Output Aspect Ratio | FLOATRANGE SLIDER | 1 |
@Input
| @Input & Type | Display Name | @Input Type | Group |
|---|---|---|---|
inputImage: (payload: IMediaItem) => void | Input Image | DATA_MEDIA_ITEM | AIR_PROPERTY |
@Output
| @Output & Type | Display Name | @Output Type | Group |
|---|---|---|---|
outputImage: AirEvent<IMediaItem> | Output Image | DATA_MEDIA_ITEM | AIR_PROPERTY |
onSuccess: AirEvent<void> | On Success | OPERATOR | OPERATOR |
onFailure: AirEvent<void> | On Failure | OPERATOR | OPERATOR |
Capture Texture Operator for 3D Screenshots#
1. Functional Overview
The Capture Texture operator provides on-demand frame rendering from the live 3D webGL scene. Triggering the Capture Texture @Input causes the engine to render the target mesh's active frame, encoding it into the specified file format (PNG, JPEG, WebP) with options to automatically download the result locally or feed it as a new optimized image into another pipeline component.
Capture Texture
CAPTURE_TEXTUREDATA_MEDIA_ITEMCapture Texture Properties Details
| Property & Type | Display Name | System Type | Default |
|---|---|---|---|
captureTextureTargetType: "OBJECT" | Capture Texture From | ENUMOPTION SELECTOR | "OBJECT" |
captureTextureTargetUnitId: any | Target Object | STRING_ARRAYUNIT SELECTOR | [] |
useUnitAspectRatio: boolean | Use Unit Aspect Ratio | BOOLTOGGLE | true |
maxDimensionPixels: float | Max Dimension (px) | FLOATRANGE SLIDER | 1024 |
outputWidthPixels: float | Width (px) | FLOATRANGE SLIDER | 1024 |
outputHeightPixels: float | Height (px) | FLOATRANGE SLIDER | 1024 |
mimeType: "image/png" | "image/jpeg" | "image/webp" | MIME Type | ENUMDROPDOWN | "image/png" |
webpQuality: float | WEBP Quality | FLOATRANGE SLIDER | 0.92 |
downloadOnCapture: boolean | Download On Capture | BOOLTOGGLE | false |
fileName: string | File Name | STRINGTEXT INPUT | "captured-texture.png" |
alwaysUpdate: boolean | Always Update | BOOLTOGGLE | false |
@Input
| @Input & Type | Display Name | @Input Type | Group |
|---|---|---|---|
captureTexture: () => void | Capture Texture | OPERATOR | OPERATOR |
@Output
| @Output & Type | Display Name | @Output Type | Group |
|---|---|---|---|
outputValue: AirEvent<IMediaItem> | Output Value | DATA_MEDIA_ITEM | AIR_PROPERTY |
FTP Upload Operator for Remote File Transfer#
1. Functional Overview
The FTP Upload operator integrates scenes with remote asset storage systems. It reads image files (such as product screenshots), logs into defined FTP server domains, uploads the payload, and outputs public hosting URL links.
FTP Upload
FTP_UPLOADDATA_MEDIA_ITEMFTP Upload Properties Details
| Property & Type | Display Name | System Type | Default |
|---|---|---|---|
mediaItemId: IMediaItem | File | MEDIA_ITEMELEMENT SELECTOR | "" |
configId: string | FTP Config | STRINGDROPDOWN | "TEST" |
filename: string | File Name | STRINGTEXT INPUT | "" |
remoteFolder: string | Remote Folder | STRINGTEXT INPUT | "" |
@Input
| @Input & Type | Display Name | @Input Type | Group |
|---|---|---|---|
upload: () => void | Upload | OPERATOR | OPERATOR |
cancel: () => void | Cancel | OPERATOR | OPERATOR |
@Output
| @Output & Type | Display Name | @Output Type | Group |
|---|---|---|---|
statusMessage: AirEvent<string> | Status Message | DATA_STRING | AIR_PROPERTY |
onSuccess: AirEvent<string> | On Success | DATA_STRING | AIR_PROPERTY |
onFailure: AirEvent<string> | On Failure | DATA_STRING | AIR_PROPERTY |
Image to PDF Operator for Printable Documents#
1. Functional Overview
The Image To PDF operator builds standardized reports. It reads active scene rendering frames or canvas assets, embeds them inside a PDF document layout containing customized margins, and triggers local print dialog downloads.
Image To PDF
IMAGE_TO_PDFDATA_MEDIA_ITEMImage To PDF Properties Details
| Property & Type | Display Name | System Type | Default |
|---|---|---|---|
textureMediaItemId: IMediaItem | Image | MEDIA_ITEMELEMENT SELECTOR | "" |
fileName: string | File Name | STRINGTEXT INPUT | "image.pdf" |
unit: "px" | "pt" | "mm" | "cm" | "in" | Units | ENUMDROPDOWN | "px" |
pageFormat: "auto" | "a4" | "letter" | "custom" | Page Format | ENUMDROPDOWN | "auto" |
pageWidth: float | Custom Page Width | FLOATRANGE SLIDER | 0 |
pageHeight: float | Custom Page Height | FLOATRANGE SLIDER | 0 |
autoOrientation: boolean | Auto Orientation | BOOLTOGGLE | true |
orientation: "p" | "l" | Orientation | ENUMDROPDOWN | "p" |
mode: "page" | "fit" | "fill" | "none" | Mode | ENUMDROPDOWN | "page" |
x: float | X | FLOATRANGE SLIDER | 0 |
y: float | Y | FLOATRANGE SLIDER | 0 |
width: float | Width | FLOATRANGE SLIDER | 0 |
height: float | Height | FLOATRANGE SLIDER | 0 |
dpi: float | DPI (Units per Inch) | FLOATRANGE SLIDER | 72 |
rotation: float | Rotation (°) | FLOATRANGE SLIDER | 0 |
compression: "MEDIUM" | "NONE" | "FAST" | "SLOW" | JPEG Compression | ENUMDROPDOWN | "MEDIUM" |
formatHint: "" | "JPEG" | "PNG" | "WEBP" | Format Hint | ENUMDROPDOWN | "" |
crossOrigin: "" | "anonymous" | "use-credentials" | Cross-Origin | ENUMDROPDOWN | "" |
@Input
| @Input & Type | Display Name | @Input Type | Group |
|---|---|---|---|
createPdf: () => void | Create PDF | OPERATOR | OPERATOR |
download: () => void | Download | OPERATOR | OPERATOR |
@Output
| @Output & Type | Display Name | @Output Type | Group |
|---|---|---|---|
outputPdf: AirEvent<IMediaItem> | Output PDF | DATA_MEDIA_ITEM | AIR_PROPERTY |
Image to SVG Operator for Vector Conversion#
1. Functional Overview
The Image to SVG operator traces pixel edges to build scalable shapes. It processes input bitmaps (JPEG/PNG) using customizable edge thresholds, compiling bezier vector coordinates, and outputs scalable SVG graphic assets.
Image to SVG
IMAGE_TO_SVGDATA_MEDIA_ITEMImage to SVG Properties Details
| Property & Type | Display Name | System Type | Default |
|---|---|---|---|
textureMediaItemId: IMediaItem | Image | MEDIA_ITEMELEMENT SELECTOR | "" |
convertOnChange: boolean | Convert On Change | BOOLTOGGLE | false |
pathColor: IColor | Path Color | COLORCOLOR PICKER | "#FFFFFF" |
outlineOnly: boolean | Outline Only | BOOLTOGGLE | true |
outlineWidth: float | Outline Width (px) | FLOATRANGE SLIDER | 1 |
mode: "spline" | "polygon" | "none" | Curve Mode | ENUMDROPDOWN | "spline" |
cornerThresholdDegrees: int | Corner Threshold (°) | INTRANGE SLIDER | 60 |
lengthThreshold: float | Segment Length (px) | FLOATRANGE SLIDER | 4 |
maxIterations: int | Max Iterations | INTRANGE SLIDER | 10 |
spliceThresholdDegrees: int | Splice Threshold (°) | INTRANGE SLIDER | 45 |
filterSpeckle: int | Filter Speckle (px) | INTRANGE SLIDER | 4 |
invert: boolean | Invert Image | BOOLTOGGLE | false |
@Input
| @Input & Type | Display Name | @Input Type | Group |
|---|---|---|---|
convert: () => void | Convert | OPERATOR | OPERATOR |
download: () => void | Download | OPERATOR | OPERATOR |
@Output
| @Output & Type | Display Name | @Output Type | Group |
|---|---|---|---|
outputSvg: AirEvent<IMediaItem> | Output SVG | DATA_MEDIA_ITEM | AIR_PROPERTY |
onSuccess: AirEvent<void> | On Success | OPERATOR | OPERATOR |
onFailure: AirEvent<void> | On Failure | OPERATOR | OPERATOR |
Posterization Texture Operator for Color Bands#
1. Functional Overview
The Posterization Texture operator reduces the unique colors in an input image down to a specified maximum count, creating a stylized posterized effect. It achieves this color-squishing process using K-Means clustering on the color space of the image.
2. Properties
- Image (
textureMediaItemId): The source image asset to posterize.
- Convert On Change (
convertOnChange): Toggle to automatically trigger the posterization process whenever the input image or settings change.
- Max Colors (
maxColors): The maximum number of color bands to extract from the image using K-Means clustering (range: 2 to 32, default: 8).
- Bit Depth (
bitDepth): The bit depth for the initial color quantization (8 - depth) before running clustering (range: 1 to 8, default: 5).
- Max Iterations (
maxIterations): The maximum number of K-Means clustering iterations to run for color grouping (range: 1 to 50, default: 10).
3. Actions & Triggers
- Actions:
Convert: Manually dispatches the posterization computation.
Set Output Colors: Manually updates the output colors.
- Triggers:
Output Texture: Dispatches the stylized, posterized output image.
Analysis Colors: Emits the list/palette of extracted colors as a data block.
On Success: Fires when the posterization finishes successfully.
On Failure: Fires if there is an error during processing.
Posterization Texture
POSTERIZATION_TEXTUREDATA_MEDIA_ITEMPosterization Texture Properties Details
| Property & Type | Display Name | System Type | Default |
|---|---|---|---|
textureMediaItemId: IMediaItem | Image | MEDIA_ITEMELEMENT SELECTOR | "" |
convertOnChange: boolean | Convert On Change | BOOLTOGGLE | true |
maxDimension: int | Max Dimension | INTRANGE SLIDER | 512 |
resizeTexture: boolean | Resize Texture | BOOLTOGGLE | true |
maxColors: int | Max Colors | INTRANGE SLIDER | 8 |
bitDepth: int | Bit Depth | INTRANGE SLIDER | 8 |
maxIterations: int | Max Iterations | INTRANGE SLIDER | 10 |
autoDetectColors: boolean | Auto Detect Colors | BOOLTOGGLE | true |
minColorRatio: float | Min Color Ratio | FLOATRANGE SLIDER | 0.015 |
colorMergeThreshold: int | Color Merge Threshold | INTRANGE SLIDER | 30 |
usePerceptualColorDistance: boolean | Use Perceptual Distance | BOOLTOGGLE | true |
useKMeansPlusPlus: boolean | K-Means++ Initialization | BOOLTOGGLE | true |
enableAlphaErosion: boolean | Enable Alpha Erosion | BOOLTOGGLE | true |
alphaErosionThreshold: int | Alpha Erosion Threshold | INTRANGE SLIDER | 250 |
autoBakeBlob: boolean | Auto Bake Blob | BOOLTOGGLE | true |
enableEdgeMasking: boolean | Enable Edge Masking | BOOLTOGGLE | true |
edgeGradientThreshold: int | Edge Gradient Threshold | INTRANGE SLIDER | 20 |
@Input
| @Input & Type | Display Name | @Input Type | Group |
|---|---|---|---|
convert: (payload: IMediaItem) => void | Convert | DATA_MEDIA_ITEM | AIR_PROPERTY |
bakeBlob: (payload: IMediaItem) => void | Bake Blob | DATA_MEDIA_ITEM | AIR_PROPERTY |
analyze: () => void | Analyze | OPERATOR | OPERATOR |
setOutputColors: (payload: DataBlock[]) => void | Set Output Colors | DATA_BLOCK | DATA_BLOCK |
@Output
| @Output & Type | Display Name | @Output Type | Group |
|---|---|---|---|
outputTexture: AirEvent<IMediaItem> | Output Texture | DATA_MEDIA_ITEM | AIR_PROPERTY |
analysisColors: AirEvent<DataBlock[]> | Analysis Colors | DATA_BLOCK | DATA_BLOCK |
analysisColorCount: AirEvent<int> | Analysis Color Count | DATA_INT | AIR_PROPERTY |
onSuccess: AirEvent<void> | On Success | OPERATOR | OPERATOR |
onFailure: AirEvent<void> | On Failure | OPERATOR | OPERATOR |
Text Image Operator for Dynamic Canvas Decals#
1. Functional Overview
The Text Image operator generates high-quality text canvas decals programmatically. It consumes custom string variables on its Text input, formats it using detailed typography configurations (textColor, backgroundColor, fontFamily, fontSize, textAlign), and outputs a composite 2D image asset through Output Image to be mapped onto 3D models.
Text Image
TEXT_IMAGEDATA_MEDIA_ITEMText Image Properties Details
| Property & Type | Display Name | System Type | Default |
|---|---|---|---|
textValue: string | Text | STRINGTEXT INPUT | "New text" |
generateOnStart: boolean | Generate on Start | BOOLTOGGLE | false |
autoBakeBlob: boolean | Auto Bake Blob | BOOLTOGGLE | true |
fontSize: float | fontSize | FLOATTEXT INPUT | 128 |
fontSizeUnit: "px" | "rem" | fontSizeUnit | ENUMDROPDOWN | "px" |
renderHeight: float | Render Height | FLOATTEXT INPUT | 512 |
renderWidth: float | Render Width | FLOATTEXT INPUT | 1024 |
textColor: IColor | Text Color | COLORCOLOR PICKER | [1, 1, 1, 1] |
backgroundColor: IColor | Background Color | COLORCOLOR PICKER | [0, 0, 0, 0] |
fontFamily: any | Font family | NONEFONT SELECTOR | {fontMediaItemId: 3662a206-5bc6-4de7-b4ac-9cacda5b5f85, variantName: regular} |
textDirection: "left-to-right" | "top-to-bottom" | "right-to-left" | "bottom-to-top" | Direction | ENUMDROPDOWN | "left-to-right" |
verticalAlign: "top" | "middle" | "bottom" | Vertical Alignment | ENUMDROPDOWN | "middle" |
textAlign: any | Align | NONETOGGLE BUTTON | "center" |
fontStyle: any | Italic | NONETOGGLE BUTTON | "normal" |
textDecorationUnderline: any | Underline | NONETOGGLE BUTTON | "none" |
textDecoration: any | Strikethrough | NONETOGGLE BUTTON | "none" |
letterSpacing: float | Letter | FLOATTEXT INPUT | 0 |
letterSpacingUnit: "px" | "em" | letterSpacingUnit | ENUMDROPDOWN | "px" |
lineHeight: float | Line | FLOATTEXT INPUT | 1 |
lineHeightUnit: "px" | "em" | "%" | lineHeightUnit | ENUMDROPDOWN | "px" |
@Input
| @Input & Type | Display Name | @Input Type | Group |
|---|---|---|---|
bakeBlob: (payload: IMediaItem) => void | Bake Blob | DATA_MEDIA_ITEM | AIR_PROPERTY |
@Output
| @Output & Type | Display Name | @Output Type | Group |
|---|---|---|---|
outputImage: AirEvent<float> | Output Image | DATA_FLOAT | AIR_PROPERTY |
onChange: AirEvent<float> | On Change | DATA_FLOAT | AIR_PROPERTY |
Tiled Texture Operator for Surface Pattern UVs#
1. Functional Overview
The Tiled Texture operator scales repeating patterns on 3D models. It intercepts image assets, applying multiplication factors to the UV coordinates on X/Y axes. Designers configure repeats, margins, and borders to display high-resolution repeated finishes (e.g. fabrics, brickwork).
Tiled Texture
TILED_TEXTUREDATA_MEDIA_ITEMTiled Texture Properties Details
| Property & Type | Display Name | System Type | Default |
|---|---|---|---|
imageTexture: IMediaItem | Texture | MEDIA_ITEMELEMENT SELECTOR | "" |
color: IColor | Color | COLORCOLOR PICKER | [1, 1, 1, 1] |
colorMix: float | Color Mix | FLOATRANGE SLIDER | 0 |
wrappingType: "REPEAT" | "CLAMP" | "MIRROR" | Wrapping | ENUMDROPDOWN | "REPEAT" |
xRepeats: float | Repeats (X) | FLOATRANGE SLIDER | 4 |
yRepeats: float | Repeats (Y) | FLOATRANGE SLIDER | 4 |
offsetX: float | Offset (X) | FLOATRANGE SLIDER | 0 |
offsetY: float | Offset (Y) | FLOATRANGE SLIDER | 0 |
matchTextureSize: boolean | Match Texture Size | BOOLTOGGLE | true |
outputWidthPixels: float | Width (px) | FLOATRANGE SLIDER | 1024 |
outputHeightPixels: float | Height (px) | FLOATRANGE SLIDER | 1024 |
@Output
| @Output & Type | Display Name | @Output Type | Group |
|---|---|---|---|
outputImage: AirEvent<IMediaItem> | Output Image | DATA_MEDIA_ITEM | AIR_PROPERTY |