Functions

说明：

本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import { image } from '@kit.ImageKit';

image.createPicture¹³⁺

createPicture(mainPixelmap : PixelMap): Picture

通过主图的pixelmap创建一个Picture对象。

由于图片占用内存较大，所以当Picture对象使用完成后，应主动调用release方法及时释放内存。释放时应确保该对象的所有异步方法均执行完成，且后续不再使用该对象。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
mainPixelmap	PixelMap	是	主图的pixelmap。

返回值：

类型	说明
Picture	返回Picture对象。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档。

错误码ID	错误信息
401	Parameter error.Possible causes:1.Mandatory parameters are left unspecified.2.Incorrect parameter types.3.Parameter verification failed.

示例：

async function CreatePicture(context: Context) {
  const resourceMgr = context.resourceManager;
  const rawFile = await resourceMgr.getRawFileContent("test.jpg");
  let ops: image.SourceOptions = {
    sourceDensity: 98,
  }
  let imageSource: image.ImageSource = image.createImageSource(rawFile.buffer as ArrayBuffer, ops);
  let commodityPixelMap: image.PixelMap = await imageSource.createPixelMap();
  let pictureObj: image.Picture = image.createPicture(commodityPixelMap);
  if (pictureObj != null) {
    console.info('Succeeded in creating picture');
  } else {
    console.error('Failed to create picture');
  }
}

image.createPictureFromParcel¹³⁺

createPictureFromParcel(sequence: rpc.MessageSequence): Picture

从MessageSequence中获取Picture。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
sequence	rpc.MessageSequence	是	保存有Picture信息的MessageSequence。

返回值：

类型	说明
Picture	返回Picture对象。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档和Image错误码。

错误码ID	错误信息
401	Parameter error.Possible causes:1.Mandatory parameters are left unspecified.2.Incorrect parameter types.3.Parameter verification failed.
62980097	IPC error. Possible cause: 1.IPC communication failed. 2. Image upload exception. 3. Decode process exception. 4. Insufficient memory.

示例：

import { rpc } from '@kit.IPCKit';
import { BusinessError } from '@kit.BasicServicesKit';

class MySequence implements rpc.Parcelable {
  picture: image.Picture | null = null;
  constructor(conPicture: image.Picture) {
    this.picture = conPicture;
  }
  marshalling(messageSequence: rpc.MessageSequence) {
    if(this.picture != null) {
      this.picture.marshalling(messageSequence);
      console.info('Succeeded in marshalling.');
      return true;
    } else {
      console.error('Failed to marshall.');
      return false;
    }
  }
  unmarshalling(messageSequence : rpc.MessageSequence) {
    this.picture = image.createPictureFromParcel(messageSequence);
    this.picture.getMainPixelmap().getImageInfo().then((imageInfo : image.ImageInfo) => {
      console.info(`Unmarshalling to get mainPixelmap information height:${imageInfo.size.height} width:${imageInfo.size.width}`);
    }).catch((error: BusinessError) => {
      console.error(`Unmarshalling failed error.code: ${error.code} ,error.message: ${error.message}`);
    });
    return true;
  }
}

async function Marshalling_UnMarshalling(context: Context) {
  const resourceMgr = context.resourceManager;
  const rawFile = await resourceMgr.getRawFileContent("test.jpg");
  let ops: image.SourceOptions = {
    sourceDensity: 98,
  }
  let imageSource: image.ImageSource = image.createImageSource(rawFile.buffer as ArrayBuffer, ops);
  let commodityPixelMap: image.PixelMap = await imageSource.createPixelMap();
  let pictureObj: image.Picture = image.createPicture(commodityPixelMap);
  if (pictureObj != null) {
    let parcelable: MySequence = new MySequence(pictureObj);
    let data: rpc.MessageSequence = rpc.MessageSequence.create();
    // 序列化。
    data.writeParcelable(parcelable);
    let ret: MySequence = new MySequence(pictureObj);
    // 反序列化。
    data.readParcelable(ret);
  } else {
    console.error('PictureObj is null');
  }
}

image.createPixelMapFromPixels

createPixelMapFromPixels(pixels: ArrayBuffer, param: InitializationOptions): Promise<PixelMap>

通过像素数据和图像属性创建PixelMap。传入的像素数据会进行拷贝并转换为InitializationOptions.pixelFormat指定的像素格式，用于初始化PixelMap的像素。使用Promise异步回调。

说明：

此接口不支持创建以下像素格式的PixelMap：RGBA_1010102、YCBCR_P010、YCRCB_P010和ASTC_4x4。

由于图片占用内存较大，所以当PixelMap对象使用完成后，应主动调用release方法及时释放内存。释放时应确保该对象的所有异步方法均执行完成，且后续不再使用该对象。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

卡片能力： 从API版本26.0.0开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API版本26.0.0开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
pixels	ArrayBuffer	是	图像像素数据的缓冲区，用于初始化PixelMap的像素。缓冲区的像素格式需要由InitializationOptions.srcPixelFormat指定，否则默认缓冲区的像素格式为BGRA_8888。说明：缓冲区长度为：width * height * 单位像素字节数。
param	InitializationOptions	是	创建图像的属性，包括尺寸、像素格式、透明度类型、缩放模式和是否可编辑。说明：如果像素格式被指定为ASTC_4x4，将使用该类型中定义的默认像素格式。

返回值：

类型	说明
Promise<PixelMap>	Promise对象，返回创建的PixelMap。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
7600206	Invalid parameter. Possible cause: Size of the pixel data buffer does not match InitializationOptions.size.
7600207	Unsupported pixel format.
7600301	Failed to allocate memory. Possible causes: 1. The resulting PixelMap size is too large. 2. The system is out of memory.
7600305	Failed to create the PixelMap. Possible causes: 1. Failed to perform pixel format conversion. 2. Internal data is corrupted. Please check the logs for detailed information.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

function DemoCreatePixelMapFromPixels() {
  const size: image.Size = {
    width: 6,
    height: 4
  };
  const pixels = new ArrayBuffer(size.width * size.height * 4); // 4为RGBA类型像素格式的单位像素字节数。
  const pixelsArr = new Uint8Array(pixels);
  for (let i = 0; i < pixelsArr.length; i += 4) {
    // RGBA_8888格式下，下列数组索引依次为：R通道、G通道、B通道、A通道。
    pixelsArr[i] = 0xFF;
    pixelsArr[i + 1] = 0x00;
    pixelsArr[i + 2] = 0x00;
    pixelsArr[i + 3] = 0xFF;
  }
  const config: image.InitializationOptions = {
    size,
    srcPixelFormat: image.PixelMapFormat.RGBA_8888, // 缓冲区内的源像素数据的像素格式。
    pixelFormat: image.PixelMapFormat.RGBA_8888, // 新创建的PixelMap的像素格式。
    editable: true
  };

  image.createPixelMapFromPixels(pixels, config)
    .then((pixelMap: image.PixelMap) => {
      console.info('创建PixelMap成功。');
    }).catch((e: BusinessError) => {
      console.error(`创建PixelMap失败。错误码：${e.code} 错误信息：${e.message}`);
    });
}

image.createPixelMapFromPixelsSync

createPixelMapFromPixelsSync(pixels: ArrayBuffer, param: InitializationOptions): PixelMap

通过像素数据和图像属性创建PixelMap。传入的像素数据会进行拷贝并转换为InitializationOptions.pixelFormat指定的像素格式，用于初始化PixelMap的像素。

说明：

此接口不支持创建以下像素格式的PixelMap：RGBA_1010102、YCBCR_P010、YCRCB_P010和ASTC_4x4。

由于图片占用内存较大，所以当PixelMap对象使用完成后，应主动调用release方法及时释放内存。释放时应确保该对象的所有异步方法均执行完成，且后续不再使用该对象。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

卡片能力： 从API版本26.0.0开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API版本26.0.0开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
pixels	ArrayBuffer	是	图像像素数据的缓冲区，用于初始化PixelMap的像素。缓冲区的像素格式需要由InitializationOptions.srcPixelFormat指定，否则默认缓冲区的像素格式为BGRA_8888。说明：缓冲区长度为：width * height * 单位像素字节数。
param	InitializationOptions	是	创建图像的属性，包括尺寸、像素格式、透明度类型、缩放模式和是否可编辑。说明：如果像素格式被指定为ASTC_4x4，将使用该类型中定义的默认像素格式。

返回值：

类型	说明
PixelMap	返回创建的PixelMap。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
7600206	Invalid parameter. Possible cause: Size of the pixel data buffer does not match InitializationOptions.size.
7600207	Unsupported pixel format.
7600301	Failed to allocate memory. Possible causes: 1. The resulting PixelMap size is too large. 2. The system is out of memory.
7600305	Failed to create the PixelMap. Possible causes: 1. Failed to perform pixel format conversion. 2. Internal data is corrupted. Please check the logs for detailed information.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

