mirror of
https://github.com/cocos/cocos4.git
synced 2026-11-21 16:12:40 +08:00
3068956648
* Remove GFX prefix in gfx module * Full deprecation for old GFX APIs * export gfx module * Fix issues and make deprecated exports backward compatible * Adaptation in engine modules for gfx * Fix ci * fix ci
224 lines
7.0 KiB
TypeScript
224 lines
7.0 KiB
TypeScript
/*
|
|
Copyright (c) 2017-2020 Xiamen Yaji Software Co., Ltd.
|
|
|
|
http://www.cocos.com
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated engine source code (the "Software"), a limited,
|
|
worldwide, royalty-free, non-assignable, revocable and non-exclusive license
|
|
to use Cocos Creator solely to develop games on your target platforms. You shall
|
|
not use Cocos Creator software for developing other software or tools that's
|
|
used for developing games. You are not granted to publish, distribute,
|
|
sublicense, and/or sell copies of Cocos Creator.
|
|
|
|
The software or tools in this License Agreement are licensed, not sold.
|
|
Xiamen Yaji Software Co., Ltd. reserves all rights not expressly granted to you.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
THE SOFTWARE.
|
|
*/
|
|
|
|
/**
|
|
* @packageDocumentation
|
|
* @module ui
|
|
*/
|
|
|
|
import { UIRenderable } from '../../core/components/ui-base/ui-renderable';
|
|
import { UI } from '../../core/renderer/ui/ui';
|
|
import { MeshBuffer } from '../../core/renderer/ui/mesh-buffer';
|
|
import { ccclass, help, menu, executionOrder, visible, type, displayName, override } from 'cc.decorator';
|
|
import { UIDrawBatch } from '../../core/renderer/ui/ui-draw-batch';
|
|
import { director, Color, Material, warnID } from '../../core';
|
|
import { vfmtPosUvColor } from '../../core/renderer/ui/ui-vertex-format';
|
|
import { BlendFactor } from '../../core/gfx';
|
|
|
|
|
|
/**
|
|
* @en
|
|
* Static batch component of UI.
|
|
* This component is placed on the root node of all node objects that need to be batch.
|
|
* Only sprites and label participate in the batch.
|
|
* Static batch must be enabled manually, otherwise dynamic batch is still used.
|
|
* Note: Do not place mask, Graphics, and objects such as UI models or particles under child nodes,
|
|
* otherwise rendering will be skipped after static batching is enabled.
|
|
*
|
|
* @zh
|
|
* UI 静态合批组件。
|
|
* 该组件放在所有需要被静态合批的节点对象的根节点上,子节点放置对象必须是精灵和文本,其余对象不参与静态合批。
|
|
* 用户必须通过手动方式启用收集静态合批数据[[markAsDirty]],否则合批方式仍然采用动态合批(采集数据的流程相同)。此后渲染的内容是采用收集到的合批渲染数据,子节点的任何修改将不再有效。
|
|
* 注意:子节点下不要放置 Mask,Graphics,以及 UI 模型或者粒子之类对象,否则会在启用完静态合批后跳过渲染。
|
|
*/
|
|
@ccclass('cc.UIStaticBatch')
|
|
@help('i18n:cc.UIStaticBatch')
|
|
@menu('UI/Render/UIStaticBatch')
|
|
@executionOrder(110)
|
|
export class UIStaticBatch extends UIRenderable {
|
|
@override
|
|
@visible(false)
|
|
get dstBlendFactor () {
|
|
return this._dstBlendFactor;
|
|
}
|
|
|
|
set dstBlendFactor (value: BlendFactor) {
|
|
if (this._dstBlendFactor === value) {
|
|
return;
|
|
}
|
|
|
|
this._dstBlendFactor = value;
|
|
this._updateBlendFunc();
|
|
}
|
|
|
|
@override
|
|
@visible(false)
|
|
get srcBlendFactor () {
|
|
return this._srcBlendFactor;
|
|
}
|
|
|
|
set srcBlendFactor (value: BlendFactor) {
|
|
if (this._srcBlendFactor === value) {
|
|
return;
|
|
}
|
|
|
|
this._srcBlendFactor = value;
|
|
this._updateBlendFunc();
|
|
}
|
|
|
|
@override
|
|
@visible(false)
|
|
get color (): Readonly<Color> {
|
|
return this._color;
|
|
}
|
|
|
|
set color (value) {
|
|
if (this._color === value) {
|
|
return;
|
|
}
|
|
|
|
this._color.set(value);
|
|
this._updateColor();
|
|
this.markForUpdateRenderData();
|
|
}
|
|
|
|
get drawBatchList () {
|
|
return this._uiDrawBatchList;
|
|
}
|
|
|
|
protected _init = false;
|
|
protected _meshBuffer: MeshBuffer | null = null;
|
|
protected _dirty = true;
|
|
private _lastMeshBuffer: MeshBuffer | null = null;
|
|
private _uiDrawBatchList: UIDrawBatch[] = [];
|
|
|
|
public onLoad () {
|
|
const ui = this._getUI();
|
|
if (!ui) {
|
|
return;
|
|
}
|
|
|
|
const attr = vfmtPosUvColor;
|
|
const buffer = new MeshBuffer(ui);
|
|
buffer.initialize(attr, this._arrivalMaxBuffer);
|
|
this._meshBuffer = buffer;
|
|
}
|
|
|
|
public onDestroy () {
|
|
super.onDestroy();
|
|
|
|
this._clearData();
|
|
if(this._meshBuffer){
|
|
this._meshBuffer.destroy();
|
|
this._meshBuffer = null;
|
|
}
|
|
}
|
|
|
|
|
|
public updateAssembler (render: UI) {
|
|
if (this._dirty) {
|
|
render.finishMergeBatches();
|
|
this._lastMeshBuffer = render.currBufferBatch;
|
|
render.currBufferBatch = this._meshBuffer;
|
|
render.currStaticRoot = this;
|
|
}
|
|
|
|
if (this._init) {
|
|
render.finishMergeBatches();
|
|
render.commitStaticBatch(this);
|
|
}
|
|
}
|
|
|
|
public postUpdateAssembler (render: UI) {
|
|
if (this._dirty) {
|
|
render.finishMergeBatches();
|
|
render.currBufferBatch = this._lastMeshBuffer;
|
|
render.currStaticRoot = null;
|
|
this._dirty = false;
|
|
this._init = true;
|
|
this.node._static = true;
|
|
|
|
this._meshBuffer!.uploadBuffers();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @en
|
|
* Recollect data tags.
|
|
* The render data will be recollected during the render phase of the current frame, and the next frame will be rendered using fixed data.
|
|
* Note: 尽量不要频繁调用此接口, 会有一定内存损耗.
|
|
*
|
|
* @zh
|
|
* 重新采集数据标记,会在当前帧的渲染阶段重新采集渲染数据,下一帧开始将会使用固定数据进行渲染。
|
|
* 注意:尽量不要频繁调用此接口,因为会清空原先存储的 ia 数据重新采集,会有一定内存损耗。
|
|
*/
|
|
public markAsDirty () {
|
|
if (!this._getUI()) {
|
|
return;
|
|
}
|
|
|
|
this.node._static = false;
|
|
this._dirty = true;
|
|
this._init = false;
|
|
|
|
this._clearData();
|
|
}
|
|
|
|
public _requireDrawBatch () {
|
|
const batch = new UIDrawBatch();
|
|
batch.isStatic = true;
|
|
this._uiDrawBatchList.push(batch);
|
|
return batch;
|
|
}
|
|
|
|
protected _clearData () {
|
|
if (this._meshBuffer) {
|
|
this._meshBuffer!.reset();
|
|
|
|
const ui = this._getUI()!;
|
|
for (let i = 0; i < this._uiDrawBatchList.length; i++) {
|
|
const element = this._uiDrawBatchList[i];
|
|
element.destroy(ui);
|
|
}
|
|
}
|
|
|
|
this._uiDrawBatchList.length = 0;
|
|
this._init = false;
|
|
}
|
|
|
|
protected _getUI (){
|
|
if(director.root && director.root.ui) {
|
|
return director.root.ui;
|
|
}
|
|
|
|
warnID(9301);
|
|
return null;
|
|
}
|
|
|
|
protected _arrivalMaxBuffer (){
|
|
warnID(9300);
|
|
}
|
|
}
|