@itwin/core-common/lib/esm/Thumbnail.d.ts

iTwin.js components common to frontend and backend

/** @packageDocumentation
 * @module Rendering
 */
/** Metadata about a thumbnail image. Often this is redundant with information in the image itself, but is held
 * outside of the image so it can be obtained without having to decode the image data.
 * @see [[ThumbnailProps]]
 * @public
 * @extensions
 */
export interface ThumbnailFormatProps {
    /** X size of the image, in pixels. */
    width: number;
    /** Y size of image, in pixels. */
    height: number;
    /** Encoding of the image */
    format: "jpeg" | "png";
}
/** Describes a thumbnail image for an [[IModel]] or [ViewDefinition]($backend).
 * @see [IModelDb.Views.getThumbnail]($backend)
 * @public
 * @extensions
 */
export interface ThumbnailProps extends ThumbnailFormatProps {
    /** The image encoded as specified by [[ThumbnailFormatProps.format]]. */
    image: Uint8Array;
}
//# sourceMappingURL=Thumbnail.d.ts.map