function DemoCreatePixelMapFromPixelsSync() {
  const size: image.Size = {
    width: 6,
    height: 4
  };
  const pixels = new ArrayBuffer(size.width * size.height * 4); // 4为RGBA类型像素格式的单位像素字节数。
  const pixelsArr = new Uint8Array(pixels);
  for (let i = 0; i < pixelsArr.length; i += 4) {
    // RGBA_8888格式下，下列数组索引依次为：R通道、G通道、B通道、A通道。
    pixelsArr[i] = 0xFF;
    pixelsArr[i + 1] = 0x00;
    pixelsArr[i + 2] = 0x00;
    pixelsArr[i + 3] = 0xFF;
  }
  const config: image.InitializationOptions = {
    size,
    srcPixelFormat: image.PixelMapFormat.RGBA_8888, // 缓冲区内的源像素数据的像素格式。
    pixelFormat: image.PixelMapFormat.RGBA_8888, // 新创建的PixelMap的像素格式。
    editable: true
  };

  try {
    const pixelMap = image.createPixelMapFromPixelsSync(pixels, config);
    console.info('创建PixelMap成功。');
  } catch (e) {
    const error = e as BusinessError;
    console.error(`创建PixelMap失败。错误码：${e.code} 错误信息：${e.message}`);
  }
}

image.createPixelMap⁸⁺

createPixelMap(colors: ArrayBuffer, options: InitializationOptions): Promise<PixelMap>

通过像素数据和图像属性创建PixelMap，传入的像素数据默认按BGRA_8888格式解析。使用Promise异步回调。

由于图片占用内存较大，所以当PixelMap对象使用完成后，应主动调用release方法及时释放内存。释放时应确保该对象的所有异步方法均执行完成，且后续不再使用该对象。

从API版本26.0.0开始，建议使用createPixelMapFromPixels代替，以获得更完善的异常处理能力。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
colors	ArrayBuffer	是	图像像素数据的缓冲区，用于初始化PixelMap的像素。初始化前，缓冲区中的像素格式需要由InitializationOptions.srcPixelFormat指定，否则默认缓冲区的像素格式为BGRA_8888。说明：图像像素数据的缓冲区长度：length = width * height * 单位像素字节数。
options	InitializationOptions	是	创建像素的属性，包括透明度，尺寸，缩略值，像素格式和是否可编辑。

返回值：

类型	说明
Promise<PixelMap>	Promise对象，返回PixelMap。当创建的pixelMap大小超过原图大小时，返回原图pixelMap大小。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

async function CreatePixelMap() {
  const color: ArrayBuffer = new ArrayBuffer(96); // 96为需要创建的像素buffer大小，取值为：height * width *4。
  let opts: image.InitializationOptions = {
    size: { height: 4, width: 6 },
    srcPixelFormat: image.PixelMapFormat.RGBA_8888, // 缓冲区中的源像素数据的像素格式。
    pixelFormat: image.PixelMapFormat.RGBA_8888, // 新创建的PixelMap的像素格式。
    editable: true
  };
  image.createPixelMap(color, opts).then((pixelMap: image.PixelMap) => {
    console.info('Succeeded in creating pixelmap.');
  }).catch((error: BusinessError) => {
    console.error(`Failed to create pixelmap. code is ${error.code}, message is ${error.message}`);
  })
}

image.createPixelMap⁸⁺

createPixelMap(colors: ArrayBuffer, options: InitializationOptions, callback: AsyncCallback<PixelMap>): void

通过像素数据和图像属性创建PixelMap，传入的像素数据默认按BGRA_8888格式解析。使用callback异步回调。

从API版本26.0.0开始，建议使用createPixelMapFromPixels代替，以获得更完善的异常处理能力。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
colors	ArrayBuffer	是	图像像素数据的缓冲区，用于初始化PixelMap的像素。初始化前，缓冲区中的像素格式需要由InitializationOptions.srcPixelFormat指定，否则默认缓冲区的像素格式为BGRA_8888。说明：图像像素数据的缓冲区长度：length = width * height * 单位像素字节数。
options	InitializationOptions	是	创建像素的属性，包括透明度、尺寸、缩略值、像素格式和是否可编辑。
callback	AsyncCallback<PixelMap>	是	回调函数，当创建PixelMap成功，err为undefined，data为获取到的PixelMap对象；否则为错误对象。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

async function CreatePixelMap() {
  const color: ArrayBuffer = new ArrayBuffer(96); // 96为需要创建的像素buffer大小，取值为：height * width *4。
  let opts: image.InitializationOptions = {
    size: { height: 4, width: 6 },
    srcPixelFormat: image.PixelMapFormat.RGBA_8888, // 缓冲区中的源像素数据的像素格式。
    pixelFormat: image.PixelMapFormat.RGBA_8888, // 新创建的PixelMap的像素格式。
    editable: true
  };
  image.createPixelMap(color, opts, (error: BusinessError, pixelMap: image.PixelMap) => {
    if(error) {
      console.error(`Failed to create pixelmap. code is ${error.code}, message is ${error.message}`);
      return;
    } else {
      console.info('Succeeded in creating pixelmap.');
    }
  })
}

image.createPixelMapUsingAllocator²⁰⁺

createPixelMapUsingAllocator(colors: ArrayBuffer, param: InitializationOptions, allocatorType?: AllocatorType): Promise<PixelMap>

通过属性创建以及指定内存类型创建PixelMap，默认采用BGRA_8888格式处理数据。使用Promise异步回调。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
colors	ArrayBuffer	是	图像像素数据的缓冲区，用于初始化PixelMap的像素。初始化前，必须通过InitializationOptions.srcPixelFormat指定缓冲区中的像素格式。说明：图像像素数据的缓冲区长度：length = width * height * 单位像素字节数。
param	InitializationOptions	是	创建像素的属性，包括透明度、尺寸、缩略值、像素格式和是否可编辑。
allocatorType	AllocatorType	否	指定创建pixelmap的内存类型，默认内存类型是AllocatorType.AUTO。 1. image.AllocatorType.AUTO：不支持该内存类型的格式有UNKNOWN、YCBCR_P010、YCRCB_P010和ASTC_4x4。RGBA_1010102默认申请DMA内存。其他格式（RGB_565、RGBA_8888、BGRA_8888和RGBAF_16）尺寸大于512*512默认申请DMA内存，否则申请共享内存。 2. image.AllocatorType.DMA：RGBA_1010102、RGB_565、RGBA_8888、BGRA_8888和RGBAF_16支持DMA内存类型，其余格式不支持。 3. image.AllocatorType.SHARED：UNKNOWN、RGBA_1010102、YCBCR_P010、YCRCB_P010和ASTC_4x4不支持共享内存，其余格式支持。

返回值：

类型	说明
Promise<PixelMap>	Promise对象，返回PixelMap。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
7600201	Unsupported operation.
7600301	Memory alloc failed.
7600302	Memory copy failed.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

async function CreatePixelMapUseAllocator() {
  const color: ArrayBuffer = new ArrayBuffer(96); // 96为需要创建的像素buffer大小，取值为：height * width *4。
  let opts: image.InitializationOptions = {
    size: { height: 4, width: 6 },
    srcPixelFormat: image.PixelMapFormat.RGBA_8888, // 缓冲区中的源像素数据的像素格式。
    pixelFormat: image.PixelMapFormat.RGBA_8888, // 新创建的PixelMap的像素格式。
    editable: true
  };
  image.createPixelMapUsingAllocator(color, opts, image.AllocatorType.AUTO).then((pixelMap: image.PixelMap) => {
    console.info('Succeeded in creating pixelmap.');
  }).catch((error: BusinessError) => {
    console.error("Failed to create pixelmap. code is ", error.code);
  })
}

image.createPixelMapFromParcel¹¹⁺

createPixelMapFromParcel(sequence: rpc.MessageSequence): PixelMap

从MessageSequence中获取PixelMap。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
sequence	rpc.MessageSequence	是	保存有PixelMap信息的MessageSequence。

返回值：

类型	说明
PixelMap	成功同步返回PixelMap对象，失败抛出异常。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
62980096	The operation failed. Possible cause: 1.Image upload exception. 2. Decoding process exception. 3. Insufficient memory.
62980097	IPC error. Possible cause: 1.IPC communication failed. 2. Image upload exception. 3. Decode process exception. 4. Insufficient memory.
62980115	Invalid input parameter.
62980105	Failed to get the data.
62980177	Abnormal API environment.
62980178	Failed to create the PixelMap.
62980179	Abnormal buffer size.
62980180	FD mapping failed. Possible cause: 1. Size and address does not match. 2. Memory map in memalloc failed.
62980246	Failed to read the PixelMap.

示例：

