mirror of
https://github.com/cocos/cocos4.git
synced 2026-11-21 08:02:39 +08:00
b162e21a93
* Update licenses * Update license for audio * Update license for core/3d * Update license for animation, assets, asset-manager, components, data * update license for event, geometry, gfx * update license for core modules math, memop, pipeline, platform, primitive, renderer, scene-graph, utils, value-types * Update license for core * Update license for particle and particle-2d * Update license for particle part2 * Update license for physics and physics-2d * Update license for all modules in cocos * Update license for exports * Fix API doc language declaration
83 lines
2.5 KiB
TypeScript
83 lines
2.5 KiB
TypeScript
/*
|
|
Copyright (c) 2020 Xiamen Yaji Software Co., Ltd.
|
|
|
|
https://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 gfx
|
|
*/
|
|
|
|
import { CommandBuffer } from './command-buffer';
|
|
import { Device } from './device';
|
|
import { Fence } from './fence';
|
|
import { Obj, ObjectType, QueueType } from './define';
|
|
|
|
export class QueueInfo {
|
|
declare private _token: never; // to make sure all usages must be an instance of this exact class, not assembled from plain object
|
|
|
|
constructor (
|
|
public type: QueueType = QueueType.GRAPHICS,
|
|
) {}
|
|
}
|
|
|
|
/**
|
|
* @en GFX Queue.
|
|
* @zh GFX 队列。
|
|
*/
|
|
export abstract class Queue extends Obj {
|
|
|
|
/**
|
|
* @en Get current type.
|
|
* @zh 队列类型。
|
|
*/
|
|
get type (): number {
|
|
return this._type;
|
|
}
|
|
|
|
protected _device: Device;
|
|
|
|
protected _type: QueueType = QueueType.GRAPHICS;
|
|
|
|
protected _isAsync = false;
|
|
|
|
constructor (device: Device) {
|
|
super(ObjectType.QUEUE);
|
|
this._device = device;
|
|
}
|
|
|
|
public isAsync () { return this._isAsync; }
|
|
|
|
public abstract initialize (info: QueueInfo): boolean;
|
|
|
|
public abstract destroy (): void;
|
|
|
|
/**
|
|
* @en Submit command buffers.
|
|
* @zh 提交命令缓冲数组。
|
|
* @param cmdBuffs The command buffers to be submitted.
|
|
* @param fence The syncing fence.
|
|
*/
|
|
public abstract submit (cmdBuffs: CommandBuffer[], fence?: Fence): void;
|
|
}
|