srm-appx-adapter
TypeScript icon, indicating that this package has built-in type declarations

0.1.1-alpha.0 • Public • Published

AppX Adapter

帮助 Galacean Effects 框架适配到微信小程序/小游戏等,抹平 DOM API 和小程序 API 的差异,目前适配对象:

  • window
  • atob
  • btoa
  • document
  • navigator
  • location
  • Blob
  • URL
  • Element
  • HTMLElement
  • HTMLCanvasElement
  • Image
  • requestAnimationFrame
  • cancelAnimationFrame
  • XMLHttpRequest
  • performance

使用步骤

1、安装依赖

# 安装 Galacean Effects 的小程序/小游戏适配器
$ npm i @galacean/appx-adapter --save
# 安装 Galacean Effects
$ npm i @galacean/effects --save

2、在微信小游戏中使用

import { registerCanvas } from '@galacean/appx-adapter/weapp';
import { Player } from '@galacean/effects/weapp';

// 1. 使用 adapter 方法注册 canvas
const canvas = await registerCanvas({ isMiniGame: true });
// 2. 通过创建的 canvas 对象实例化一个 Galacean Effects 播放器
const player = new Player({
  transparentBackground: true,
  canvas,
  pixelRatio: 2,
  renderFramework: 'webgl',
});
// 3. 加载资源并执行播放
void this.player.loadScene(url);

3、在微信小程序中使用

<view style="width: 375px; height: 375px; background-color: black">
  <canvas type="webgl" id="webgl" style="width: 100%; height: 100%;"></canvas>
</view>
import { registerCanvas } from '@galacean/appx-adapter/weapp';
import { Player } from '@galacean/effects/weapp';

// 1. 使用 adapter 方法注册 canvas
const canvas = await registerCanvas({ id:'#webgl' });
// 2. 通过创建的 canvas 对象实例化一个 Galacean Effects 播放器
const player = new Player({
  transparentBackground: true,
  canvas,
  pixelRatio: 2,
  renderFramework: 'webgl',
});

// 3. 加载资源并执行播放
void this.player.loadScene('url');

Readme

Keywords

none

Package Sidebar

Install

npm i srm-appx-adapter

Weekly Downloads

7

Version

0.1.1-alpha.0

License

MIT

Unpacked Size

210 kB

Total Files

75

Last publish

Collaborators

  • ruimeng.su