import { rpc } from '@kit.IPCKit';
import { BusinessError } from '@kit.BasicServicesKit';

class MySequence implements rpc.Parcelable {
  pixel_map: image.PixelMap;
  constructor(conPixelmap: image.PixelMap) {
    this.pixel_map = conPixelmap;
  }
  marshalling(messageSequence: rpc.MessageSequence) {
    this.pixel_map.marshalling(messageSequence);
    return true;
  }
  unmarshalling(messageSequence: rpc.MessageSequence) {
    try {
      this.pixel_map = image.createPixelMapFromParcel(messageSequence);
    } catch(e) {
      let error = e as BusinessError;
      console.error(`createPixelMapFromParcel error. code is ${error.code}, message is ${error.message}`);
      return false;
    }
    return true;
  }
}
async function CreatePixelMapFromParcel() {
  const color: ArrayBuffer = new ArrayBuffer(96);
  let bufferArr: Uint8Array = new Uint8Array(color);
  for (let i = 0; i < bufferArr.length; i++) {
    bufferArr[i] = 0x80;
  }
  let opts: image.InitializationOptions = {
    editable: true,
    pixelFormat: image.PixelMapFormat.BGRA_8888,
    size: { height: 4, width: 6 },
    alphaType: image.AlphaType.UNPREMUL
  }
  let pixelMap: image.PixelMap | undefined = undefined;
  await image.createPixelMap(color, opts).then((srcPixelMap: image.PixelMap) => {
    pixelMap = srcPixelMap;
  })
  if (pixelMap != undefined) {
    // 序列化。
    let parcelable: MySequence = new MySequence(pixelMap);
    let data: rpc.MessageSequence = rpc.MessageSequence.create();
    data.writeParcelable(parcelable);

    // 反序列化rpc获取到data。
    let ret: MySequence = new MySequence(pixelMap);
    data.readParcelable(ret);

    // 获取到pixelmap。
    let newPixelmap = ret.pixel_map;
    if (newPixelmap != undefined ) {
      console.info('Get PixelMap successfully.')
    }
  }
}

image.createPixelMapFromSurface¹¹⁺

createPixelMapFromSurface(surfaceId: string, region: Region): Promise<PixelMap>

根据Surface ID和区域信息创建一个PixelMap对象。该区域的大小由Region.size指定。使用Promise异步回调。

说明： 当设备为折叠屏，且折叠状态切换时，可能因Surface自带旋转角度导致接口创建失败。需将宽高适配旋转角度。推荐使用image.createPixelMapFromSurface。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
surfaceId	string	是	对应Surface的ID，可通过预览组件获取，如XComponent组件。
region	Region	是	截取的画面区域。仅支持从画面左上角开始截取部分或整个画面，即Region中的x和y必须为0，Region.size中width和height的取值范围分别为[1, 预览流宽度]和[1, 预览流高度]。如需截取任意区域，可先使用image.createPixelMapFromSurface获取整个画面，再使用crop截取所需区域。

返回值：

类型	说明
Promise<PixelMap>	Promise对象，返回PixelMap。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
62980115	If the image parameter invalid.
62980105	Failed to get the data.
62980178	Failed to create the PixelMap.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

async function CreatePixelMapFromSurface(surfaceId: string) {
  let region: image.Region = { x: 0, y: 0, size: { height: 100, width: 100 } };
  image.createPixelMapFromSurface(surfaceId, region).then(() => {
    console.info('Succeeded in creating pixelmap from Surface');
  }).catch((error: BusinessError) => {
    console.error(`Failed to create pixelmap. code is ${error.code}, message is ${error.message}`);
  });
}

image.createPixelMapFromSurfaceSync¹²⁺

createPixelMapFromSurfaceSync(surfaceId: string, region: Region): PixelMap

以同步方式，根据Surface ID和区域信息创建一个PixelMap对象。该区域的大小由Region.size指定。

说明： 当设备为折叠屏，且折叠状态切换时，可能因Surface自带旋转角度导致接口创建失败。需将宽高适配旋转角度。推荐使用image.createPixelMapFromSurfaceSync。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
surfaceId	string	是	对应Surface的ID，可通过预览组件获取，如XComponent组件。
region	Region	是	截取的画面区域。仅支持从画面左上角开始截取部分或整个画面，即Region中的x和y必须为0，Region.size中width和height的取值范围分别为[1, 预览流宽度]和[1, 预览流高度]。如需截取任意区域，可先使用image.createPixelMapFromSurfaceSync获取整个画面，再使用cropSync截取所需区域。

返回值：

类型	说明
PixelMap	成功同步返回PixelMap对象，失败抛出异常。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档和Image错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed.
62980105	Failed to get the data.
62980178	Failed to create the PixelMap.

示例：

async function Demo(surfaceId: string) {
  let region: image.Region = { x: 0, y: 0, size: { height: 100, width: 100 } };
  let pixelMap: image.PixelMap = image.createPixelMapFromSurfaceSync(surfaceId, region);
  return pixelMap;
}

image.createPixelMapFromSurface¹⁵⁺

createPixelMapFromSurface(surfaceId: string): Promise<PixelMap>

从Surface ID创建一个PixelMap对象。使用Promise异步回调。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
surfaceId	string	是	对应Surface的ID，可通过预览组件获取，如XComponent组件。

返回值：

类型	说明
Promise<PixelMap>	Promise对象，返回PixelMap。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档和Image错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed
62980105	Failed to get the data
62980178	Failed to create the PixelMap

示例：

import { BusinessError } from '@kit.BasicServicesKit';

async function CreatePixelMapFromSurface(surfaceId: string) {
  image.createPixelMapFromSurface(surfaceId).then(() => {
    console.info('Succeeded in creating pixelmap from Surface');
  }).catch((error: BusinessError) => {
    console.error(`Failed to create pixelmap. code is ${error.code}, message is ${error.message}`);
  });
}

image.createPixelMapFromSurfaceSync¹⁵⁺

createPixelMapFromSurfaceSync(surfaceId: string): PixelMap

从Surface ID创建一个PixelMap对象，同步返回PixelMap结果。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
surfaceId	string	是	对应Surface的ID，可通过预览组件获取，如XComponent组件。

返回值：

类型	说明
PixelMap	成功同步返回PixelMap对象，失败抛出异常。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档和Image错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed
62980105	Failed to get the data
62980178	Failed to create the PixelMap

示例：

async function CreatePixelMapFromSurfaceSync(surfaceId: string) {
  let pixelMap : image.PixelMap = image.createPixelMapFromSurfaceSync(surfaceId);
  return pixelMap;
}

image.createPixelMapFromSurfaceWithTransformation²³⁺

createPixelMapFromSurfaceWithTransformation(surfaceId: string, transformEnabled: boolean): Promise<PixelMap>

通过Surface的ID创建一个预览流画面的PixelMap对象。该Surface可能携带旋转或翻转的变换信息。使用Promise异步回调。

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
surfaceId	string	是	对应Surface的ID，可通过预览组件获取，如XComponent组件。
transformEnabled	boolean	是	是否对携带变换信息的Surface预先进行逆变换来消除PixelMap的旋转或翻转效果。若Surface未携带变换信息，本参数不生效。 true：进行逆变换，变换的角度与Surface携带的角度一致且方向相反，输出的PixelMap无旋转或翻转效果。 false：不进行逆变换，输出的PixelMap会根据Surface中的变换信息而带有旋转或翻转效果。

返回值：

类型	说明
Promise<PixelMap>	Promise对象，返回PixelMap。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
7600104	Failed to get the data from Surface.
7600201	Unsupported operation, e.g. on cross-platform.
7600206	Invalid parameter.
7600305	Failed to create the PixelMap.

示例：

function DemoCreatePixelMapFromSurfaceWithTransformation(surfaceId: string, transformEnabled: boolean) {
  image.createPixelMapFromSurfaceWithTransformation(surfaceId, transformEnabled).then((pixelMap: image.PixelMap) => {
    console.info('Succeeded in creating pixelMap.');
  }).catch((e: Error) => {
    console.error(`Failed to create PixelMap. Code: ${e}`);
  });
}

image.createPixelMapFromSurfaceWithTransformationSync²³⁺

createPixelMapFromSurfaceWithTransformationSync(surfaceId: string, transformEnabled: boolean): PixelMap

通过Surface的ID创建一个预览流画面的PixelMap对象。该Surface可能携带旋转或翻转的变换信息。同步返回PixelMap结果。

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
surfaceId	string	是	对应Surface的ID，可通过预览组件获取，如XComponent组件。
transformEnabled	boolean	是	是否对携带变换信息的Surface预先进行逆变换来消除PixelMap的旋转或翻转效果。若Surface未携带变换信息，本参数不生效。 true：进行逆变换，变换的角度与Surface携带的角度一致且方向相反，输出的PixelMap无旋转或翻转效果。 false：不进行逆变换，输出的PixelMap会根据Surface中的变换信息而带有旋转或翻转效果。

