SarEngine2D

Document

SarEngine2D Output

Output

输出接口。作为图像和音频输出的接口,维护着HTML Canvas元素等底层呈现载体,并提供对绘图接口和音频接口的访问。

Syntax

//from global
//  create by HTML Canvas
var output = new Output(canvas, width, height);
//  create by HTML Element
var output = new Output(element, width, height);
//from SarEngine
var output = new SarEngine.Output(canvas, width, height);
var output = new SarEngine.Output(element, width, height);

Parameters

用于呈现的HTML Canvas对象。
Element element
用于容纳HTML Canvas的任意HTML Element容器对象。
Number width
呈现的宽度。
Number height
呈现的高度。

Classes

OutputTypes
输出类型枚举类。

Properties

audioTrack
Array 在该输出接口上播放的音轨集合。
camera
Camera 该输出接口连接的摄像机。
height
Number 在HTML页面中的呈现高度。
layers
Array 该输出接口所维护的绘图接口集合。
renderHeight
Number 该输出接口的实际渲染高度,如果小于height图像将被拉伸。
renderWidth
Number 该输出接口实际渲染宽度,如果小于width图像将被拉伸。
type
Output.OutputTypes 底层输出类型,单Canvas输出或多Canvas层叠输出。
viewArea
Rectangle 表示该输出接口的渲染区域。
width
Number 在HTML页面中的呈现宽度。

Methods

addAudioTrack(audioTrack)
向该输出接口添加音轨。
connectTo(camera)
将该输出接口连接到指定的摄像机。
getLayer(zIndex)
获取指定z序的绘图接口。
计算判断指定的GameObject是否呈现在显示区域之外。
playAudio(audio)
播放指定的音频。
播放新的指定音频的实例,对于同一个Audio实例可以形成重叠播放的效果。
removeAudioTrack(audioTrack)
将指定的音轨从该输出接口中移除。
setLayer(count)
设置底层呈现图层的数目。