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
255 lines
6.4 KiB
TypeScript
255 lines
6.4 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 { Buffer } from './buffer';
|
|
import { Device } from './device';
|
|
import { murmurhash2_32_gc } from '../utils/murmurhash2_gc';
|
|
import { Format, Obj, ObjectType } from './define';
|
|
|
|
export interface IAttribute {
|
|
name: string;
|
|
format: Format;
|
|
isNormalized: boolean;
|
|
tream: number;
|
|
isInstanced: boolean;
|
|
location: number;
|
|
}
|
|
|
|
export class Attribute {
|
|
declare private _token: never; // to make sure all usages must be an instance of this exact class, not assembled from plain object
|
|
|
|
constructor (
|
|
public name: string = '',
|
|
public format: Format = Format.UNKNOWN,
|
|
public isNormalized: boolean = false,
|
|
public stream: number = 0,
|
|
public isInstanced: boolean = false,
|
|
public location: number = 0,
|
|
) {}
|
|
}
|
|
|
|
export class InputAssemblerInfo {
|
|
declare private _token: never; // to make sure all usages must be an instance of this exact class, not assembled from plain object
|
|
|
|
constructor (
|
|
public attributes: Attribute[] = [],
|
|
public vertexBuffers: Buffer[] = [],
|
|
public indexBuffer: Buffer | null = null,
|
|
public indirectBuffer: Buffer | null = null,
|
|
) {}
|
|
}
|
|
|
|
/**
|
|
* @en GFX input assembler.
|
|
* @zh GFX 输入汇集器。
|
|
*/
|
|
export abstract class InputAssembler extends Obj {
|
|
|
|
/**
|
|
* @en Get current vertex buffers.
|
|
* @zh 顶点缓冲数组。
|
|
*/
|
|
get vertexBuffers (): Buffer[] {
|
|
return this._vertexBuffers;
|
|
}
|
|
|
|
/**
|
|
* @en Get current index buffer.
|
|
* @zh 索引缓冲。
|
|
*/
|
|
get indexBuffer (): Buffer | null {
|
|
return this._indexBuffer;
|
|
}
|
|
|
|
/**
|
|
* @en Get current attributes.
|
|
* @zh 顶点属性数组。
|
|
*/
|
|
get attributes (): Attribute[] {
|
|
return this._attributes;
|
|
}
|
|
|
|
/**
|
|
* @en Get hash of current attributes.
|
|
* @zh 获取顶点属性数组的哈希值。
|
|
*/
|
|
get attributesHash (): number {
|
|
return this._attributesHash;
|
|
}
|
|
|
|
/**
|
|
* @en Get current vertex count.
|
|
* @zh 顶点数量。
|
|
*/
|
|
get vertexCount (): number {
|
|
return this._vertexCount;
|
|
}
|
|
|
|
set vertexCount (count: number) {
|
|
this._vertexCount = count;
|
|
}
|
|
|
|
/**
|
|
* @en Get starting vertex.
|
|
* @zh 起始顶点。
|
|
*/
|
|
get firstVertex (): number {
|
|
return this._firstVertex;
|
|
}
|
|
|
|
set firstVertex (first: number) {
|
|
this._firstVertex = first;
|
|
}
|
|
|
|
/**
|
|
* @en Get current index count.
|
|
* @zh 索引数量。
|
|
*/
|
|
get indexCount (): number {
|
|
return this._indexCount;
|
|
}
|
|
|
|
set indexCount (count: number) {
|
|
this._indexCount = count;
|
|
}
|
|
|
|
/**
|
|
* @en Get starting index.
|
|
* @zh 起始索引。
|
|
*/
|
|
get firstIndex (): number {
|
|
return this._firstIndex;
|
|
}
|
|
|
|
set firstIndex (first: number) {
|
|
this._firstIndex = first;
|
|
}
|
|
|
|
/**
|
|
* @en Get current vertex offset.
|
|
* @zh 顶点偏移量。
|
|
*/
|
|
get vertexOffset (): number {
|
|
return this._vertexOffset;
|
|
}
|
|
|
|
set vertexOffset (offset: number) {
|
|
this._vertexOffset = offset;
|
|
}
|
|
|
|
/**
|
|
* @en Get current instance count.
|
|
* @zh 实例数量。
|
|
*/
|
|
get instanceCount (): number {
|
|
return this._instanceCount;
|
|
}
|
|
|
|
set instanceCount (count: number) {
|
|
this._instanceCount = count;
|
|
}
|
|
|
|
/**
|
|
* @en Get starting instance.
|
|
* @zh 起始实例。
|
|
*/
|
|
get firstInstance (): number {
|
|
return this._firstInstance;
|
|
}
|
|
|
|
set firstInstance (first: number) {
|
|
this._firstInstance = first;
|
|
}
|
|
|
|
/**
|
|
* @en Get the indirect buffer, if present.
|
|
* @zh 间接绘制缓冲。
|
|
*/
|
|
get indirectBuffer (): Buffer | null {
|
|
return this._indirectBuffer;
|
|
}
|
|
|
|
protected _device: Device;
|
|
|
|
protected _attributes: Attribute[] = [];
|
|
|
|
protected _vertexBuffers: Buffer[] = [];
|
|
|
|
protected _indexBuffer: Buffer | null = null;
|
|
|
|
protected _vertexCount = 0;
|
|
|
|
protected _firstVertex = 0;
|
|
|
|
protected _indexCount = 0;
|
|
|
|
protected _firstIndex = 0;
|
|
|
|
protected _vertexOffset = 0;
|
|
|
|
protected _instanceCount = 0;
|
|
|
|
protected _firstInstance = 0;
|
|
|
|
protected _attributesHash = 0;
|
|
|
|
protected _indirectBuffer: Buffer | null = null;
|
|
|
|
constructor (device: Device) {
|
|
super(ObjectType.INPUT_ASSEMBLER);
|
|
this._device = device;
|
|
}
|
|
|
|
/**
|
|
* @en Get the specified vertex buffer.
|
|
* @zh 获取顶点缓冲。
|
|
* @param stream The stream index of the vertex buffer.
|
|
*/
|
|
public getVertexBuffer (stream = 0): Buffer | null {
|
|
if (stream < this._vertexBuffers.length) {
|
|
return this._vertexBuffers[stream];
|
|
} else {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
protected computeAttributesHash (): number {
|
|
let res = 'attrs';
|
|
for (let i = 0; i < this.attributes.length; ++i) {
|
|
const at = this.attributes[i];
|
|
res += `,${at.name},${at.format},${at.isNormalized},${at.stream},${at.isInstanced}`;
|
|
}
|
|
return murmurhash2_32_gc(res, 666);
|
|
}
|
|
|
|
public abstract initialize (info: InputAssemblerInfo): boolean;
|
|
public abstract destroy (): void;
|
|
}
|