返回值：

类型	说明
PixelMap	成功会同步返回PixelMap对象，失败则抛出异常。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
7600104	Failed to get the data from Surface.
7600201	Unsupported operation, e.g. on cross-platform.
7600206	Invalid parameter.
7600305	Failed to create the PixelMap.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

function DemoCreatePixelMapFromSurfaceWithTransformationSync(surfaceId: string, transformEnabled: boolean) {
  try {
    const pixelMap: image.PixelMap = image.createPixelMapFromSurfaceWithTransformationSync(surfaceId, transformEnabled);
    console.info('Succeeded in creating pixelMap.');
  } catch (e) {
    const error = e as BusinessError;
    console.error(`Failed to create PixelMap. Code: ${error.code}, message: ${error.message}`);
  }
}

image.createPixelMapSync¹²⁺

createPixelMapSync(colors: ArrayBuffer, options: InitializationOptions): PixelMap

通过像素数据和图像属性创建PixelMap，传入的像素数据默认按BGRA_8888格式解析。同步返回结果。

从API版本26.0.0开始，建议使用createPixelMapFromPixelsSync代替，以获得更完善的异常处理能力。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
colors	ArrayBuffer	是	图像像素数据的缓冲区，用于初始化PixelMap的像素。初始化前，缓冲区中的像素格式需要由InitializationOptions.srcPixelFormat指定，否则默认缓冲区的像素格式为BGRA_8888。说明：图像像素数据的缓冲区长度：length = width * height * 单位像素字节数。
options	InitializationOptions	是	创建像素的属性，包括透明度，尺寸，缩略值，像素格式和是否可编辑。

返回值：

类型	说明
PixelMap	成功同步返回PixelMap对象，失败抛出异常。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed

示例：

function CreatePixelMapSync() {
  const color: ArrayBuffer = new ArrayBuffer(96); // 96为需要创建的像素buffer大小，取值为：height * width *4。
  let opts: image.InitializationOptions = {
    size: { height: 4, width: 6 },
    srcPixelFormat: image.PixelMapFormat.RGBA_8888, // 缓冲区中的源像素数据的像素格式。
    pixelFormat: image.PixelMapFormat.RGBA_8888, // 新创建的PixelMap的像素格式。
    editable: true
  };
  let pixelMap : image.PixelMap = image.createPixelMapSync(color, opts);
  return pixelMap;
}

image.createEmptyPixelMap

createEmptyPixelMap(param: InitializationOptions): PixelMap

通过图像属性创建空白PixelMap。

说明：

此接口不支持创建以下像素格式的PixelMap：ASTC_4x4。

由于图片占用内存较大，所以当PixelMap对象使用完成后，应主动调用release方法及时释放内存。释放时应确保该对象的所有异步方法均执行完成，且后续不再使用该对象。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

卡片能力： 从API版本26.0.0开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API版本26.0.0开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
param	InitializationOptions	是	创建图像的属性，包括尺寸、像素格式、透明度类型、缩放模式和是否可编辑。说明：如果像素格式被指定为ASTC_4x4，将使用该类型中定义的默认像素格式。

返回值：

类型	说明
PixelMap	返回创建的空白PixelMap。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
7600206	Invalid parameter.
7600301	Failed to allocate memory. Possible causes: 1. The resulting PixelMap size is too large. 2. The system is out of memory.
7600305	Failed to create the PixelMap. Possible cause: Internal data is corrupted. Please check the logs for detailed information.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

function DemoCreateEmptyPixelMap() {
  const config: image.InitializationOptions = {
    size: { width: 6, height: 4 },
    pixelFormat: image.PixelMapFormat.RGBA_8888, // 新创建的PixelMap的像素格式。
    editable: true
  };

  try {
    const pixelMap = image.createEmptyPixelMap(config);
    console.info('创建空白PixelMap成功。');
  } catch (e) {
    const error = e as BusinessError;
    console.error(`创建空白PixelMap失败。错误码：${e.code} 错误信息：${e.message}`);
  }
}

image.createPixelMapSync¹²⁺

createPixelMapSync(options: InitializationOptions): PixelMap

通过图像属性创建空白PixelMap，同步返回PixelMap结果。

从API版本26.0.0开始，建议使用createEmptyPixelMap代替，以获得更完善的异常处理能力。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
options	InitializationOptions	是	创建像素的属性，包括透明度，尺寸，缩略值，像素格式和是否可编辑。

返回值：

类型	说明
PixelMap	成功同步返回PixelMap对象，失败抛出异常。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed

示例：

function CreatePixelMapSync() {
  let opts: image.InitializationOptions = { editable: true, pixelFormat: image.PixelMapFormat.RGBA_8888, size: { height: 4, width: 6 } }
  let pixelMap : image.PixelMap = image.createPixelMapSync(opts);
  return pixelMap;
}

image.createPixelMapUsingAllocatorSync²⁰⁺

createPixelMapUsingAllocatorSync(colors: ArrayBuffer, param: InitializationOptions, allocatorType?: AllocatorType): PixelMap

通过像素数据和图像属性创建PixelMap，可以指定内存类型。同步返回结果。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
colors	ArrayBuffer	是	图像像素数据的缓冲区，用于初始化PixelMap的像素。初始化前，必须通过InitializationOptions.srcPixelFormat指定缓冲区中的像素格式。说明：图像像素数据的缓冲区长度：length = width * height * 单位像素字节数。
param	InitializationOptions	是	创建像素的属性，包括透明度、尺寸、缩略值、像素格式和是否可编辑。
allocatorType	AllocatorType	否	指定创建pixelmap的内存类型，默认内存类型是AllocatorType.AUTO。 1. image.AllocatorType.AUTO：不支持该内存类型的格式有UNKNOWN、YCBCR_P010、YCRCB_P010和ASTC_4x4。RGBA_1010102默认申请DMA内存。其他格式（RGB_565、RGBA_8888、BGRA_8888和RGBAF_16）尺寸大于512*512默认申请DMA内存，否则申请共享内存。 2. image.AllocatorType.DMA：RGBA_1010102、RGB_565、RGBA_8888、BGRA_8888和RGBAF_16支持DMA内存类型，其余格式不支持。 3. image.AllocatorType.SHARED：UNKNOWN、RGBA_1010102、YCBCR_P010、YCRCB_P010和ASTC_4x4不支持共享内存，其余格式支持。

返回值：

类型	说明
PixelMap	成功同步返回PixelMap对象，失败抛出异常。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
7600201	Unsupported operation.
7600301	Memory alloc failed.
7600302	Memory copy failed.

示例：

function CreatePixelMapUsingAllocatorSync() {
  const color: ArrayBuffer = new ArrayBuffer(96); // 96为需要创建的像素buffer大小，取值为：height * width *4。
  let opts: image.InitializationOptions = {
    size: { height: 4, width: 6 },
    srcPixelFormat: image.PixelMapFormat.RGBA_8888, // 缓冲区中的源像素数据的像素格式。
    pixelFormat: image.PixelMapFormat.RGBA_8888, // 新创建的PixelMap的像素格式。
    editable: true
  };
  let pixelMap : image.PixelMap = image.createPixelMapUsingAllocatorSync(color, opts, image.AllocatorType.AUTO);
  return pixelMap;
}

image.createPixelMapUsingAllocatorSync²⁰⁺

createPixelMapUsingAllocatorSync(param: InitializationOptions, allocatorType?: AllocatorType): PixelMap

通过图像属性创建空白PixelMap，可以指定内存类型。同步返回PixelMap结果。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
param	InitializationOptions	是	创建像素的属性，包括透明度、尺寸、缩略值、像素格式和是否可编辑。
allocatorType	AllocatorType	否	指定创建pixelmap的内存类型，默认内存类型是AllocatorType.AUTO。 1. image.AllocatorType.AUTO：不支持该内存类型的格式有UNKNOWN和ASTC_4x4。RGBA_1010102、YCBCR_P010、YCRCB_P010格式默认申请DMA内存。其他格式（RGB_565, RGBA_8888, BGRA_8888, RGBAF_16）尺寸大于512*512默认申请DMA内存，否则申请共享内存。 2. image.AllocatorType.DMA：RGB_565、RGBA_8888、BGRA_8888、RGBAF_16、RGBA_1010102、YCBCR_P010和YCRCB_P010支持DMA内存类型，其余格式不支持。 3. image.AllocatorType.SHARED：UNKNOWN、RGBA_1010102、YCBCR_P010、YCRCB_P010和ASTC_4x4不支持共享内存，其余格式支持。

返回值：

类型	说明
PixelMap	成功同步返回PixelMap对象，失败抛出异常。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
7600201	Unsupported operation.
7600301	Memory alloc failed.

