@galacean/effects-core 1.1.2 → 1.1.3

package/dist/render/mesh.d.ts

@@ -0,0 +1,82 @@
+import { Matrix4 } from '@galacean/effects-math/es/core/index';
+import type { Engine } from '../engine';
+import type { Material, MaterialDestroyOptions } from '../material';
+import type { Geometry, Renderer } from '../render';
+import type { Disposable } from '../utils';
+import { DestroyOptions } from '../utils';
+export interface MeshOptionsBase {
+    material: Material;
+    name?: string;
+    worldMatrix?: Matrix4;
+    priority?: number;
+}
+export interface GeometryMeshProps extends MeshOptionsBase {
+    geometry: Geometry;
+}
+export interface MeshDestroyOptions {
+    geometries?: DestroyOptions;
+    material?: MaterialDestroyOptions | DestroyOptions.keep;
+}
+/**
+ * Mesh 抽象类
+ */
+export declare class Mesh implements Disposable {
+    private engine;
+    /**
+     * Mesh 的全局唯一 id
+     */
+    readonly id: string;
+    /**
+     * Mesh 名称，缺省是 \<unnamed>
+     */
+    readonly name: string;
+    /**
+     * Mesh 的世界矩阵
+     */
+    worldMatrix: Matrix4;
+    /**
+     * Mesh 的材质
+     */
+    material: Material;
+    /**
+     * Mesh 的 Geometry
+     */
+    geometry: Geometry;
+    protected destroyed: boolean;
+    private _priority;
+    private visible;
+    /**
+     * 创建一个新的 Mesh 对象。
+     */
+    static create: (engine: Engine, props: GeometryMeshProps) => Mesh;
+    constructor(engine: Engine, props: GeometryMeshProps);
+    get priority(): number;
+    set priority(value: number);
+    get isDestroyed(): boolean;
+    /**
+     * 设置当前 Mesh 的可见性。
+     * @param visible - true：可见，false：不可见
+     */
+    setVisible(visible: boolean): void;
+    render(renderer: Renderer): void;
+    /**
+     * 获取当前 Mesh 的可见性。
+     */
+    getVisible(): boolean;
+    /**
+     * 获取当前 Mesh 的第一个 geometry。
+     */
+    firstGeometry(): Geometry;
+    /**
+     * 设置当前 Mesh 的材质
+     * @param material - 要设置的材质
+     * @param destroy - 可选的材质销毁选项
+     */
+    setMaterial(material: Material, destroy?: MaterialDestroyOptions | DestroyOptions.keep): void;
+    restore(): void;
+    /**
+     * 销毁当前资源
+     * @param options - 可选的销毁选项
+     */
+    dispose(options?: MeshDestroyOptions): void;
+}

package/dist/render/post-process-pass.d.ts

@@ -0,0 +1,37 @@
+import type { RenderPassOptions } from './render-pass';
+import { RenderTargetHandle } from './render-pass';
+import { RenderPass } from './render-pass';
+import type { Renderer } from './renderer';
+export declare class BloomThresholdPass extends RenderPass {
+    sceneTextureHandle: RenderTargetHandle;
+    private mainTexture;
+    private screenMesh;
+    constructor(renderer: Renderer, option: RenderPassOptions);
+    configure(renderer: Renderer): void;
+    execute(renderer: Renderer): void;
+}
+export declare class HQGaussianDownSamplePass extends RenderPass {
+    gaussianResult: RenderTargetHandle;
+    private mainTexture;
+    private screenMesh;
+    private readonly type;
+    constructor(renderer: Renderer, type: 'V' | 'H', options: RenderPassOptions);
+    configure(renderer: Renderer): void;
+    execute(renderer: Renderer): void;
+}
+export declare class HQGaussianUpSamplePass extends RenderPass {
+    gaussianDownSampleResult: RenderTargetHandle;
+    private mainTexture;
+    private screenMesh;
+    constructor(renderer: Renderer, options: RenderPassOptions);
+    configure(renderer: Renderer): void;
+    execute(renderer: Renderer): void;
+}
+export declare class ToneMappingPass extends RenderPass {
+    private screenMesh;
+    private sceneTextureHandle;
+    private mainTexture;
+    constructor(renderer: Renderer, sceneTextureHandle?: RenderTargetHandle);
+    configure(renderer: Renderer): void;
+    execute(renderer: Renderer): void;
+}

package/dist/render/render-buffer.d.ts

@@ -0,0 +1,20 @@
+import type { Disposable } from '../utils';
+import type { RenderPassAttachmentStorageType } from './render-pass';
+export interface RenderBufferProps {
+    storageType: RenderPassAttachmentStorageType;
+    format: GLenum;
+    attachment: GLenum;
+}
+export declare abstract class RenderBuffer implements Disposable {
+    readonly size: [x: number, y: number];
+    readonly multiSample = 1;
+    readonly storageType: RenderPassAttachmentStorageType;
+    readonly format: GLenum;
+    readonly attachment: GLenum;
+    protected destroyed: boolean;
+    static create: (props: RenderBufferProps) => RenderBuffer;
+    constructor(props: RenderBufferProps);
+    get isDestroyed(): boolean;
+    abstract setSize(width: number, height: number): void;
+    abstract dispose(): void;
+}

