Class ImageRef

Optional ReadonlyuniqueId

buffer

• get buffer(): string | undefined

  Returns string | undefined

clear

• clear(): Promise<void>

  Releases native resources stored by the ref. If two different ImageRef objects have the same uniqueId both of them become cleared. If uniqueId is not set or the image is already released, an exception will be thrown.

  Returns Promise<void>

encodeImage

• encodeImage(options?: EncodeImageOptions): Promise<string | null>

  Returns the stored image as base64.

  Parameters

  • Optionaloptions: EncodeImageOptions

  Returns Promise<string | null>

encodeInPlace

• encodeInPlace(): Promise<void>

  Encode image.

  Returns Promise<void>

hibernate

• hibernate(): Promise<void>

  Compresses ImageRef and stores it either on disk or in memory according to global settings. If uniqueId is not set or the image is already released, an exception will be thrown.

  Returns Promise<void>

info

• info(): Promise<ImageInfo | null>

  Information about stored image as reference. If uniqueId is not set or the image is already released, an exception will be thrown.

  Returns Promise<ImageInfo | null>

release

• release(): void

  Releases strong reference to the image. If uniqueId to the image is not set, an exception will be thrown.

  Returns void

saveImage

• saveImage(path: string, options?: SaveImageOptions): Promise<boolean>

  Saves the stored image with the given options. If uniqueId is not set or the image is already released, an exception will be thrown.

  Parameters

  • path: string
  • Optionaloptions: SaveImageOptions

  Returns Promise<boolean>

serialize

• serialize(
      imageSerializationMode: ImageSerializationMode,
  ): Promise<
      | {
          buffer?: string;
          clear?: () => Promise<void>;
          encodeImage?: (options?: EncodeImageOptions) => Promise<string | null>;
          encodeInPlace?: () => Promise<void>;
          hibernate?: () => Promise<void>;
          info?: () => Promise<ImageInfo | null>;
          isRetained?: () => boolean;
          release?: () => void;
          retain?: () => void;
          saveImage?: (path: string, options?: SaveImageOptions) => Promise<boolean>;
          serialize?: (
              imageSerializationMode: ImageSerializationMode,
          ) => Promise<({ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<...>) | undefined; ... 8 more ...; retain?: (() => void) | undefined; } & {}) | null>;
          uniqueId?: string;
      } & {}
      | null,
  >

  Converts the Image Ref to Json representation

  Parameters

  • imageSerializationMode: ImageSerializationMode

  Returns Promise<
      | {
          buffer?: string;
          clear?: () => Promise<void>;
          encodeImage?: (options?: EncodeImageOptions) => Promise<string | null>;
          encodeInPlace?: () => Promise<void>;
          hibernate?: () => Promise<void>;
          info?: () => Promise<ImageInfo | null>;
          isRetained?: () => boolean;
          release?: () => void;
          retain?: () => void;
          saveImage?: (path: string, options?: SaveImageOptions) => Promise<boolean>;
          serialize?: (
              imageSerializationMode: ImageSerializationMode,
          ) => Promise<({ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<...>) | undefined; ... 8 more ...; retain?: (() => void) | undefined; } & {}) | null>;
          uniqueId?: string;
      } & {}
      | null,
  >

Staticdeserialize

• deserialize(
      serializedRef: {
          buffer?: string;
          clear?: () => Promise<void>;
          encodeImage?: (options?: EncodeImageOptions) => Promise<string | null>;
          encodeInPlace?: () => Promise<void>;
          hibernate?: () => Promise<void>;
          info?: () => Promise<ImageInfo | null>;
          isRetained?: () => boolean;
          release?: () => void;
          retain?: () => void;
          saveImage?: (path: string, options?: SaveImageOptions) => Promise<boolean>;
          serialize?: (
              imageSerializationMode: ImageSerializationMode,
          ) => Promise<
              | {
                  buffer?: string;
                  clear?: () => Promise<void>;
                  encodeImage?: (options?: EncodeImageOptions) => Promise<(...) | (...)>;
                  encodeInPlace?: () => Promise<void>;
                  hibernate?: () => Promise<void>;
                  info?: () => Promise<(...) | (...)>;
                  isRetained?: () => boolean;
                  release?: () => void;
                  retain?: () => void;
                  saveImage?: (
                      path: string,
                      options?: SaveImageOptions,
                  ) => Promise<boolean>;
                  serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<({ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ... | undefined; ... 8 more ...; retain?: (() => void) | undefined; } & {}) | null>) | undefined;
                  uniqueId?: string;
              } & {}
              | null,
          >;
          uniqueId?: string;
      },
  ): ImageRef

  Parameters

  • serializedRef: {
        buffer?: string;
        clear?: () => Promise<void>;
        encodeImage?: (options?: EncodeImageOptions) => Promise<string | null>;
        encodeInPlace?: () => Promise<void>;
        hibernate?: () => Promise<void>;
        info?: () => Promise<ImageInfo | null>;
        isRetained?: () => boolean;
        release?: () => void;
        retain?: () => void;
        saveImage?: (path: string, options?: SaveImageOptions) => Promise<boolean>;
        serialize?: (
            imageSerializationMode: ImageSerializationMode,
        ) => Promise<
            | {
                buffer?: string;
                clear?: () => Promise<void>;
                encodeImage?: (options?: EncodeImageOptions) => Promise<(...) | (...)>;
                encodeInPlace?: () => Promise<void>;
                hibernate?: () => Promise<void>;
                info?: () => Promise<(...) | (...)>;
                isRetained?: () => boolean;
                release?: () => void;
                retain?: () => void;
                saveImage?: (
                    path: string,
                    options?: SaveImageOptions,
                ) => Promise<boolean>;
                serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<({ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ... | undefined; ... 8 more ...; retain?: (() => void) | undefined; } & {}) | null>) | undefined;
                uniqueId?: string;
            } & {}
            | null,
        >;
        uniqueId?: string;
    }

    • Optionalbuffer?: string

    • Optionalclear?: () => Promise<void>

    • OptionalencodeImage?: (options?: EncodeImageOptions) => Promise<string | null>

    • OptionalencodeInPlace?: () => Promise<void>

    • Optionalhibernate?: () => Promise<void>

    • Optionalinfo?: () => Promise<ImageInfo | null>

    • OptionalisRetained?: () => boolean

    • Optionalrelease?: () => void

    • Optionalretain?: () => void

    • OptionalsaveImage?: (path: string, options?: SaveImageOptions) => Promise<boolean>

    • Optionalserialize?: (
          imageSerializationMode: ImageSerializationMode,
      ) => Promise<
          | {
              buffer?: string;
              clear?: () => Promise<void>;
              encodeImage?: (options?: EncodeImageOptions) => Promise<(...) | (...)>;
              encodeInPlace?: () => Promise<void>;
              hibernate?: () => Promise<void>;
              info?: () => Promise<(...) | (...)>;
              isRetained?: () => boolean;
              release?: () => void;
              retain?: () => void;
              saveImage?: (path: string, options?: SaveImageOptions) => Promise<boolean>;
              serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<({ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ... | undefined; ... 8 more ...; retain?: (() => void) | undefined; } & {}) | null>) | undefined;
              uniqueId?: string;
          } & {}
          | null,
      >

    • Optional ReadonlyuniqueId?: string

  Returns ImageRef

Staticfrom