示例：

function CreatePixelMapUsingAllocatorSync() {
  let opts: image.InitializationOptions = { editable: true, pixelFormat: image.PixelMapFormat.RGBA_8888, size: { height: 4, width: 6 } }
  let pixelMap : image.PixelMap = image.createPixelMapUsingAllocatorSync(opts, image.AllocatorType.AUTO);
  return pixelMap;
}

image.createPremultipliedPixelMap¹²⁺

createPremultipliedPixelMap(src: PixelMap, dst: PixelMap, callback: AsyncCallback<void>): void

将PixelMap的透明通道非预乘模式转变为预乘模式，转换后的数据存入目标PixelMap。使用callback异步回调。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
src	PixelMap	是	源PixelMap对象。
dst	PixelMap	是	目标PixelMap对象。
callback	AsyncCallback<void>	是	回调函数，当创建PixelMap成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档和Image错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed
62980103	The image data is not supported
62980246	Failed to read the pixelMap
62980248	Pixelmap not allow modify

示例：

import { BusinessError } from '@kit.BasicServicesKit';

async function CreatePremultipliedPixelMap() {
  const color: ArrayBuffer = new ArrayBuffer(16); // 16为需要创建的像素buffer大小，取值为：height * width *4。
  let bufferArr = new Uint8Array(color);
  for (let i = 0; i < bufferArr.length; i += 4) {
    bufferArr[i] = 255;
    bufferArr[i+1] = 255;
    bufferArr[i+2] = 122;
    bufferArr[i+3] = 122;
  }
  let optsForUnpre: image.InitializationOptions = { editable: true, pixelFormat: image.PixelMapFormat.RGBA_8888, size: { height: 2, width: 2 } , alphaType: image.AlphaType.UNPREMUL}
  let srcPixelmap = image.createPixelMapSync(color, optsForUnpre);
  let optsForPre: image.InitializationOptions = { editable: true, pixelFormat: image.PixelMapFormat.RGBA_8888, size: { height: 2, width: 2 } , alphaType: image.AlphaType.PREMUL}
  let dstPixelMap = image.createPixelMapSync(optsForPre);
  image.createPremultipliedPixelMap(srcPixelmap, dstPixelMap, (error: BusinessError) => {
    if(error) {
      console.error(`Failed to convert pixelmap, error code is ${error}`);
      return;
    } else {
      console.info('Succeeded in converting pixelmap.');
    }
  })
}

image.createPremultipliedPixelMap¹²⁺

createPremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise<void>

将PixelMap数据按照透明度非预乘格式转为预乘格式，转换后的数据存入另一个PixelMap。使用Promise异步回调。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
src	PixelMap	是	源PixelMap对象。
dst	PixelMap	是	目标PixelMap对象。

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档和Image错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed
62980103	The image data is not supported
62980246	Failed to read the pixelMap
62980248	Pixelmap not allow modify

示例：

import { BusinessError } from '@kit.BasicServicesKit';

async function CreatePremultipliedPixelMap() {
  const color: ArrayBuffer = new ArrayBuffer(16); // 16为需要创建的像素buffer大小，取值为：height * width *4。
  let bufferArr = new Uint8Array(color);
  for (let i = 0; i < bufferArr.length; i += 4) {
    bufferArr[i] = 255;
    bufferArr[i+1] = 255;
    bufferArr[i+2] = 122;
    bufferArr[i+3] = 122;
  }
  let optsForUnpre: image.InitializationOptions = { editable: true, pixelFormat: image.PixelMapFormat.RGBA_8888, size: { height: 2, width: 2 } , alphaType: image.AlphaType.UNPREMUL}
  let srcPixelmap = image.createPixelMapSync(color, optsForUnpre);
  let optsForPre: image.InitializationOptions = { editable: true, pixelFormat: image.PixelMapFormat.RGBA_8888, size: { height: 2, width: 2 } , alphaType: image.AlphaType.PREMUL}
  let dstPixelMap = image.createPixelMapSync(optsForPre);
  image.createPremultipliedPixelMap(srcPixelmap, dstPixelMap).then(() => {
    console.info('Succeeded in converting pixelmap.');
  }).catch((error: BusinessError) => {
    console.error(`Failed to convert pixelmap, error code is ${error}`);
  })
}

image.createUnpremultipliedPixelMap¹²⁺

createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap, callback: AsyncCallback<void>): void

将PixelMap的透明通道预乘模式转变为非预乘模式，转换后的数据存入目标PixelMap。使用callback异步回调。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
src	PixelMap	是	源PixelMap对象。
dst	PixelMap	是	目标PixelMap对象。
callback	AsyncCallback<void>	是	回调函数，当创建PixelMap成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档和Image错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed
62980103	The image data is not supported
62980246	Failed to read the pixelMap
62980248	Pixelmap not allow modify

示例：

import { BusinessError } from '@kit.BasicServicesKit';

async function CreateUnpremultipliedPixelMap() {
  const color: ArrayBuffer = new ArrayBuffer(16); // 16为需要创建的像素buffer大小，取值为：height * width *4。
  let bufferArr = new Uint8Array(color);
  for (let i = 0; i < bufferArr.length; i += 4) {
    bufferArr[i] = 255;
    bufferArr[i+1] = 255;
    bufferArr[i+2] = 122;
    bufferArr[i+3] = 122;
  }
  let optsForPre: image.InitializationOptions = { editable: true, pixelFormat: image.PixelMapFormat.RGBA_8888, size: { height: 2, width: 2 } , alphaType: image.AlphaType.PREMUL}
  let srcPixelmap = image.createPixelMapSync(color, optsForPre);
  let optsForUnpre: image.InitializationOptions = { editable: true, pixelFormat: image.PixelMapFormat.RGBA_8888, size: { height: 2, width: 2 } , alphaType: image.AlphaType.UNPREMUL}
  let dstPixelMap = image.createPixelMapSync(optsForUnpre);
  image.createUnpremultipliedPixelMap(srcPixelmap, dstPixelMap, (error: BusinessError) => {
    if(error) {
      console.error(`Failed to convert pixelmap, error code is ${error}`);
      return;
    } else {
      console.info('Succeeded in converting pixelmap.');
    }
  })
}

image.createUnpremultipliedPixelMap¹²⁺

createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise<void>

将PixelMap的透明通道预乘模式转变为非预乘模式，转换后的数据存入目标PixelMap。使用Promise异步回调。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
src	PixelMap	是	源PixelMap对象。
dst	PixelMap	是	目标PixelMap对象。

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档和Image错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed.
62980103	The image data is not supported.
62980246	Failed to read the pixelMap.
62980248	Pixelmap not allow modify.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

async function CreateUnpremultipliedPixelMap() {
  const color: ArrayBuffer = new ArrayBuffer(16); // 16为需要创建的像素buffer大小，取值为：height * width *4。
  let bufferArr = new Uint8Array(color);
  for (let i = 0; i < bufferArr.length; i += 4) {
    bufferArr[i] = 255;
    bufferArr[i+1] = 255;
    bufferArr[i+2] = 122;
    bufferArr[i+3] = 122;
  }
  let optsForPre: image.InitializationOptions = { editable: true, pixelFormat: image.PixelMapFormat.RGBA_8888, size: { height: 2, width: 2 } , alphaType: image.AlphaType.PREMUL}
  let srcPixelmap = image.createPixelMapSync(color, optsForPre);
  let optsForUnpre: image.InitializationOptions = { editable: true, pixelFormat: image.PixelMapFormat.RGBA_8888, size: { height: 2, width: 2 } , alphaType: image.AlphaType.UNPREMUL}
  let dstPixelMap = image.createPixelMapSync(optsForUnpre);
  image.createUnpremultipliedPixelMap(srcPixelmap, dstPixelMap).then(() => {
    console.info('Succeeded in converting pixelmap.');
  }).catch((error: BusinessError) => {
    console.error(`Failed to convert pixelmap, error code is ${error}`);
  })
}

image.createImageSource

createImageSource(uri: string): ImageSource

通过传入的uri创建ImageSource实例。

由于图片占用内存较大，所以当ImageSource实例使用完成后，应主动调用release方法及时释放内存。释放时应确保该实例的所有异步方法均执行完成，且后续不再使用该实例。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
uri	string	是	图片路径，当前仅支持应用沙箱路径。当前支持格式有：JPEG、PNG、GIF、BMP、WebP、DNG、HEIC¹²⁺、WBMP²³⁺、HEIFS²³⁺、TIFF²³⁺、SVG¹⁰⁺（可参考SVG标签说明）、ICO¹¹⁺。从API版本26.0.0开始，增加支持AVIF、AVIS格式。部分格式的解码能力依赖于具体的设备硬件，建议在调用前使用image.getImageSourceSupportedFormats接口，动态查询当前设备上的解码能力。

