[V3.8.5 pipeline] Export RenderWindow #17003
Merged
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
# Conflicts: # cocos/rendering/custom/builtin-forward-pipeline.ts
Interface Check Report! WARNING this pull request has changed these public interfaces:
@@ -7724,27 +7724,27 @@
/**
* @en The main window
* @zh 主窗口
*/
- get mainWindow(): __private._cocos_render_scene_core_render_window__RenderWindow | null;
+ get mainWindow(): renderer.RenderWindow | null;
/**
* @en The current active window
* @zh 当前激活的窗口
*/
- set curWindow(window: __private._cocos_render_scene_core_render_window__RenderWindow | null);
- get curWindow(): __private._cocos_render_scene_core_render_window__RenderWindow | null;
+ set curWindow(window: renderer.RenderWindow | null);
+ get curWindow(): renderer.RenderWindow | null;
/**
* @e The temporary window for data transmission
* @zh 临时窗口（用于数据传输）
* @internal
*/
- set tempWindow(window: __private._cocos_render_scene_core_render_window__RenderWindow | null);
- get tempWindow(): __private._cocos_render_scene_core_render_window__RenderWindow | null;
+ set tempWindow(window: renderer.RenderWindow | null);
+ get tempWindow(): renderer.RenderWindow | null;
/**
* @en The windows list
* @zh 窗口列表
*/
- get windows(): __private._cocos_render_scene_core_render_window__RenderWindow[];
+ get windows(): renderer.RenderWindow[];
/**
* @zh
* 启用自定义渲染管线
*/
@@ -7821,9 +7821,9 @@
_createSceneFun: (root: Root) => renderer.RenderScene;
/**
* @deprecated since v3.5.0, this is an engine private interface that will be removed in the future.
*/
- _createWindowFun: (root: Root) => __private._cocos_render_scene_core_render_window__RenderWindow;
+ _createWindowFun: (root: Root) => renderer.RenderWindow;
/**
* @en The constructor of the root, user shouldn't create the root instance, it's managed by the [[Director]].
* @zh 构造函数，用户不应该自己创建任何 Root 对象，它是由 [[Director]] 管理的。
* @param device GFX device
@@ -7864,9 +7864,9 @@
* @en Active the render window as the [[curWindow]]
* @zh 激活指定窗口为当前窗口 [[curWindow]]
* @param window The render window to be activated
*/
- activeWindow(window: __private._cocos_render_scene_core_render_window__RenderWindow): void;
+ activeWindow(window: renderer.RenderWindow): void;
/**
* @en Reset the time cumulated
* @zh 重置累计时间
*/
@@ -7881,15 +7881,15 @@
* @en Create a render window
* @zh 创建一个新的窗口
* @param info @en The window creation information @zh 窗口描述信息
*/
- createWindow(info: __private._cocos_render_scene_core_render_window__IRenderWindowInfo): __private._cocos_render_scene_core_render_window__RenderWindow | null;
+ createWindow(info: __private._cocos_render_scene_core_render_window__IRenderWindowInfo): renderer.RenderWindow | null;
/**
* @en Destroy a render window
* @zh 销毁指定的窗口
* @param window The render window to be destroyed
*/
- destroyWindow(window: __private._cocos_render_scene_core_render_window__RenderWindow): void;
+ destroyWindow(window: renderer.RenderWindow): void;
/**
* @en Destroy all render windows
* @zh 销毁全部窗口
*/
@@ -10296,8 +10296,123 @@
samplerStartBinding: number;
}
export const programLib: __private._cocos_render_scene_core_program_lib__ProgramLib;
export function getDeviceShaderVersion(device: gfx.Device): string;
+ /**
+ * @en The render window represents the render target, it could be an off screen frame buffer or the on screen buffer.
+ * @zh 渲染窗口代表了一个渲染目标，可以是离屏的帧缓冲，也可以是屏幕缓冲
+ */
+ export class RenderWindow {
+ /**
+ * @en Get window width. Pre-rotated (i.e. rotationally invariant, always in identity/portrait mode) if possible.
+ * If you want to get oriented size instead, you should use [[renderer.scene.Camera.width]] which corresponds to the current screen rotation.
+ * @zh 获取窗口宽度。如果支持交换链预变换，返回值将始终处于单位旋转（竖屏）坐标系下。如果需要获取旋转后的尺寸，请使用 [[renderer.scene.Camera.width]]。
+ */
+ get width(): number;
+ /**
+ * @en Get window height. Pre-rotated (i.e. rotationally invariant, always in identity/portrait mode) if possible.
+ * If you want to get oriented size instead, you should use [[renderer.scene.Camera.width]] which corresponds to the current screen rotation.
+ * @zh 获取窗口高度。如果支持交换链预变换，返回值将始终处于单位旋转（竖屏）坐标系下。如果需要获取旋转后的尺寸，请使用 [[renderer.scene.Camera.height]]。
+ */
+ get height(): number;
+ /**
+ * @en Get the swapchain for this window, if there is one
+ * @zh 如果存在的话，获取此窗口的交换链
+ */
+ get swapchain(): gfx.Swapchain;
+ /**
+ * @en Get window frame buffer.
+ * @zh 帧缓冲对象。
+ */
+ get framebuffer(): gfx.Framebuffer;
+ get cameras(): scene.Camera[];
+ /**
+ * @en Get render window Id.
+ * Render windowd Id is used to identify the render window in the render pipeline.
+ * @zh 获得渲染窗口Id。渲染窗口Id用于在渲染管线中标识渲染窗口。
+ */
+ get renderWindowId(): number;
+ /**
+ * @en Get the name of the color attachment.
+ * The name is used to identify the color attachment in the render pipeline.
+ * @zh 获取颜色附件的名称。用于自定义渲染管线中的资源注册。
+ */
+ get colorName(): string;
+ /**
+ * @en Get the name of the depth stencil attachment.
+ * The name is used to identify the depth stencil attachment in the render pipeline.
+ * @zh 获取深度模板附件的名称。用于自定义渲染管线中的资源注册。
+ */
+ get depthStencilName(): string;
+ /**
+ * @en The render pipeline should handle the resize event properly
+ * @zh 渲染管线应该正确处理窗口大小变化事件
+ */
+ isRenderWindowResized(): boolean;
+ /**
+ * @en The render pipeline should set this value to false after handling the resize event
+ * @zh 渲染管线应该在处理完窗口大小变化事件后将此值设置为 false
+ */
+ setRenderWindowResizeHandled(): void;
+ protected _title: string;
+ protected _width: number;
+ protected _height: number;
+ protected _swapchain: gfx.Swapchain;
+ protected _renderPass: gfx.RenderPass | null;
+ protected _colorTextures: gfx.Texture[];
+ protected _depthStencilTexture: gfx.Texture | null;
+ protected _cameras: scene.Camera[];
+ protected _hasOnScreenAttachments: boolean;
+ protected _hasOffScreenAttachments: boolean;
+ protected _framebuffer: gfx.Framebuffer | null;
+ protected _device: gfx.Device | null;
+ protected _renderWindowId: number;
+ protected _isResized: boolean;
+ protected _colorName: string;
+ protected _depthStencilName: string;
+ /**
+ * @private
+ */
+ static registerCreateFunc(root: Root): void;
+ initialize(device: gfx.Device, info: __private._cocos_render_scene_core_render_window__IRenderWindowInfo): boolean;
+ destroy(): void;
+ /**
+ * @en Resize window.
+ * @zh 重置窗口大小。
+ * @param width The new width.
+ * @param height The new height.
+ */
+ resize(width: number, height: number): void;
+ /**
+ * @en Extract all render cameras attached to the render window to the output cameras list
+ * @zh 将所有挂载到当前渲染窗口的摄像机存储到输出列表参数中
+ * @param cameras @en The output cameras list, should be empty before invoke this function
+ * @zh 输出相机列表参数，传入时应该为空
+ */
+ extractRenderCameras(cameras: scene.Camera[]): void;
+ /**
+ * @en Attach a new camera to the render window
+ * @zh 添加渲染相机
+ * @param camera @en The camera to attach @zh 要挂载的相机
+ */
+ attachCamera(camera: scene.Camera): void;
+ /**
+ * @en Detach a camera from the render window
+ * @zh 移除场景中的渲染相机
+ * @param camera @en The camera to detach @zh 要移除的相机
+ */
+ detachCamera(camera: scene.Camera): void;
+ /**
+ * @en Clear all attached cameras
+ * @zh 清空全部渲染相机
+ */
+ clearCameras(): void;
+ /**
+ * @en Sort all attached cameras with priority
+ * @zh 按照优先级对所有挂载的相机排序
+ */
+ sortCameras(): void;
+ }
export namespace scene {
/**
* @en The enumeration type for the fixed axis of the camera.
* The field of view along the corresponding axis would be fixed regardless of screen aspect changes.
@@ -10612,9 +10727,9 @@
/**
* @en The target render window of the camera, is absent, the camera won't be rendered.
* @zh 相机的目标渲染窗口，如果缺省，该相机不会执行渲染流程。
*/
- window?: __private._cocos_render_scene_core_render_window__RenderWindow | null;
+ window?: RenderWindow | null;
/**
* @en Render priority of the camera. Cameras with higher depth are rendered after cameras with lower depth.
* @zh 相机的渲染优先级，值越小越优先渲染。
*/
@@ -10678,10 +10793,10 @@
/**
* @en The render window of the camera
* @zh 相机关联的渲染窗口
*/
- set window(val: __private._cocos_render_scene_core_render_window__RenderWindow);
- get window(): __private._cocos_render_scene_core_render_window__RenderWindow;
+ set window(val: RenderWindow);
+ get window(): RenderWindow;
/**
* @en Whether the camera is enabled, a disabled camera won't be processed in the render pipeline.
* @zh 相机是否启用，未启用的相机不会被渲染
*/
@@ -10949,9 +11064,9 @@
* @en Change the target render window to another one
* @zh 修改相机的目标渲染窗口
* @param window The target render window, could be null
*/
- changeTargetWindow(window?: __private._cocos_render_scene_core_render_window__RenderWindow | null): void;
+ changeTargetWindow(window?: RenderWindow | null): void;
/**
* @en Detach camera from the render window
* @zh 将 camera 从渲染窗口移除
*/
@@ -23583,9 +23698,9 @@
* @zh
* 创建四边形输入汇集器。
*/
protected _createQuadInputAssembler(): __private._cocos_rendering_render_pipeline__PipelineInputAssemblerData;
- updateQuadVertexData(renderArea: gfx.Rect, window: __private._cocos_render_scene_core_render_window__RenderWindow): void;
+ updateQuadVertexData(renderArea: gfx.Rect, window: renderer.RenderWindow): void;
/**
* @en Internal destroy function
* @zh 内部销毁函数。
*/
@@ -29567,9 +29682,9 @@
/**
* @en The render window for the render pipeline, it's created internally and cannot be modified.
* @zh 渲染管线所使用的渲染窗口，内部逻辑创建，无法被修改。
*/
- get window(): __private._cocos_render_scene_core_render_window__RenderWindow | null;
+ get window(): renderer.RenderWindow | null;
/**
* @en Initialize the render texture. Using IRenderTextureCreateInfo.
* @zh 初始化渲染贴图。设置渲染贴图的名称、尺寸、渲染通道信息。
* @param info @en The create info of render texture. @zh 渲染贴图的创建信息。
@@ -36269,17 +36384,17 @@
* @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;
+ addRenderWindow(name: string, format: gfx.Format, width: number, height: number, renderWindow: renderer.RenderWindow): number;
/**
* @deprecated Method will be removed in 3.9.0
* @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;
+ updateRenderWindow(name: string, renderWindow: renderer.RenderWindow): void;
/**
* @en Add or update 2D render target.
* @zh 添加或更新2D渲染目标
* @param name @en Resource name @zh 资源名字
@@ -36981,13 +37096,13 @@
* 用户可以实现这个接口，来构建自己想要的render graph。
* 调用setCustomPipeline注册管线
*/
export interface PipelineBuilder {
- editorWindowResize?(pipeline: BasicPipeline, window: __private._cocos_render_scene_core_render_window__RenderWindow, width: number, height: number): void;
- editorSceneViewResize?(pipeline: BasicPipeline, window: __private._cocos_render_scene_core_render_window__RenderWindow, width: number, height: number): void;
- editorGameViewResize?(pipeline: BasicPipeline, window: __private._cocos_render_scene_core_render_window__RenderWindow, width: number, height: number): void;
- editorPreviewResize?(pipeline: BasicPipeline, window: __private._cocos_render_scene_core_render_window__RenderWindow, width: number, height: number): void;
- gameWindowResize?(pipeline: BasicPipeline, window: __private._cocos_render_scene_core_render_window__RenderWindow, width: number, height: number): void;
+ editorWindowResize?(pipeline: BasicPipeline, window: renderer.RenderWindow, width: number, height: number): void;
+ editorSceneViewResize?(pipeline: BasicPipeline, window: renderer.RenderWindow, width: number, height: number): void;
+ editorGameViewResize?(pipeline: BasicPipeline, window: renderer.RenderWindow, width: number, height: number): void;
+ editorPreviewResize?(pipeline: BasicPipeline, window: renderer.RenderWindow, width: number, height: number): void;
+ gameWindowResize?(pipeline: BasicPipeline, window: renderer.RenderWindow, width: number, height: number): void;
/**
* @en Setup render graph
* @zh 构建渲染管线
* @param cameras @en Camera list to render @zh 需要渲染的相机列表
@@ -37000,9 +37115,9 @@
*/
onGlobalPipelineStateChanged?(): void;
}
export function supportsR32FloatTexture(device: gfx.Device): boolean;
- export function defaultWindowResize(ppl: BasicPipeline, window: __private._cocos_render_scene_core_render_window__RenderWindow, width: number, height: number): void;
+ export function defaultWindowResize(ppl: BasicPipeline, window: renderer.RenderWindow, width: number, height: number): void;
export function dispatchResizeEvents(cameras: renderer.scene.Camera[], builder: PipelineBuilder, ppl: BasicPipeline): void;
}
export namespace postProcess {
export class PostProcessSetting extends Component {
@@ -61632,133 +61747,8 @@
STARTED = "started",
ENDED = "ended"
}
export type _pal_audio_type__AudioBufferView = Int8Array | Uint8Array | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array;
- export interface _cocos_render_scene_core_render_window__IRenderWindowInfo {
- title?: string;
- width: number;
- height: number;
- renderPassInfo: gfx.RenderPassInfo;
- swapchain?: gfx.Swapchain;
- externalResLow?: number;
- externalResHigh?: number;
- externalFlag?: gfx.TextureFlags;
- }
- /**
- * @en The render window represents the render target, it could be an off screen frame buffer or the on screen buffer.
- * @zh 渲染窗口代表了一个渲染目标，可以是离屏的帧缓冲，也可以是屏幕缓冲
- */
- export class _cocos_render_scene_core_render_window__RenderWindow {
- /**
- * @en Get window width. Pre-rotated (i.e. rotationally invariant, always in identity/portrait mode) if possible.
- * If you want to get oriented size instead, you should use [[renderer.scene.Camera.width]] which corresponds to the current screen rotation.
- * @zh 获取窗口宽度。如果支持交换链预变换，返回值将始终处于单位旋转（竖屏）坐标系下。如果需要获取旋转后的尺寸，请使用 [[renderer.scene.Camera.width]]。
- */
- get width(): number;
- /**
- * @en Get window height. Pre-rotated (i.e. rotationally invariant, always in identity/portrait mode) if possible.
- * If you want to get oriented size instead, you should use [[renderer.scene.Camera.width]] which corresponds to the current screen rotation.
- * @zh 获取窗口高度。如果支持交换链预变换，返回值将始终处于单位旋转（竖屏）坐标系下。如果需要获取旋转后的尺寸，请使用 [[renderer.scene.Camera.height]]。
- */
- get height(): number;
- /**
- * @en Get the swapchain for this window, if there is one
- * @zh 如果存在的话，获取此窗口的交换链
- */
- get swapchain(): gfx.Swapchain;
- /**
- * @en Get window frame buffer.
- * @zh 帧缓冲对象。
- */
- get framebuffer(): gfx.Framebuffer;
- get cameras(): renderer.scene.Camera[];
- /**
- * @en Get render window Id.
- * Render windowd Id is used to identify the render window in the render pipeline.
- * @zh 获得渲染窗口Id。渲染窗口Id用于在渲染管线中标识渲染窗口。
- */
- get renderWindowId(): number;
- /**
- * @en Get the name of the color attachment.
- * The name is used to identify the color attachment in the render pipeline.
- * @zh 获取颜色附件的名称。用于自定义渲染管线中的资源注册。
- */
- get colorName(): string;
- /**
- * @en Get the name of the depth stencil attachment.
- * The name is used to identify the depth stencil attachment in the render pipeline.
- * @zh 获取深度模板附件的名称。用于自定义渲染管线中的资源注册。
- */
- get depthStencilName(): string;
- /**
- * @en The render pipeline should handle the resize event properly
- * @zh 渲染管线应该正确处理窗口大小变化事件
- */
- isRenderWindowResized(): boolean;
- /**
- * @en The render pipeline should set this value to false after handling the resize event
- * @zh 渲染管线应该在处理完窗口大小变化事件后将此值设置为 false
- */
- setRenderWindowResizeHandled(): void;
- protected _title: string;
- protected _width: number;
- protected _height: number;
- protected _swapchain: gfx.Swapchain;
- protected _renderPass: gfx.RenderPass | null;
- protected _colorTextures: gfx.Texture[];
- protected _depthStencilTexture: gfx.Texture | null;
- protected _cameras: renderer.scene.Camera[];
- protected _hasOnScreenAttachments: boolean;
- protected _hasOffScreenAttachments: boolean;
- protected _framebuffer: gfx.Framebuffer | null;
- protected _device: gfx.Device | null;
- protected _renderWindowId: number;
- protected _isResized: boolean;
- protected _colorName: string;
- protected _depthStencilName: string;
- /**
- * @private
- */
- static registerCreateFunc(root: Root): void;
- initialize(device: gfx.Device, info: _cocos_render_scene_core_render_window__IRenderWindowInfo): boolean;
- destroy(): void;
- /**
- * @en Resize window.
- * @zh 重置窗口大小。
- * @param width The new width.
- * @param height The new height.
- */
- resize(width: number, height: number): void;
- /**
- * @en Extract all render cameras attached to the render window to the output cameras list
- * @zh 将所有挂载到当前渲染窗口的摄像机存储到输出列表参数中
- * @param cameras @en The output cameras list, should be empty before invoke this function
- * @zh 输出相机列表参数，传入时应该为空
- */
- extractRenderCameras(cameras: renderer.scene.Camera[]): void;
- /**
- * @en Attach a new camera to the render window
- * @zh 添加渲染相机
- * @param camera @en The camera to attach @zh 要挂载的相机
- */
- attachCamera(camera: renderer.scene.Camera): void;
- /**
- * @en Detach a camera from the render window
- * @zh 移除场景中的渲染相机
- * @param camera @en The camera to detach @zh 要移除的相机
- */
- detachCamera(camera: renderer.scene.Camera): void;
- /**
- * @en Clear all attached cameras
- * @zh 清空全部渲染相机
- */
- clearCameras(): void;
- /**
- * @en Sort all attached cameras with priority
- * @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;
@@ -62016,8 +62006,18 @@
*/
export interface _cocos_root__IRootInfo {
enableHDR?: boolean;
}
+ export interface _cocos_render_scene_core_render_window__IRenderWindowInfo {
+ title?: string;
+ width: number;
+ height: number;
+ renderPassInfo: gfx.RenderPassInfo;
+ swapchain?: gfx.Swapchain;
+ externalResLow?: number;
+ externalResHigh?: number;
+ externalFlag?: gfx.TextureFlags;
+ }
/**
* @en GFX buffer barrier.
* @zh GFX buffer内存屏障。
*/
@@ -63257,9 +63257,9 @@
sampler: gfx.Sampler;
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 updateGlobalUBOView(window: renderer.RenderWindow, bufferView: Float32Array): 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: _cocos_rendering_custom_pipeline__PipelineRuntime, shadowBufferView: Float32Array, csmBufferView: Float32Array, camera: renderer.scene.Camera): void;
@@ -63284,9 +63284,9 @@
/**
* @en Update all UBOs
* @zh 更新全部 UBO。
*/
- updateGlobalUBO(window: _cocos_render_scene_core_render_window__RenderWindow): void;
+ updateGlobalUBO(window: renderer.RenderWindow): void;
updateCameraUBO(camera: renderer.scene.Camera): void;
updateShadowUBO(camera: renderer.scene.Camera): void;
updateShadowUBOLight(globalDS: gfx.DescriptorSet, light: renderer.scene.Light, level?: number): void;
updateShadowUBORange(offset: number, data: math.Mat4 | math.Color): void;
|
minggo
approved these changes
May 17, 2024
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.
Export
RenderWindow.RenderWindowis widely used in the pipeline interface.It becomes an important type and user need access to it.
Changelog
RenderWindowContinuous Integration
This pull request:
Compatibility Check
This pull request: