目录

OffscreenCanvas

OffscreenCanvas实例,可通过has.createOffscreenCanvas创建。

离屏画布不绑定同层渲染组件,支持独立的2D绘图上下文和绘制操作,可与可见画布互操作。

起始版本: 2.0.6

重要提示:

使用离屏画布前,请将ASCF运行时版本升级至2.0.6及以上,升级方法请参见ASCF接口兼容性指南。

调用离屏画布接口时,如果获取不到渲染内容,请通过setTimeout等时延函数延迟获取,待离屏画布渲染完成后再读取内容。

属性:

参数 类型 描述
width number 画布宽度,单位px。取值范围0-1365,默认值300。
height number 画布高度,单位px。取值范围0-1365,默认值150。

OffscreenCanvas.getContext

OffscreenCanvas.getContext(string contextType, Object settings)

返回OffscreenCanvas的绘图上下文。首次调用时惰性创建native控制器。

起始版本: 2.0.6

参数:

参数 类型 默认值 必填 描述
contextType string '2d' 否 上下文类型。
settings Object - 否 上下文配置。默认值:开启抗锯齿。
settings.antialias boolean true 否 是否开启抗锯齿。

返回值:

返回OffscreenCanvasRenderingContext2D对象。

示例:

const offscreenCanvas = has.createOffscreenCanvas({
  type: '2d',
  width: 300,
  height: 150
});
const offCtx = offscreenCanvas.getContext('2d', { antialias: true });
console.info('offscreen canvas context: ', offCtx);

OffscreenCanvas.toDataURL

OffscreenCanvas.toDataURL(string type, number encoderOptions)

返回一个包含图片展示的data URL。调用前自动flush所有pending绘制命令。

起始版本: 2.0.6

参数:

参数 类型 默认值 必填 描述
type string image/png 否

图片格式。

合法值:'image/png','image/jpeg','image/webp'。

encoderOptions number 0.92 否

图片的质量,取值范围为0-1。

只有在指定图片格式为'image/jpeg'或'image/webp'的情况下,才可以从0到1的区间内选择图片的质量。 数值越大图片质量越好。

返回值:

参数 类型 描述
data URL string 返回一个包含图片展示的data URL。

示例:

const offscreenCanvas = has.createOffscreenCanvas({
  type: '2d',
  width: 300,
  height: 150
});
const offCtx = offscreenCanvas.getContext('2d');
offCtx.fillStyle = 'red';
offCtx.fillRect(0, 0, 100, 100);
const base64 = offscreenCanvas.toDataURL();
console.info('toDataURL res: ', base64);

OffscreenCanvas.requestAnimationFrame

OffscreenCanvas.requestAnimationFrame(function callback)

注册一个函数,在下次进行重绘时执行。

起始版本: 2.0.6

参数:

参数 类型 必填 描述
callback function 是 在下次重绘之前调用的回调函数。

返回值:

返回requestId,作为动画帧请求ID,可以传递给OffscreenCanvas.cancelAnimationFrame以实现取消该动画帧请求。

示例:

const offscreenCanvas = has.createOffscreenCanvas({
  type: '2d',
  width: 300,
  height: 150
});
const offCtx = offscreenCanvas.getContext('2d');
let x = 0;
const draw = () => {
  offCtx.clearRect(0, 0, 300, 150);
  x = (x + 2) % 300;
  offCtx.fillStyle = 'red';
  offCtx.fillRect(x, 50, 50, 50);
  const requestId = offscreenCanvas.requestAnimationFrame(draw);
};
draw();

OffscreenCanvas.cancelAnimationFrame

OffscreenCanvas.cancelAnimationFrame(number requestId)

取消由OffscreenCanvas.requestAnimationFrame添加到计划中的动画帧请求。

起始版本: 2.0.6

参数:

参数 类型 必填 描述
requestId number 是 动画帧请求ID,调用OffscreenCanvas.requestAnimationFrame时返回。

示例:

const offscreenCanvas = has.createOffscreenCanvas({
  type: '2d',
  width: 300,
  height: 150
});
offscreenCanvas.cancelAnimationFrame(requestId); // requestId是调用OffscreenCanvas.requestAnimationFrame接口返回的值

OffscreenCanvas.createImage

OffscreenCanvas.createImage()

创建一个图片对象,仅支持2D Canvas类型。

起始版本: 2.0.6

返回值:

返回Image对象。

示例:

const offscreenCanvas = has.createOffscreenCanvas({
  type: '2d',
  width: 300,
  height: 150
});
const offCtx = offscreenCanvas.getContext('2d');
const img = offscreenCanvas.createImage();
img.src = 'https://www.example.com/xxxx.png'; // 此处仅为样例,请开发者更换为可用图片资源地址
img.onload = () => {
  offCtx.drawImage(img, 0, 10, 237, 133);
  console.info('image width', img.width);
  console.info('image height', img.height);
};
img.onerror = (err) => {
  console.error('createImage err', err);
};

OffscreenCanvas.createPath2D

OffscreenCanvas.createPath2D(string|Path2D path)

创建一个Path2D对象。

起始版本: 2.0.6

参数:

参数 类型 必填 描述
path string|Path2D 否 用于创建新路径的源路径。默认值:创建空路径。

返回值:

返回Path2D对象。

示例:

const offscreenCanvas = has.createOffscreenCanvas({
  type: '2d',
  width: 300,
  height: 150
});
const offCtx = offscreenCanvas.getContext('2d');
const path = offscreenCanvas.createPath2D();
path.rect(10, 10, 100, 50);
offCtx.fill(path);

OffscreenCanvas.destroy

OffscreenCanvas.destroy()

销毁离屏画布,释放native资源。清空命令队列、通知native移除控制器、从全局注册表移除。销毁后再次调用不产生副作用。

起始版本: 2.0.6

示例:

const offscreenCanvas = has.createOffscreenCanvas({
  type: '2d',
  width: 300,
  height: 150
});
const offCtx = offscreenCanvas.getContext('2d');
offCtx.fillRect(0, 0, 100, 100);
// 使用完毕后销毁
offscreenCanvas.destroy();