返回值：

类型	说明
ImageSource	返回ImageSource类实例，失败时返回undefined。

示例：

async function CreateImageSource(context : Context) {
  // 此处'test.jpg'仅作示例，请开发者自行替换。否则imageSource会创建失败，导致后续无法正常执行。
  const path: string = context.filesDir + "/test.jpg";
  const imageSourceObj: image.ImageSource = image.createImageSource(path);
}

image.createImageSource⁹⁺

createImageSource(uri: string, options: SourceOptions): ImageSource

通过传入的uri创建ImageSource实例。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
uri	string	是	图片路径，当前仅支持应用沙箱路径（可参考使用说明）。当前支持格式有：JPEG、PNG、GIF、BMP、WebP、DNG、HEIC¹²⁺、WBMP²³⁺、HEIFS²³⁺、TIFF²³⁺、SVG¹⁰⁺（可参考SVG标签说明）、ICO¹¹⁺。从API版本26.0.0开始，增加支持AVIF、AVIS格式。部分格式的解码能力依赖于具体的设备硬件，建议在调用前使用image.getImageSourceSupportedFormats接口，动态查询当前设备上的解码能力。
options	SourceOptions	是	图片属性，包括图片像素密度、像素格式和图片尺寸。

返回值：

类型	说明
ImageSource	返回ImageSource类实例，失败时返回undefined。

示例：

async function CreateImageSource(context : Context) {
  let sourceOptions: image.SourceOptions = { sourceDensity: 120 };
  // 此处'test.png'仅作示例，请开发者自行替换。否则imageSource会创建失败，导致后续无法正常执行。
  const path: string = context.filesDir + "/test.png";
  let imageSourceObj: image.ImageSource = image.createImageSource(path, sourceOptions);
}

image.createImageSource⁷⁺

createImageSource(fd: number): ImageSource

通过传入文件描述符来创建ImageSource实例。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
fd	number	是	文件描述符fd。取值范围为[0，65535]。

返回值：

类型	说明
ImageSource	返回ImageSource类实例，失败时返回undefined。

示例：

import { fileIo } from '@kit.CoreFileKit';

async function CreateImageSource(context : Context) {
  // 此处'test.jpg'仅作示例，请开发者自行替换，否则imageSource会创建失败导致后续无法正常执行。
  let filePath: string = context.filesDir + "/test.jpg";
  let file = fileIo.openSync(filePath, fileIo.OpenMode.CREATE | fileIo.OpenMode.READ_WRITE);
  const imageSourceObj: image.ImageSource = image.createImageSource(file.fd);
}

image.createImageSource⁹⁺

createImageSource(fd: number, options: SourceOptions): ImageSource

通过传入文件描述符来创建ImageSource实例。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
fd	number	是	文件描述符fd。取值范围为[0，65535]。
options	SourceOptions	是	图片属性，包括图片像素密度、像素格式和图片尺寸。

返回值：

类型	说明
ImageSource	返回ImageSource类实例，失败时返回undefined。

示例：

import { fileIo } from '@kit.CoreFileKit';

async function CreateImageSource(context : Context) {
  let sourceOptions: image.SourceOptions = { sourceDensity: 120 };
  // 此处'test.jpg'仅作示例，请开发者自行替换，否则imageSource创建失败会导致后续无法正常执行。
  const filePath: string = context.filesDir + "/test.jpg";
  let file = fileIo.openSync(filePath, fileIo.OpenMode.CREATE | fileIo.OpenMode.READ_WRITE);
  const imageSourceObj: image.ImageSource = image.createImageSource(file.fd, sourceOptions);
}

image.createImageSource⁹⁺

createImageSource(buf: ArrayBuffer): ImageSource

通过缓冲区创建ImageSource实例。buf数据是未解码的数据，不可以传入类似于RBGA，YUV的像素buffer数据，如果想通过像素buffer数据创建pixelMap，可以调用image.createPixelMapSync这一类接口。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
buf	ArrayBuffer	是	图像缓冲区数组。

返回值：

类型	说明
ImageSource	返回ImageSource类实例，失败时返回undefined。

示例：

async function CreateImageSource() {
  const buf: ArrayBuffer = new ArrayBuffer(96); // 96为需要创建的像素buffer大小，取值为：height * width *4。
  const imageSourceObj: image.ImageSource = image.createImageSource(buf);
}

image.createImageSource⁹⁺

createImageSource(buf: ArrayBuffer, options: SourceOptions): ImageSource

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
buf	ArrayBuffer	是	图像缓冲区数组。
options	SourceOptions	是	图片属性，包括图片像素密度、像素格式和图片尺寸。

返回值：

类型	说明
ImageSource	返回ImageSource类实例，失败时返回undefined。

示例：

async function CreateImageSource() {
  const data: ArrayBuffer = new ArrayBuffer(112);
  let sourceOptions: image.SourceOptions = { sourceDensity: 120 };
  const imageSourceObj: image.ImageSource = image.createImageSource(data, sourceOptions);
}

image.createImageSource¹¹⁺

createImageSource(rawfile: resourceManager.RawFileDescriptor, options?: SourceOptions): ImageSource

通过图像资源文件的RawFileDescriptor创建ImageSource实例。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
rawfile	resourceManager.RawFileDescriptor	是	图像资源文件的RawFileDescriptor。
options	SourceOptions	否	图片属性，包括图片像素密度、像素格式和图片尺寸。

返回值：

类型	说明
ImageSource	返回ImageSource类实例，失败时返回undefined。

示例：

import { resourceManager } from '@kit.LocalizationKit';
import { BusinessError } from '@kit.BasicServicesKit';
  
async function CreateImageSource(context : Context) {
  // 获取resourceManager资源管理器。
  const resourceMgr: resourceManager.ResourceManager = context.resourceManager;
  // 此处'test.jpg'仅作示例，请开发者自行替换，否则imageSource创建失败会导致后续无法正常执行。
  resourceMgr.getRawFd('test.jpg').then((rawFileDescriptor: resourceManager.RawFileDescriptor) => {
    const imageSourceObj: image.ImageSource = image.createImageSource(rawFileDescriptor);
  }).catch((error: BusinessError) => {
    console.error(`Failed to get RawFileDescriptor.code is ${error.code}, message is ${error.message}`);
  })
}

image.CreateIncrementalSource⁹⁺

CreateIncrementalSource(buf: ArrayBuffer): ImageSource

通过缓冲区以增量的方式创建ImageSource实例，IncrementalSource不支持读写Exif信息。

以增量方式创建的ImageSource实例，仅支持使用以下功能，同步、异步callback、异步Promise均支持。

获取图片信息：指定序号-getImageInfo、直接获取-getImageInfo
获取图片中给定索引处图像的指定属性键的值：getImageProperty
批量获取图片中的指定属性键的值：getImageProperties
更新增量数据：updateData
创建PixelMap对象：通过图片解码参数创建-createPixelMap、通过默认参数创建-createPixelMap 、通过图片解码参数-createPixelMap
释放ImageSource实例：release

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
buf	ArrayBuffer	是	增量数据。

返回值：

类型	说明
ImageSource	返回ImageSource，失败时返回undefined。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

async function CreateIncrementalImageSource(context : Context) {
  let imageArray = context.resourceManager.getMediaContentSync($r('app.media.startIcon').id); // 获取图像资源。
  // 此处'app.media.startIcon'仅作示例，请开发者自行替换，否则imageArray创建失败会导致后续无法正常执行。
  let splitBuff1 = imageArray.slice(0, imageArray.byteLength / 2);  // 分片。
  let splitBuff2 = imageArray.slice(imageArray.byteLength / 2);
  const imageSourceIncrementalSApi: image.ImageSource = image.CreateIncrementalSource(new ArrayBuffer(imageArray.byteLength));
  imageSourceIncrementalSApi.updateData(splitBuff1, false, 0, splitBuff1.byteLength).then(() => {
    imageSourceIncrementalSApi.updateData(splitBuff2, true, 0, splitBuff2.byteLength).then(() => {
      let pixelMap = imageSourceIncrementalSApi.createPixelMapSync();
      let imageInfo = pixelMap.getImageInfoSync();
      console.info('Succeeded in creating pixelMap');
    }).catch((error : BusinessError) => {
      console.error(`Failed to updateData error code is ${error.code}, message is ${error.message}`);
    })
  }).catch((error : BusinessError) => {
    console.error(`Failed to updateData error code is ${error.code}, message is ${error.message}`);
  })
}

image.CreateIncrementalSource⁹⁺

CreateIncrementalSource(buf: ArrayBuffer, options?: SourceOptions): ImageSource

通过缓冲区以增量的方式创建ImageSource实例，IncrementalSource不支持读写Exif信息。

此接口支持的功能与CreateIncrementalSource(buf: ArrayBuffer): ImageSource所生成的实例支持的功能相同。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
buf	ArrayBuffer	是	增量数据。
options	SourceOptions	否	图片属性，包括图片像素密度、像素格式和图片尺寸。

返回值：

类型	说明
ImageSource	返回ImageSource，失败时返回undefined。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

async function CreateIncrementalImageSource(context : Context) {
  let imageArray = context.resourceManager.getMediaContentSync($r('app.media.startIcon').id); // 获取图像资源。
  // 此处'app.media.startIcon'仅作示例，请开发者自行替换，否则imageArray创建失败会导致后续无法正常执行。
  let splitBuff1 = imageArray.slice(0, imageArray.byteLength / 2);  // 分片。
  let splitBuff2 = imageArray.slice(imageArray.byteLength / 2);
  let sourceOptions: image.SourceOptions = { sourceDensity: 120};

  const imageSourceIncrementalSApi: image.ImageSource = image.CreateIncrementalSource(new ArrayBuffer(imageArray.byteLength), sourceOptions);
  imageSourceIncrementalSApi.updateData(splitBuff1, false, 0, splitBuff1.byteLength).then(() => {
    imageSourceIncrementalSApi.updateData(splitBuff2, true, 0, splitBuff2.byteLength).then(() => {
      let pixelMap = imageSourceIncrementalSApi.createPixelMapSync();
      let imageInfo = pixelMap.getImageInfoSync();
      console.info('Succeeded in creating pixelMap');
    }).catch((error : BusinessError) => {
      console.error(`Failed to updateData error code is ${error.code}, message is ${error.message}`);
    })
  }).catch((error : BusinessError) => {
    console.error(`Failed to updateData error code is ${error.code}, message is ${error.message}`);
  })
}

image.getImageSourceSupportedFormats²⁰⁺

getImageSourceSupportedFormats(): string[]

获取支持解码的图片格式，图片格式以mime type表示。

系统能力： SystemCapability.Multimedia.Image.ImageSource

返回值：

类型	说明
string[]	支持解码的图片格式（mime type）列表。

示例：

async function GetImageSourceSupportedFormats() {
    let formats = image.getImageSourceSupportedFormats();
    console.info('formats:', formats);
}

async function IsSupportedTiffFormat() {
    let formats = image.getImageSourceSupportedFormats();
    return formats.includes("image/tiff");
}

image.createImagePacker

createImagePacker(): ImagePacker

创建ImagePacker实例。

由于图片占用内存较大，所以当ImagePacker实例使用完成后，应主动调用release方法及时释放内存。释放时应确保该实例的所有异步方法均执行完成，且后续不再使用该实例。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.ImagePacker

返回值：

类型	说明
ImagePacker	返回ImagePacker实例。

示例：

async function CreateImagePacker() {
  const imagePackerObj: image.ImagePacker = image.createImagePacker();
}

image.getImagePackerSupportedFormats²⁰⁺

getImagePackerSupportedFormats(): string[]

获取支持编码的图片格式，图片格式以mime type表示。

系统能力： SystemCapability.Multimedia.Image.ImagePacker

返回值：

类型	说明
string[]	支持编码的图片格式（mime type）列表。

示例：

async function GetImagePackerSupportedFormats() {
    let formats = image.getImagePackerSupportedFormats();
    console.info('formats:', formats);
}

image.createAuxiliaryPicture¹³⁺

createAuxiliaryPicture(buffer: ArrayBuffer, size: Size, type: AuxiliaryPictureType): AuxiliaryPicture

通过ArrayBuffer图片数据、辅助图尺寸、辅助图类型创建AuxiliaryPicture实例。该接口仅支持传入BGRA的连续像素数据，会创建出RGBA的辅助图。

由于图片占用内存较大，所以当AuxiliaryPicture实例使用完成后，应主动调用release方法及时释放内存。释放时应确保该实例的所有异步方法均执行完成，且后续不再使用该实例。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
buffer	ArrayBuffer	是	以buffer形式存放的图像数据。
size	Size	是	辅助图的尺寸。单位为像素（px）。
type	AuxiliaryPictureType	是	辅助图类型。

返回值：

类型	说明
AuxiliaryPicture	如果操作成功，则返回AuxiliaryPicture实例。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档。

错误码ID	错误信息
401	Parameter error.Possible causes:1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed.

示例：

async function CreateAuxiliaryPicture(context: Context) {
  let funcName = "CreateAuxiliaryPicture";
  const resourceMgr = context.resourceManager;
  const rawFile = await resourceMgr.getRawFileContent("hdr.jpg"); // 需要支持hdr的图片。
  let auxBuffer: ArrayBuffer = rawFile.buffer as ArrayBuffer;
  let auxSize: Size = {
    height: 180,
    width: 240
  };
  let auxType: image.AuxiliaryPictureType = image.AuxiliaryPictureType.GAINMAP;
  let auxPictureObj: image.AuxiliaryPicture | null = image.createAuxiliaryPicture(auxBuffer, auxSize, auxType);
  if(auxPictureObj != null) {
    let type: image.AuxiliaryPictureType = auxPictureObj.getType();
    console.info(funcName, `CreateAuxiliaryPicture succeeded this.Aux_picture.type ${type}`);
  } else {
    console.error(funcName, 'CreateAuxiliaryPicture failed');
  }
}

image.createAuxiliaryPictureUsingAllocator²⁴⁺

createAuxiliaryPictureUsingAllocator(auxiliaryPictureInfo: AuxiliaryPictureInfo, allocatorType?: AllocatorType, pixels?: ArrayBuffer): AuxiliaryPicture

使用指定的内存类型，根据辅助图信息和像素数据创建辅助图对象。

说明：

在处理此接口返回的AuxiliaryPicture时，需要考虑内存中每行像素所占的空间的影响。

创建的辅助图像会使用输入的像素进行初始化。

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
auxiliaryPictureInfo	AuxiliaryPictureInfo	是	辅助图图像信息。 - 输入的ArrayBuffer的pixelFormat和最终创建出的辅助图的实际pixelFormat需与auxiliaryPictureInfo中指定的pixelFormat保持一致。 - 当AuxiliaryPictureType为GAINMAP时，AllocatorType仅支持传入AUTO/DMA。 - 当传入SHARE_MEMORY时，返回错误码7600205。
allocatorType	AllocatorType	否	图像解码的内存类型，AUTO及默认情况下按照DMA处理。
pixels	ArrayBuffer	否	以buffer形式存放的图像数据。当未提供ArrayBuffer参数时，默认创建空白辅助图。

返回值：

类型	说明
AuxiliaryPicture	如果操作成功，则返回AuxiliaryPicture实例。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
7600205	Unsupported allocator type,e.g., use shared memory to create a gainmap as only DMA supported hdr metadata.
7600206	Invalid parameter, size.height or size.width is less than or equal to 0.
7600301	Alloc memory failed.

示例：

import { image } from '@kit.ImageKit';

function CreateAuxiliaryPictureUsingAllocator(info: image.AuxiliaryPictureInfo,  allocatorType?: image.AllocatorType, pixels?: ArrayBuffer ) {
  let res : image.AuxiliaryPicture;
  try {
    res = image.createAuxiliaryPictureUsingAllocator(info, allocatorType, pixels);
  } catch (error) {
    console.error(`Failed to create auxiliary picture using allocator=${allocatorType} and pixels=${pixels?.byteLength}.`);
  }
}

image.createImageReceiver¹¹⁺

createImageReceiver(size: Size, format: ImageFormat, capacity: number): ImageReceiver

通过图片大小、图片格式、容量创建ImageReceiver实例。ImageReceiver做为图片的接收方、消费者，它的参数属性实际上不会对接收到的图片产生影响。图片属性的配置应在发送方、生产者进行，如相机预览流createPreviewOutput。

由于图片占用内存较大，所以当ImageReceiver实例使用完成后，应主动调用release方法及时释放内存。释放时应确保该实例的所有异步方法均执行完成，且后续不再使用该实例。

系统能力： SystemCapability.Multimedia.Image.ImageReceiver

参数：

参数名	类型	必填	说明
size	Size	是	图像的默认大小。该参数不会影响接收到的图片大小，实际返回大小由生产者决定，如相机。
format	ImageFormat	是	图像格式，取值为ImageFormat常量（目前仅支持 ImageFormat:JPEG，实际返回格式由生产者决定，如相机）。
capacity	number	是	同时访问的最大图像数。该参数仅作为期望值，实际capacity由设备硬件决定。

返回值：

类型	说明
ImageReceiver	如果操作成功，则返回ImageReceiver实例。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档。

错误码ID	错误信息
401	Parameter error.Possible causes:1.Mandatory parameters are left unspecified;2.Incorrect parameter types;

示例：

