APIs - 蓝紫开发文档一、画布初始化 二、程序接口三、资源接口四、其它接口一、画布初始化

蓝紫程序的一切都从唯一的全局变量 Lan 开始,我们通常是使用 Lan.canvasxx 方法初始化画布,然后开始绘制。

const canvas = Lan.canvasxx(width, height, options)

我们也可以将 widthheight 写在 options 中,比如:

const canvas = Lan.canvasfs({width:900, height:600, ...})

如果未指定 widthheight,我们会采用 Canvas 元素样式宽高,同时参考其 scale 属性:

<canvas scale="2" style="width:600;height:400"><canvas>

这时候,计算得到的宽度为 600 x 2 = 1200,高度为 400 x 2 = 800。这样的处理方式对于我们集成蓝紫程序到第三方平台进行自动宽高处理非常有帮助,具体请参考我们在 jsFiddle 上的例子:蓝紫向导程序 - Fluid

无论采用哪种渲染引擎初始化画布,返回的 canvas 对象都会有一些公共属性:

画布初始化接口的参数基本是都是 (width, height, options) 这样的形式,我们也可以将 widthheight 写在 options 参数里:

const canvas = Lan.canvasxx({
  width  : 900, 
  height : 600, 
  ...
})

每一种渲染引擎的画布初始化方法请参考对应的文档了解详情。

二、程序接口 async Lan.loop(callback, options = {maxframes:0})

该方法用于循环执行,通常用于渲染动画或执行其它重复操作,maxframes 控制最多循环次数,或者当 callback 函数返回 false 的时候也会结束循环。回调函数 callback 形式如下:

callback(loop)

其中,参数 loop 是一个 JSON 对象,具有如下属性:

Lan.log(msg)

写程序运行日志

async Lan.import(lib)

导入 JS 程序库,前提是该库必须是一个标准的 Module。比如 Lan.import('three') 用于引入 three.js 库。也可以通过 URL 地址导入外部 JS 库,比如:Lan.import('https://...')。以下是蓝紫缺省提供的 JS 库,可直接通过名称导入,名称不区分大小写:

三、资源接口 async Lan.font(name, url)

加载字体,返回 FontFace 对象。

async Lan.file([options])

选择本地文件,比如,选择一个图像。其中,参数 options.rettype 指定返回数据类型:

未指定参数 options.rettype 时缺省返回 DataURL 数据。当用户取消选择文件时,返回 null 值。此外,还可以指定提示信息 options.message 参数,该参数缺省为 选择文件 字样。

async Lan.painters(resource_list)

加载颜色桶(Painter)资源,使用代码参考官方 Demo:Pixel Shader Painters。该函数返回一个 ImageData 对象,里面每一行 256 个颜色,表示一个颜色桶的数据。同时,返回对象附带获取颜色的方法:

painters.get = (painter_number, color_position) => {r, g, b};
async Lan.audio([url, options = {play:true, loop:true}])

加载并播放音频文件,返回 Audio 对象,同时附加如下属性和方法:

async Lan.image([url])

加载图像,返回 ImageData 对象,并附加如下属性及方法:

由于 CanvasRenderingContext2D.drawImage 不支持 ImageData 数据源,如果需要在 canvas2d 渲染引擎里使用 drawImage 函数渲染 ImageData,可以使用其 canvas() 方法先将其转换为 canvas 对象。

async Lan.video([url, options = {mute:true, loop:true}])

加载视频,返回 Video 对象,附加如下属性:

async Lan.camera(options = {})

打开摄像头,返回 Video 对象,附加如下属性:

通过 options 可以指定一些参数:

const camera = Lan.camera({
  width  : 1280, 
  height : 720
});
const camera = Lan.camera({
  width  : { min: 1280 },
  height : { min: 720 },
});
const camera = Lan.camera({
  width  : { ideal: 1280 },
  height : { ideal: 720 },
});
四、其它接口 Lan.mouse(options = {flipy:false})

我们可以使用本接口取得鼠标设备状态,options.flipy 控制是否将 Y 方向坐标翻转。const mouse = Lan.mouse(),返回对象有如下属性:

当用户未与 Canvas 产生交互的时候,坐标值为 undefined。鼠标交互接口具体使用方法可参考 canvasps 引擎向导程序 粒子系统。我们可以直接在返回的 mouse 对象上为画布配置鼠标交互处理器:

具体使用方法,请参考蓝紫 canvas2d 引擎的向导程序:交互式画布

Lan.gaussian(radius)

我们可以使用本接口生成一个高斯卷积核,返回对象是一个正方形的二维数组 kernel[][],每一个元素均为一个浮点数,所有数字相加等于 1。附加属性及方法如下:

具体使用示例,请参考 Gaussian Kernel

Lan.rand([seed])

有状态随机数生成器,给定随机数种子,返回随机数生成器:

var rng = Lan.rand('seed');
var val = rng(); // [0, 1)
Lan.project(pitch, yaw[, perspective])

生成一个三维投影相机,参考 YB 的公开发表作品:Curve.js 三维投影