package/dist/render/render-frame.d.ts

@@ -0,0 +1,269 @@
+import type { vec4 } from '@galacean/effects-specification';
+import type { Matrix4 } from '@galacean/effects-math/es/core/index';
+import { Vector2, Vector4 } from '@galacean/effects-math/es/core/index';
+import type { Camera } from '../camera';
+import type { UniformValue } from '../material';
+import { PassTextureCache } from '../paas-texture-cache';
+import type { SemanticFunc } from '../semantic-map';
+import { SemanticMap } from '../semantic-map';
+import { Texture } from '../texture';
+import type { Disposable } from '../utils';
+import { DestroyOptions } from '../utils';
+import { Mesh } from './mesh';
+import type { RenderPassClearAction, RenderPassColorAttachmentOptions, RenderPassDepthStencilAttachment, RenderPassDestroyOptions, RenderPassStoreAction } from './render-pass';
+import { RenderPass } from './render-pass';
+import type { Renderer } from './renderer';
+import type { GlobalVolume } from './global-volume';
+/**
+ * 渲染数据，保存了当前渲染使用到的数据。
+ */
+export interface RenderingData {
+    /**
+     * 当前渲染使用的 Camera
+     */
+    currentCamera: Camera;
+    /**
+     * 当前渲染的 RenderFrame
+     */
+    currentFrame: RenderFrame;
+    /**
+     * 当前渲染的 RenderPass
+     */
+    currentPass: RenderPass;
+}
+/**
+ * RenderPass 信息，记录了 RenderFrame 中 RenderPass 的信息
+ */
+export interface RenderPassInfo {
+    /**
+     * 内部包含 Mesh 中最小优先级
+     */
+    listStart: number;
+    /**
+     * 内部包含 Mesh 中最大优先级
+     */
+    listEnd: number;
+    /**
+     * 是否绑定 Framebuffer 对象
+     */
+    intermedia: boolean;
+    /**
+     * RenderPass 对象
+     */
+    renderPass: RenderPass;
+    /**
+     * 前面的 RenderPass 对象数组
+     */
+    prePasses?: {
+        pass: RenderPass;
+        destroyOptions?: RenderPassDestroyOptions | boolean;
+    }[];
+    /**
+     * 前一个 RenderPass 对象
+     */
+    preRenderPass?: RenderPass;
+}
+/**
+ * RenderFrame 内部保存的多 Pass 相关资源
+ */
+export interface RenderFrameResource {
+    /**
+     * 纹理对象，用于 FrameBuffer 的颜色 Attachment
+     */
+    color_a: Texture;
+    /**
+     * 纹理对象，用于 FrameBuffer 的颜色 Attachment
+     */
+    color_b: Texture;
+    /**
+     * 拷贝 RenderPass 对象，将前 RenderPass 的渲染结果拷贝到硬件帧缓存中
+     */
+    finalCopyRP: RenderPass;
+    /**
+     * 资源 RenderPass 对象，为临时生成的 RenderPass 提供 Attachment 资源
+     */
+    resRP: RenderPass;
+    /**
+     * 深度和蒙版，为临时生成的 RenderPass 提供 Attachment 资源
+     */
+    depthStencil?: RenderPassDepthStencilAttachment;
+}
+/**
+ * RenderPass 切分时的参数
+ */
+export interface RenderPassSplitOptions {
+    attachments?: RenderPassColorAttachmentOptions[];
+    storeAction?: RenderPassStoreAction;
+    prePasses?: RenderPass[];
+}
+export declare const RENDER_PASS_NAME_PREFIX = "_effects_default_";
+/**
+ * 抽象 RenderFrame 选项
+ */
+export interface RenderFrameOptions {
+    camera: Camera;
+    /**
+     * 编辑器整体变换，Player 开发不需要关注
+     */
+    editorTransform?: vec4;
+    /**
+     * 是否每次渲染时清除 RenderFrame 颜色缓存
+     */
+    keepColorBuffer?: boolean;
+    /**
+     * 渲染视口大小
+     */
+    viewport?: vec4;
+    /**
+     * RenderFrame 范围内共用的 Shader Uniform 变量，
+     * 以及多 Pass 渲染时 ColorAttachment 关联到后面的 Shader Uniform 上
+     */
+    semantics?: Record<string, UniformValue | SemanticFunc>;
+    /**
+     * 每个 RenderPass 使用前进行的 Clear 操作
+     */
+    clearAction?: RenderPassClearAction;
+    /**
+     * 后处理渲染配置
+     */
+    globalVolume?: Partial<GlobalVolume>;
+    /**
+     * 名称
+     */
+    name?: string;
+    renderer: Renderer;
+}
+export type RenderFrameDestroyOptions = {
+    passes?: RenderPassDestroyOptions | DestroyOptions.keep;
+    semantics?: DestroyOptions;
+};
+/**
+ * RenderFrame 抽象类
+ */
+export declare class RenderFrame implements Disposable {
+    /**
+     * 当前使用的全部 RenderPass
+     */
+    _renderPasses: RenderPass[];
+    /**
+     * RenderPass 清除帧缓存操作
+     */
+    clearAction: RenderPassClearAction;
+    /**
+     * 滤镜中 RenderPass 用到的纹理缓存器
+     */
+    passTextureCache: PassTextureCache;
+    /**
+     * 渲染时的相机
+     */
+    camera: Camera;
+    /**
+     * Composition中用到的所有纹理缓存
+     */
+    cachedTextures: Texture[];
+    /**
+     * 存放后处理的属性设置
+     */
+    globalVolume: GlobalVolume;
+    renderer: Renderer;
+    resource: RenderFrameResource;
+    keepColorBuffer?: boolean;
+    editorTransform: Vector4;
+    /**
+     * 名称
+     */
+    readonly name: string;
+    /**
+     * 公用 Uniform 变量表
+     */
+    readonly semantics: SemanticMap;
+    readonly globalUniforms: GlobalUniforms;
+    /**
+     * 空纹理，大小1x1，白色
+     */
+    readonly emptyTexture: Texture;
+    /**
+     * 空纹理，大小1x1，透明
+     */
+    readonly transparentTexture: Texture;
+    protected destroyed: boolean;
+    protected renderPassInfoMap: WeakMap<RenderPass, RenderPassInfo>;
+    constructor(options: RenderFrameOptions);
+    get renderPasses(): RenderPass[];
+    get isDestroyed(): boolean;
+    /**
+     * 根据 Mesh 优先级添加到 RenderPass
+     * @param mesh - 要添加的 Mesh 对象
+     */
+    addMeshToDefaultRenderPass(mesh: Mesh): void;
+    /**
+     * 把 Mesh 从 RenderPass 中移除，
+     * 如果 renderPass 中没有 mesh，此 renderPass 会被删除
+     * @param mesh - 要删除的 Mesh 对象
+     */
+    removeMeshFromDefaultRenderPass(mesh: Mesh): void;
+    /**
+     * 将 Mesh 所有在 RenderPass 进行切分
+     * @param mesh - 目标 Mesh 对象
+     * @param options - 切分选项，包含 RenderPass 相关的 Attachment 等数据
+     */
+    splitDefaultRenderPassByMesh(mesh: Mesh, options: RenderPassSplitOptions): RenderPass;
+    /**
+     * 销毁 RenderFrame
+     * @param options - 可以有选择销毁一些对象
+     */
+    dispose(options?: RenderFrameDestroyOptions): void;
+    /**
+     * 重置 RenderPass ColorAttachment，解决 FrameBuffer 即读又写的问题
+     * @param renderPasses - RenderPass 对象数组
+     * @param startIndex - 开始重置的索引
+     */
+    resetRenderPassDefaultAttachment(renderPasses: RenderPass[], startIndex: number): void;
+    /**
+     * 查找 Mesh 所在的 RenderPass 索引，没找到是-1
+     * @param mesh - 需要查找的 Mesh
+     */
+    findMeshRenderPassIndex(mesh: Mesh): number;
+    protected addToRenderPass(renderPass: RenderPass, mesh: Mesh): void;
+    protected getRPAttachments(attachments: RenderPassColorAttachmentOptions[], preRP?: RenderPass): RenderPassColorAttachmentOptions[];
+    protected resetClearActions(): void;
+    protected updateRenderInfo(renderPass: RenderPass): RenderPassInfo;
+    /**
+     * 设置 RenderPass 数组，直接修改内部的 RenderPass 数组
+     * @param passes - RenderPass 数组
+     */
+    setRenderPasses(passes: RenderPass[]): void;
+    /**
+     * 添加 RenderPass
+     * @param pass - 需要添加的 RenderPass
+     */
+    addRenderPass(pass: RenderPass): void;
+    /**
+     * 创建 RenderPass 切分时需要的 GPU 资源
+     */
+    createResource(): void;
+    /**
+     * 创建拷贝 RenderPass 用到的 Mesh 对象
+     * @param semantics - RenderPass 渲染时 FrameBuffer 的颜色和深度纹理、大小和是否混合
+     */
+    createCopyMesh(semantics?: {
+        tex?: string;
+        size?: string;
+        blend?: boolean;
+        depthTexture?: Texture;
+    }): Mesh;
+    /**
+     * 移除 RenderPass
+     * @param pass - 需要移除的 RenderPass
+     */
+    removeRenderPass(pass: RenderPass): void;
+}
+export declare function getTextureSize(tex?: Texture): Vector2;
+export declare function findPreviousRenderPass(renderPasses: RenderPass[], renderPass: RenderPass): RenderPass | undefined;
+export declare class GlobalUniforms {
+    floats: Record<string, number>;
+    ints: Record<string, number>;
+    matrices: Record<string, Matrix4>;
+    samplers: string[];
+    uniforms: string[];
+}