let size: image.Size = {
  height: 8192,
  width: 8192
}
let receiver: image.ImageReceiver = image.createImageReceiver(size, image.ImageFormat.JPEG, 8);

image.createImageReceiver²³⁺

createImageReceiver(options?: ImageReceiverOptions): ImageReceiver | undefined

通过ImageReceiverOptions创建ImageReceiver实例。ImageReceiver做为图片的接收方、消费者，其参数属性实际上不会对接收到的图片产生影响。图片属性的配置应在发送方、生产者进行，如相机预览流createPreviewOutput。

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Multimedia.Image.ImageReceiver

参数：

参数名	类型	必填	说明
options	ImageReceiverOptions	否	创建ImageReceiver的属性，包括图片的默认大小和同时访问的最大图片数。未传入options时，默认的size为1920*1080，单位为像素（px），表示期望接收宽为1920px，高为1080px的图片。未传入options时，默认的capacity为3，表示期望同时最多有3张图片等待读取。

返回值：

类型	说明
ImageReceiver \| undefined	操作成功时返回ImageReceiver实例，否则返回undefined。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
7900201	Invalid parameter.

示例：

let options: image.ImageReceiverOptions = {
  size: { width: 480, height: 480 },
  capacity: 3
}
let receiver: image.ImageReceiver | undefined = image.createImageReceiver(options);

image.createImageCreator¹¹⁺

createImageCreator(size: Size, format: ImageFormat, capacity: number): ImageCreator

通过图片大小、图片格式、容量创建ImageCreator实例。

由于图片占用内存较大，所以当ImageCreator实例使用完成后，应主动调用release方法及时释放内存。释放时应确保该实例的所有异步方法均执行完成，且后续不再使用该实例。

系统能力： SystemCapability.Multimedia.Image.ImageCreator

参数：

参数名	类型	必填	说明
size	Size	是	图像的默认大小。
format	ImageFormat	是	图像格式，如YCBCR_422_SP，JPEG。
capacity	number	是	同时访问的最大图像数。该参数仅作为期望值，实际capacity由设备硬件决定。

返回值：

类型	说明
ImageCreator	如果操作成功，则返回ImageCreator实例。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档和。

错误码ID	错误信息
401	Parameter error.Possible causes:1.Mandatory parameters are left unspecified;2.Incorrect parameter types;

示例：

let size: image.Size = {
  height: 8192,
  width: 8192
}
let creator: image.ImageCreator = image.createImageCreator(size, image.ImageFormat.JPEG, 8);

image.createImageReceiver^(deprecated)

createImageReceiver(width: number, height: number, format: number, capacity: number): ImageReceiver

通过宽、高、图片格式、容量创建ImageReceiver实例。ImageReceiver做为图片的接收方、消费者，它的参数属性实际上不会对接收到的图片产生影响。图片属性的配置应在发送方、生产者进行，如相机预览流createPreviewOutput。

说明：

从API version 9开始支持，从API version 11废弃，建议使用createImageReceiver代替。

系统能力： SystemCapability.Multimedia.Image.ImageReceiver

参数：

参数名	类型	必填	说明
width	number	是	图像的默认宽度。单位为像素（px）。该参数不会影响接收到的图片宽度，实际宽度由生产者决定，如相机。
height	number	是	图像的默认高度。单位为像素（px）。该参数不会影响接收到的图片高度，实际高度由生产者决定，如相机。
format	number	是	图像格式，取值为ImageFormat常量（目前仅支持 ImageFormat:JPEG，实际返回格式由生产者决定，如相机）。
capacity	number	是	同时访问的最大图像数。该参数仅作为期望值，实际capacity由设备硬件决定。

返回值：

类型	说明
ImageReceiver	如果操作成功，则返回ImageReceiver实例。

示例：

let receiver: image.ImageReceiver = image.createImageReceiver(8192, 8192, image.ImageFormat.JPEG, 8);

image.createImageCreator^(deprecated)

createImageCreator(width: number, height: number, format: number, capacity: number): ImageCreator

通过宽、高、图片格式、容量创建ImageCreator实例。

说明：

从API version 9开始支持，从API version 11废弃，建议使用createImageCreator代替。

系统能力： SystemCapability.Multimedia.Image.ImageCreator

参数：

参数名	类型	必填	说明
width	number	是	图像的默认宽度。单位为像素（px）。
height	number	是	图像的默认高度。单位为像素（px）。
format	number	是	图像格式，如YCBCR_422_SP，JPEG。
capacity	number	是	同时访问的最大图像数。该参数仅作为期望值，实际capacity由设备硬件决定。

返回值：

类型	说明
ImageCreator	如果操作成功，则返回ImageCreator实例。

示例：

let creator: image.ImageCreator = image.createImageCreator(8192, 8192, image.ImageFormat.JPEG, 8);

SVG标签说明

从API version 10开始支持SVG标签，使用版本为(SVG) 1.1，SVG标签需设置width，height。SVG文件可添加xml声明，应以“<?xml”开头，当前支持的标签列表有：

a
circle
clipPath
defs
ellipse
feBlend
feColorMatrix
feComposite
feDiffuseLighting
feDisplacementMap
feDistantLight
feFlood
feGaussianBlur
feImage
feMorphology
feOffset
fePointLight
feSpecularLighting
feSpotLight
feTurbulence
filter
g
image
line
linearGradient
mask
path
pattern
polygon
polyline
radialGradient
rect
stop
svg
text
textPath
tspan
use

Functions

导入模块

image.createPicture13+

image.createPictureFromParcel13+

image.createPixelMapFromPixels

image.createPixelMapFromPixelsSync

image.createPixelMap8+

image.createPixelMap8+

image.createPixelMapUsingAllocator20+

image.createPixelMapFromParcel11+

image.createPixelMapFromSurface11+

image.createPixelMapFromSurfaceSync12+

image.createPixelMapFromSurface15+

image.createPixelMapFromSurfaceSync15+

image.createPixelMapFromSurfaceWithTransformation23+

image.createPixelMapFromSurfaceWithTransformationSync23+

image.createPixelMapSync12+

image.createEmptyPixelMap

image.createPixelMapSync12+

image.createPixelMapUsingAllocatorSync20+

image.createPixelMapUsingAllocatorSync20+

image.createPremultipliedPixelMap12+

image.createPremultipliedPixelMap12+

image.createUnpremultipliedPixelMap12+

image.createUnpremultipliedPixelMap12+

image.createImageSource

image.createImageSource9+

image.createImageSource7+

image.createImageSource9+

image.createImageSource9+

image.createImageSource9+

image.createImageSource11+

image.CreateIncrementalSource9+

image.CreateIncrementalSource9+

image.getImageSourceSupportedFormats20+

image.createImagePacker

image.getImagePackerSupportedFormats20+

image.createAuxiliaryPicture13+

image.createAuxiliaryPictureUsingAllocator24+

image.createImageReceiver11+

image.createImageReceiver23+

image.createImageCreator11+

image.createImageReceiver(deprecated)

image.createImageCreator(deprecated)

SVG标签说明

image.createPicture¹³⁺

image.createPictureFromParcel¹³⁺

image.createPixelMap⁸⁺

image.createPixelMap⁸⁺

image.createPixelMapUsingAllocator²⁰⁺

image.createPixelMapFromParcel¹¹⁺

image.createPixelMapFromSurface¹¹⁺

image.createPixelMapFromSurfaceSync¹²⁺

image.createPixelMapFromSurface¹⁵⁺

image.createPixelMapFromSurfaceSync¹⁵⁺

image.createPixelMapFromSurfaceWithTransformation²³⁺

image.createPixelMapFromSurfaceWithTransformationSync²³⁺

image.createPixelMapSync¹²⁺

image.createPixelMapSync¹²⁺

image.createPixelMapUsingAllocatorSync²⁰⁺

image.createPixelMapUsingAllocatorSync²⁰⁺

image.createPremultipliedPixelMap¹²⁺

image.createPremultipliedPixelMap¹²⁺

image.createUnpremultipliedPixelMap¹²⁺

image.createUnpremultipliedPixelMap¹²⁺

image.createImageSource⁹⁺

image.createImageSource⁷⁺

image.createImageSource⁹⁺

image.createImageSource⁹⁺

image.createImageSource⁹⁺

image.createImageSource¹¹⁺

image.CreateIncrementalSource⁹⁺

image.CreateIncrementalSource⁹⁺

image.getImageSourceSupportedFormats²⁰⁺

image.getImagePackerSupportedFormats²⁰⁺

image.createAuxiliaryPicture¹³⁺

image.createAuxiliaryPictureUsingAllocator²⁴⁺

image.createImageReceiver¹¹⁺

image.createImageReceiver²³⁺

image.createImageCreator¹¹⁺

image.createImageReceiver^(deprecated)

image.createImageCreator^(deprecated)