Files
cocos4/cocos/rendering/pipeline-serialization.ts
T
pandamicro afd22296b4 MIT license update and to new year 2023 (#13927)
* Cpp MIT license update and to date
* TS MIT license update and to date
2022-12-28 11:25:12 +08:00

188 lines
5.2 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
/*
Copyright (c) 2020-2023 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 documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
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.
*/
import { ccclass, type, serializable, editable } from 'cc.decorator';
import { CCString, ccenum } from '../core';
import { AccessFlagBit, Format, LoadOp, StoreOp, TextureType, TextureUsageBit } from '../gfx';
import { RenderTexture } from '../asset/assets/render-texture';
import { Material } from '../asset/assets/material';
ccenum(TextureType);
ccenum(TextureUsageBit);
ccenum(StoreOp);
ccenum(LoadOp);
ccenum(AccessFlagBit);
ccenum(Format);
/**
* @en The tag of the render flow, including SCENE, POSTPROCESS and UI.
* @zh 渲染流程的标签,包含:常规场景(SCENE),后处理(POSTPROCESS),UI 界面(UI)
*/
export enum RenderFlowTag {
SCENE,
POSTPROCESS,
UI,
}
ccenum(RenderFlowTag);
@ccclass('RenderTextureDesc')
export class RenderTextureDesc {
@serializable
@editable
public name = '';
@type(TextureType)
public type: TextureType = TextureType.TEX2D;
@type(TextureUsageBit)
public usage: TextureUsageBit = TextureUsageBit.COLOR_ATTACHMENT;
@type(Format)
public format: Format = Format.UNKNOWN;
@serializable
@editable
public width = -1;
@serializable
@editable
public height = -1;
}
@ccclass('RenderTextureConfig')
export class RenderTextureConfig {
@serializable
@editable
public name = '';
@type(RenderTexture)
public texture: RenderTexture | null = null;
}
@ccclass('MaterialConfig')
export class MaterialConfig {
@serializable
@editable
public name = '';
@type(Material)
public material: Material | null = null;
}
@ccclass('FrameBufferDesc')
export class FrameBufferDesc {
@serializable
@editable
public name = '';
@serializable
@editable
public renderPass = 0;
@type([CCString])
public colorTextures: string[] = [];
@serializable
@editable
public depthStencilTexture = '';
@type(RenderTexture)
public texture: RenderTexture | null = null;
}
@ccclass('ColorDesc')
export class ColorDesc {
@type(Format)
public format: Format = Format.UNKNOWN;
@type(LoadOp)
public loadOp: LoadOp = LoadOp.CLEAR;
@type(StoreOp)
public storeOp: StoreOp = StoreOp.STORE;
@serializable
@editable
public sampleCount = 1;
@type(AccessFlagBit)
public beginAccesses: AccessFlagBit = AccessFlagBit.NONE;
@type(AccessFlagBit)
public endAccesses: AccessFlagBit = AccessFlagBit.COLOR_ATTACHMENT_WRITE;
}
@ccclass('DepthStencilDesc')
export class DepthStencilDesc {
@type(Format)
public format: Format = Format.UNKNOWN;
@type(LoadOp)
public depthLoadOp: LoadOp = LoadOp.CLEAR;
@type(StoreOp)
public depthStoreOp: StoreOp = StoreOp.STORE;
@type(LoadOp)
public stencilLoadOp: LoadOp = LoadOp.CLEAR;
@type(StoreOp)
public stencilStoreOp: StoreOp = StoreOp.STORE;
@serializable
@editable
public sampleCount = 1;
@type(AccessFlagBit)
public beginAccesses: AccessFlagBit = AccessFlagBit.NONE;
@type(AccessFlagBit)
public endAccesses: AccessFlagBit = AccessFlagBit.DEPTH_STENCIL_ATTACHMENT_WRITE;
}
@ccclass('RenderPassDesc')
export class RenderPassDesc {
@serializable
@editable
public index = -1;
@type([ColorDesc])
public colorAttachments = [];
@type(DepthStencilDesc)
public depthStencilAttachment: DepthStencilDesc = new DepthStencilDesc();
}
export enum RenderQueueSortMode {
FRONT_TO_BACK,
BACK_TO_FRONT,
}
ccenum(RenderQueueSortMode);
/**
* @en The render queue descriptor
* @zh 渲染队列描述信息
*/
@ccclass('RenderQueueDesc')
export class RenderQueueDesc {
/**
* @en Whether the render queue is a transparent queue
* @zh 当前队列是否是半透明队列
*/
@serializable
@editable
public isTransparent = false;
/**
* @en The sort mode of the render queue
* @zh 渲染队列的排序模式
*/
@type(RenderQueueSortMode)
public sortMode: RenderQueueSortMode = RenderQueueSortMode.FRONT_TO_BACK;
/**
* @en The stages using this queue
* @zh 使用当前渲染队列的阶段列表
*/
@type([CCString])
public stages: string[] = [];
}