• from(
      source: {
          buffer?: string;
          clear?: () => Promise<void>;
          encodeImage?: (options?: EncodeImageOptions) => Promise<string | null>;
          encodeInPlace?: () => Promise<void>;
          hibernate?: () => Promise<void>;
          info?: () => Promise<ImageInfo | null>;
          isRetained?: () => boolean;
          release?: () => void;
          retain?: () => void;
          saveImage?: (path: string, options?: SaveImageOptions) => Promise<boolean>;
          serialize?: (
              imageSerializationMode: ImageSerializationMode,
          ) => Promise<
              | {
                  buffer?: string;
                  clear?: () => Promise<void>;
                  encodeImage?: (options?: EncodeImageOptions) => Promise<(...) | (...)>;
                  encodeInPlace?: () => Promise<void>;
                  hibernate?: () => Promise<void>;
                  info?: () => Promise<(...) | (...)>;
                  isRetained?: () => boolean;
                  release?: () => void;
                  retain?: () => void;
                  saveImage?: (
                      path: string,
                      options?: SaveImageOptions,
                  ) => Promise<boolean>;
                  serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<({ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ... | undefined; ... 8 more ...; retain?: (() => void) | undefined; } & {}) | null>) | undefined;
                  uniqueId?: string;
              } & {}
              | null,
          >;
          uniqueId?: string;
      },
  ): ImageRef

  Parameters

  • source: {
        buffer?: string;
        clear?: () => Promise<void>;
        encodeImage?: (options?: EncodeImageOptions) => Promise<string | null>;
        encodeInPlace?: () => Promise<void>;
        hibernate?: () => Promise<void>;
        info?: () => Promise<ImageInfo | null>;
        isRetained?: () => boolean;
        release?: () => void;
        retain?: () => void;
        saveImage?: (path: string, options?: SaveImageOptions) => Promise<boolean>;
        serialize?: (
            imageSerializationMode: ImageSerializationMode,
        ) => Promise<
            | {
                buffer?: string;
                clear?: () => Promise<void>;
                encodeImage?: (options?: EncodeImageOptions) => Promise<(...) | (...)>;
                encodeInPlace?: () => Promise<void>;
                hibernate?: () => Promise<void>;
                info?: () => Promise<(...) | (...)>;
                isRetained?: () => boolean;
                release?: () => void;
                retain?: () => void;
                saveImage?: (
                    path: string,
                    options?: SaveImageOptions,
                ) => Promise<boolean>;
                serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<({ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ... | undefined; ... 8 more ...; retain?: (() => void) | undefined; } & {}) | null>) | undefined;
                uniqueId?: string;
            } & {}
            | null,
        >;
        uniqueId?: string;
    }

    • Optionalbuffer?: string

    • Optionalclear?: () => Promise<void>

    • OptionalencodeImage?: (options?: EncodeImageOptions) => Promise<string | null>

    • OptionalencodeInPlace?: () => Promise<void>

    • Optionalhibernate?: () => Promise<void>

    • Optionalinfo?: () => Promise<ImageInfo | null>

    • OptionalisRetained?: () => boolean

    • Optionalrelease?: () => void

    • Optionalretain?: () => void

    • OptionalsaveImage?: (path: string, options?: SaveImageOptions) => Promise<boolean>

    • Optionalserialize?: (
          imageSerializationMode: ImageSerializationMode,
      ) => Promise<
          | {
              buffer?: string;
              clear?: () => Promise<void>;
              encodeImage?: (options?: EncodeImageOptions) => Promise<(...) | (...)>;
              encodeInPlace?: () => Promise<void>;
              hibernate?: () => Promise<void>;
              info?: () => Promise<(...) | (...)>;
              isRetained?: () => boolean;
              release?: () => void;
              retain?: () => void;
              saveImage?: (path: string, options?: SaveImageOptions) => Promise<boolean>;
              serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<({ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ... | undefined; ... 8 more ...; retain?: (() => void) | undefined; } & {}) | null>) | undefined;
              uniqueId?: string;
          } & {}
          | null,
      >

    • Optional ReadonlyuniqueId?: string

  Returns ImageRef

StaticfromEncodedBuffer

• fromEncodedBuffer(
      buffer: string,
      options?: BufferImageLoadOptions,
  ): Promise<ImageRef | null>

  Creates ImageRef with uniqueId from base64 encoded buffer, e.g. from jpeg.

  Parameters

  • buffer: string
  • Optionaloptions: BufferImageLoadOptions

  Returns Promise<ImageRef | null>

StaticfromImageFileUri

• fromImageFileUri(
      uri: string,
      options?: PathImageLoadOptions,
  ): Promise<ImageRef | null>

  Creates ImageRef with uniqueId from the file uri to an image.

  Parameters

  • uri: string
  • Optionaloptions: PathImageLoadOptions

  Returns Promise<ImageRef | null>

StaticmakeSnapshot

• makeSnapshot(): Promise<ImageRefPoolSnapshot | null>

  Returns a snapshot of all alive ImageRefs. The snapshot contains a list of ImageRefs with information such as in-memory size.

  Returns Promise<ImageRefPoolSnapshot | null>

StaticreleaseAll

• releaseAll(): void

  Releases all alive images despite any existing references.

  Returns void