photoeditorsdk/types/configuration/engine/index.d.ts

The most comprehensive photo editor SDK for HTML5

import { Color } from '../../common/color';
import { WatermarkConfiguration } from '../feature/watermark';
import { AssetProvider } from './assetProvider';
import { ImageDownscaleOptions } from './downscaleOptions';
export type CrossOriginType = 'anonymous' | 'use-credentials' | '';
/**
 * Configuration options which have to be provided when creating a new Engine.
 */
export interface EngineConfiguration {
    /**
     * The PESDK license. If no license (or an invalid license) is provided, the
     * engine will render a watermark over the preview and export output.
     */
    license: string;
    /**
     * Specifies which cross origin flag is set when resources are loaded.
     */
    crossOrigin?: CrossOriginType;
    /**
     * Specifies the conditions under which the input image should be downscaled
     * by the image.
     */
    downscaleOptions?: ImageDownscaleOptions;
    /**
     * @ignore
     * The asset provider which the engine should use to load all assets.
     */
    assetProvider?: AssetProvider;
    /**
     * Specifies the preferred renderer for the engine.
     * WebGL will result in the best performance and Canvas should only be used if WebGL is not available
     */
    preferredRenderer?: 'webgl' | 'canvas';
    /**
     * color is represented as a number array which encodes as a single gray value or a RGB(A) tuple of floating point values where
     * each channel is defined in the range of `[0, 1]
     */
    backgroundColor?: Color;
    watermark?: WatermarkConfiguration;
}