V3.8.0 pipeline api document #15529
Merged
V3.8.0 pipeline api document #15529
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Interface Check Report! WARNING this pull request has changed these public interfaces:
@@ -7459,9 +7459,9 @@
/**
* @en The render pipeline
* @zh 渲染管线
*/
- get pipeline(): rendering.PipelineRuntime;
+ get pipeline(): __private._cocos_rendering_custom_pipeline__PipelineRuntime;
/**
* @en The custom render pipeline
* @zh 自定义渲染管线
*/
@@ -22869,9 +22869,9 @@
* @zh 渲染管线对象决定了引擎对相关渲染场景下的所有渲染对象实施的完整渲染流程。
* 这个类主要包含一些通用的管线配置，必要的渲染资源和一些 [[RenderFlow]]。
* 渲染流程函数 [[render]] 会由 [[Root]] 发起调用并对所有 [[Camera]] 执行预设的渲染流程。
*/
- export abstract class RenderPipeline extends Asset implements __private._cocos_rendering_pipeline_event__IPipelineEvent, rendering.PipelineRuntime {
+ export abstract class RenderPipeline extends Asset implements __private._cocos_rendering_pipeline_event__IPipelineEvent, __private._cocos_rendering_custom_pipeline__PipelineRuntime {
/**
* @en The tag of pipeline.
* @zh 管线的标签。
* @readonly
@@ -34841,8 +34841,11 @@
BACKBUFFER = 4
}
export enum QueueHint {
NONE = 0,
+ OPAQUE = 1,
+ MASK = 2,
+ BLEND = 3,
RENDER_OPAQUE = 1,
RENDER_CUTOUT = 2,
RENDER_TRANSPARENT = 3
}
@@ -35060,167 +35063,790 @@
export const enableEffectImport = true;
export const programLib: __private._cocos_rendering_custom_private__ProgramLibrary;
export const customPipelineBuilderMap: Map<string, PipelineBuilder>;
export function getPipelineTypeName(e: PipelineType): string;
- export interface PipelineRuntime {
- activate(swapchain: gfx.Swapchain): boolean;
- destroy(): boolean;
- render(cameras: renderer.scene.Camera[]): void;
- readonly device: gfx.Device;
- readonly macros: renderer.MacroRecord;
- readonly globalDSManager: __private._cocos_rendering_global_descriptor_set_manager__GlobalDSManager;
- readonly descriptorSetLayout: gfx.DescriptorSetLayout;
- readonly descriptorSet: gfx.DescriptorSet;
- readonly commandBuffers: gfx.CommandBuffer[];
- readonly pipelineSceneData: PipelineSceneData;
- readonly constantMacros: string;
- profiler: renderer.scene.Model | null;
- readonly geometryRenderer: GeometryRenderer | null;
- shadingScale: number;
- getMacroString(name: string): string;
- getMacroInt(name: string): number;
- getMacroBool(name: string): boolean;
- setMacroString(name: string, value: string): void;
- setMacroInt(name: string, value: number): void;
- setMacroBool(name: string, value: boolean): void;
- onGlobalPipelineStateChanged(): void;
- }
+ /**
+ * @en Type of render pipeline.
+ * Different types of pipeline have different hardward capabilities and interfaces.
+ * @zh 管线类型，不同类型的管线具有不同的硬件能力与接口
+ */
export enum PipelineType {
+ /**
+ * @en Basic render pipeline.
+ * Basic render pipeline is available on all platforms.
+ * The corresponding interface is {@link BasicPipeline}
+ * @zh 基础渲染管线，全平台支持。对应接口为 {@link BasicPipeline}
+ */
BASIC = 0,
+ /**
+ * @en Standard render pipeline.
+ * Standard render pipeline supports compute shader and subpass rendering.
+ * It works well on Tile-based GPUs and is available on all native platforms.
+ * Vulkan, GLES3 and Metal backends are supported.
+ * The corresponding interface is {@link Pipeline}
+ * @zh 标准渲染管线.
+ * 标准渲染管线支持计算着色器(Compute Shader)与次通道渲染(Subpass rendering)。
+ * 能充分利用Tile-based GPU，支持所有原生平台并对移动平台特别优化。
+ * 支持Vulkan、GLES3、Metal图形后端。
+ * 对应接口为{@link Pipeline}
+ */
STANDARD = 1
}
+ /**
+ * @en Render subpass capabilities.
+ * Tile-based GPUs support reading color or depth_stencil attachment in pixel shader.
+ * Our implementation is based-on Vulkan abstraction (aka input attachment),
+ * and it is emulated on other graphics backends.
+ * For example, in GLES3 we have used various framebuffer fetch (FBF) extensions.
+ * As a result, different backends and hardwares support different input attachment features.
+ * User should inspect pipeline capabilities when implementing tile-based rendering algorithms.
+ * Using unsupported feature is undefined behaviour.
+ * @zh 次通道渲染能力
+ * Tile-based GPU可以在像素着色器读取当前像素的值。
+ * 我们的抽象方式基于Vulkan的input attachment，并在其他图形后端模拟了这个功能。
+ * 比如在GLES3上，我们使用了多种framebuffer fetch (FBF) 扩展来实现这个功能。
+ * 所以对于不同的硬件以及图形API，支持的能力是略有不同的。
+ * 在编写渲染算法时，应该查询当前设备的能力，来选择合适的tile-based算法。
+ * 使用硬件不支持的特性，会导致未定义行为。
+ */
export enum SubpassCapabilities {
NONE = 0,
+ /**
+ * @en Supports read depth/stencil value at current pixel.
+ * @zh 支持读取当前像素的depth/stencil值
+ */
INPUT_DEPTH_STENCIL = 1,
+ /**
+ * @en Supports read color value 0 at current pixel.
+ * @zh 支持读取当前像素第0个颜色值
+ */
INPUT_COLOR = 2,
+ /**
+ * @en Supports read color values at current pixel.
+ * @zh 支持读取当前像素任意颜色值
+ */
INPUT_COLOR_MRT = 4
}
+ /**
+ * @en Pipeline capabilities.
+ * The following capabilities are partially supported on different hardware and graphics backends.
+ * @zh 管线能力。根据硬件与后端，支持的特性会有所不同
+ */
export class PipelineCapabilities {
subpass: SubpassCapabilities;
}
+ /**
+ * @en Base class of render graph node.
+ * A node of render graph represents a specific type of rendering operation.
+ * A render graph consists of these nodes and form a forest(which is a set of trees).
+ * @zh RenderGraph中节点的基类，每个RenderGraph节点代表一种渲染操作，并构成一个森林(一组树)
+ */
export interface RenderNode {
+ /**
+ * @en Get debug name of current node.
+ * @zh 获得当前节点调试用的名字
+ */
name: string;
/**
- * @beta function signature might change
+ * @experimental
*/
setCustomBehavior(name: string): void;
}
+ /**
+ * @en Render node which supports setting uniforms and descriptors.
+ * @zh 节点支持设置常量值(uniform/constant)与描述符
+ */
export interface Setter extends RenderNode {
+ /**
+ * @en Set matrix4x4 常量(uniform) which consists of 16 floats (64 bytes).
+ * @zh 设置4x4矩阵，常量(uniform)有16个float (64 bytes)
+ * @param name @en uniform name in shader. @zh 填写着色器中的常量(uniform)名字
+ */
setMat4(name: string, mat: math.Mat4): void;
+ /**
+ * @en Set quaternion uniform which consists of 4 floats (16 bytes).
+ * @zh 设置四元数向量，常量(uniform)有4个float (16 bytes)
+ * @param name @en uniform name in shader. @zh 填写着色器中的常量(uniform)名字
+ */
setQuaternion(name: string, quat: math.Quat): void;
+ /**
+ * @en Set color uniform which consists of 4 floats (16 bytes).
+ * @zh 设置颜色值，常量(uniform)有4个float (16 bytes)
+ * @param name @en uniform name in shader. @zh 填写着色器中的常量(uniform)名字
+ */
setColor(name: string, color: gfx.Color): void;
+ /**
+ * @en Set vector4 uniform which consists of 4 floats (16 bytes).
+ * @zh 设置vector4向量，常量(uniform)有4个float (16 bytes)
+ * @param name @en uniform name in shader. @zh 填写着色器中的常量(uniform)名字
+ */
setVec4(name: string, vec: math.Vec4): void;
+ /**
+ * @en Set vector2 uniform which consists of 2 floats (8 bytes).
+ * @zh 设置vector2向量，常量(uniform)有2个float (8 bytes)
+ * @param name @en uniform name in shader. @zh 填写着色器中的常量(uniform)名字
+ */
setVec2(name: string, vec: math.Vec2): void;
+ /**
+ * @en Set float uniform (4 bytes).
+ * @zh 设置浮点值 (4 bytes)
+ * @param name @en uniform name in shader. @zh 填写着色器中的常量(uniform)名字
+ */
setFloat(name: string, v: number): void;
+ /**
+ * @en Set uniform array.
+ * Size and type of the data should match the corresponding uniforms in the shader.
+ * Mismatches will cause undefined behaviour.
+ * Memory alignment is not required.
+ * @zh 设置数组。类型与大小需要与着色器中的常量(uniform)相匹配，不匹配会引起未定义行为。
+ * 内存地址不需要对齐。
+ * @param name @en uniform name in shader. @zh 填写着色器中的常量(uniform)名字
+ * @param arrayBuffer @en array of bytes @zh byte数组
+ */
setArrayBuffer(name: string, arrayBuffer: ArrayBuffer): void;
+ /**
+ * @en Set buffer descriptor.
+ * Size and type of the buffer should match the one in shader.
+ * Buffer should be in read states and satisfy shader stage visibilities.
+ * Mismatches will cause undefined behaviour.
+ * @zh 设置缓冲(buffer)描述符。大小与类型需要与着色器中的一致，处于只读状态且着色阶段可见。
+ * 不匹配会引起未定义行为。
+ * @param name @en descriptor name in shader. @zh 填写着色器中的描述符(descriptor)名字
+ * @param buffer @en readonly buffer @zh 只读的缓冲
+ */
setBuffer(name: string, buffer: gfx.Buffer): void;
+ /**
+ * @en Set texture descriptor.
+ * Type of the texture should match the one in shader.
+ * Texture should be in read states and satisfy shader stage visibilities.
+ * Mismatches will cause undefined behaviour.
+ * @zh 设置贴图描述符。类型需要与着色器中的一致，处于只读状态且着色阶段可见。
+ * 不匹配会引起未定义行为。
+ * @param name @en descriptor name in shader. @zh 填写着色器中的描述符(descriptor)名字
+ * @param texture @en readonly texture @zh 只读的贴图
+ */
setTexture(name: string, texture: gfx.Texture): void;
+ /**
+ * @deprecated Method will be removed in 3.9.0
+ */
setReadWriteBuffer(name: string, buffer: gfx.Buffer): void;
+ /**
+ * @deprecated Method will be removed in 3.9.0
+ */
setReadWriteTexture(name: string, texture: gfx.Texture): void;
+ /**
+ * @en Set sampler descriptor.
+ * Type of the sampler should match the one in shader.
+ * @zh 设置采样器描述符。类型需要与着色器中的一致。
+ * 不匹配会引起未定义行为。
+ * @param name @en descriptor name in shader. @zh 填写着色器中的描述符(descriptor)名字
+ */
setSampler(name: string, sampler: gfx.Sampler): void;
}
+ /**
+ * @en Render queue
+ * A render queue is an abstraction of graphics commands submission.
+ * Only when the graphics commands in a render queue are all submitted,
+ * the next render queue will start submitting.
+ * @zh 渲染队列。渲染队列是图形命令提交的抽象。
+ * 只有一个渲染队列中的渲染命令全部提交完，才会开始提交下一个渲染队列中的命令。
+ */
export interface RenderQueueBuilder extends Setter {
/**
- * @deprecated method will be removed in 3.9.0
+ * @deprecated Method will be removed in 3.9.0
+ * @en Render the scene the camera is looking at.
+ * @zh 渲染当前相机指向的场景。
+ * @param camera @en Required camera @zh 所需相机
+ * @param light @en Lighting information of the scene @zh 场景光照信息
+ * @param sceneFlags @en Rendering flags of the scene @zh 场景渲染标志位
*/
addSceneOfCamera(camera: renderer.scene.Camera, light: LightInfo, sceneFlags?: SceneFlags): void;
+ /**
+ * @en Render a full-screen quad.
+ * @zh 渲染全屏四边形
+ * @param material @en The material used for shading @zh 着色所需材质
+ * @param passID @en Material pass ID @zh 材质通道ID
+ * @param sceneFlags @en Rendering flags of the quad @zh Quad所需场景渲染标志位
+ */
addFullscreenQuad(material: Material, passID: number, sceneFlags?: SceneFlags): void;
+ /**
+ * @en Render a full-screen quad from the camera view.
+ * @zh 从相机视角渲染全屏四边形
+ * @param camera @en The required camera @zh 所需相机
+ * @param material @en The material used for shading @zh 着色所需材质
+ * @param passID @en Material pass ID @zh 材质通道ID
+ * @param sceneFlags @en Rendering flags of the quad @zh Quad所需场景渲染标志位
+ */
addCameraQuad(camera: renderer.scene.Camera, material: Material, passID: number, sceneFlags?: SceneFlags): void;
+ /**
+ * @en Clear current render target.
+ * @zh 清除当前渲染目标
+ * @param name @en The name of the render target @zh 渲染目标的名字
+ * @param color @en The clearing color @zh 用来清除与填充的颜色
+ */
clearRenderTarget(name: string, color?: gfx.Color): void;
+ /**
+ * @en Set rendering viewport.
+ * @zh 设置渲染视口
+ * @param viewport @en The required viewport @zh 所需视口
+ */
setViewport(viewport: gfx.Viewport): void;
/**
- * @beta function signature might change
+ * @experimental
*/
addCustomCommand(customBehavior: string): void;
}
+ /**
+ * @en Basic render pass.
+ * @zh 基础光栅通道
+ */
export interface BasicRenderPassBuilder extends Setter {
+ /**
+ * @en Add render target for rasterization
+ * The render target must have registered in pipeline.
+ * @zh 添加光栅化渲染目标，渲染目标必须已注册。
+ * @param name @en name of the render target @zh 渲染目标的名字
+ * @param loadOp @en Type of load operation @zh 读取操作的类型
+ * @param storeOp @en Type of store operation @zh 写入操作的类型
+ * @param color @en The clear color to use when loadOp is Clear @zh 读取操作为清除时，所用颜色
+ */
addRenderTarget(name: string, loadOp?: gfx.LoadOp, storeOp?: gfx.StoreOp, color?: gfx.Color): void;
+ /**
+ * @en Add depth stencil for rasterization
+ * The depth stencil must have registered in pipeline.
+ * @zh 添加光栅化深度模板缓冲，深度模板缓冲必须已注册。
+ * @param name @en name of the depth stencil @zh 渲染目标的名字
+ * @param loadOp @en Type of load operation @zh 读取操作的类型
+ * @param storeOp @en Type of store operation @zh 写入操作的类型
+ * @param depth @en Depth value used to clear @zh 用于清除的深度值
+ * @param stencil @en Stencil value used to clear @zh 用于清除的模板值
+ * @param clearFlags @en To clear depth, stencil or both @zh 清除分量：深度、模板、两者。
+ */
addDepthStencil(name: string, loadOp?: gfx.LoadOp, storeOp?: gfx.StoreOp, depth?: number, stencil?: number, clearFlags?: gfx.ClearFlagBit): void;
+ /**
+ * @en Add texture for sampling
+ * The texture must have registered in pipeline.
+ * @zh 添加采样用的贴图，贴图必须已注册。
+ * @param name @en name of the texture @zh 贴图的注册名
+ * @param slotName @en name of descriptor in the shader @zh 着色器中描述符的名字
+ * @param sampler @en the sampler to use @zh 采样器名字
+ * @param plane @en the image plane ID to sample (color|depth|stencil|video) @zh 需要采样的贴图平面(颜色|深度|模板|视频)
+ */
addTexture(name: string, slotName: string, sampler?: gfx.Sampler | null, plane?: number): void;
+ /**
+ * @en Add render queue.
+ * Every render queue has a hint type, such as NONE, OPAQUE, MASK or BLEND.
+ * User should only add objects of this hint type to the render queue.
+ * Objects of mixed types might cause downgrading of performance.
+ * The order of render queues should be adjusted according to the hardward and algorithms,
+ * in order to reach peak performance.
+ * For example, [1.opaque, 2.mask, 3.blend] might result in best performance on mobile platforms.
+ * This hint is for validation only and has no effect on rendering.
+ *
+ * Every render queue has a phase name. Only objects of the same phase name will be rendered.
+ *
+ * @zh 添加渲染队列
+ * 每个渲染队列有一个用途提示，例如无提示(NONE)、不透明(OPAQUE)、遮罩(MASK)和混合(BLEND)。
+ * 每个队列最好只渲染相匹配的对象，混合不同类型的对象，会造成性能下降。
+ * 不同类型队列的渲染顺序，需要根据硬件类型与渲染算法进行调整，以到达最高性能。
+ * 比如在移动平台上，先渲染OPAQUE，再渲染MASK、最后渲染BLEND可能会有最好的性能。
+ * 用途提示只用于问题检测，对渲染流程没有任何影响。
+ *
+ * 每个队列有一个相位(phase)名字，具有相同相位名字的物件才会被渲染。
+ *
+ * @param hint @en Usage hint of the queue @zh 用途的提示
+ * @param phaseName @en The name of the phase declared in the effect. Default value is 'default' @zh effect中相位(phase)的名字，缺省为'default'。
+ * @returns @en render queue builder @zh 渲染队列
+ */
addQueue(hint?: QueueHint, phaseName?: string): RenderQueueBuilder;
+ /**
+ * @en Set rendering viewport.
+ * @zh 设置渲染视口
+ * @param viewport @en The required viewport @zh 所需视口
+ */
setViewport(viewport: gfx.Viewport): void;
+ /**
+ * @deprecated Method will be removed in 3.9.0
+ */
setVersion(name: string, version: number): void;
+ /**
+ * @en Show statistics on screen
+ * @zh 在屏幕上渲染统计数据
+ */
showStatistics: boolean;
}
- export interface BasicPipeline extends PipelineRuntime {
+ /**
+ * @en BasicPipeline
+ * Basic pipeline provides basic rendering features which are supported on all platforms.
+ * User can register resources which will be used in the render graph.
+ * Theses resources are generally read and write, and will be managed by the pipeline.
+ * In each frame, user can create a render graph to be executed by the pipeline.
+ * @zh 基础渲染管线。
+ * 基础渲染管线提供基础的渲染能力，能在全平台使用。
+ * 用户可以在渲染管线中注册资源，这些资源将由管线托管，用于render graph。
+ * 这些资源一般是可读写的资源。
+ * 用户可以每帧构建一个render graph，然后交由管线执行。
+ */
+ export interface BasicPipeline extends __private._cocos_rendering_custom_pipeline__PipelineRuntime {
readonly type: PipelineType;
readonly capabilities: PipelineCapabilities;
- beginSetup(): void;
- endSetup(): void;
+ /**
+ * @en Check whether the resource has been registered in the pipeline.
+ * @zh 检查资源是否在管线中已注册
+ * @param name @en Resource name @zh 资源名字
+ * @returns Exist or not
+ */
containsResource(name: string): boolean;
+ /**
+ * @en Add render window to the pipeline.
+ * @zh 注册渲染窗口(RenderWindow)
+ * @param name @en Resource name @zh 资源名字
+ * @param format @en Expected format of the render window @zh 期望的渲染窗口格式
+ * @param width @en Expected width of the render window @zh 期望的渲染窗口宽度
+ * @param height @en Expected height of the render window @zh 期望的渲染窗口高度
+ * @param renderWindow @en The render window to add. @zh 需要注册的渲染窗口
+ * @returns Resource ID
+ */
addRenderWindow(name: string, format: gfx.Format, width: number, height: number, renderWindow: __private._cocos_render_scene_core_render_window__RenderWindow): number;
+ /**
+ * @en Update render window information.
+ * When render window information is updated, such as resized, user should notify the pipeline.
+ * @zh 更新渲染窗口信息。当渲染窗口发生更新时，用户应通知管线。
+ * @param renderWindow @en The render window to update. @zh 渲染窗口
+ */
updateRenderWindow(name: string, renderWindow: __private._cocos_render_scene_core_render_window__RenderWindow): void;
+ /**
+ * @en Add 2D render target.
+ * @zh 添加2D渲染目标
+ * @param name @en Resource name @zh 资源名字
+ * @param format @en Format of the resource @zh 资源的格式
+ * @param width @en Width of the resource @zh 资源的宽度
+ * @param height @en Height of the resource @zh 资源的高度
+ * @param residency @en Residency of the resource. @zh 资源的驻留性
+ * @returns Resource ID
+ */
addRenderTarget(name: string, format: gfx.Format, width: number, height: number, residency?: ResourceResidency): number;
+ /**
+ * @en Add 2D depth stencil.
+ * @zh 添加2D深度模板缓冲
+ * @param name @en Resource name @zh 资源名字
+ * @param format @en Format of the resource @zh 资源的格式
+ * @param width @en Width of the resource @zh 资源的宽度
+ * @param height @en Height of the resource @zh 资源的高度
+ * @param residency @en Residency of the resource. @zh 资源的驻留性
+ * @returns Resource ID
+ */
addDepthStencil(name: string, format: gfx.Format, width: number, height: number, residency?: ResourceResidency): number;
+ /**
+ * @en Update render target information.
+ * @zh 更新渲染目标的信息
+ * @param name @en Resource name @zh 资源名字
+ * @param width @en Width of the resource @zh 资源的宽度
+ * @param height @en Height of the resource @zh 资源的高度
+ * @param format @en Format of the resource @zh 资源的格式
+ */
updateRenderTarget(name: string, width: number, height: number, format?: gfx.Format): void;
+ /**
+ * @en Update depth stencil information.
+ * @zh 更新深度模板缓冲的信息
+ * @param name @en Resource name @zh 资源名字
+ * @param width @en Width of the resource @zh 资源的宽度
+ * @param height @en Height of the resource @zh 资源的高度
+ * @param format @en Format of the resource @zh 资源的格式
+ */
updateDepthStencil(name: string, width: number, height: number, format?: gfx.Format): void;
- beginFrame(): void;
- update(camera: renderer.scene.Camera): void;
- endFrame(): void;
+ /**
+ * @en Add render pass
+ * @zh 添加渲染通道
+ * @param width @en Width of the render pass @zh 渲染通道的宽度
+ * @param height @en Height of the render pass @zh 渲染通道的高度
+ * @param passName @en Pass name declared in the effect. Default value is 'default' @zh effect中的pass name，缺省为'default'
+ * @returns Basic render pass builder
+ */
addRenderPass(width: number, height: number, passName?: string): BasicRenderPassBuilder;
+ /**
+ * @beta Feature is under development
+ * @en Add multisample render pass
+ * @zh 添加多重采样渲染通道
+ * @param width @en Width of the render pass @zh 渲染通道的宽度
+ * @param height @en Height of the render pass @zh 渲染通道的高度
+ * @param count @en Sample count @zh 采样数
+ * @param quality @en Sample quality. Default value is 0 @zh 采样质量，默认值是0
+ * @param passName @en Pass name declared in the effect. Default value is 'default' @zh effect中的pass name，缺省为'default'
+ * @returns Multisample basic render pass builder
+ */
addMultisampleRenderPass(width: number, height: number, count: number, quality: number, passName?: string): BasicRenderPassBuilder;
+ /**
+ * @deprecated Method will be removed in 3.9.0
+ */
addResolvePass(resolvePairs: ResolvePair[]): void;
+ /**
+ * @en Add copy pass.
+ * The source and target resources:
+ * Must be different resources(have different resource names).
+ * Must have compatible formats.
+ * Must have identical dimensions(width, height, depth), sample count and sample quality.
+ * Can't be currently mapped.
+ *
+ * Reinterpret copy is not supported.
+ *
+ * @zh 添加拷贝通道，来源与目标必须满足：
+ * 是不同的注册资源。
+ * 资源格式兼容。
+ * 具有相同的尺寸、采样数、采样质量。
+ * 不能被Map。
+ *
+ * 暂不支持转义拷贝。
+ *
+ * @param copyPairs @en Array of copy source and target @zh 拷贝来源与目标的数组
+ */
addCopyPass(copyPairs: CopyPair[]): void;
- getDescriptorSetLayout(shaderName: string, freq: UpdateFrequency): gfx.DescriptorSetLayout | null;
}
+ /**
+ * @beta Feature is under development
+ * @en Render subpass
+ * @zh 渲染次通道
+ */
export interface RenderSubpassBuilder extends Setter {
+ /**
+ * @en Add render target for rasterization
+ * The render target must have registered in pipeline.
+ * @zh 添加光栅化渲染目标，渲染目标必须已注册。
+ * @param name @en name of the render target @zh 渲染目标的名字
+ * @param accessType @en Access type @zh 读写状态
+ * @param slotName @en name of the descriptor in shader @zh 着色器中描述符的名字
+ * @param loadOp @en Type of load operation @zh 读取操作的类型
+ * @param storeOp @en Type of store operation @zh 写入操作的类型
+ * @param color @en The clear color to use when loadOp is Clear @zh 读取操作为清除时，所用颜色
+ */
addRenderTarget(name: string, accessType: AccessType, slotName?: string, loadOp?: gfx.LoadOp, storeOp?: gfx.StoreOp, color?: gfx.Color): void;
+ /**
+ * @en Add depth stencil for rasterization
+ * The depth stencil must have registered in pipeline.
+ * @zh 添加光栅化深度模板缓冲，深度模板缓冲必须已注册。
+ * @param name @en name of the depth stencil @zh 渲染目标的名字
+ * @param accessType @en Access type @zh 读写状态
+ * @param depthSlotName @en name of the depth descriptor in shader @zh 着色器中深度描述符的名字
+ * @param stencilSlotName @en name of the stencil descriptor in shader @zh 着色器中模板描述符的名字
+ * @param loadOp @en Type of load operation @zh 读取操作的类型
+ * @param storeOp @en Type of store operation @zh 写入操作的类型
+ * @param depth @en Depth value used to clear @zh 用于清除的深度值
+ * @param stencil @en Stencil value used to clear @zh 用于清除的模板值
+ * @param clearFlags @en To clear depth, stencil or both @zh 清除分量：深度、模板、两者。
+ */
addDepthStencil(name: string, accessType: AccessType, depthSlotName?: string, stencilSlotName?: string, loadOp?: gfx.LoadOp, storeOp?: gfx.StoreOp, depth?: number, stencil?: number, clearFlags?: gfx.ClearFlagBit): void;
+ /**
+ * @en Add texture for sampling
+ * The texture must have registered in pipeline.
+ * @zh 添加采样用的贴图，贴图必须已注册。
+ * @param name @en name of the texture @zh 贴图的注册名
+ * @param slotName @en name of descriptor in the shader @zh 着色器中描述符的名字
+ * @param sampler @en the sampler to use @zh 采样器名字
+ * @param plane @en the image plane ID to sample (color|depth|stencil|video) @zh 需要采样的贴图平面(颜色|深度|模板|视频)
+ */
addTexture(name: string, slotName: string, sampler?: gfx.Sampler | null, plane?: number): void;
+ /**
+ * @en Add storage buffer.
+ * The buffer must have registered in pipeline.
+ * @zh 添加存储缓冲，缓冲必须已注册。
+ * @param name @en Name of the buffer @zh 缓冲的注册名
+ * @param accessType @en Access type @zh 读写状态
+ * @param slotName @en name of descriptor in the shader @zh 着色器中描述符的名字
+ */
addStorageBuffer(name: string, accessType: AccessType, slotName: string): void;
+ /**
+ * @en Add storage texture.
+ * The texture must have registered in pipeline.
+ * @zh 添加存储贴图，贴图必须已注册。
+ * @param name @en Name of the buffer @zh 贴图的注册名
+ * @param accessType @en Access type @zh 读写状态
+ * @param slotName @en name of descriptor in the shader @zh 着色器中描述符的名字
+ */
addStorageImage(name: string, accessType: AccessType, slotName: string): void;
+ /**
+ * @en Set rendering viewport.
+ * @zh 设置渲染视口
+ * @param viewport @en The required viewport @zh 所需视口
+ */
setViewport(viewport: gfx.Viewport): void;
+ /**
+ * @en Add render queue.
+ * Every render queue has a hint type, such as NONE, OPAQUE, MASK or BLEND.
+ * User should only add objects of this hint type to the render queue.
+ * Objects of mixed types might cause downgrading of performance.
+ * The order of render queues should be adjusted according to the hardward and algorithms,
+ * in order to reach peak performance.
+ * For example, [1.opaque, 2.mask, 3.blend] might result in best performance on mobile platforms.
+ * This hint is for validation only and has no effect on rendering.
+ *
+ * Every render queue has a phase name. Only objects of the same phase name will be rendered.
+ *
+ * @zh 添加渲染队列
+ * 每个渲染队列有一个用途提示，例如无提示(NONE)、不透明(OPAQUE)、遮罩(MASK)和混合(BLEND)。
+ * 每个队列最好只渲染相匹配的对象，混合不同类型的对象，会造成性能下降。
+ * 不同类型队列的渲染顺序，需要根据硬件类型与渲染算法进行调整，以到达最高性能。
+ * 比如在移动平台上，先渲染OPAQUE，再渲染MASK、最后渲染BLEND可能会有最好的性能。
+ * 用途提示只用于问题检测，对渲染流程没有任何影响。
+ *
+ * 每个队列有一个相位(phase)名字，具有相同相位名字的物件才会被渲染。
+ *
+ * @param hint @en Usage hint of the queue @zh 用途的提示
+ * @param phaseName @en The name of the phase declared in the effect. Default value is 'default' @zh effect中相位(phase)的名字，缺省为'default'。
+ * @returns @en render queue builder @zh 渲染队列
+ */
addQueue(hint?: QueueHint, phaseName?: string): RenderQueueBuilder;
+ /**
+ * @en Show statistics on screen
+ * @zh 在屏幕上渲染统计数据
+ */
showStatistics: boolean;
/**
- * @beta function signature might change
+ * @experimental
*/
setCustomShaderStages(name: string, stageFlags: gfx.ShaderStageFlagBit): void;
}
+ /**
+ * @beta Feature is under development
+ * @en Multisample render subpass
+ * @zh 多重采样渲染次通道
+ */
export interface MultisampleRenderSubpassBuilder extends RenderSubpassBuilder {
+ /**
+ * @en Resolve render target
+ * @zh 汇总渲染目标
+ * @param source @en Multisample source @zh 多重采样来源
+ * @param target @en Resolve target @zh 汇总目标
+ */
resolveRenderTarget(source: string, target: string): void;
+ /**
+ * @en Resolve depth stencil
+ * @zh 汇总深度模板缓冲
+ * @param source @en Multisample source @zh 多重采样来源
+ * @param target @en Resolve target @zh 汇总目标
+ * @param depthMode @en Resolve mode of depth component @zh 深度分量汇总模式
+ * @param stencilMode @en Resolve mode of stencil component @zh 模板分量汇总模式
+ */
resolveDepthStencil(source: string, target: string, depthMode?: gfx.ResolveMode, stencilMode?: gfx.ResolveMode): void;
}
+ /**
+ * @en Compute queue
+ * @zh 计算队列
+ */
export interface ComputeQueueBuilder extends Setter {
+ /**
+ * @en Dispatch compute task
+ * @zh 发送计算任务
+ * @param threadGroupCountX @en Thread group count X @zh 线程组的X分量的数目
+ * @param threadGroupCountY @en Thread group count Y @zh 线程组的Y分量的数目
+ * @param threadGroupCountZ @en Thread group count Z @zh 线程组的Z分量的数目
+ * @param material @en The material to use @zh 计算任务用的材质
+ * @param passID @en The name of the pass declared in the effect. @zh effect中的通道名字
+ */
addDispatch(threadGroupCountX: number, threadGroupCountY: number, threadGroupCountZ: number, material?: Material, passID?: number): void;
}
+ /**
+ * @beta Feature is under development
+ * @en Compute subpass
+ * @zh 计算次通道
+ */
export interface ComputeSubpassBuilder extends Setter {
+ /**
+ * @en Add input render target.
+ * @zh 添加输入渲染目标
+ * @param name @en name of the render target @zh 渲染目标的名字
+ * @param slotName @en name of the descriptor in shader @zh 着色器中描述符的名字
+ */
addRenderTarget(name: string, slotName: string): void;
+ /**
+ * @en Add texture for sampling
+ * The texture must have registered in pipeline.
+ * @zh 添加采样用的贴图，贴图必须已注册。
+ * @param name @en name of the texture @zh 贴图的注册名
+ * @param slotName @en name of descriptor in the shader @zh 着色器中描述符的名字
+ * @param sampler @en the sampler to use @zh 采样器名字
+ * @param plane @en the image plane ID to sample (color|depth|stencil|video) @zh 需要采样的贴图平面(颜色|深度|模板|视频)
+ */
addTexture(name: string, slotName: string, sampler?: gfx.Sampler | null, plane?: number): void;
+ /**
+ * @en Add storage buffer.
+ * The buffer must have registered in pipeline.
+ * @zh 添加存储缓冲，缓冲必须已注册。
+ * @param name @en Name of the buffer @zh 缓冲的注册名
+ * @param accessType @en Access type @zh 读写状态
+ * @param slotName @en name of descriptor in the shader @zh 着色器中描述符的名字
+ */
addStorageBuffer(name: string, accessType: AccessType, slotName: string): void;
+ /**
+ * @en Add storage texture.
+ * The texture must have registered in pipeline.
+ * @zh 添加存储贴图，贴图必须已注册。
+ * @param name @en Name of the buffer @zh 贴图的注册名
+ * @param accessType @en Access type @zh 读写状态
+ * @param slotName @en name of descriptor in the shader @zh 着色器中描述符的名字
+ */
addStorageImage(name: string, accessType: AccessType, slotName: string): void;
+ /**
+ * @en Add render queue.
+ * Every render queue has a hint type, such as NONE, OPAQUE, MASK or BLEND.
+ * User should only add objects of this hint type to the render queue.
+ * Objects of mixed types might cause downgrading of performance.
+ * The order of render queues should be adjusted according to the hardward and algorithms,
+ * in order to reach peak performance.
+ * For example, [1.opaque, 2.mask, 3.blend] might result in best performance on mobile platforms.
+ * This hint is for validation only and has no effect on rendering.
+ *
+ * Every render queue has a phase name. Only objects of the same phase name will be rendered.
+ *
+ * @zh 添加渲染队列
+ * 每个渲染队列有一个用途提示，例如无提示(NONE)、不透明(OPAQUE)、遮罩(MASK)和混合(BLEND)。
+ * 每个队列最好只渲染相匹配的对象，混合不同类型的对象，会造成性能下降。
+ * 不同类型队列的渲染顺序，需要根据硬件类型与渲染算法进行调整，以到达最高性能。
+ * 比如在移动平台上，先渲染OPAQUE，再渲染MASK、最后渲染BLEND可能会有最好的性能。
+ * 用途提示只用于问题检测，对渲染流程没有任何影响。
+ *
+ * 每个队列有一个相位(phase)名字，具有相同相位名字的物件才会被渲染。
+ *
+ * @param hint @en Usage hint of the queue @zh 用途的提示
+ * @param phaseName @en The name of the phase declared in the effect. Default value is 'default' @zh effect中相位(phase)的名字，缺省为'default'。
+ * @returns @en compute queue builder @zh 计算队列
+ */
addQueue(phaseName?: string): ComputeQueueBuilder;
/**
- * @beta function signature might change
+ * @experimental
*/
setCustomShaderStages(name: string, stageFlags: gfx.ShaderStageFlagBit): void;
}
+ /**
+ * @beta Feature is under development
+ * @en Render pass
+ * @zh 渲染通道
+ */
export interface RenderPassBuilder extends BasicRenderPassBuilder {
+ /**
+ * @en Add storage buffer.
+ * The buffer must have registered in pipeline.
+ * @zh 添加存储缓冲，缓冲必须已注册。
+ * @param name @en Name of the buffer @zh 缓冲的注册名
+ * @param accessType @en Access type @zh 读写状态
+ * @param slotName @en name of descriptor in the shader @zh 着色器中描述符的名字
+ */
addStorageBuffer(name: string, accessType: AccessType, slotName: string): void;
+ /**
+ * @en Add storage texture.
+ * The texture must have registered in pipeline.
+ * @zh 添加存储贴图，贴图必须已注册。
+ * @param name @en Name of the buffer @zh 贴图的注册名
+ * @param accessType @en Access type @zh 读写状态
+ * @param slotName @en name of descriptor in the shader @zh 着色器中描述符的名字
+ */
addStorageImage(name: string, accessType: AccessType, slotName: string): void;
/**
- * @beta function signature might change
+ * @beta Feature is under development
*/
addMaterialTexture(resourceName: string, flags?: gfx.ShaderStageFlagBit): void;
+ /**
+ * @beta Feature is under development
+ * @en Add render subpass.
+ * @zh 添加渲染次通道
+ * @param subpassName @en Subpass name declared in the effect @zh effect中的subpass name
+ * @returns Render subpass builder
+ */
addRenderSubpass(subpassName: string): RenderSubpassBuilder;
+ /**
+ * @beta Feature is under development
+ * @en Add multisample render subpass.
+ * Sample count and quality should match those of the resources.
+ * @zh 添加多重采样渲染次通道，采样数与质量需要与资源一致。
+ * @param count @en Sample count @zh 采样数
+ * @param quality @en Sample quality @zh 采样质量
+ * @param subpassName @en Subpass name declared in the effect @zh effect中的subpass name
+ * @returns Multisample render subpass builder
+ */
addMultisampleRenderSubpass(count: number, quality: number, subpassName: string): MultisampleRenderSubpassBuilder;
+ /**
+ * @experimental
+ * @en Add compute subpass.
+ * @zh 添加计算次通道
+ * @param subpassName @en Subpass name declared in the effect @zh effect中的subpass name
+ * @returns Compute subpass builder
+ */
addComputeSubpass(subpassName?: string): ComputeSubpassBuilder;
/**
- * @beta function signature might change
+ * @experimental
*/
setCustomShaderStages(name: string, stageFlags: gfx.ShaderStageFlagBit): void;
}
+ /**
+ * @en Compute pass
+ * @zh 计算通道
+ */
export interface ComputePassBuilder extends Setter {
+ /**
+ * @en Add texture for sampling
+ * The texture must have registered in pipeline.
+ * @zh 添加采样用的贴图，贴图必须已注册。
+ * @param name @en name of the texture @zh 贴图的注册名
+ * @param slotName @en name of descriptor in the shader @zh 着色器中描述符的名字
+ * @param sampler @en the sampler to use @zh 采样器名字
+ * @param plane @en the image plane ID to sample (color|depth|stencil|video) @zh 需要采样的贴图平面(颜色|深度|模板|视频)
+ */
addTexture(name: string, slotName: string, sampler?: gfx.Sampler | null, plane?: number): void;
+ /**
+ * @en Add storage buffer.
+ * The buffer must have registered in pipeline.
+ * @zh 添加存储缓冲，缓冲必须已注册。
+ * @param name @en Name of the buffer @zh 缓冲的注册名
+ * @param accessType @en Access type @zh 读写状态
+ * @param slotName @en name of descriptor in the shader @zh 着色器中描述符的名字
+ */
addStorageBuffer(name: string, accessType: AccessType, slotName: string): void;
+ /**
+ * @en Add storage texture.
+ * The texture must have registered in pipeline.
+ * @zh 添加存储贴图，贴图必须已注册。
+ * @param name @en Name of the buffer @zh 贴图的注册名
+ * @param accessType @en Access type @zh 读写状态
+ * @param slotName @en name of descriptor in the shader @zh 着色器中描述符的名字
+ */
addStorageImage(name: string, accessType: AccessType, slotName: string): void;
+ /**
+ * @beta Feature is under development
+ */
addMaterialTexture(resourceName: string, flags?: gfx.ShaderStageFlagBit): void;
+ /**
+ * @en Add render queue.
+ * Every render queue has a hint type, such as NONE, OPAQUE, MASK or BLEND.
+ * User should only add objects of this hint type to the render queue.
+ * Objects of mixed types might cause downgrading of performance.
+ * The order of render queues should be adjusted according to the hardward and algorithms,
+ * in order to reach peak performance.
+ * For example, [1.opaque, 2.mask, 3.blend] might result in best performance on mobile platforms.
+ * This hint is for validation only and has no effect on rendering.
+ *
+ * Every render queue has a phase name. Only objects of the same phase name will be rendered.
+ *
+ * @zh 添加渲染队列
+ * 每个渲染队列有一个用途提示，例如无提示(NONE)、不透明(OPAQUE)、遮罩(MASK)和混合(BLEND)。
+ * 每个队列最好只渲染相匹配的对象，混合不同类型的对象，会造成性能下降。
+ * 不同类型队列的渲染顺序，需要根据硬件类型与渲染算法进行调整，以到达最高性能。
+ * 比如在移动平台上，先渲染OPAQUE，再渲染MASK、最后渲染BLEND可能会有最好的性能。
+ * 用途提示只用于问题检测，对渲染流程没有任何影响。
+ *
+ * 每个队列有一个相位(phase)名字，具有相同相位名字的物件才会被渲染。
+ *
+ * @param hint @en Usage hint of the queue @zh 用途的提示
+ * @param phaseName @en The name of the phase declared in the effect. Default value is 'default' @zh effect中相位(phase)的名字，缺省为'default'。
+ * @returns @en compute queue builder @zh 计算队列
+ */
addQueue(phaseName?: string): ComputeQueueBuilder;
/**
- * @beta function signature might change
+ * @experimental
*/
setCustomShaderStages(name: string, stageFlags: gfx.ShaderStageFlagBit): void;
}
+ /**
+ * @deprecated @en Not used @zh 未使用
+ */
export interface SceneVisitor {
readonly pipelineSceneData: PipelineSceneData;
setViewport(vp: gfx.Viewport): void;
setScissor(rect: gfx.Rect): void;
@@ -35229,45 +35855,166 @@
draw(info: gfx.DrawInfo): void;
bindDescriptorSet(set: number, descriptorSet: gfx.DescriptorSet, dynamicOffsets?: number[]): void;
updateBuffer(buffer: gfx.Buffer, data: ArrayBuffer, size?: number): void;
}
+ /**
+ * @deprecated @en Not used @zh 未使用
+ */
export interface SceneTask {
readonly taskType: TaskType;
start(): void;
join(): void;
submit(): void;
}
+ /**
+ * @deprecated @en Not used @zh 未使用
+ */
export interface SceneTransversal {
transverse(visitor: SceneVisitor): SceneTask;
}
+ /**
+ * @en Render pipeline.
+ * @zh 渲染管线
+ */
export interface Pipeline extends BasicPipeline {
+ /**
+ * @en Add storage buffer.
+ * @zh 添加存储缓冲
+ * @param name @en Resource name @zh 资源名字
+ * @param format @en Format of the resource @zh 资源的格式
+ * @param size @en Size of the resource @zh 资源的大小
+ * @param residency @en Residency of the resource. @zh 资源的驻留性
+ */
addStorageBuffer(name: string, format: gfx.Format, size: number, residency?: ResourceResidency): number;
+ /**
+ * @en Add 2D storage texture
+ * @zh 添加2D存储贴图
+ * @param name @en Resource name @zh 资源名字
+ * @param format @en Format of the resource @zh 资源的格式
+ * @param width @en Width of the resource @zh 资源的宽度
+ * @param height @en Height of the resource @zh 资源的高度
+ * @param residency @en Residency of the resource. @zh 资源的驻留性
+ */
addStorageTexture(name: string, format: gfx.Format, width: number, height: number, residency?: ResourceResidency): number;
+ /**
+ * @experimental
+ * @en Add 2D shading rate texture
+ * @zh 添加2D着色率贴图
+ * @param name @en Resource name @zh 资源名字
+ * @param width @en Width of the resource @zh 资源的宽度
+ * @param height @en Height of the resource @zh 资源的高度
+ * @param residency @en Residency of the resource. @zh 资源的驻留性
+ */
addShadingRateTexture(name: string, width: number, height: number, residency?: ResourceResidency): number;
+ /**
+ * @en Update storage buffer information.
+ * @zh 更新存储缓冲的信息
+ * @param name @en Resource name @zh 资源名字
+ * @param size @en Size of the resource @zh 资源的大小
+ * @param format @en Format of the resource @zh 资源的格式
+ */
updateStorageBuffer(name: string, size: number, format?: gfx.Format): void;
+ /**
+ * @en Update storage texture information.
+ * @zh 更新2D存储贴图的信息
+ * @param name @en Resource name @zh 资源名字
+ * @param width @en Width of the resource @zh 资源的宽度
+ * @param height @en Height of the resource @zh 资源的高度
+ * @param format @en Format of the resource @zh 资源的格式
+ */
updateStorageTexture(name: string, width: number, height: number, format?: gfx.Format): void;
+ /**
+ * @en Update shading rate texture information.
+ * @zh 更新2D着色率贴图的信息
+ * @param name @en Resource name @zh 资源名字
+ * @param width @en Width of the resource @zh 资源的宽度
+ * @param height @en Height of the resource @zh 资源的高度
+ */
updateShadingRateTexture(name: string, width: number, height: number): void;
+ /**
+ * @en Add render pass
+ * @zh 添加渲染通道
+ * @param width @en Width of the render pass @zh 渲染通道的宽度
+ * @param height @en Height of the render pass @zh 渲染通道的高度
+ * @param passName @en Pass name declared in the effect. Default value is 'default' @zh effect中的pass name，缺省为'default'
+ * @returns Render pass builder
+ */
addRenderPass(width: number, height: number, passName: string): RenderPassBuilder;
+ /**
+ * @en Add compute pass
+ * @zh 添加计算通道
+ * @param passName @en Pass name declared in the effect. Default value is 'default' @zh effect中的pass name，缺省为'default'
+ * @returns Compute pass builder
+ */
addComputePass(passName: string): ComputePassBuilder;
+ /**
+ * @beta Feature is under development
+ * @en Add upload pass.
+ * The source and target resources:
+ * Must be different resources(have different resource names).
+ * Must have compatible formats.
+ * Must have identical dimensions(width, height, depth), sample count and sample quality.
+ * Can't be currently mapped.
+ *
+ * @zh 添加上传通道，来源与目标必须满足：
+ * 是不同的注册资源。
+ * 资源格式兼容。
+ * 具有相同的尺寸、采样数、采样质量。
+ * 不能被Map。
+ *
+ * @param uploadPairs @en Array of upload source and target @zh 上传来源与目标的数组
+ */
addUploadPass(uploadPairs: UploadPair[]): void;
+ /**
+ * @en Add move pass.
+ * Move-construct target resource, by moving source resources into subresources of target.
+ * After the move, the target resource must be completely initialized.
+ * Target write conflicts will result in undefined behaviour.
+ * The source and target resources:
+ * Must be different resources(have different resource names).
+ * Must have compatible formats.
+ * Must have identical dimensions(width, height, depth), sample count and sample quality.
+ * Can't be currently mapped.
+ *
+ * @zh 添加移动通道。
+ * 移动构造目标资源，将来源移入目标的次级资源。
+ * 移动后，目标资源必须完全初始化。
+ * 目标写入冲突是未定义行为。
+ * 来源与目标必须满足：
+ * 是不同的注册资源。
+ * 资源格式兼容。
+ * 具有相同的尺寸、采样数、采样质量。
+ * 不能被Map。
+ *
+ * @param movePairs @en Array of move source and target @zh 移动来源与目标的数组
+ */
addMovePass(movePairs: MovePair[]): void;
/**
- * @beta function signature might change
+ * @experimental
*/
addCustomBuffer(name: string, info: gfx.BufferInfo, type: string): number;
/**
- * @beta function signature might change
+ * @experimental
*/
addCustomTexture(name: string, info: gfx.TextureInfo, type: string): number;
}
+ /**
+ * @en Pipeline builder.
+ * User can implement this interface and setup render graph.
+ * Call setCustomPipeline to register the pipeline builder
+ * @zh 管线构造器
+ * 用户可以实现这个接口，来构建自己想要的render graph。
+ * 调用setCustomPipeline注册管线
+ */
export interface PipelineBuilder {
+ /**
+ * @en Setup render graph
+ * @zh 构建渲染管线
+ * @param cameras @en Camera list to render @zh 需要渲染的相机列表
+ * @param pipeline @en Current render pipeline @zh 当前管线
+ */
setup(cameras: renderer.scene.Camera[], pipeline: BasicPipeline): void;
}
- export interface RenderingModule {
- getPassID(name: string): number;
- getSubpassID(passID: number, name: string): number;
- getPhaseID(subpassOrPassID: number, name: string): number;
- }
}
export namespace postProcess {
export class PostProcessSetting extends Component {
static _default: PostProcessSetting | undefined;
@@ -35353,9 +36100,9 @@
get setting(): PostProcessSetting;
checkEnable(camera: renderer.scene.Camera): boolean;
}
export function getRTFormatBeforeToneMapping(ppl: rendering.BasicPipeline): gfx.Format.RGBA8 | gfx.Format.RGBA16F;
- export function forceEnableFloatOutput(ppl: rendering.PipelineRuntime): boolean;
+ export function forceEnableFloatOutput(ppl: __private._cocos_rendering_custom_pipeline__PipelineRuntime): boolean;
export function disablePostProcessForDebugView(): boolean;
export function getShadowMapSampler(): gfx.Sampler | null;
export abstract class BasePass {
abstract name: string;
@@ -59938,8 +60685,187 @@
* @zh 按照优先级对所有挂载的相机排序
*/
sortCameras(): void;
}
+ export class _cocos_rendering_global_descriptor_set_manager__GlobalDSManager {
+ get descriptorSetMap(): Map<renderer.scene.Light, gfx.DescriptorSet>;
+ get linearSampler(): gfx.Sampler;
+ get pointSampler(): gfx.Sampler;
+ get descriptorSetLayout(): gfx.DescriptorSetLayout;
+ set globalDescriptorSet(val: gfx.DescriptorSet);
+ get globalDescriptorSet(): gfx.DescriptorSet;
+ constructor(device: gfx.Device);
+ regenLayout(): void;
+ /**
+ * @en Bind buffer for all descriptorSets, so that all created descriptorSet buffer are consistent
+ * @zh 为所有的 descriptorSet 绑定 buffer，使得所有已创建的 descriptorSet buffer 保持一致
+ * @param binding The target binding.
+ * @param buffer The buffer to be bound.
+ */
+ bindBuffer(binding: number, buffer: gfx.Buffer): void;
+ /**
+ * @en Bind sampler for all descriptorSets, so that all created descriptorSet sampler are consistent
+ * @zh 为所有的 descriptorSet 绑定 sampler，使得所有已创建的 descriptorSet sampler 保持一致
+ * @param binding The target binding.
+ * @param sampler The sampler to be bound.
+ */
+ bindSampler(binding: number, sampler: gfx.Sampler): void;
+ /**
+ * @en Bind texture for all descriptorSets, so that all created descriptorSet texture are consistent
+ * @zh 为所有的 descriptorSet 绑定 texture，使得所有已创建的 descriptorSet texture 保持一致
+ * @param binding The target binding.
+ * @param texture The texture to be bound.
+ */
+ bindTexture(binding: number, texture: gfx.Texture): void;
+ /**
+ * @en Update all descriptorSet
+ * @zh 更新所有的 descriptorSet
+ */
+ update(): void;
+ /**
+ * @en The layout of all created descriptorSets in buffer, sampler, and texture (except shadow) is consistent with the globalDescriptorSet
+ * @zh 所有创建出来的 descriptorSet 在 buffer、 sampler、 texture（shadow 除外）的布局与 globalDescriptorSet 保持一致
+ * @param idx Specify index creation
+ * @return descriptorSet
+ */
+ getOrCreateDescriptorSet(light: renderer.scene.Light): gfx.DescriptorSet | undefined;
+ destroy(): void;
+ }
+ /**
+ * @engineInternal
+ * @en PipelineRuntime is the runtime of both classical and custom pipelines.
+ * It is used internally and should not be called directly.
+ * @zh PipelineRuntime是经典管线以及自定义管线的运行时。
+ * 属于内部实现，用户不应直接调用。
+ */
+ export interface _cocos_rendering_custom_pipeline__PipelineRuntime {
+ /**
+ * @en Activate PipelineRuntime with default swapchain
+ * @zh 用默认交换链初始化PipelineRuntime
+ * @param swapchain @en Default swapchain @zh 默认的交换链
+ * @returns Success or not
+ */
+ activate(swapchain: gfx.Swapchain): boolean;
+ /**
+ * @en Destroy resources of PipelineRuntime
+ * @zh 销毁PipelineRuntime所持资源
+ * @returns Success or not
+ */
+ destroy(): boolean;
+ /**
+ * @en Render contents of cameras
+ * @zh 根据相机进行绘制
+ * @param cameras @en Camera list @zh 相机列表
+ */
+ render(cameras: renderer.scene.Camera[]): void;
+ /**
+ * @en Get graphics device
+ * @zh 获得图形设备
+ */
+ readonly device: gfx.Device;
+ /**
+ * @en Get user macros
+ * @zh 获得用户宏列表
+ */
+ readonly macros: renderer.MacroRecord;
+ /**
+ * @en Get global descriptor set manager
+ * @zh 获得全局(Global)级别描述符集(DescriptorSet)管理器
+ */
+ readonly globalDSManager: _cocos_rendering_global_descriptor_set_manager__GlobalDSManager;
+ /**
+ * @en Get global descriptor set layout
+ * @zh 获得全局(Global)级别描述符集的布局(DescriptorSet Layout)
+ */
+ readonly descriptorSetLayout: gfx.DescriptorSetLayout;
+ /**
+ * @en Get global descriptor set
+ * @zh 获得全局(Global)级别描述符集(DescriptorSet)
+ */
+ readonly descriptorSet: gfx.DescriptorSet;
+ /**
+ * @en Get command buffers of render pipeline
+ * @zh 获得渲染管线的命令缓冲(CommandBuffer)列表
+ */
+ readonly commandBuffers: gfx.CommandBuffer[];
+ /**
+ * @en Get scene data of render pipeline.
+ * Scene data contains render configurations of the current scene.
+ * @zh 获得渲染管线相关的场景数据，此场景数据一般包含渲染所需配置信息
+ */
+ readonly pipelineSceneData: PipelineSceneData;
+ /**
+ * @en Get constant macros.
+ * Constant macro is platform-dependent and immutable.
+ * @zh 获得常量宏列表，常量宏平台相关且无法修改
+ */
+ readonly constantMacros: string;
+ /**
+ * @en Get profiler model.
+ * This model is used to render profile information in Debug mode.
+ * @zh 获得分析工具(Profiler)的渲染实例，用于Debug模式下显示调试与性能检测信息
+ */
+ profiler: renderer.scene.Model | null;
+ /**
+ * @en Get geometry renderer.
+ * Geometry renderer is used to render procedural geometries.
+ * @zh 获得几何渲染器(GeometryRenderer)，几何渲染器用于程序化渲染基础几何图形
+ */
+ readonly geometryRenderer: GeometryRenderer | null;
+ /**
+ * @en Get shading scale.
+ * Shading scale affects shading texels per pixel.
+ * @zh 获得渲染倍率(ShadingScale)，每像素(pixel)绘制的纹素(texel)会根据渲染倍率进行调整。
+ */
+ shadingScale: number;
+ /**
+ * @en Get macro as string.
+ * @zh 根据宏名获得字符串
+ * @param name @en Name of macro @zh 宏的名字
+ * @returns String value
+ */
+ getMacroString(name: string): string;
+ /**
+ * @en Get macro as integer.
+ * @zh 根据宏名获得整型
+ * @param name @en Name of macro @zh 宏的名字
+ * @returns Integer value
+ */
+ getMacroInt(name: string): number;
+ /**
+ * @en Get macro as boolean.
+ * @zh 根据宏名获得布尔值
+ * @param name @en Name of macro @zh 宏的名字
+ * @returns Boolean value
+ */
+ getMacroBool(name: string): boolean;
+ /**
+ * @en Assign string value to macro.
+ * @zh 给宏赋值字符串
+ * @param name @en Name of macro @zh 宏的名字
+ * @param value @en String value @zh 字符串
+ */
+ setMacroString(name: string, value: string): void;
+ /**
+ * @en Assign integer value to macro.
+ * @zh 给宏赋值整型
+ * @param name @en Name of macro @zh 宏的名字
+ * @param value @en Integer value @zh 整型值
+ */
+ setMacroInt(name: string, value: number): void;
+ /**
+ * @en Assign boolean value to macro.
+ * @zh 给宏赋值布尔值
+ * @param name @en Name of macro @zh 宏的名字
+ * @param value @en Boolean value @zh 布尔值
+ */
+ setMacroBool(name: string, value: boolean): void;
+ /**
+ * @en Trigger pipeline state change event
+ * @zh 触发管线状态更新事件
+ */
+ onGlobalPipelineStateChanged(): void;
+ }
export interface _cocos_rendering_pipeline_event__IPipelineEvent {
on(type: PipelineEventType, callback: any, target?: any, once?: boolean): typeof callback;
once(type: PipelineEventType, callback: any, target?: any): typeof callback;
off(type: PipelineEventType, callback?: any, target?: any): any;
@@ -60096,54 +61022,10 @@
* @param defines Preprocess macros
* @param pipeline The [[RenderPipeline]] which owns the render command
* @param key The shader cache key, if already known
*/
- getGFXShader(device: gfx.Device, name: string, defines: renderer.MacroRecord, pipeline: rendering.PipelineRuntime, key?: string): gfx.Shader;
+ getGFXShader(device: gfx.Device, name: string, defines: renderer.MacroRecord, pipeline: _cocos_rendering_custom_pipeline__PipelineRuntime, key?: string): gfx.Shader;
}
- export class _cocos_rendering_global_descriptor_set_manager__GlobalDSManager {
- get descriptorSetMap(): Map<renderer.scene.Light, gfx.DescriptorSet>;
- get linearSampler(): gfx.Sampler;
- get pointSampler(): gfx.Sampler;
- get descriptorSetLayout(): gfx.DescriptorSetLayout;
- set globalDescriptorSet(val: gfx.DescriptorSet);
- get globalDescriptorSet(): gfx.DescriptorSet;
- constructor(device: gfx.Device);
- regenLayout(): void;
- /**
- * @en Bind buffer for all descriptorSets, so that all created descriptorSet buffer are consistent
- * @zh 为所有的 descriptorSet 绑定 buffer，使得所有已创建的 descriptorSet buffer 保持一致
- * @param binding The target binding.
- * @param buffer The buffer to be bound.
- */
- bindBuffer(binding: number, buffer: gfx.Buffer): void;
- /**
- * @en Bind sampler for all descriptorSets, so that all created descriptorSet sampler are consistent
- * @zh 为所有的 descriptorSet 绑定 sampler，使得所有已创建的 descriptorSet sampler 保持一致
- * @param binding The target binding.
- * @param sampler The sampler to be bound.
- */
- bindSampler(binding: number, sampler: gfx.Sampler): void;
- /**
- * @en Bind texture for all descriptorSets, so that all created descriptorSet texture are consistent
- * @zh 为所有的 descriptorSet 绑定 texture，使得所有已创建的 descriptorSet texture 保持一致
- * @param binding The target binding.
- * @param texture The texture to be bound.
- */
- bindTexture(binding: number, texture: gfx.Texture): void;
- /**
- * @en Update all descriptorSet
- * @zh 更新所有的 descriptorSet
- */
- update(): void;
- /**
- * @en The layout of all created descriptorSets in buffer, sampler, and texture (except shadow) is consistent with the globalDescriptorSet
- * @zh 所有创建出来的 descriptorSet 在 buffer、 sampler、 texture（shadow 除外）的布局与 globalDescriptorSet 保持一致
- * @param idx Specify index creation
- * @return descriptorSet
- */
- getOrCreateDescriptorSet(light: renderer.scene.Light): gfx.DescriptorSet | undefined;
- destroy(): void;
- }
export type _types_globals__RecursivePartial<T> = {
[P in keyof T]?: T[P] extends Array<infer U> ? Array<_types_globals__RecursivePartial<U>> : T[P] extends ReadonlyArray<infer V> ? ReadonlyArray<_types_globals__RecursivePartial<V>> : _types_globals__RecursivePartial<T[P]>;
};
export interface _cocos_render_scene_core_pass__IPassDynamics {
@@ -61322,20 +62204,20 @@
bloom: _cocos_rendering_render_pipeline__BloomRenderData | null;
}
export class _cocos_rendering_pipeline_ubo__PipelineUBO {
static updateGlobalUBOView(window: _cocos_render_scene_core_render_window__RenderWindow, bufferView: Float32Array): void;
- static updateCameraUBOView(pipeline: rendering.PipelineRuntime, bufferView: Float32Array, camera: renderer.scene.Camera): void;
+ static updateCameraUBOView(pipeline: _cocos_rendering_custom_pipeline__PipelineRuntime, bufferView: Float32Array, camera: renderer.scene.Camera): void;
static getPCFRadius(shadowInfo: renderer.scene.Shadows, mainLight: renderer.scene.DirectionalLight): number;
static updatePlanarNormalAndDistance(shadowInfo: renderer.scene.Shadows, shadowUBO: Float32Array): void;
- static updateShadowUBOView(pipeline: rendering.PipelineRuntime, shadowBufferView: Float32Array, csmBufferView: Float32Array, camera: renderer.scene.Camera): void;
- static updateShadowUBOLightView(pipeline: rendering.PipelineRuntime, shadowBufferView: Float32Array, light: renderer.scene.Light, level: number): void;
+ static updateShadowUBOView(pipeline: _cocos_rendering_custom_pipeline__PipelineRuntime, shadowBufferView: Float32Array, csmBufferView: Float32Array, camera: renderer.scene.Camera): void;
+ static updateShadowUBOLightView(pipeline: _cocos_rendering_custom_pipeline__PipelineRuntime, shadowBufferView: Float32Array, light: renderer.scene.Light, level: number): void;
protected _globalUBO: Float32Array;
protected _cameraUBO: Float32Array;
protected _shadowUBO: Float32Array;
protected _csmUBO: Float32Array;
static _combineSignY: number;
protected _device: gfx.Device;
- protected _pipeline: rendering.PipelineRuntime;
+ protected _pipeline: _cocos_rendering_custom_pipeline__PipelineRuntime;
/**
*|combinedSignY|clipSpaceSignY|screenSpaceSignY| Backends |
*| :--: | :--: | :--: | :--: |
*| 0 | -1 | -1 | Vulkan |
@@ -61343,9 +62225,9 @@
*| 2 | -1 | 1 | |
*| 3 | 1 | 1 | GL-like |
*/
static getCombineSignY(): number;
- activate(device: gfx.Device, pipeline: rendering.PipelineRuntime): void;
+ activate(device: gfx.Device, pipeline: _cocos_rendering_custom_pipeline__PipelineRuntime): void;
/**
* @en Update all UBOs
* @zh 更新全部 UBO。
*/
|
|
@cocos-robot run test cases |
|
@star-e, Please check the result of
Task Details
|
minggo
reviewed
Jun 29, 2023
minggo
reviewed
Jun 29, 2023
| /** | ||
| * @en Activate PipelineRuntime with default swapchain | ||
| * @zh 用默认交换链初始化PipelineRuntime | ||
| */ | ||
| activate (swapchain: Swapchain): boolean; |
There was a problem hiding this comment.
Missing docs for parameter and return value.
minggo
reviewed
Jun 29, 2023
| name: string; | ||
| /** | ||
| * @beta function signature might change | ||
| * @experimental |
There was a problem hiding this comment.
I am not sure if our documentation tool supports it.
minggo
reviewed
Jun 29, 2023
minggo
reviewed
Jun 29, 2023
pandamicro
approved these changes
Jun 29, 2023
minggo
approved these changes
Jun 29, 2023
bluesky013
pushed a commit
to bluesky013/cocos-engine
that referenced
this pull request
Jul 11, 2023
# Conflicts: # cocos/rendering/custom/pipeline.ts # native/cocos/renderer/pipeline/custom/RenderInterfaceTypes.h
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add api documents.
Renamed
QueueHintenumerations.Changelog
Continuous Integration
This pull request:
Compatibility Check
This pull request: