mirror of
https://github.com/cocos/cocos4.git
synced 2026-11-19 14:52:40 +08:00
Compare commits
197 Commits
4.0.0-alpha.7
...
v4.0.0
| Author | SHA1 | Date | |
|---|---|---|---|
| b01aabdf57 | |||
| 7995924100 | |||
| af2b9e9ed9 | |||
| 229ad74757 | |||
| 5313b86ed1 | |||
| 7fb5ae075b | |||
| 1b0455e10e | |||
| 714bd9d3e2 | |||
| 6ccf1cf9a8 | |||
| 1df519e248 | |||
| aaa3a9168b | |||
| 178b9edca9 | |||
| 8e62e7e044 | |||
| 62bd937e7e | |||
| 990e3b09aa | |||
| 111fe1755d | |||
| 4a0dbc977a | |||
| 7037052b40 | |||
| e78ad4d759 | |||
| 25026f9edd | |||
| 5bcfb9fa04 | |||
| a56706c9ad | |||
| 022be418f9 | |||
| 86fe5f41cd | |||
| a69be8d0a7 | |||
| b9f9e95b9b | |||
| 7ef2d0a772 | |||
| fcdc4333b7 | |||
| 60a24625b2 | |||
| 2157fd176d | |||
| 5e627951a0 | |||
| 2c632d6dd6 | |||
| 4f6479f083 | |||
| 142c7ec6aa | |||
| 7302715a18 | |||
| 5b0b4522c0 | |||
| a803406ef1 | |||
| f570c1f02d | |||
| d0a696cfe6 | |||
| 1b3ad36e4b | |||
| ff0f46ff81 | |||
| 0616a948ef | |||
| ee89a99a9b | |||
| f620989ce7 | |||
| 661de759ef | |||
| 0ab8246486 | |||
| 67642997f7 | |||
| 3be9ebc5b7 | |||
| 47ebc462e5 | |||
| b4bea55859 | |||
| 82f13c86e9 | |||
| 0fd910220e | |||
| 557b06f7e6 | |||
| b46553e615 | |||
| fffd9a514a | |||
| 5678d0d17c | |||
| 2ce7b89be5 | |||
| 6b455561f4 | |||
| 60f9352c56 | |||
| f66365f959 | |||
| a3c3fcbea5 | |||
| 2a75cfb9da | |||
| 0c3f4534b8 | |||
| 7f806abad6 | |||
| df98a99bb6 | |||
| a5090e5ae4 | |||
| 3b71bf6935 | |||
| 54fd070848 | |||
| 6722aac669 | |||
| 68552314c0 | |||
| 550eb15641 | |||
| c438c2d3f8 | |||
| f5eaf97ce7 | |||
| 69d3d6033a | |||
| 469614cf0b | |||
| f81094f226 | |||
| 825362fac1 | |||
| 609512f8da | |||
| 09b63786f4 | |||
| 2b7b438768 | |||
| 6b5c8556a2 | |||
| ff436d6a27 | |||
| 09c38ea03f | |||
| 926bd5b619 | |||
| e317c04512 | |||
| 140068ddb1 | |||
| 80a9d0619e | |||
| a01046e391 | |||
| 2b6ec3b4f0 | |||
| 6060f58d1a | |||
| 18456b6706 | |||
| 62b55a0c48 | |||
| 0eac18be1a | |||
| 01983b75f2 | |||
| 2d003cc616 | |||
| b710cb6e9b | |||
| f948b5900e | |||
| b7883f18ba | |||
| 3ab299035a | |||
| c2ab919e9d | |||
| 5690d1b8a5 | |||
| ed0751652b | |||
| 97e402c3dc | |||
| f378a866cb | |||
| 7253ee4a7f | |||
| db5462603e | |||
| 9f0e30acb3 | |||
| a0a2e97c00 | |||
| 90e551b4a1 | |||
| 0a21bb9397 | |||
| 2c91155928 | |||
| 6f90cec3d4 | |||
| 4992692780 | |||
| d5f24e6170 | |||
| e778833d15 | |||
| c3a8a72f63 | |||
| 2c0e75059f | |||
| 19f4bd5b16 | |||
| 085d05928d | |||
| fb4d586629 | |||
| 620d38cf42 | |||
| d2713fe00e | |||
| 3aeb193d42 | |||
| c4e4790ee6 | |||
| 143af30cf2 | |||
| d6ff23fed4 | |||
| 84e8d4ebf7 | |||
| f2b9936033 | |||
| 129eb437ad | |||
| c58c893334 | |||
| ab982aec68 | |||
| 2d2bbe6731 | |||
| 187387b03f | |||
| 661253a521 | |||
| b6d0f02e88 | |||
| dd1b155d3a | |||
| df96ee85f3 | |||
| 708a343ce8 | |||
| 393203c2f8 | |||
| f3d11f017b | |||
| 09c201017c | |||
| ce6107d930 | |||
| ab8792686b | |||
| 44ef76855b | |||
| 8878e7aade | |||
| 621880a123 | |||
| 2eb268bf9a | |||
| 2e6cc9b127 | |||
| 98917ff2a7 | |||
| dc29d2f8f8 | |||
| eec2a1693b | |||
| 632f9b442f | |||
| 8ce19b658e | |||
| 07f2c5fb43 | |||
| 9b17fd6165 | |||
| e2795f9ecd | |||
| 89a412e0d6 | |||
| aef31099d8 | |||
| 89f8768e57 | |||
| 424be5d0b2 | |||
| e5183b796a | |||
| 32478c1a9c | |||
| 74e632a3d6 | |||
| 26883ba6f4 | |||
| 055c70f8d2 | |||
| 99f6db401c | |||
| 9390ee6bc0 | |||
| 7f258dac58 | |||
| 5c99570616 | |||
| 821928733b | |||
| f567861ff6 | |||
| a7a20b64ab | |||
| 7c75834010 | |||
| 8fd985af75 | |||
| cc97bc8af4 | |||
| 92124590fe | |||
| 822ac6026c | |||
| 4a6f83bd6d | |||
| 04f063eb2b | |||
| 910865bd8b | |||
| e384f54ed2 | |||
| 5964835c83 | |||
| f4ae16247c | |||
| 4b4a3ca13f | |||
| f1c5d21be6 | |||
| da75e89f4a | |||
| aba27a715d | |||
| 62c1eb58c3 | |||
| 5b09978eb1 | |||
| 1b8da1df9b | |||
| ea6ff53aad | |||
| b7ba9f76bb | |||
| ab670c4f99 | |||
| ba0a042ef5 | |||
| 8aa41cc3e7 | |||
| db7666f821 | |||
| 37abbf226a |
@@ -20,8 +20,14 @@ if ($env:GITHUB_BASE_REF) {
|
||||
# Push
|
||||
$gitHubEvent = Get-Content $env:GITHUB_EVENT_PATH | ConvertFrom-Json
|
||||
Write-Host "GitHub event: $gitHubEvent"
|
||||
git fetch origin $gitHubEvent.before --depth=1
|
||||
$diffFiles = git diff --name-only --diff-filter=$diffFilter $gitHubEvent.before $env:GITHUB_SHA
|
||||
$beforeSha = $gitHubEvent.before
|
||||
# On tag creation or initial push, before is all zeros - skip diff in that case
|
||||
if ($beforeSha -match '^0+$') {
|
||||
Write-Host "No previous commit (tag creation or initial push). Skipping diff."
|
||||
return
|
||||
}
|
||||
git fetch origin $beforeSha --depth=1
|
||||
$diffFiles = git diff --name-only --diff-filter=$diffFilter $beforeSha $env:GITHUB_SHA
|
||||
}
|
||||
|
||||
Write-Host "Diff files: $diffFiles"
|
||||
|
||||
@@ -18,6 +18,7 @@ jobs:
|
||||
with:
|
||||
token: ${{ github.token }}
|
||||
ref: ${{ github.head_sha }}
|
||||
fetch-depth: 0
|
||||
|
||||
- id: get_change_files
|
||||
uses: fish9167/file-changes-action@v1.2.3
|
||||
@@ -25,18 +26,13 @@ jobs:
|
||||
output: ' '
|
||||
fileOutput: ' '
|
||||
|
||||
- name: Echo change files
|
||||
run: |
|
||||
cat $HOME/files.txt
|
||||
mv $HOME/files.txt ${{github.workspace}}/files.txt
|
||||
|
||||
- uses: fish9167/clang-format-lint-action@master
|
||||
- uses: DoozyX/clang-format-lint-action@v0.18
|
||||
with:
|
||||
source: ./native
|
||||
exclude: ./native/cocos/bindings/auto
|
||||
exclude: ./native/cocos/bindings/auto ./native/cocos/base/std ./native/cocos/editor-support/spine-wasm ./native/cocos/editor-support/spine ./native/cocos/gi/light-probe/predicates.cpp ./native/cocos/gi/light-probe/tetgen.cpp ./native/cocos/gi/light-probe/tetgen.h ./native/cocos/platform/openharmony/napi ./native/tools ./native/vendor ./native/cocos/cocos-version.h
|
||||
extensions: 'c,h,hpp,cpp,cxx'
|
||||
style: file
|
||||
inplace: True
|
||||
inplace: true
|
||||
clangFormatVersion: 12
|
||||
|
||||
- name: Create Pull Request
|
||||
|
||||
@@ -17,7 +17,7 @@ jobs:
|
||||
name: "Linux-Ubuntu"
|
||||
if:
|
||||
(! contains(github.event.pull_request.body, '[X] does not change any runtime related code or build configuration'))
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: ubuntu-24.04
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Download external libraries
|
||||
|
||||
@@ -255,7 +255,7 @@ jobs:
|
||||
name: "Openharmony"
|
||||
if:
|
||||
(! contains(github.event.pull_request.body, '[X] does not change any runtime related code or build configuration'))
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: ubuntu-24.04
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
@@ -483,8 +483,8 @@ jobs:
|
||||
echo "set(CC_USE_GLES3 OFF)" >> build-mac/proj/cfg.cmake
|
||||
echo "set(CC_USE_METAL ON)" >> build-mac/proj/cfg.cmake
|
||||
# Test JSVM v8 backend on macOS.
|
||||
echo "set(USE_SE_V8 OFF)" >> build-mac/proj/cfg.cmake
|
||||
echo "set(USE_SE_JSVM ON)" >> build-mac/proj/cfg.cmake
|
||||
echo "set(USE_SE_V8 ON)" >> build-mac/proj/cfg.cmake
|
||||
echo "set(USE_SE_JSVM OFF)" >> build-mac/proj/cfg.cmake
|
||||
echo "set(USE_WEBSOCKET_SERVER OFF)" >> build-mac/proj/cfg.cmake
|
||||
echo "set(CMAKE_CXX_STANDARD_REQUIRED ON)" >> build-mac/proj/cfg.cmake
|
||||
echo "set(CC_EXECUTABLE_NAME \"\")" >> build-mac/proj/cfg.cmake
|
||||
@@ -493,7 +493,6 @@ jobs:
|
||||
RES_DIR=$GITHUB_WORKSPACE/templates/mac/build-mac
|
||||
cd build-mac
|
||||
cmake ../ -GXcode -DCMAKE_OSX_ARCHITECTURES=${{ matrix.config.arch }} -DRES_DIR=$RES_DIR -DCOCOS_X_PATH=$NATIVE_ROOT
|
||||
set +e
|
||||
cmake --build . --config Release -- -jobs $NUM_OF_CORES -arch ${{ matrix.config.arch }}
|
||||
echo "Compile MacOSX Release Done!"
|
||||
|
||||
@@ -534,7 +533,7 @@ jobs:
|
||||
echo "set(CC_USE_VULKAN OFF)" >> build-ios/proj/cfg.cmake
|
||||
echo "set(CC_USE_GLES2 OFF)" >> build-ios/proj/cfg.cmake
|
||||
echo "set(CC_USE_METAL ON)" >> build-ios/proj/cfg.cmake
|
||||
echo "set(TARGET_IOS_VERSION 12.0)" >> build-ios/proj/cfg.cmake
|
||||
echo "set(TARGET_IOS_VERSION 13.0)" >> build-ios/proj/cfg.cmake
|
||||
echo "set(USE_WEBSOCKET_SERVER OFF)" >> build-ios/proj/cfg.cmake
|
||||
echo "set(USE_DRAGONBONES OFF)" >> build-ios/proj/cfg.cmake
|
||||
echo "set(CMAKE_CXX_STANDARD_REQUIRED OFF)" >> build-ios/proj/cfg.cmake
|
||||
@@ -548,7 +547,6 @@ jobs:
|
||||
-DCMAKE_OSX_ARCHITECTURES=${{ matrix.config.arch }} \
|
||||
-DRES_DIR=$RES_DIR \
|
||||
-DCOCOS_X_PATH=$NATIVE_ROOT
|
||||
set +e
|
||||
#cmake --build . --config Debug -- -quiet -jobs $NUM_OF_CORES -allowProvisioningUpdates CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED=NO CODE_SIGNING_ALLOWED=NO
|
||||
cmake --build . --config Debug -- -jobs $NUM_OF_CORES CODE_SIGNING_REQUIRED=NO CODE_SIGNING_ALLOWED=NO
|
||||
echo "Compile iOS Done!"
|
||||
|
||||
@@ -20,7 +20,7 @@ jobs:
|
||||
# Set the type of machine to run on
|
||||
if:
|
||||
(! contains(github.event.pull_request.body, '[X] does not change any runtime related code or build configuration'))
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: ubuntu-24.04
|
||||
|
||||
steps:
|
||||
# Checks out a copy of your repository on the ubuntu-latest machine
|
||||
|
||||
@@ -28,6 +28,7 @@ jobs:
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
- run: npm ci --ignore-scripts
|
||||
- run: node scripts/spread-pal.cjs
|
||||
- run: npm run build:debug-infos
|
||||
- name: Download external
|
||||
run: |
|
||||
|
||||
@@ -46,3 +46,11 @@ platforms/runtime/platforms/vivo-mini-game/ral.min.js
|
||||
@types/consts.d.ts
|
||||
|
||||
__TS_ENGINE__/
|
||||
|
||||
# pal 由 @cocos/engine-pal 在 postinstall 挂载(软链/复制),不入库
|
||||
/pal
|
||||
|
||||
# platforms 源码已抽到 @cocos/engine-platforms;其预打包 adapter 由 postinstall 的
|
||||
# spread-adapter.cjs 复制到 bin/adapter(/bin 已忽略)。platforms 源码不再入库。
|
||||
/platforms
|
||||
|
||||
|
||||
Vendored
+1
@@ -26,6 +26,7 @@ declare namespace jsb {
|
||||
export function getDeviceOrientation(): number;
|
||||
export function getNetworkType(): number; // TODO: enum type
|
||||
export function getSafeAreaEdge(): NativeSafeAreaEdge;
|
||||
export function setKeepScreenOn(enabled: boolean): void;
|
||||
|
||||
export function setAccelerometerEnabled(isEnabled: boolean);
|
||||
export function setAccelerometerInterval(intervalInSeconds: number);
|
||||
|
||||
Vendored
+83
@@ -37,6 +37,38 @@ declare module 'pal/minigame' {
|
||||
getSharedCanvas(): any;
|
||||
getOpenDataContext(): any;
|
||||
|
||||
// worker
|
||||
/**
|
||||
* Create a worker thread from a packaged script path.
|
||||
*
|
||||
* IMPORTANT — this is optional and genuinely absent on some platforms:
|
||||
* - Present: WeChat (`wx.createWorker`), ByteDance (`tt.createWorker`), Alipay
|
||||
* (`my.createWorker`), Baidu (`swan.createWorker`, base library 1.6.1+), and the
|
||||
* quick-game family (`qg.createWorker` on Xiaomi / Huawei 1117+ / OPPO / vivo).
|
||||
* Each `pal/minigame/*.js` adapter starts with `cloneObject(minigame, <platformGlobal>)`,
|
||||
* and `cloneObject` copies functions with `.bind(origin)` — so `createWorker` arrives on
|
||||
* `minigame` for free, already bound to the right global. No per-platform adapter code
|
||||
* is needed, and `pal/` itself must not be edited (it is regenerated from the
|
||||
* `@cocos/engine-pal` package on postinstall).
|
||||
* - Absent: Taobao mini-game has NO worker API at all (its API surface has no Worker
|
||||
* category), and no `Worker` / `Blob` / `URL.createObjectURL` either — there is no way to
|
||||
* get a real thread there. Callers must degrade to synchronous execution.
|
||||
*
|
||||
* Returns `undefined` (rather than throwing) when creation fails on Huawei quick game, so
|
||||
* the result MUST be null-checked.
|
||||
*
|
||||
* Every platform caps concurrency at ONE worker except WeChat V2 (standard worker).
|
||||
* Script paths must be relative (no leading "/") and end with ".js", and the file must be
|
||||
* packaged under the workers directory declared in game.json / manifest.json / app.json.
|
||||
*/
|
||||
createWorker?: (scriptPath: string, options?: MinigameWorkerOptions) => MinigameWorker | undefined;
|
||||
/**
|
||||
* Platform environment info. On WeChat this carries `isSupportStandardWorker`, which gates
|
||||
* the V2 standard worker (grey release; NOT supported in the WeChat devtools). Absent on
|
||||
* platforms whose global has no `env`.
|
||||
*/
|
||||
env?: MinigameEnv;
|
||||
|
||||
// file system
|
||||
getFileSystemManager(): FileSystemManager;
|
||||
loadSubpackage? (option: LoadSubpackageOption): LoadSubpackageTask;
|
||||
@@ -133,6 +165,57 @@ declare module 'pal/minigame' {
|
||||
getAudioContext?: () => AudioContext;
|
||||
}
|
||||
|
||||
/**
|
||||
* Options accepted by `minigame.createWorker`. Only WeChat defines any; other platforms ignore
|
||||
* the second argument. Kept loose on purpose — the platform surface differs and grows.
|
||||
*/
|
||||
export interface MinigameWorkerOptions {
|
||||
/**
|
||||
* WeChat only, base library 2.13.0+. Uses the "experimental" worker implementation, which
|
||||
* speeds up JS execution several times over on iOS. Requires pairing with
|
||||
* `onProcessKilled`, because the system may reclaim the worker process at any time.
|
||||
* This legacy option does not select the V2 standard Worker.
|
||||
*/
|
||||
useExperimentalWorker?: boolean;
|
||||
[key: string]: any;
|
||||
}
|
||||
|
||||
/**
|
||||
* Platform environment info exposed as `minigame.env`.
|
||||
*/
|
||||
export interface MinigameEnv {
|
||||
/**
|
||||
* WeChat only. `true` when the runtime supports the V2 standard worker: multiple concurrent
|
||||
* workers, `SharedArrayBuffer`, transfer lists in `postMessage`, `OffscreenCanvas`. Requires
|
||||
* WeChat client >= 8.0.74 (Android) and base library >= 3.17.0, is in grey release, and is
|
||||
* NOT supported in the WeChat devtools — so it must be checked at runtime, never assumed.
|
||||
*/
|
||||
isSupportStandardWorker?: boolean;
|
||||
[key: string]: any;
|
||||
}
|
||||
|
||||
/**
|
||||
* The worker handle returned by `minigame.createWorker`. The API shape is remarkably consistent
|
||||
* across WeChat / ByteDance / Alipay / Baidu / quick-game: all use `postMessage` + `onMessage`,
|
||||
* and all expose the worker-side global as `worker` (NOT `self`).
|
||||
*
|
||||
* Differences that the engine's backend layer must absorb:
|
||||
* - `onError` is missing on some platforms (Huawei quick game documents only
|
||||
* create/postMessage/onMessage/terminate) — guard before calling.
|
||||
* - `onProcessKilled` is WeChat-only (iOS experimental worker reclamation).
|
||||
* - The transfer list (second `postMessage` argument) is honored ONLY by WeChat V2. Huawei quick
|
||||
* game documents data transfer as structured clone with no transferable objects; passing a
|
||||
* transfer list elsewhere may throw, so omit it unless the platform supports it.
|
||||
*/
|
||||
export interface MinigameWorker {
|
||||
postMessage(message: any, transfer?: any[]): void;
|
||||
onMessage(listener: (res: any) => void): void;
|
||||
onError?: (listener: (err: any) => void) => void;
|
||||
terminate(): void;
|
||||
/** WeChat only: fired when the system reclaims the worker process. */
|
||||
onProcessKilled?: (listener: (err: any) => void) => void;
|
||||
}
|
||||
|
||||
export type AccelerometerIntervalMode = 'game' | 'ui' | 'normal';
|
||||
|
||||
export interface AccelerometerStartParameter {
|
||||
|
||||
Vendored
+12
@@ -22,6 +22,12 @@ declare module 'pal/screen-adapter' {
|
||||
* Determine whether use headless renderer, which means do not support some screen operations.
|
||||
*/
|
||||
isHeadlessMode: boolean;
|
||||
/**
|
||||
* Optional startup DPR cap, currently consumed by Web.
|
||||
* Supporting adapters validate that it is finite and >= 1; other adapters ignore it.
|
||||
* Omission/null preserves the adapter's default policy (Web caps DPR at 2).
|
||||
*/
|
||||
maxDevicePixelRatio?: number | null;
|
||||
}
|
||||
|
||||
class ScreenAdapter {
|
||||
@@ -58,6 +64,12 @@ declare module 'pal/screen-adapter' {
|
||||
* Query the current fullscreen state.
|
||||
*/
|
||||
public get isFullScreen (): boolean;
|
||||
/**
|
||||
* Optional capability: the applied startup cap, or null for the adapter's default.
|
||||
* Adapters exposing this property consume and validate maxDevicePixelRatio.
|
||||
* Absent on adapters that ignore this setting.
|
||||
*/
|
||||
public readonly maxDevicePixelRatio?: number | null;
|
||||
/**
|
||||
* The ratio of pixel sizes:
|
||||
* the size of one CSS pixel to the size of one physical pixel.
|
||||
|
||||
Vendored
+61
@@ -0,0 +1,61 @@
|
||||
/**
|
||||
* Engine-side contract of the `pal/worker` module.
|
||||
*
|
||||
* Self-contained on purpose: type checking, IDE services and declaration builds must not depend on
|
||||
* whether the installed PAL package ships a worker module. When `pal/worker` is absent (an older
|
||||
* PAL, or the single-thread compatibility module which is JS only), TypeScript resolves the import to
|
||||
* this ambient declaration. `tests/scripts/pal-worker-types.test.cjs` checks that a real PAL
|
||||
* `worker/type.d.ts` stays structurally identical to these interfaces.
|
||||
*/
|
||||
declare module 'pal/worker' {
|
||||
export interface IWorker {
|
||||
postMessage (message: any, transfer?: Transferable[]): void;
|
||||
onMessage (listener: (res: any) => void): void;
|
||||
onError (listener: (err: any) => void): void;
|
||||
terminate (): void;
|
||||
}
|
||||
|
||||
export interface IWorkerDiagnosis {
|
||||
ready: boolean;
|
||||
version: 0 | 1 | 2;
|
||||
reason: string;
|
||||
}
|
||||
|
||||
export interface IWorkerBackend {
|
||||
readonly concurrencyLimit: number;
|
||||
readonly supportsTransfer: boolean;
|
||||
readonly supportsSharedArrayBuffer: boolean;
|
||||
readonly supportsFunctionWorker: boolean;
|
||||
readonly capabilityReason: string;
|
||||
createScriptWorker (path: string): IWorker;
|
||||
diagnose (path: string): IWorkerDiagnosis;
|
||||
}
|
||||
|
||||
export interface IPlatformWorkerBackend extends IWorkerBackend {
|
||||
readonly supportsStandardWorker: boolean;
|
||||
readonly scriptFailureHint: string;
|
||||
resolveScriptWorker (path: string): IWorkerResolution;
|
||||
readonly hardwareConcurrency: number;
|
||||
readonly scriptFallback: IPlatformWorkerBackend | null;
|
||||
createFunctionWorker (fn: (...args: any[]) => any): IWorker | null;
|
||||
}
|
||||
|
||||
export interface IWorkerResolution {
|
||||
backend: IPlatformWorkerBackend | null;
|
||||
diagnosis: IWorkerDiagnosis;
|
||||
warnOnFailure: boolean;
|
||||
}
|
||||
|
||||
export interface IWorkerCapabilities {
|
||||
supportsStandardWorker: boolean;
|
||||
available: boolean;
|
||||
parallel: boolean;
|
||||
concurrencyLimit: number;
|
||||
supportsTransfer: boolean;
|
||||
supportsSharedArrayBuffer: boolean;
|
||||
supportsFunctionWorker: boolean;
|
||||
reason: string;
|
||||
}
|
||||
|
||||
export function createWorkerBackend (): IPlatformWorkerBackend;
|
||||
}
|
||||
@@ -3205,6 +3205,38 @@ request fullscreen is not supported on this platform.
|
||||
|
||||
exit fullscreen is not supported on this platform.
|
||||
|
||||
### 9010
|
||||
|
||||
UIMesh.setMeshData: unsupported vertexStride %d, expected %d (V3F_T2F_C4B) or %d (V3F_T2F_C4B_C4B); data rejected.
|
||||
|
||||
### 9011
|
||||
|
||||
UIMesh.setMeshData: negative counts (vertexCount %d, indexCount %d); data rejected.
|
||||
|
||||
### 9012
|
||||
|
||||
UIMesh.setMeshData: vertexData holds %d bytes, but %d vertices x %d bytes are declared; data rejected.
|
||||
|
||||
### 9013
|
||||
|
||||
UIMesh.setMeshData: indexData is %d bytes at offset %d, but %d Uint16 indices need %d bytes (2-byte aligned view); data rejected.
|
||||
|
||||
### 9014
|
||||
|
||||
UIMesh.setMeshData: indices[%d] = %d is out of range for %d vertices; data rejected.
|
||||
|
||||
### 9015
|
||||
|
||||
UIMesh.setMeshData: segment %d range [%d, %d) is out of bounds for indexCount %d; data rejected.
|
||||
|
||||
### 9016
|
||||
|
||||
UIMesh.setMeshData: %d vertices / %d indices exceed the accessor cap (%d / %d); split the mesh. Data rejected.
|
||||
|
||||
### 9017
|
||||
|
||||
UIMesh: render data allocation failed for %d vertices / %d indices (accessor cap: %d / %d).
|
||||
|
||||
### 9100
|
||||
|
||||
texture size exceeds current device limits %d/%d
|
||||
@@ -3226,6 +3258,18 @@ Cannot access game frame or container.
|
||||
|
||||
Setting window size is not supported.
|
||||
|
||||
### 9204
|
||||
|
||||
maxDevicePixelRatio, when specified, must be a finite number >= 1.
|
||||
|
||||
### 9205
|
||||
|
||||
PAL did not apply the configured maximum DPR. Check that the engine and PAL versions match.
|
||||
|
||||
### 9206
|
||||
|
||||
maxDevicePixelRatio cannot change after ScreenAdapter.init().
|
||||
|
||||
### 9300
|
||||
|
||||
The current buffer beyond the limit in ui static component, please reduce the amount
|
||||
@@ -3980,3 +4024,75 @@ Debug bones or slots is invalid in cached mode.
|
||||
### 16419
|
||||
|
||||
Spine version not supported.
|
||||
|
||||
### 16420
|
||||
|
||||
End time must bigger than start time.
|
||||
|
||||
### 16500
|
||||
|
||||
WorkerPool script path must be a non-empty string
|
||||
|
||||
### 16501
|
||||
|
||||
WorkerPool requires a self-contained task function or a worker script path
|
||||
|
||||
### 16502
|
||||
|
||||
WorkerPool has been terminated
|
||||
|
||||
### 16503
|
||||
|
||||
WorkerPool has no available execution backend
|
||||
|
||||
### 16504
|
||||
|
||||
No worker backend for "%s" (%s). Provide options.fallback to run single-threaded, or fix packaging (docs/worker/README.md).
|
||||
|
||||
### 16505
|
||||
|
||||
WorkerPool degraded to single-threaded for "%s": worker backend failed (%s). %s
|
||||
|
||||
### 16506
|
||||
|
||||
WorkerPool is rejecting tasks (no options.fallback) for "%s": worker backend failed (%s). %s
|
||||
|
||||
### 16507
|
||||
|
||||
WorkerPool could not use a worker for "%s" and is running single-threaded via options.fallback. Reason: %s. %s
|
||||
|
||||
### 16508
|
||||
|
||||
WorkerPool could not use a worker for "%s" and is REJECTING tasks (no options.fallback). Reason: %s. %s
|
||||
|
||||
### 16509
|
||||
|
||||
Worker error
|
||||
|
||||
### 16510
|
||||
|
||||
Worker is unavailable and no synchronous fallback exists
|
||||
|
||||
### 16511
|
||||
|
||||
Worker task timed out after %sms — the worker never replied (deadlock, infinite loop, or non-protocol script). Worker discarded; see docs/worker/README.md
|
||||
|
||||
### 16512
|
||||
|
||||
Worker has been disposed
|
||||
|
||||
### 16513
|
||||
|
||||
Worker script sent a malformed reply — it must implement the engine protocol: receive { id, args }, post back { id, ok, value } or { id, ok: false, error } (docs/worker/cc-worker-template.js)
|
||||
|
||||
### 16514
|
||||
|
||||
Worker task failed
|
||||
|
||||
### 16515
|
||||
|
||||
createWorker(path) requires a non-empty worker script path
|
||||
|
||||
### 16516
|
||||
|
||||
Function workers are unavailable; use WorkerPool for an automatic sync fallback, or createWorker(path) (mode 2).
|
||||
|
||||
+77
-47
@@ -300,6 +300,16 @@
|
||||
"overrideConstants": {
|
||||
"CULL_MESHOPT": false
|
||||
}
|
||||
},
|
||||
"worker": {
|
||||
"modules": ["worker"]
|
||||
},
|
||||
"worker-pool": {
|
||||
"modules": ["worker", "worker-pool"],
|
||||
"dependentModules": ["worker"]
|
||||
},
|
||||
"webassembly": {
|
||||
"modules": ["webassembly"]
|
||||
}
|
||||
},
|
||||
"moduleOverrides": [{
|
||||
@@ -382,70 +392,75 @@
|
||||
"test": "context.buildTimeConstants && context.buildTimeConstants.HTML5",
|
||||
"isVirtualModule": true,
|
||||
"overrides": {
|
||||
"pal/minigame": "pal/minigame/non-minigame.ts",
|
||||
"pal/audio": "pal/audio/web/player.ts",
|
||||
"pal/system-info": "pal/system-info/web/system-info.ts",
|
||||
"pal/screen-adapter": "pal/screen-adapter/web/screen-adapter.ts",
|
||||
"pal/input": "pal/input/web/index.ts",
|
||||
"pal/env": "pal/env/web/env.ts",
|
||||
"pal/pacer": "pal/pacer/pacer-web.ts",
|
||||
"pal/wasm": "pal/wasm/wasm-web.ts"
|
||||
"pal/minigame": "pal/minigame/non-minigame.js",
|
||||
"pal/worker": "pal/worker/web/index.js",
|
||||
"pal/audio": "pal/audio/web/player.js",
|
||||
"pal/system-info": "pal/system-info/web/system-info.js",
|
||||
"pal/screen-adapter": "pal/screen-adapter/web/screen-adapter.js",
|
||||
"pal/input": "pal/input/web/index.js",
|
||||
"pal/env": "pal/env/web/env.js",
|
||||
"pal/pacer": "pal/pacer/pacer-web.js",
|
||||
"pal/wasm": "pal/wasm/wasm-web.js"
|
||||
}
|
||||
},
|
||||
{
|
||||
"test": "context.buildTimeConstants && context.buildTimeConstants.NATIVE",
|
||||
"isVirtualModule": true,
|
||||
"overrides": {
|
||||
"pal/minigame": "pal/minigame/non-minigame.ts",
|
||||
"pal/audio": "pal/audio/native/player.ts",
|
||||
"pal/system-info": "pal/system-info/native/system-info.ts",
|
||||
"pal/screen-adapter": "pal/screen-adapter/native/screen-adapter.ts",
|
||||
"pal/input": "pal/input/native/index.ts",
|
||||
"pal/env": "pal/env/native/env.ts",
|
||||
"pal/pacer": "pal/pacer/pacer-native.ts",
|
||||
"pal/wasm": "pal/wasm/wasm-native.ts"
|
||||
"pal/minigame": "pal/minigame/non-minigame.js",
|
||||
"pal/worker": "pal/worker/native/index.js",
|
||||
"pal/audio": "pal/audio/native/player.js",
|
||||
"pal/system-info": "pal/system-info/native/system-info.js",
|
||||
"pal/screen-adapter": "pal/screen-adapter/native/screen-adapter.js",
|
||||
"pal/input": "pal/input/native/index.js",
|
||||
"pal/env": "pal/env/native/env.js",
|
||||
"pal/pacer": "pal/pacer/pacer-native.js",
|
||||
"pal/wasm": "pal/wasm/wasm-native.js"
|
||||
}
|
||||
},
|
||||
{
|
||||
"test": "context.buildTimeConstants && context.buildTimeConstants.MINIGAME",
|
||||
"isVirtualModule": true,
|
||||
"overrides": {
|
||||
"pal/minigame": "pal/minigame/{{context.platform.toLowerCase()}}.ts",
|
||||
"pal/audio": "pal/audio/minigame/player.ts",
|
||||
"pal/system-info": "pal/system-info/minigame/system-info.ts",
|
||||
"pal/screen-adapter": "pal/screen-adapter/minigame/screen-adapter.ts",
|
||||
"pal/input": "pal/input/minigame/index.ts",
|
||||
"pal/env": "pal/env/minigame/env.ts",
|
||||
"pal/pacer": "pal/pacer/pacer-minigame.ts",
|
||||
"pal/wasm": "pal/wasm/wasm-minigame.ts"
|
||||
"pal/minigame": "pal/minigame/{{context.platform.toLowerCase()}}.js",
|
||||
"pal/worker": "pal/worker/minigame/index.js",
|
||||
"pal/audio": "pal/audio/minigame/player.js",
|
||||
"pal/system-info": "pal/system-info/minigame/system-info.js",
|
||||
"pal/screen-adapter": "pal/screen-adapter/minigame/screen-adapter.js",
|
||||
"pal/input": "pal/input/minigame/index.js",
|
||||
"pal/env": "pal/env/minigame/env.js",
|
||||
"pal/pacer": "pal/pacer/pacer-minigame.js",
|
||||
"pal/wasm": "pal/wasm/wasm-minigame.js"
|
||||
}
|
||||
},
|
||||
{
|
||||
"test": "context.buildTimeConstants && context.buildTimeConstants.RUNTIME_BASED",
|
||||
"isVirtualModule": true,
|
||||
"overrides": {
|
||||
"pal/minigame": "pal/minigame/runtime.ts",
|
||||
"pal/audio": "pal/audio/minigame/player.ts",
|
||||
"pal/system-info": "pal/system-info/minigame/system-info.ts",
|
||||
"pal/screen-adapter": "pal/screen-adapter/minigame/screen-adapter.ts",
|
||||
"pal/input": "pal/input/minigame/index.ts",
|
||||
"pal/env": "pal/env/runtime/env.ts",
|
||||
"pal/pacer": "pal/pacer/pacer-minigame.ts",
|
||||
"pal/wasm": "pal/wasm/wasm-minigame.ts"
|
||||
"pal/minigame": "pal/minigame/runtime.js",
|
||||
"pal/worker": "pal/worker/minigame/index.js",
|
||||
"pal/audio": "pal/audio/minigame/player.js",
|
||||
"pal/system-info": "pal/system-info/minigame/system-info.js",
|
||||
"pal/screen-adapter": "pal/screen-adapter/minigame/screen-adapter.js",
|
||||
"pal/input": "pal/input/minigame/index.js",
|
||||
"pal/env": "pal/env/runtime/env.js",
|
||||
"pal/pacer": "pal/pacer/pacer-minigame.js",
|
||||
"pal/wasm": "pal/wasm/wasm-minigame.js"
|
||||
}
|
||||
},
|
||||
{
|
||||
"test": "context.buildTimeConstants && context.buildTimeConstants.NODEJS",
|
||||
"isVirtualModule": true,
|
||||
"overrides": {
|
||||
"pal/minigame": "pal/minigame/non-minigame.ts",
|
||||
"pal/audio": "pal/audio/nodejs/player.ts",
|
||||
"pal/system-info": "pal/system-info/nodejs/system-info.ts",
|
||||
"pal/screen-adapter": "pal/screen-adapter/nodejs/screen-adapter.ts",
|
||||
"pal/input": "pal/input/nodejs/index.ts",
|
||||
"pal/env": "pal/env/nodejs/env.ts",
|
||||
"pal/pacer": "pal/pacer/pacer-nodejs.ts",
|
||||
"pal/wasm": "pal/wasm/wasm-nodejs.ts"
|
||||
"pal/minigame": "pal/minigame/non-minigame.js",
|
||||
"pal/worker": "pal/worker/nodejs/index.js",
|
||||
"pal/audio": "pal/audio/nodejs/player.js",
|
||||
"pal/system-info": "pal/system-info/nodejs/system-info.js",
|
||||
"pal/screen-adapter": "pal/screen-adapter/nodejs/screen-adapter.js",
|
||||
"pal/input": "pal/input/nodejs/index.js",
|
||||
"pal/env": "pal/env/nodejs/env.js",
|
||||
"pal/pacer": "pal/pacer/pacer-nodejs.js",
|
||||
"pal/wasm": "pal/wasm/wasm-nodejs.js"
|
||||
}
|
||||
},
|
||||
{
|
||||
@@ -470,7 +485,15 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"test": "context.buildTimeConstants.SPINE_3_8",
|
||||
"test": "context.buildTimeConstants.SPINE_3_8 && context.buildTimeConstants.SPINE_4_2",
|
||||
"isVirtualModule": false,
|
||||
"overrides": {
|
||||
"cocos/spine/lib/spine-version.ts": "cocos/spine/lib/spine-version-dynamic.ts",
|
||||
"cocos/spine/lib/spine-instantiate.ts": "cocos/spine/lib/spine-instantiate-dynamic.ts"
|
||||
}
|
||||
},
|
||||
{
|
||||
"test": "context.buildTimeConstants.SPINE_3_8 && !context.buildTimeConstants.SPINE_4_2",
|
||||
"isVirtualModule": false,
|
||||
"overrides": {
|
||||
"cocos/spine/lib/spine-version.ts": "cocos/spine/lib/spine-version-3.8.ts",
|
||||
@@ -478,7 +501,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"test": "context.buildTimeConstants.SPINE_4_2",
|
||||
"test": "context.buildTimeConstants.SPINE_4_2 && !context.buildTimeConstants.SPINE_3_8",
|
||||
"isVirtualModule": false,
|
||||
"overrides": {
|
||||
"cocos/spine/lib/spine-version.ts": "cocos/spine/lib/spine-version-4.2.ts",
|
||||
@@ -659,6 +682,13 @@
|
||||
"ccGlobal": true,
|
||||
"internal": false
|
||||
},
|
||||
"SUDV2": {
|
||||
"comment": "Running in the sud v2's quick game.",
|
||||
"type": "boolean",
|
||||
"value": false,
|
||||
"ccGlobal": true,
|
||||
"internal": false
|
||||
},
|
||||
"NODEJS": {
|
||||
"comment": "Running in the Node.js environment.",
|
||||
"type": "boolean",
|
||||
@@ -738,7 +768,7 @@
|
||||
"RUNTIME_BASED": {
|
||||
"comment": "Running in runtime based environment.",
|
||||
"type": "boolean",
|
||||
"value": "$OPPO || $VIVO || $HUAWEI || $MIGU || $HONOR || $COCOS_RUNTIME || $SUD",
|
||||
"value": "$OPPO || $VIVO || $HUAWEI || $MIGU || $HONOR || $COCOS_RUNTIME || $SUD || $SUDV2",
|
||||
"ccGlobal": true,
|
||||
"internal": false
|
||||
},
|
||||
@@ -870,10 +900,10 @@
|
||||
"cocos/asset/asset-manager/weak-cache.ts",
|
||||
"cocos/2d/framework/ui-skew-utils.ts",
|
||||
"cocos/spine/lib/spine-binary.ts",
|
||||
"pal/input/minigame/gamepad-input.ts",
|
||||
"pal/input/minigame/handheld-input.ts",
|
||||
"pal/input/minigame/handle-input.ts",
|
||||
"pal/input/minigame/hmd-input.ts"
|
||||
"pal/input/minigame/gamepad-input.js",
|
||||
"pal/input/minigame/handheld-input.js",
|
||||
"pal/input/minigame/handle-input.js",
|
||||
"pal/input/minigame/hmd-input.js"
|
||||
]
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
/*
|
||||
Copyright (c) 2022-2023 Xiamen Yaji Software Co., Ltd.
|
||||
Copyright (c) 2017-2023 Xiamen Yaji Software Co., Ltd.
|
||||
|
||||
https://www.cocos.com/
|
||||
http://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
|
||||
@@ -22,15 +22,11 @@
|
||||
THE SOFTWARE.
|
||||
*/
|
||||
|
||||
import { checkPalIntegrity, withImpl } from '../../integrity-check';
|
||||
// Vertex/index capacity limits of the graphics geometry.
|
||||
|
||||
export * from './accelerometer-input';
|
||||
export * from './gamepad-input';
|
||||
export * from './handle-input';
|
||||
export * from './hmd-input';
|
||||
export * from './handheld-input';
|
||||
export * from './keyboard-input';
|
||||
export * from './mouse-input';
|
||||
export * from './touch-input';
|
||||
|
||||
checkPalIntegrity<typeof import('pal/input')>(withImpl<typeof import('./index')>());
|
||||
// Uint16 can address 65536 vertices (indices 0-65535), and a single fill()/stroke() batch is not
|
||||
// split, so the buffers have to cover this count.
|
||||
export const MAX_VERTEX_COUNT = 65536;
|
||||
// Fill and stroke both emit at most 3 indices per vertex, see GraphicsAssembler.
|
||||
export const INDICES_PER_VERTEX = 3;
|
||||
export const MAX_INDEX_COUNT = MAX_VERTEX_COUNT * INDICES_PER_VERTEX;
|
||||
@@ -28,12 +28,10 @@ import { MeshRenderData } from '../../../renderer/render-data';
|
||||
import { IBatcher } from '../../../renderer/i-batcher';
|
||||
import { Graphics } from '../../../components/graphics';
|
||||
import { LineCap, LineJoin, PointFlags } from '../types';
|
||||
import { MAX_VERTEX_COUNT, INDICES_PER_VERTEX } from '../constants';
|
||||
import { earcut as Earcut } from './earcut';
|
||||
import { Impl, Point } from './impl';
|
||||
|
||||
const MAX_VERTEX = 65535;
|
||||
const MAX_INDICES = MAX_VERTEX * 2;
|
||||
|
||||
const PI = Math.PI;
|
||||
const min = Math.min;
|
||||
const max = Math.max;
|
||||
@@ -95,7 +93,7 @@ export class GraphicsAssembler implements IAssembler {
|
||||
let meshBuffer = renderData;
|
||||
|
||||
const maxVertexCount = meshBuffer ? meshBuffer.vertexStart + vertexCount : 0;
|
||||
if (maxVertexCount > MAX_VERTEX || maxVertexCount * 3 > MAX_INDICES) {
|
||||
if (maxVertexCount > MAX_VERTEX_COUNT) {
|
||||
++_impl.dataOffset;
|
||||
|
||||
if (_impl.dataOffset < renderDataList.length) {
|
||||
@@ -109,7 +107,7 @@ export class GraphicsAssembler implements IAssembler {
|
||||
}
|
||||
|
||||
if (meshBuffer && meshBuffer.vertexCount < maxVertexCount) {
|
||||
meshBuffer.request(vertexCount, vertexCount * 3);
|
||||
meshBuffer.request(vertexCount, vertexCount * INDICES_PER_VERTEX);
|
||||
}
|
||||
|
||||
return renderData;
|
||||
|
||||
@@ -32,6 +32,7 @@ import { safeMeasureText, BASELINE_RATIO, MIDDLE_RATIO, getBaselineOffset, getSy
|
||||
import { director, DirectorEvent } from '../../../game/director';
|
||||
import { ccwindow } from '../../../core/global-exports';
|
||||
import { TextureBase } from '../../../asset/assets/texture-base';
|
||||
import { buildFontDesc, CssFontFamily, DEFAULT_FONT_FAMILY } from '../../utils/font-family';
|
||||
|
||||
export interface ISharedLabelData {
|
||||
canvas: HTMLCanvasElement;
|
||||
@@ -102,7 +103,7 @@ interface ILabelInfo {
|
||||
fontSize: number;
|
||||
lineHeight: number;
|
||||
hash: string;
|
||||
fontFamily: string;
|
||||
fontFamily: CssFontFamily;
|
||||
fontDesc: string;
|
||||
hAlign: number;
|
||||
vAlign: number;
|
||||
@@ -194,10 +195,7 @@ class LetterTexture {
|
||||
// Add a white background to avoid black edges.
|
||||
context.fillStyle = _backgroundStyle;
|
||||
context.fillRect(0, 0, width, height);
|
||||
context.font = labelInfo.fontDesc.replace(
|
||||
/(\d+)(\.\d+)?(px|em|rem|pt)/g,
|
||||
(w, m: string, n: string, u: string) => (+m * fontScale + (+n || 0) * fontScale).toString() + u,
|
||||
);
|
||||
context.font = buildFontDesc(labelInfo.fontSize * fontScale, labelInfo.fontFamily);
|
||||
|
||||
const fontSize = labelInfo.fontSize * fontScale;
|
||||
const startX = width / 2;
|
||||
@@ -425,7 +423,7 @@ export interface IShareLabelInfo {
|
||||
hAlign: number;
|
||||
vAlign: number;
|
||||
hash: string;
|
||||
fontFamily: string;
|
||||
fontFamily: CssFontFamily;
|
||||
fontDesc: string;
|
||||
color: Color;
|
||||
isOutlined: boolean;
|
||||
@@ -441,7 +439,7 @@ export const shareLabelInfo: IShareLabelInfo = {
|
||||
hAlign: 0,
|
||||
vAlign: 0,
|
||||
hash: '',
|
||||
fontFamily: '',
|
||||
fontFamily: DEFAULT_FONT_FAMILY,
|
||||
fontDesc: 'Arial',
|
||||
color: Color.WHITE.clone(),
|
||||
isOutlined: false,
|
||||
|
||||
@@ -26,6 +26,7 @@ import type { Label } from '../../components';
|
||||
import { IAssembler } from '../../renderer/base';
|
||||
import { BmfontUtils } from './bmfontUtils';
|
||||
import { shareLabelInfo, LetterAtlas, computeHash, LetterRenderTexture } from './font-utils';
|
||||
import { buildFontDesc, CssFontFamily, getCanvasFontFamily } from '../../utils/font-family';
|
||||
|
||||
const _atlasWidth = 1024;
|
||||
const _atlasHeight = 1024;
|
||||
@@ -59,17 +60,8 @@ export class LetterFont extends BmfontUtils {
|
||||
}
|
||||
}
|
||||
|
||||
protected _getFontFamily (comp: Label): string {
|
||||
let fontFamily = 'Arial';
|
||||
if (!comp.useSystemFont) {
|
||||
if (comp.font) {
|
||||
fontFamily = comp.font._nativeAsset || 'Arial';
|
||||
}
|
||||
} else {
|
||||
fontFamily = comp.fontFamily || 'Arial';
|
||||
}
|
||||
|
||||
return fontFamily;
|
||||
protected _getFontFamily (comp: Label): CssFontFamily {
|
||||
return getCanvasFontFamily(comp);
|
||||
}
|
||||
|
||||
protected _updateLabelInfo (comp: Label): void {
|
||||
@@ -79,12 +71,6 @@ export class LetterFont extends BmfontUtils {
|
||||
}
|
||||
|
||||
protected _getFontDesc (): string {
|
||||
let fontDesc = `${shareLabelInfo.fontSize.toString()}px `;
|
||||
fontDesc += shareLabelInfo.fontFamily;
|
||||
if (_isBold) {
|
||||
fontDesc = `bold ${fontDesc}`;
|
||||
}
|
||||
|
||||
return fontDesc;
|
||||
return buildFontDesc(shareLabelInfo.fontSize, shareLabelInfo.fontFamily, _isBold);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -45,6 +45,7 @@ import {
|
||||
safeMeasureText,
|
||||
} from '../../utils/text-utils';
|
||||
import type { Batcher2D } from '../../renderer/batcher-2d';
|
||||
import { buildFontDesc, CssFontFamily } from '../../utils/font-family';
|
||||
|
||||
const Alignment = [
|
||||
'left', // macro.TextAlignment.LEFT
|
||||
@@ -115,7 +116,7 @@ export class TextProcessing {
|
||||
const maxValue = Math.max(outputLayoutData.canvasSize.width, outputLayoutData.canvasSize.height);
|
||||
const canvasScaleToMaxSizeRatio = MAX_SIZE / maxValue;
|
||||
this._fontScale *= canvasScaleToMaxSizeRatio;
|
||||
this._fontScale = Math.max(1, this._fontScale);
|
||||
this._fontScale = Math.max(0.1, this._fontScale);
|
||||
}
|
||||
|
||||
this._updatePaddingRect(style, outputLayoutData);
|
||||
@@ -260,18 +261,8 @@ export class TextProcessing {
|
||||
}
|
||||
|
||||
// can cache
|
||||
private _getFontDesc (fontSize: number, fontFamily: string, isBold: boolean, isItalic: boolean): string {
|
||||
let fontDesc = `${fontSize.toString()}px `;
|
||||
fontDesc += fontFamily;
|
||||
if (isBold) {
|
||||
fontDesc = `bold ${fontDesc}`;
|
||||
}
|
||||
|
||||
if (isItalic) {
|
||||
fontDesc = `italic ${fontDesc}`;
|
||||
}
|
||||
|
||||
return fontDesc;
|
||||
private _getFontDesc (fontSize: number, fontFamily: CssFontFamily, isBold: boolean, isItalic: boolean): string {
|
||||
return buildFontDesc(fontSize, fontFamily, isBold, isItalic);
|
||||
}
|
||||
|
||||
// can cache
|
||||
|
||||
@@ -25,6 +25,7 @@
|
||||
import { Color } from '../../../core';
|
||||
import { IConfig } from '../../assets/bitmap-font';
|
||||
import { SpriteFrame } from '../../assets/sprite-frame';
|
||||
import { CssFontFamily, DEFAULT_FONT_FAMILY } from '../../utils/font-family';
|
||||
|
||||
export class TextStyle {
|
||||
// ---------------ttf extra part-----------------
|
||||
@@ -59,7 +60,7 @@ export class TextStyle {
|
||||
public bmfontScale = 1.0;// both
|
||||
|
||||
// font info // todo merge to font
|
||||
public fontFamily = 'Arial'; // both
|
||||
public fontFamily: CssFontFamily = DEFAULT_FONT_FAMILY; // Serialized CSS family, both TTF and CHAR.
|
||||
public fontDesc = ''; // both
|
||||
|
||||
// -----------------------bitMap extra part-------------------------
|
||||
|
||||
@@ -31,6 +31,7 @@ import type { TextStyle } from './text-style';
|
||||
import type { TextLayout } from './text-layout';
|
||||
import { view } from '../../../ui/view';
|
||||
import { approx } from '../../../core';
|
||||
import { CssFontFamily, getCanvasFontFamily } from '../../utils/font-family';
|
||||
|
||||
const Overflow = Label.Overflow;
|
||||
|
||||
@@ -192,18 +193,8 @@ export class TTFUtils {
|
||||
// no needs to update uv data
|
||||
}
|
||||
|
||||
_updateFontFamily (comp: Label): string {
|
||||
let _fontFamily = '';
|
||||
if (!comp.useSystemFont) {
|
||||
if (comp.font) {
|
||||
_fontFamily = comp.font._nativeAsset || 'Arial';
|
||||
} else {
|
||||
_fontFamily = 'Arial';
|
||||
}
|
||||
} else {
|
||||
_fontFamily = comp.fontFamily || 'Arial';
|
||||
}
|
||||
return _fontFamily;
|
||||
_updateFontFamily (comp: Label): CssFontFamily {
|
||||
return getCanvasFontFamily(comp);
|
||||
}
|
||||
|
||||
_calDynamicAtlas (comp: Label, outputLayoutData: TextOutputLayoutData): void {
|
||||
|
||||
@@ -32,6 +32,7 @@ import { Color, warnID, cclegacy } from '../../core';
|
||||
import { scene } from '../../render-scene';
|
||||
import type { IBatcher } from '../renderer/i-batcher';
|
||||
import { LineCap, LineJoin } from '../assembler/graphics/types';
|
||||
import { MAX_VERTEX_COUNT, MAX_INDEX_COUNT } from '../assembler/graphics/constants';
|
||||
import { Impl } from '../assembler/graphics/webgl/impl';
|
||||
import { Material, RenderingSubMesh } from '../../asset/assets';
|
||||
import { Format, PrimitiveMode, Attribute, Device, BufferUsageBit, BufferInfo, MemoryUsageBit, deviceManager } from '../../gfx';
|
||||
@@ -39,21 +40,33 @@ import { vfmtPosColor, getAttributeStride, getComponentPerVertex } from '../rend
|
||||
import { NativeUIModelProxy } from '../renderer/native-2d';
|
||||
import { RenderEntity, RenderEntityType } from '../renderer/render-entity';
|
||||
import type { GraphicsAssembler } from '../assembler/graphics/webgl/graphics-assembler';
|
||||
import type { MeshRenderData } from '../renderer/render-data';
|
||||
import type { InputAssembler } from '../../gfx';
|
||||
|
||||
const attributes = vfmtPosColor.concat([
|
||||
new Attribute('a_dist', Format.R32F),
|
||||
]);
|
||||
|
||||
const componentPerVertex = getComponentPerVertex(attributes);
|
||||
const alphaOffset = 6; // position.xyz, color.rgba, distance
|
||||
|
||||
const stride = getAttributeStride(attributes);
|
||||
|
||||
// Grow only, by powers of two, so a changing geometry does not re-create the GPU buffer every frame.
|
||||
function growCapacity (needed: number, current: number, max: number): number {
|
||||
let cap = Math.max(current, 1);
|
||||
while (cap < needed) {
|
||||
cap *= 2;
|
||||
}
|
||||
return Math.min(cap, max);
|
||||
}
|
||||
|
||||
/**
|
||||
* @en
|
||||
* Graphics component.
|
||||
* Graphics component. Fill and stroke alpha are multiplied by the node's cascaded UI opacity at draw time.
|
||||
*
|
||||
* @zh
|
||||
* 自定义图形类。
|
||||
* 自定义图形组件。绘制时,填充和描边的 alpha 会乘以节点的累计 UI 透明度。
|
||||
*/
|
||||
@ccclass('cc.Graphics')
|
||||
@help('i18n:cc.Graphics')
|
||||
@@ -224,6 +237,8 @@ export class Graphics extends UIRenderer {
|
||||
protected _isNeedUploadData = true;
|
||||
|
||||
private _graphicsUseSubMeshes: RenderingSubMesh[] = [];
|
||||
private _uploadedOpacity = 1;
|
||||
private _opacityScratch: Float32Array | null = null;
|
||||
|
||||
//nativeObj
|
||||
protected declare _graphicsNativeProxy: NativeUIModelProxy;
|
||||
@@ -266,6 +281,15 @@ export class Graphics extends UIRenderer {
|
||||
this._updateMtlForGraphics();
|
||||
}
|
||||
|
||||
protected override get _keepRenderData (): boolean {
|
||||
// Graphics is a retained-mode renderer: its MeshRenderData is the result of the
|
||||
// user's previous fill()/stroke() calls. Destroying it here would leave Impl's
|
||||
// render-data list pointing at cleared geometry, so re-enabling the node on native
|
||||
// platforms would require the user to draw the paths again. Keep it attached to the
|
||||
// disabled RenderEntity; clear() and onDestroy() remain the owning release points.
|
||||
return true;
|
||||
}
|
||||
|
||||
public onDestroy (): void {
|
||||
this._sceneGetter = null;
|
||||
if (JSB) {
|
||||
@@ -292,6 +316,7 @@ export class Graphics extends UIRenderer {
|
||||
this.impl = null;
|
||||
}
|
||||
|
||||
this._opacityScratch = null;
|
||||
super.onDestroy();
|
||||
}
|
||||
|
||||
@@ -546,6 +571,7 @@ export class Graphics extends UIRenderer {
|
||||
}
|
||||
|
||||
this.impl.clear();
|
||||
this._opacityScratch = null;
|
||||
this._isDrawing = false;
|
||||
if (JSB) {
|
||||
this._graphicsNativeProxy.clear();// need native
|
||||
@@ -626,7 +652,7 @@ export class Graphics extends UIRenderer {
|
||||
/**
|
||||
* @deprecated since v3.7.0, this is an engine private interface that will be removed in the future.
|
||||
*/
|
||||
public activeSubModel (idx: number): void {
|
||||
public activeSubModel (idx: number, vertexCount = 1, indexCount = 1): void {
|
||||
if (!this.model) {
|
||||
warnID(4500, this.node.name);
|
||||
return;
|
||||
@@ -637,13 +663,13 @@ export class Graphics extends UIRenderer {
|
||||
const vertexBuffer = gfxDevice.createBuffer(new BufferInfo(
|
||||
BufferUsageBit.VERTEX | BufferUsageBit.TRANSFER_DST,
|
||||
MemoryUsageBit.DEVICE,
|
||||
65535 * stride,
|
||||
growCapacity(vertexCount, 0, MAX_VERTEX_COUNT) * stride,
|
||||
stride,
|
||||
));
|
||||
const indexBuffer = gfxDevice.createBuffer(new BufferInfo(
|
||||
BufferUsageBit.INDEX | BufferUsageBit.TRANSFER_DST,
|
||||
MemoryUsageBit.DEVICE,
|
||||
65535 * Uint16Array.BYTES_PER_ELEMENT * 2,
|
||||
growCapacity(indexCount, 0, MAX_INDEX_COUNT) * Uint16Array.BYTES_PER_ELEMENT,
|
||||
Uint16Array.BYTES_PER_ELEMENT,
|
||||
));
|
||||
|
||||
@@ -655,50 +681,86 @@ export class Graphics extends UIRenderer {
|
||||
}
|
||||
}
|
||||
|
||||
protected _uploadData (): void {
|
||||
const impl = this.impl;
|
||||
if (!impl) {
|
||||
return;
|
||||
}
|
||||
|
||||
const renderDataList = impl && impl.getRenderDataList();
|
||||
if (renderDataList.length <= 0 || !this.model) {
|
||||
protected _uploadData (opacity = this.node._uiProps.opacity): void {
|
||||
if (!this.impl || !this.model) {
|
||||
return;
|
||||
}
|
||||
|
||||
const renderDataList = this.impl.getRenderDataList();
|
||||
const subModelList = this.model.subModels;
|
||||
for (let i = 0; i < renderDataList.length; i++) {
|
||||
const renderData = renderDataList[i];
|
||||
const ia = subModelList[i].inputAssembler;
|
||||
if (renderData.lastFilledVertex === renderData.vertexStart) {
|
||||
continue;
|
||||
const indexCount = renderData.indexStart;
|
||||
const vertexCount = indexCount ? renderData.vertexStart : 0;
|
||||
const newSubModel = i >= subModelList.length;
|
||||
if (newSubModel) {
|
||||
this.activeSubModel(i, vertexCount, indexCount);
|
||||
}
|
||||
const ia = subModelList[i].inputAssembler;
|
||||
const verticesChanged = newSubModel || renderData.lastFilledVertex !== vertexCount;
|
||||
const indicesChanged = newSubModel || renderData.lastFilledIndex !== indexCount;
|
||||
if (verticesChanged || indicesChanged) {
|
||||
this._ensureCapacity(renderData, ia);
|
||||
}
|
||||
if (vertexCount && (verticesChanged || opacity !== this._uploadedOpacity)) {
|
||||
ia.vertexBuffers[0].update(this._getUploadVertices(renderData, vertexCount, opacity));
|
||||
}
|
||||
if (verticesChanged) {
|
||||
ia.vertexCount = vertexCount;
|
||||
renderData.lastFilledVertex = vertexCount;
|
||||
}
|
||||
if (indicesChanged) {
|
||||
if (indexCount) ia.indexBuffer!.update(renderData.iData.subarray(0, indexCount));
|
||||
ia.indexCount = indexCount;
|
||||
renderData.lastFilledIndex = indexCount;
|
||||
}
|
||||
|
||||
const vb = new Float32Array(renderData.vData.buffer, 0, renderData.vertexStart * componentPerVertex);
|
||||
ia.vertexBuffers[0].update(vb);
|
||||
ia.vertexCount = renderData.vertexStart;
|
||||
const ib = new Uint16Array(renderData.iData.buffer, 0, renderData.indexStart);
|
||||
ia.indexBuffer!.update(ib);
|
||||
ia.indexCount = renderData.indexStart;
|
||||
renderData.lastFilledVertex = renderData.vertexStart;
|
||||
renderData.lastFilledIndex = renderData.indexStart;
|
||||
}
|
||||
|
||||
this._uploadedOpacity = opacity;
|
||||
this._isNeedUploadData = false;
|
||||
}
|
||||
|
||||
private _getUploadVertices (data: MeshRenderData, vertexCount: number, opacity: number): Float32Array {
|
||||
const raw = new Float32Array(data.vData.buffer, data.vData.byteOffset, vertexCount * componentPerVertex);
|
||||
if (opacity === 1) return raw;
|
||||
|
||||
// Keep the retained paint colors intact so each fade starts from its original alpha.
|
||||
if (!this._opacityScratch || this._opacityScratch.length < raw.length) {
|
||||
this._opacityScratch = new Float32Array(growCapacity(vertexCount, 0, MAX_VERTEX_COUNT) * componentPerVertex);
|
||||
}
|
||||
const output = this._opacityScratch.subarray(0, raw.length);
|
||||
output.set(raw);
|
||||
for (let i = alphaOffset; i < output.length; i += componentPerVertex) {
|
||||
output[i] = raw[i] * opacity;
|
||||
}
|
||||
return output;
|
||||
}
|
||||
|
||||
/**
|
||||
* Grow only, never shrink: the capacity is reused after clear().
|
||||
*/
|
||||
private _ensureCapacity (renderData: MeshRenderData, ia: InputAssembler): void {
|
||||
const vb = ia.vertexBuffers[0];
|
||||
const vbStride = vb.stride;
|
||||
if (renderData.vertexStart * vbStride > vb.size) {
|
||||
const count = growCapacity(renderData.vertexStart, vb.size / vbStride, MAX_VERTEX_COUNT);
|
||||
vb.resize(count * vbStride);
|
||||
}
|
||||
|
||||
const ib = ia.indexBuffer;
|
||||
if (!ib) {
|
||||
return;
|
||||
}
|
||||
if (renderData.indexStart * Uint16Array.BYTES_PER_ELEMENT > ib.size) {
|
||||
const count = growCapacity(renderData.indexStart, ib.size / Uint16Array.BYTES_PER_ELEMENT, MAX_INDEX_COUNT);
|
||||
ib.resize(count * Uint16Array.BYTES_PER_ELEMENT);
|
||||
}
|
||||
}
|
||||
|
||||
protected _render (render: IBatcher): void {
|
||||
if (this._isNeedUploadData) {
|
||||
if (this.impl) {
|
||||
const renderDataList = this.impl.getRenderDataList();
|
||||
const len = this.model!.subModels.length;
|
||||
if (renderDataList.length > len) {
|
||||
for (let i = len; i < renderDataList.length; i++) {
|
||||
this.activeSubModel(i);
|
||||
}
|
||||
}
|
||||
}
|
||||
this._uploadData();
|
||||
const opacity = this.node._uiProps.opacity;
|
||||
if (this._isNeedUploadData || this._uploadedOpacity !== opacity) {
|
||||
this._uploadData(opacity);
|
||||
}
|
||||
|
||||
render.commitModel(this, this.model, this.getMaterialInstance(0));
|
||||
|
||||
@@ -25,6 +25,7 @@
|
||||
export * from './label';
|
||||
export { Sprite } from './sprite';
|
||||
export { UIMeshRenderer } from './ui-mesh-renderer';
|
||||
export * from './ui-mesh';
|
||||
export { LabelOutline } from './label-outline';
|
||||
export { UIStaticBatch } from './ui-static-batch';
|
||||
export { LabelShadow } from './label-shadow';
|
||||
|
||||
@@ -64,10 +64,10 @@ function _calculateCircle (center: Vec3, radius: Vec3, segments: number): Vec3[]
|
||||
*/
|
||||
export enum MaskType {
|
||||
/**
|
||||
* @en Rect mask.
|
||||
* @en Rect mask, supports rounded corners by setting radius.
|
||||
*
|
||||
* @zh
|
||||
* 使用矩形作为遮罩。
|
||||
* 使用矩形作为遮罩,可通过 radius 设置圆角。
|
||||
*/
|
||||
GRAPHICS_RECT = 0,
|
||||
|
||||
@@ -215,6 +215,32 @@ export class Mask extends Component {
|
||||
this._updateGraphics();
|
||||
}
|
||||
|
||||
/**
|
||||
* @en
|
||||
* The radius for rounded corners of rect mask.
|
||||
*
|
||||
* @zh
|
||||
* 矩形遮罩的圆角半径。
|
||||
*/
|
||||
@visible(function (this: Mask) {
|
||||
return this.type === MaskType.GRAPHICS_RECT;
|
||||
})
|
||||
@tooltip('i18n:mask.radius')
|
||||
@range([0, Number.POSITIVE_INFINITY])
|
||||
get radius (): number {
|
||||
return this._radius;
|
||||
}
|
||||
|
||||
set radius (value) {
|
||||
const radius = clamp(value, 0, Number.POSITIVE_INFINITY);
|
||||
if (this._radius === radius) {
|
||||
return;
|
||||
}
|
||||
|
||||
this._radius = radius;
|
||||
this._updateGraphics();
|
||||
}
|
||||
|
||||
/**
|
||||
* @en
|
||||
* The mask image.
|
||||
@@ -289,6 +315,9 @@ export class Mask extends Component {
|
||||
@serializable
|
||||
protected _segments = 64;
|
||||
|
||||
@serializable
|
||||
protected _radius = 0;
|
||||
|
||||
@serializable
|
||||
protected _alphaThreshold = 0.1;
|
||||
|
||||
@@ -350,7 +379,25 @@ export class Mask extends Component {
|
||||
testPt.y += ap.y * h;
|
||||
|
||||
let result = false;
|
||||
if (this.type === MaskType.GRAPHICS_RECT || this.type === MaskType.GRAPHICS_STENCIL || this.type === MaskType.SPRITE_STENCIL) {
|
||||
if (this.type === MaskType.GRAPHICS_RECT) {
|
||||
result = testPt.x >= 0 && testPt.y >= 0 && testPt.x <= w && testPt.y <= h;
|
||||
const radius = Math.min(this._radius, w / 2, h / 2);
|
||||
if (result && radius > 0) {
|
||||
let dx = 0;
|
||||
let dy = 0;
|
||||
if (testPt.x < radius) {
|
||||
dx = testPt.x - radius;
|
||||
} else if (testPt.x > w - radius) {
|
||||
dx = testPt.x - (w - radius);
|
||||
}
|
||||
if (testPt.y < radius) {
|
||||
dy = testPt.y - radius;
|
||||
} else if (testPt.y > h - radius) {
|
||||
dy = testPt.y - (h - radius);
|
||||
}
|
||||
result = dx * dx + dy * dy <= radius * radius;
|
||||
}
|
||||
} else if (this.type === MaskType.GRAPHICS_STENCIL || this.type === MaskType.SPRITE_STENCIL) {
|
||||
result = testPt.x >= 0 && testPt.y >= 0 && testPt.x <= w && testPt.y <= h;
|
||||
} else if (this.type === MaskType.GRAPHICS_ELLIPSE) {
|
||||
const rx = w / 2;
|
||||
@@ -423,7 +470,12 @@ export class Mask extends Component {
|
||||
const x = -width * ap.x;
|
||||
const y = -height * ap.y;
|
||||
if (this._type === MaskType.GRAPHICS_RECT) {
|
||||
graphics.rect(x, y, width, height);
|
||||
const radius = Math.min(this._radius, width / 2, height / 2);
|
||||
if (radius > 0) {
|
||||
graphics.roundRect(x, y, width, height, radius);
|
||||
} else {
|
||||
graphics.rect(x, y, width, height);
|
||||
}
|
||||
} else if (this._type === MaskType.GRAPHICS_ELLIPSE) {
|
||||
const center = new Vec3(x + width / 2, y + height / 2, 0);
|
||||
const radius = new Vec3(width / 2, height / 2, 0);
|
||||
|
||||
@@ -567,7 +567,7 @@ export class Sprite extends UIRenderer {
|
||||
if (this.spriteFrame && this.spriteFrame.texture instanceof RenderTexture) {
|
||||
const rtMatName = `rt-${mat.name}`;
|
||||
let rtMat = builtinResMgr.get(rtMatName) as Material | null;
|
||||
if (!rtMat) {
|
||||
if (!rtMat || !rtMat.passes.length) {
|
||||
rtMat = new Material(rtMatName);
|
||||
rtMat.copy(mat, { defines: { SAMPLE_FROM_RT: true } });
|
||||
builtinResMgr.addAsset(rtMatName, rtMat);
|
||||
|
||||
@@ -0,0 +1,636 @@
|
||||
/*
|
||||
Copyright (c) 2026
|
||||
Generic 2D mesh data consumer: the plugin feeds pre-baked vertex/index/segment
|
||||
data through setMeshData; this component owns buffer allocation, batching and
|
||||
submission through the 2D batcher, so extensions can render custom meshes
|
||||
without touching engine internals.
|
||||
|
||||
Vertices are ALWAYS node-local; UIMesh owns the node transform:
|
||||
* not batched -- on the GPU, via USE_LOCAL + the per-draw cc-local UBO the
|
||||
batcher already maintains for middleware draws;
|
||||
* batched -- the FULL world matrix baked into the chunk copy on the CPU
|
||||
(a merged batch carries no per-draw matrix), matching the GPU path, z /
|
||||
X-Y rotation included.
|
||||
USE_LOCAL / setUseLocal are derived internally; there is no world-baked
|
||||
input mode.
|
||||
|
||||
Data is FillColorType.VERTEX, so the batcher applies no cascaded opacity:
|
||||
UIMesh folds it into the copied vertices itself, accumulated as Batcher2D.walk
|
||||
does for COLOR data (own color alpha x, per ancestor, UIOpacity localOpacity x
|
||||
that ancestor's color alpha). `premultipliedAlpha` declares the data format:
|
||||
alpha-byte-only vs RGBA + dark RGB fading.
|
||||
|
||||
The batcher resets the shared index tail after every upload (vertex bytes
|
||||
survive), so indices are re-submitted EVERY frame (appendIndexBuffer) and only
|
||||
the vertex refresh is _vertexDirty-gated. A dirty-gated submission would leave
|
||||
a static mesh's draw range aliasing whichever sibling appends after the reset
|
||||
(two UIMeshes in one buffer, one paused: it would draw the other's triangles).
|
||||
*/
|
||||
|
||||
import { JSB } from 'internal:constants';
|
||||
import { ccclass, editable, serializable } from 'cc.decorator';
|
||||
import { errorID } from '../../core';
|
||||
import { Mat4 } from '../../core/math';
|
||||
import { UIRenderer } from '../framework/ui-renderer';
|
||||
import { RenderData } from '../renderer/render-data';
|
||||
import { RenderDrawInfo, RenderDrawInfoType } from '../renderer/render-draw-info';
|
||||
import { StaticVBAccessor } from '../renderer/static-vb-accessor';
|
||||
import type { Batcher2D } from '../renderer/batcher-2d';
|
||||
import { vfmtPosUvColor4B, vfmtPosUvTwoColor4B, getAttributeStride } from '../renderer/vertex-format';
|
||||
import { RenderEntity, RenderEntityType } from '../renderer/render-entity';
|
||||
import { director, DirectorEvent } from '../../game';
|
||||
import { Texture2D } from '../../asset/assets';
|
||||
import { builtinResMgr } from '../../asset/asset-manager';
|
||||
import { BlendFactor } from '../../gfx';
|
||||
import type { MeshBuffer } from '../renderer/mesh-buffer';
|
||||
import type { MaterialInstance } from '../../render-scene';
|
||||
import type { Material } from '../../asset/assets/material';
|
||||
import type { Node } from '../../scene-graph';
|
||||
|
||||
/**
|
||||
* @en A segment of the mesh: a range of indices drawn with one texture+material.
|
||||
* @zh 网格的一个片段:一段索引,用同一纹理+材质绘制。
|
||||
*/
|
||||
export interface UIMeshSegment {
|
||||
indexOffset: number;
|
||||
indexCount: number;
|
||||
texture: Texture2D | null;
|
||||
material: MaterialInstance | null;
|
||||
}
|
||||
|
||||
/**
|
||||
* @en Pre-baked mesh data for one frame.
|
||||
* @zh 一帧的预烘焙网格数据。
|
||||
* vertexStride: 24 (single-color V3F_T2F_C4B) or 28 (two-color V3F_T2F_C4B_C4B).
|
||||
*/
|
||||
export interface UIMeshData {
|
||||
vertexCount: number;
|
||||
vertexStride: number;
|
||||
vertexData: Uint8Array;
|
||||
indexCount: number;
|
||||
indexData: Uint8Array;
|
||||
segments: UIMeshSegment[];
|
||||
}
|
||||
|
||||
// Shared static vertex-buffer accessors, keyed by the current Batcher2D: it
|
||||
// destroys every accessor registered with it, so a rebuilt root must never
|
||||
// reuse a cached (destroyed) accessor, and each new one must be registered
|
||||
// with the current batcher or its buffers would never be uploaded or reset.
|
||||
let _accessorBatcher: Batcher2D | null = null;
|
||||
let _sharedAccessor: StaticVBAccessor | null = null;
|
||||
let _sharedTintAccessor: StaticVBAccessor | null = null;
|
||||
|
||||
// Registration keys in the batcher's accessor map (base-36 namespaced, the
|
||||
// same convention as the built-in middleware assemblers — spine/dragon-bones).
|
||||
const UIMESH_ACCESSOR_KEY = Number.parseInt('UIMESH', 36);
|
||||
const UIMESH_TINT_ACCESSOR_KEY = Number.parseInt('UIMESHTINT', 36);
|
||||
|
||||
// The two consumed vertex formats (24 / 28 bytes); strides derived from the
|
||||
// definitions so the byte math always matches the chunk's format.
|
||||
const MESH_STRIDE_BYTES = getAttributeStride(vfmtPosUvColor4B);
|
||||
const MESH_STRIDE_TINT_BYTES = getAttributeStride(vfmtPosUvTwoColor4B);
|
||||
|
||||
/**
|
||||
* @en A generic 2D mesh renderer that consumes pre-baked vertex/index data.
|
||||
* The data provider (e.g. a spine plugin) fills setMeshData every frame; this
|
||||
* component handles buffer allocation, batching and submission.
|
||||
* @zh 通用 2D 网格渲染器,消费预烘焙的顶点/索引数据。数据提供方(如 spine 插件)
|
||||
* 每帧调用 setMeshData,本组件负责缓冲分配、合批与提交。
|
||||
*/
|
||||
@ccclass('cc.UIMesh')
|
||||
export class UIMesh extends UIRenderer {
|
||||
@serializable
|
||||
protected _enableBatch = false;
|
||||
|
||||
/**
|
||||
* @en Whether the incoming color data is premultiplied-alpha. Declares how
|
||||
* cascaded opacity is folded into the vertices (alpha byte only vs
|
||||
* RGBA + dark RGB) and the blend factors of the builtin material.
|
||||
* @zh 输入颜色数据是否为预乘 alpha 格式。决定级联不透明度折算方式
|
||||
* (仅 alpha 字节 vs RGBA + dark RGB)及内置材质混合因子。
|
||||
*/
|
||||
@serializable
|
||||
protected _premultipliedAlpha = false;
|
||||
|
||||
protected _meshData: UIMeshData | null = null;
|
||||
protected _useTint = false;
|
||||
private _drawInfoList: RenderDrawInfo[] = [];
|
||||
|
||||
// Poll cache (see _onBeforeDraw): inputs captured by the last
|
||||
// updateVertexBuffer run; drift means the baked transform / folded opacity
|
||||
// no longer match. The full matrix is tracked — the bake applies all of it.
|
||||
private _pollOpacity = 1;
|
||||
private _pollWorldMatrix = new Mat4();
|
||||
|
||||
// Vertex-staleness latch, consumed by _onBeforeDraw to pick a full refresh
|
||||
// vs an index-only resubmit. Starts dirty so the first frame prepares.
|
||||
private _vertexDirty = true;
|
||||
|
||||
constructor () {
|
||||
super();
|
||||
this._useVertexOpacity = true;
|
||||
}
|
||||
|
||||
/**
|
||||
* @en Feeds the pre-baked mesh data for the current frame.
|
||||
* @zh 喂入当前帧的预烘焙网格数据。
|
||||
*/
|
||||
public setMeshData (data: UIMeshData): void {
|
||||
// Reject bad input at the call site; a rejected frame keeps the last
|
||||
// accepted mesh.
|
||||
if (!this._validateMeshData(data)) return;
|
||||
const useTint = data.vertexStride === MESH_STRIDE_TINT_BYTES;
|
||||
if (useTint !== this._useTint) {
|
||||
this.destroyRenderData();
|
||||
this._useTint = useTint;
|
||||
this._flushAssembler();
|
||||
// The builtin fallback material follows the stride (TWO_COLORED).
|
||||
this.updateMaterial();
|
||||
}
|
||||
this._meshData = data;
|
||||
this._vertexDirty = true;
|
||||
}
|
||||
|
||||
private _validateMeshData (data: UIMeshData): boolean {
|
||||
const vc = data.vertexCount;
|
||||
const ic = data.indexCount;
|
||||
if (data.vertexStride !== MESH_STRIDE_BYTES && data.vertexStride !== MESH_STRIDE_TINT_BYTES) {
|
||||
errorID(9010, data.vertexStride, MESH_STRIDE_BYTES, MESH_STRIDE_TINT_BYTES);
|
||||
return false;
|
||||
}
|
||||
if (vc < 0 || ic < 0) {
|
||||
errorID(9011, vc, ic);
|
||||
return false;
|
||||
}
|
||||
// Capacity limits come from the accessor that will serve the data.
|
||||
const accessor = this.ensureAccessor(data.vertexStride === MESH_STRIDE_TINT_BYTES);
|
||||
if (vc > accessor.maxVertexCount || ic > accessor.maxIndexCount) {
|
||||
errorID(9016, vc, ic, accessor.maxVertexCount, accessor.maxIndexCount);
|
||||
return false;
|
||||
}
|
||||
if (!data.vertexData || data.vertexData.byteLength < vc * data.vertexStride) {
|
||||
errorID(9012, data.vertexData ? data.vertexData.byteLength : 0, vc, data.vertexStride);
|
||||
return false;
|
||||
}
|
||||
if (!data.indexData || data.indexData.byteOffset % 2 !== 0 || data.indexData.byteLength < ic * 2) {
|
||||
errorID(
|
||||
9013,
|
||||
data.indexData ? data.indexData.byteLength : 0,
|
||||
data.indexData ? data.indexData.byteOffset : 0,
|
||||
ic,
|
||||
ic * 2,
|
||||
);
|
||||
return false;
|
||||
}
|
||||
// Indices are mesh-local; anything >= vertexCount would sample vertices
|
||||
// of other chunks in the shared buffer (silent geometry corruption).
|
||||
const indices = new Uint16Array(data.indexData.buffer, data.indexData.byteOffset, ic);
|
||||
for (let i = 0; i < ic; ++i) {
|
||||
if (indices[i] >= vc) {
|
||||
errorID(9014, i, indices[i], vc);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
for (let i = 0; i < data.segments.length; ++i) {
|
||||
const seg = data.segments[i];
|
||||
if (seg.indexOffset < 0 || seg.indexCount < 0 || seg.indexOffset + seg.indexCount > ic) {
|
||||
errorID(9015, i, seg.indexOffset, seg.indexOffset + seg.indexCount, ic);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* @en Whether to enable sprite batching.
|
||||
* @zh 是否启用合批。
|
||||
*/
|
||||
@editable
|
||||
get enableBatch (): boolean { return this._enableBatch; }
|
||||
set enableBatch (value: boolean) {
|
||||
this._enableBatch = value;
|
||||
this._syncTransformMode();
|
||||
this.updateMaterial();
|
||||
}
|
||||
|
||||
/**
|
||||
* @en Whether the input color data is premultiplied-alpha.
|
||||
* @zh 输入颜色数据是否为预乘 alpha 格式。
|
||||
*/
|
||||
@editable
|
||||
get premultipliedAlpha (): boolean { return this._premultipliedAlpha; }
|
||||
set premultipliedAlpha (value: boolean) {
|
||||
this._premultipliedAlpha = value;
|
||||
this.updateMaterial();
|
||||
this._vertexDirty = true;
|
||||
this.onPremultipliedAlphaChanged();
|
||||
}
|
||||
|
||||
/**
|
||||
* Notifies subclasses the declared format changed. The property is owned
|
||||
* here (single source of truth); producers override this to forward it to
|
||||
* their baker instead of redeclaring the field.
|
||||
*/
|
||||
protected onPremultipliedAlphaChanged (): void {}
|
||||
|
||||
public onLoad (): void {
|
||||
super.onLoad();
|
||||
// Deserialization has applied _enableBatch by now; re-derive the
|
||||
// legacy switch state.
|
||||
this._syncTransformMode();
|
||||
}
|
||||
|
||||
/**
|
||||
* useLocal == "vertices are still node-local at submit time". Batched data
|
||||
* is world-baked by updateVertexBuffer before submit, and native
|
||||
* middleware draws only merge when !useLocal — hence !enableBatch.
|
||||
*/
|
||||
private _syncTransformMode (): void {
|
||||
this._renderEntity.setUseLocal(!this._enableBatch);
|
||||
this._vertexDirty = true;
|
||||
}
|
||||
|
||||
protected _updateColor (): void {
|
||||
super._updateColor();
|
||||
// The opacity fold in updateVertexBuffer reads this._color, so a
|
||||
// change must re-prepare. Visibility (color.a 0 <-> !0) is recomputed
|
||||
// fresh by _onBeforeDraw.
|
||||
this._vertexDirty = true;
|
||||
}
|
||||
|
||||
protected _onMaterialModified (idx: number, material: Material | null): void {
|
||||
super._onMaterialModified(idx, material);
|
||||
// Draw infos cache the material reference; a swap must rebuild them.
|
||||
// The base mark only re-syncs visibility (no updateRenderer override
|
||||
// anymore), and the passDirty self-heal path needs an assembler.
|
||||
this._vertexDirty = true;
|
||||
}
|
||||
|
||||
public onEnable (): void {
|
||||
super.onEnable();
|
||||
// BEFORE_DRAW fires between the update and render phases, outside the
|
||||
// director.pause() gate — the render loop still redraws (and resets
|
||||
// shared buffers) while paused, so submission must keep running.
|
||||
if (JSB) director.on(DirectorEvent.BEFORE_DRAW, this._onBeforeDraw, this);
|
||||
}
|
||||
|
||||
public onDisable (): void {
|
||||
if (JSB) director.off(DirectorEvent.BEFORE_DRAW, this._onBeforeDraw, this);
|
||||
super.onDisable();
|
||||
}
|
||||
|
||||
/**
|
||||
* JSB per-frame driver (director BEFORE_DRAW); web is driven by fillBuffers
|
||||
* instead. Three jobs:
|
||||
* * poll — transforms / UIOpacity never mark a middleware renderer, so
|
||||
* compare the live values against the last updateVertexBuffer capture;
|
||||
* * visibility — recomputed fresh (the base class' synchronous
|
||||
* _updateColor recompute is assembler-gated, dead here); an invisible
|
||||
* mesh submits nothing and its draw infos are cleared;
|
||||
* * data — full refresh when the latch is set or the mesh just became
|
||||
* visible again, else the frame-scoped appendIndexBuffer only.
|
||||
*/
|
||||
private _onBeforeDraw (): void {
|
||||
if (!JSB || !this._renderData || !this._meshData) return;
|
||||
if (this._enableBatch && !this.node.worldMatrix.strictEquals(this._pollWorldMatrix)) {
|
||||
this._vertexDirty = true;
|
||||
}
|
||||
if (this._computeCascadedOpacity() !== this._pollOpacity) {
|
||||
this._vertexDirty = true;
|
||||
}
|
||||
const wasRenderable = this._renderFlag;
|
||||
const canRender = this._canRender();
|
||||
this._renderFlag = canRender;
|
||||
this._renderEntity.enabled = canRender;
|
||||
if (!canRender) {
|
||||
if (wasRenderable) this._renderEntity.clearDynamicRenderDrawInfos();
|
||||
return;
|
||||
}
|
||||
if (this._vertexDirty || !wasRenderable) {
|
||||
this._prepareNativeDrawInfos();
|
||||
this._vertexDirty = false;
|
||||
} else {
|
||||
this.appendIndexBuffer();
|
||||
}
|
||||
}
|
||||
|
||||
protected _flushAssembler (): void {
|
||||
if (this._renderData === null) {
|
||||
const accessor = this.ensureAccessor(this._useTint);
|
||||
this._renderData = RenderData.add(this._useTint ? vfmtPosUvTwoColor4B : vfmtPosUvColor4B, accessor);
|
||||
}
|
||||
}
|
||||
|
||||
protected _render (batcher: any): void {
|
||||
const prepared = this._prepareBuffers();
|
||||
if (!prepared || !this._meshData) return;
|
||||
const { meshBuffer, startIndex } = prepared;
|
||||
const data = this._meshData;
|
||||
|
||||
// Segments without their own material fall back to the component
|
||||
// material (the builtin spine effect).
|
||||
for (const seg of data.segments) {
|
||||
const mat = seg.material || this.getRenderMaterial(0);
|
||||
if (seg.texture && mat) {
|
||||
batcher.commitMiddleware(
|
||||
this,
|
||||
meshBuffer,
|
||||
startIndex + seg.indexOffset,
|
||||
seg.indexCount,
|
||||
seg.texture,
|
||||
mat,
|
||||
this._enableBatch,
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private _prepareBuffers (): { meshBuffer: MeshBuffer, startIndex: number } | null {
|
||||
// Full refresh: the dirty-gated vertex half + the frame-scoped index
|
||||
// half. Shared by the web walk (_render) and _prepareNativeDrawInfos.
|
||||
if (!this.updateVertexBuffer()) return null;
|
||||
return this.appendIndexBuffer();
|
||||
}
|
||||
|
||||
/**
|
||||
* Vertex half of a refresh: grow the chunk, copy this frame's bytes, bake
|
||||
* the world matrix when batching, fold cascaded opacity, capture the poll
|
||||
* inputs. The expensive half — callers gate it (native: dirty only; web:
|
||||
* every frame). Returns whether the chunk holds this frame's vertices.
|
||||
*/
|
||||
protected updateVertexBuffer (): boolean {
|
||||
if (!this._renderData || !this._meshData) return false;
|
||||
const data = this._meshData;
|
||||
const rd = this._renderData;
|
||||
const vc = data.vertexCount;
|
||||
const ic = data.indexCount;
|
||||
if (vc < 1 || ic < 1) return false;
|
||||
const vLength = vc * data.vertexStride;
|
||||
|
||||
// ~10% head room, clamped to the accessor's per-chunk caps — an
|
||||
// unclamped reserve would permanently fail data that fits (30000 ->
|
||||
// 33000 requested > 32767). Per-frame counts live on the render data;
|
||||
// the reserve lives on the chunk.
|
||||
if (!rd.chunk || rd.chunk.vb.byteLength < vLength || rd.chunk.indexCount < ic) {
|
||||
rd.resize(
|
||||
Math.min(Math.ceil(vc * 1.1), rd.accessor.maxVertexCount),
|
||||
Math.min(Math.ceil(ic * 1.1), rd.accessor.maxIndexCount),
|
||||
);
|
||||
if (!rd.chunk) {
|
||||
errorID(9017, vc, ic, rd.accessor.maxVertexCount, rd.accessor.maxIndexCount);
|
||||
return false;
|
||||
}
|
||||
rd.updateSize(vc, ic);
|
||||
} else if (rd.vertexCount !== vc || rd.indexCount !== ic) {
|
||||
rd.updateSize(vc, ic);
|
||||
}
|
||||
if (!rd.chunk) return false;
|
||||
// Copy into the chunk's view of the shared vData.
|
||||
const vbuf = rd.chunk.vb;
|
||||
const vU8 = new Uint8Array(vbuf.buffer, vbuf.byteOffset, vLength);
|
||||
vU8.set(data.vertexData.subarray(0, vLength));
|
||||
|
||||
// Batched: a merged batch carries no per-draw matrix, so bake the
|
||||
// world transform into the chunk copy (the incoming vertexData may be
|
||||
// a worker-shared view — never touch it).
|
||||
if (this._enableBatch) {
|
||||
this._bakeWorldTransform(vbuf, vLength, data.vertexStride);
|
||||
}
|
||||
|
||||
// Cascaded opacity: VERTEX-type data gets no engine-side fade, UIMesh
|
||||
// applies it while copying (see the opacity contract in the header).
|
||||
const opacity = this._computeCascadedOpacity();
|
||||
if (opacity < 0.9999) {
|
||||
this._applyOpacity(vU8, vc, data.vertexStride, opacity);
|
||||
}
|
||||
|
||||
// Capture the poll inputs (compared in _onBeforeDraw).
|
||||
this._pollOpacity = opacity;
|
||||
if (this._enableBatch) {
|
||||
this._pollWorldMatrix.set(this.node.worldMatrix);
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Index half: offset by the chunk's vertexOffset, append into the shared
|
||||
* index buffer, refresh the draw-info offsets. Must run EVERY frame for
|
||||
* every participating mesh — the batcher resets the index tail after each
|
||||
* upload while draw infos keep absolute offsets, so a mesh that skipped
|
||||
* would alias whichever sibling appends first (see the header contract).
|
||||
* Runs exactly once per frame (native pump / web fillBuffers);
|
||||
* commitMiddleware reads meshBuffer.iData.
|
||||
*/
|
||||
protected appendIndexBuffer (): { meshBuffer: MeshBuffer, startIndex: number } | null {
|
||||
const data = this._meshData;
|
||||
const rd = this._renderData;
|
||||
if (!rd || !rd.chunk || !data || data.vertexCount < 1 || data.indexCount < 1) {
|
||||
return null;
|
||||
}
|
||||
const meshBuffer = rd.getMeshBuffer()!;
|
||||
// The native batcher resets indexOffset through shared memory after
|
||||
// uploading — sync the JS-side cache before appending.
|
||||
if (JSB) meshBuffer.indexOffset = meshBuffer.sharedBuffer[2];
|
||||
const startIndex = meshBuffer.indexOffset;
|
||||
const ic = data.indexCount;
|
||||
const chunkOffset = rd.chunk.vertexOffset;
|
||||
const offsetIndices = new Uint16Array(ic);
|
||||
new Uint8Array(offsetIndices.buffer).set(data.indexData.subarray(0, ic * 2));
|
||||
for (let i = 0; i < ic; i++) offsetIndices[i] += chunkOffset;
|
||||
rd.chunk.vertexAccessor.appendIndices(rd.chunk.bufferId, offsetIndices);
|
||||
rd.chunk.vertexAccessor.getMeshBuffer(rd.chunk.bufferId).setDirty();
|
||||
|
||||
// Static frames never re-run _prepareNativeDrawInfos — keep the cached
|
||||
// draw infos' offsets in step (segment mapping mirrors it).
|
||||
this._refreshDrawInfoOffsets(startIndex);
|
||||
return { meshBuffer, startIndex };
|
||||
}
|
||||
|
||||
private _refreshDrawInfoOffsets (startIndex: number): void {
|
||||
const data = this._meshData;
|
||||
if (!data || this._drawInfoList.length === 0) return;
|
||||
let drawIndex = 0;
|
||||
for (const seg of data.segments) {
|
||||
const mat = seg.material || this.getRenderMaterial(0);
|
||||
if (!seg.texture || !mat) continue;
|
||||
const drawInfo = this._drawInfoList[drawIndex++];
|
||||
if (drawInfo) drawInfo.setIndexOffset(startIndex + seg.indexOffset);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Bakes the FULL world matrix into the chunk copy's positions — exactly
|
||||
* what the USE_LOCAL GPU path applies (pos = cc_matWorld * pos), z and
|
||||
* X/Y-rotation included, so batched and unbatched renders agree. Identity
|
||||
* is skipped.
|
||||
*/
|
||||
private _bakeWorldTransform (vbuf: Float32Array, byteLength: number, stride: number): void {
|
||||
const m = this.node.worldMatrix;
|
||||
const m00 = m.m00; const m01 = m.m01; const m02 = m.m02;
|
||||
const m04 = m.m04; const m05 = m.m05; const m06 = m.m06;
|
||||
const m08 = m.m08; const m09 = m.m09; const m10 = m.m10;
|
||||
const m12 = m.m12; const m13 = m.m13; const m14 = m.m14;
|
||||
if (m00 === 1 && m01 === 0 && m02 === 0
|
||||
&& m04 === 0 && m05 === 1 && m06 === 0
|
||||
&& m08 === 0 && m09 === 0 && m10 === 1
|
||||
&& m12 === 0 && m13 === 0 && m14 === 0) return;
|
||||
const floats = new Float32Array(vbuf.buffer, vbuf.byteOffset, byteLength >> 2);
|
||||
const strideF = stride >> 2;
|
||||
const vertexCount = byteLength / stride;
|
||||
for (let i = 0; i < vertexCount; i++) {
|
||||
const o = i * strideF;
|
||||
const x = floats[o];
|
||||
const y = floats[o + 1];
|
||||
const z = floats[o + 2];
|
||||
floats[o] = m00 * x + m04 * y + m08 * z + m12;
|
||||
floats[o + 1] = m01 * x + m05 * y + m09 * z + m13;
|
||||
floats[o + 2] = m02 * x + m06 * y + m10 * z + m14;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Cascaded opacity as Batcher2D.walk accumulates it for COLOR data: own
|
||||
* color alpha x, per ancestor, localOpacity x that ancestor's color alpha.
|
||||
*/
|
||||
private _computeCascadedOpacity (): number {
|
||||
let opacity = this._color.a / 255;
|
||||
for (let node: Node | null = this.node; node; node = node.parent) {
|
||||
opacity *= node._uiProps.localOpacity;
|
||||
if (node !== this.node) {
|
||||
const ancestor = node._uiProps.uiComp as UIRenderer | null;
|
||||
if (ancestor && ancestor.color) opacity *= ancestor.color.a / 255;
|
||||
}
|
||||
}
|
||||
return opacity;
|
||||
}
|
||||
|
||||
/**
|
||||
* Folds opacity into the copied vertices. Light color sits at bytes
|
||||
* 20..23 (pos*3f + uv*2f), dark at 24..27 for two-color. Straight data
|
||||
* fades via the alpha byte only; PMA data scales light RGBA + dark RGB
|
||||
* (dark alpha is the sentinel, not a fade channel).
|
||||
*/
|
||||
private _applyOpacity (vU8: Uint8Array, vc: number, stride: number, opacity: number): void {
|
||||
const pma = this._premultipliedAlpha;
|
||||
const darkRGB = (pma && stride === MESH_STRIDE_TINT_BYTES) ? 3 : 0;
|
||||
for (let i = 0; i < vc; i++) {
|
||||
const o = i * stride + 20;
|
||||
if (pma) {
|
||||
vU8[o] = (vU8[o] * opacity + 0.5) | 0;
|
||||
vU8[o + 1] = (vU8[o + 1] * opacity + 0.5) | 0;
|
||||
vU8[o + 2] = (vU8[o + 2] * opacity + 0.5) | 0;
|
||||
}
|
||||
vU8[o + 3] = (vU8[o + 3] * opacity + 0.5) | 0;
|
||||
for (let j = 0; j < darkRGB; j++) {
|
||||
vU8[o + 4 + j] = (vU8[o + 4 + j] * opacity + 0.5) | 0;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private _prepareNativeDrawInfos (): void {
|
||||
this._renderEntity.clearDynamicRenderDrawInfos();
|
||||
// Vertex refresh + this frame's index submission; a null return means
|
||||
// there is nothing drawable this frame.
|
||||
const prepared = this._prepareBuffers();
|
||||
const data = this._meshData;
|
||||
const rd = this._renderData;
|
||||
if (!prepared || !data || !rd?.chunk) return;
|
||||
|
||||
const { startIndex } = prepared;
|
||||
let drawIndex = 0;
|
||||
for (const seg of data.segments) {
|
||||
const mat = seg.material || this.getRenderMaterial(0);
|
||||
if (!seg.texture || !mat) continue;
|
||||
let drawInfo = this._drawInfoList[drawIndex];
|
||||
if (!drawInfo) {
|
||||
drawInfo = new RenderDrawInfo();
|
||||
drawInfo.setDrawInfoType(RenderDrawInfoType.MIDDLEWARE);
|
||||
this._drawInfoList[drawIndex] = drawInfo;
|
||||
}
|
||||
drawInfo.setAccAndBuffer(rd.accessor.id, rd.chunk.bufferId);
|
||||
drawInfo.setIndexOffset(startIndex + seg.indexOffset);
|
||||
drawInfo.setIBCount(seg.indexCount);
|
||||
drawInfo.setTexture(seg.texture.getGFXTexture());
|
||||
drawInfo.setSampler(seg.texture.getGFXSampler());
|
||||
drawInfo.setMaterial(mat);
|
||||
this._renderEntity.setDynamicRenderDrawInfo(drawInfo, drawIndex);
|
||||
drawIndex++;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* The spine effect (default-spine-material): ui-sprite-material has no
|
||||
* USE_LOCAL variant — node-local input through it would render stuck at
|
||||
* the origin.
|
||||
*/
|
||||
protected _updateBuiltinMaterial (): Material {
|
||||
return builtinResMgr.get<Material>('default-spine-material');
|
||||
}
|
||||
|
||||
/**
|
||||
* Keeps the builtin material instance in step with the declared vertex
|
||||
* space / data format: USE_LOCAL for the GPU take-over mode, TWO_COLORED
|
||||
* for two-color data, and blend factors matching the alpha format.
|
||||
*/
|
||||
public updateMaterial (): void {
|
||||
// Align the legacy blend-factor fields first so _updateBlendFunc
|
||||
// (inside super) never fights the explicit patching below.
|
||||
this._srcBlendFactor = this._premultipliedAlpha ? BlendFactor.ONE : BlendFactor.SRC_ALPHA;
|
||||
this._dstBlendFactor = BlendFactor.ONE_MINUS_SRC_ALPHA;
|
||||
super.updateMaterial();
|
||||
if (this._customMaterial) return; // custom materials are the user's contract
|
||||
const inst = this.getMaterialInstance(0);
|
||||
if (!inst) return;
|
||||
inst.recompileShaders({
|
||||
USE_LOCAL: !this._enableBatch,
|
||||
TWO_COLORED: this._useTint,
|
||||
});
|
||||
// Straight data: src_alpha / 1-src_alpha (the effect default);
|
||||
// premultiplied data: ONE / 1-src_alpha, color and alpha channels.
|
||||
const src = this._premultipliedAlpha ? BlendFactor.ONE : BlendFactor.SRC_ALPHA;
|
||||
const pass = inst.passes[0];
|
||||
const target = pass.blendState.targets[0];
|
||||
target.blend = true;
|
||||
target.blendSrc = src;
|
||||
target.blendSrcAlpha = src;
|
||||
target.blendDst = BlendFactor.ONE_MINUS_SRC_ALPHA;
|
||||
target.blendDstAlpha = BlendFactor.ONE_MINUS_SRC_ALPHA;
|
||||
pass.blendState.setTarget(0, target);
|
||||
pass._updatePassHash();
|
||||
}
|
||||
|
||||
protected createRenderEntity (): RenderEntity {
|
||||
const entity = new RenderEntity(RenderEntityType.DYNAMIC);
|
||||
// useLocal is re-derived in _syncTransformMode once deserialization
|
||||
// has run.
|
||||
entity.setUseLocal(!this._enableBatch);
|
||||
return entity;
|
||||
}
|
||||
|
||||
private ensureAccessor (useTint: boolean): StaticVBAccessor {
|
||||
const batcher = director.root!.batcher2D;
|
||||
// The previous batcher destroyed its accessors — invalidate the cache.
|
||||
if (_accessorBatcher !== batcher) {
|
||||
_accessorBatcher = batcher;
|
||||
_sharedAccessor = null;
|
||||
_sharedTintAccessor = null;
|
||||
}
|
||||
let accessor = useTint ? _sharedTintAccessor : _sharedAccessor;
|
||||
if (!accessor) {
|
||||
const device = director.root!.device;
|
||||
// Copy the format: the accessor empties its attributes array on
|
||||
// destroy, and the vfmt* constants are shared module-level state.
|
||||
const attributes = (useTint ? vfmtPosUvTwoColor4B : vfmtPosUvColor4B).slice();
|
||||
// 32767: the spine middleware assembler's per-chunk cap
|
||||
// (cocos/spine/assembler/simple.ts), half the Uint16 index space.
|
||||
accessor = new StaticVBAccessor(device, attributes, 32767);
|
||||
batcher.registerBufferAccessor(useTint ? UIMESH_TINT_ACCESSOR_KEY : UIMESH_ACCESSOR_KEY, accessor);
|
||||
if (useTint) {
|
||||
_sharedTintAccessor = accessor;
|
||||
} else {
|
||||
_sharedAccessor = accessor;
|
||||
}
|
||||
}
|
||||
return accessor;
|
||||
}
|
||||
}
|
||||
@@ -29,7 +29,7 @@ import { EDITOR_NOT_IN_PREVIEW } from 'internal:constants';
|
||||
import { Camera, CameraEvent } from '../../misc/camera-component';
|
||||
import { Widget } from '../../ui/widget';
|
||||
import { Vec3, screen, Enum, cclegacy, visibleRect } from '../../core';
|
||||
import { view } from '../../ui/view';
|
||||
import { toUISpace, view } from '../../ui/view';
|
||||
import { RenderRoot2D } from './render-root-2d';
|
||||
|
||||
const _worldPos = new Vec3();
|
||||
@@ -226,7 +226,7 @@ export class Canvas extends RenderRoot2D {
|
||||
this._cameraComponent.orthoHeight = visibleRect.height / 2;
|
||||
} else {
|
||||
const size = screen.windowSize;
|
||||
this._cameraComponent.orthoHeight = size.height / view.getScaleY() / 2;
|
||||
this._cameraComponent.orthoHeight = toUISpace(size.height, view.getRatioY()) / 2;
|
||||
}
|
||||
|
||||
this.node.getWorldPosition(_worldPos);
|
||||
|
||||
@@ -398,12 +398,23 @@ export class UIRenderer extends Renderer {
|
||||
this.node.off(NodeEventType.ANCHOR_CHANGED, this._nodeStateChange, this);
|
||||
this.node.off(NodeEventType.SIZE_CHANGED, this._nodeStateChange, this);
|
||||
this.node.off(NodeEventType.PARENT_CHANGED, this._colorDirty, this);
|
||||
this.destroyRenderData();
|
||||
if (!this._keepRenderData) {
|
||||
this.destroyRenderData();
|
||||
}
|
||||
uiRendererManager.removeRenderer(this);
|
||||
this._renderFlag = false;
|
||||
this._renderEntity.enabled = false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether to keep render data when the component leaves the active hierarchy.
|
||||
* Retained-mode renderers may override this policy and keep their render data until
|
||||
* the content is explicitly cleared or the component is destroyed.
|
||||
*/
|
||||
protected get _keepRenderData (): boolean {
|
||||
return false;
|
||||
}
|
||||
|
||||
public onDestroy (): void {
|
||||
this._renderEntity.setNode(null);
|
||||
if (this.node._uiProps.uiComp === this) {
|
||||
@@ -536,7 +547,7 @@ export class UIRenderer extends Renderer {
|
||||
const mat = this._updateBuiltinMaterial();
|
||||
this.setSharedMaterial(mat, 0);
|
||||
if (this.stencilStage === Stage.ENTER_LEVEL || this.stencilStage === Stage.ENTER_LEVEL_INVERTED) {
|
||||
this.getMaterialInstance(0)!.recompileShaders({ USE_ALPHA_TEST: true });
|
||||
this.getMaterialInstance(0)?.recompileShaders({ USE_ALPHA_TEST: true });
|
||||
}
|
||||
this._updateBlendFunc();
|
||||
}
|
||||
@@ -600,16 +611,24 @@ export class UIRenderer extends Renderer {
|
||||
*/
|
||||
public _updateBlendFunc (): void {
|
||||
// todo: Not only Pass[0].target[0]
|
||||
let target = this.getRenderMaterial(0)!.passes[0].blendState.targets[0];
|
||||
const renderMat = this.getRenderMaterial(0);
|
||||
if (!renderMat || !renderMat.passes[0]) {
|
||||
return;
|
||||
}
|
||||
let target = renderMat.passes[0].blendState.targets[0];
|
||||
this._dstBlendFactorCache = target.blendDst;
|
||||
this._srcBlendFactorCache = target.blendSrc;
|
||||
if (this._dstBlendFactorCache !== this._dstBlendFactor || this._srcBlendFactorCache !== this._srcBlendFactor) {
|
||||
target = this.getMaterialInstance(0)!.passes[0].blendState.targets[0];
|
||||
const matInstance = this.getMaterialInstance(0);
|
||||
if (!matInstance || !matInstance.passes[0]) {
|
||||
return;
|
||||
}
|
||||
target = matInstance.passes[0].blendState.targets[0];
|
||||
target.blend = true;
|
||||
target.blendDstAlpha = BlendFactor.ONE_MINUS_SRC_ALPHA;
|
||||
target.blendDst = this._dstBlendFactor;
|
||||
target.blendSrc = this._srcBlendFactor;
|
||||
const targetPass = this.getMaterialInstance(0)!.passes[0];
|
||||
const targetPass = matInstance.passes[0];
|
||||
targetPass.blendState.setTarget(0, target);
|
||||
targetPass._updatePassHash();
|
||||
this._dstBlendFactorCache = this._dstBlendFactor;
|
||||
|
||||
@@ -23,7 +23,7 @@
|
||||
*/
|
||||
|
||||
import { JSB } from 'internal:constants';
|
||||
import { Device, BufferUsageBit, MemoryUsageBit, Attribute, Buffer, BufferInfo, InputAssembler, InputAssemblerInfo, Feature, API } from '../../gfx';
|
||||
import { Device, BufferUsageBit, MemoryUsageBit, Attribute, Buffer, BufferInfo, InputAssembler, InputAssemblerInfo, Feature } from '../../gfx';
|
||||
import { getAttributeStride } from './vertex-format';
|
||||
import { sys, getError, warnID, assertIsTrue } from '../../core';
|
||||
import { NativeUIMeshBuffer } from './native-2d';
|
||||
@@ -251,11 +251,10 @@ export class MeshBuffer {
|
||||
|
||||
this.floatsPerVertex = getAttributeStride(attrs) >> 2;
|
||||
|
||||
var vDataCountLimit = 65536; // 2^16 - 1
|
||||
const glApi = device.gfxAPI;
|
||||
if (glApi === API.WEBGPU || glApi === API.WEBGL2 || glApi === API.WEBGL && device.hasFeature(Feature.ELEMENT_INDEX_UINT)) {
|
||||
vDataCountLimit = 4294967295; // 2^32 - 1
|
||||
}
|
||||
// Use the GPU's actual reported capability to determine max addressable vertex count.
|
||||
// Feature.ELEMENT_INDEX_UINT is set to true in: WebGL2, WebGPU, Vulkan, Metal, GLES3, GLES2+ext.
|
||||
// vDataCountLimit is a vertex COUNT limit (max index value + 1), not the max index value itself.
|
||||
const vDataCountLimit = device.hasFeature(Feature.ELEMENT_INDEX_UINT) ? 4294967296 : 65536; // Uint32 or Uint16 can address 2^32 or 2^16 vertices (indices 0–2^32-1 or 0–2^16-1)
|
||||
assertIsTrue(this._initVDataCount / this._floatsPerVertex < vDataCountLimit, getError(9005));
|
||||
|
||||
if (!this.vData || !this.iData) {
|
||||
@@ -396,24 +395,59 @@ export class MeshBuffer {
|
||||
}
|
||||
const byteCount = this.byteOffset;
|
||||
const indexCount = this.indexOffset;
|
||||
const indexBytes = indexCount * 2;
|
||||
let allUploaded = true;
|
||||
for (let i = 0; i < submitCount; ++i) {
|
||||
const iaRef = this._iaPool[i];
|
||||
|
||||
const verticesData = new Float32Array(this.vData.buffer, 0, byteCount >> 2);
|
||||
let verticesData = new Float32Array(this.vData.buffer, 0, byteCount >> 2);
|
||||
const indicesData = new Uint16Array(this.iData.buffer, 0, indexCount);
|
||||
|
||||
let requiredVertexBytes = byteCount;
|
||||
const vertexBuffer = iaRef.vertexBuffers[0];
|
||||
if (byteCount > vertexBuffer.size) {
|
||||
vertexBuffer.resize(byteCount);
|
||||
if (byteCount > vertexBuffer.size && indexCount > 0) {
|
||||
let maxVertex = 0;
|
||||
for (let j = 0; j < indexCount; ++j) {
|
||||
if (indicesData[j] > maxVertex) {
|
||||
maxVertex = indicesData[j];
|
||||
}
|
||||
}
|
||||
const actualByteCount = (maxVertex + 1) * this._vertexFormatBytes;
|
||||
if (actualByteCount < byteCount) {
|
||||
requiredVertexBytes = actualByteCount;
|
||||
if (actualByteCount > vertexBuffer.size) {
|
||||
vertexBuffer.resize(actualByteCount);
|
||||
}
|
||||
verticesData = new Float32Array(this.vData.buffer, 0, actualByteCount >> 2);
|
||||
}
|
||||
}
|
||||
}
|
||||
vertexBuffer.update(verticesData);
|
||||
|
||||
if (indexCount * 2 > iaRef.indexBuffer.size) {
|
||||
iaRef.indexBuffer.resize(indexCount * 2);
|
||||
const indexBuffer = iaRef.indexBuffer;
|
||||
if (indexBytes > indexBuffer.size) {
|
||||
indexBuffer.resize(indexBytes);
|
||||
}
|
||||
iaRef.indexBuffer.update(indicesData);
|
||||
|
||||
if (vertexBuffer.size < requiredVertexBytes || indexBuffer.size < indexBytes) {
|
||||
allUploaded = false;
|
||||
if (iOS14) {
|
||||
iaRef.ia.indexCount = 0;
|
||||
} else {
|
||||
for (let k = 0; k < this._nextFreeIAHandle; ++k) {
|
||||
this._iaPool[k].ia.indexCount = 0;
|
||||
}
|
||||
}
|
||||
continue;
|
||||
}
|
||||
|
||||
vertexBuffer.update(verticesData);
|
||||
indexBuffer.update(indicesData);
|
||||
}
|
||||
if (allUploaded) {
|
||||
this.dirty = false;
|
||||
}
|
||||
this.dirty = false;
|
||||
}
|
||||
|
||||
private createNewIA (device: Device): IIARef {
|
||||
|
||||
@@ -634,7 +634,7 @@ export class MeshRenderData extends BaseRenderData {
|
||||
const newVBytes = this._byteLength + vertexCount * this.stride;
|
||||
const newICount = this.indexCount + indexCount;
|
||||
|
||||
if (vertexCount + this.vertexCount > 65535) {
|
||||
if (vertexCount + this.vertexCount > 65536) { // Uint16 can address 65536 vertices (indices 0–65535)
|
||||
return false;
|
||||
}
|
||||
|
||||
@@ -697,13 +697,13 @@ export class MeshRenderData extends BaseRenderData {
|
||||
if (this._byteLength > vertexBuffer.size) {
|
||||
vertexBuffer.resize(this._byteLength);
|
||||
}
|
||||
vertexBuffer.update(verticesData);
|
||||
vertexBuffer.update(verticesData.buffer as ArrayBuffer, this._byteLength);
|
||||
|
||||
const indexBytes = indexCount << 1;
|
||||
if (indexBytes > this._indexBuffer.size) {
|
||||
this._indexBuffer.resize(indexBytes);
|
||||
}
|
||||
this._indexBuffer.update(indicesData);
|
||||
this._indexBuffer.update(indicesData.buffer as ArrayBuffer, indexBytes);
|
||||
}
|
||||
|
||||
public freeIAPool (): void {
|
||||
@@ -735,6 +735,10 @@ export class MeshRenderData extends BaseRenderData {
|
||||
this._vertexBuffers[0].destroy();
|
||||
this._vertexBuffers = [];
|
||||
}
|
||||
if (this._indexBuffer) {
|
||||
this._indexBuffer.destroy();
|
||||
this._indexBuffer = null!;
|
||||
}
|
||||
this._iaInfo = null!;
|
||||
this.vData = new Float32Array(256 * this.stride);
|
||||
this.iData = new Uint16Array(256 * 6);
|
||||
|
||||
@@ -85,6 +85,12 @@ export class StaticVBAccessor extends BufferAccessor {
|
||||
private _id = 0;
|
||||
get id (): number { return this._id; }
|
||||
|
||||
/** Per-chunk capacity; allocateChunk refuses requests above these. */
|
||||
get maxVertexCount (): number { return this._vCount; }
|
||||
|
||||
/** Per-chunk index capacity; allocateChunk refuses requests above these. */
|
||||
get maxIndexCount (): number { return this._iCount; }
|
||||
|
||||
public constructor (device: Device, attributes: Attribute[], vCount?: number, iCount?: number) {
|
||||
super(device, attributes);
|
||||
this._vCount = vCount || Math.floor(macro.BATCHER2D_MEM_INCREMENT * 1024 / this._vertexFormatBytes);
|
||||
@@ -165,6 +171,10 @@ export class StaticVBAccessor extends BufferAccessor {
|
||||
errorID(9004, byteLength);
|
||||
return null;
|
||||
}
|
||||
if (vertexCount > 65536) { // Vertex count must less than 65536 for index is uint16 (0 to 65535)
|
||||
errorID(9004, byteLength);
|
||||
return null;
|
||||
}
|
||||
let buf: MeshBuffer = null!;
|
||||
let freeList: IFreeEntry[];
|
||||
let bid = 0;
|
||||
@@ -176,9 +186,11 @@ export class StaticVBAccessor extends BufferAccessor {
|
||||
freeList = this._freeLists[i];
|
||||
// Loop entries
|
||||
for (let e = 0; e < freeList.length; ++e) {
|
||||
const freeEntry = freeList[e];
|
||||
const vertexOffset: number = freeEntry.offset / this.vertexFormatBytes;
|
||||
// Found suitable free entry
|
||||
if (freeList[e].length >= byteLength) {
|
||||
entry = freeList[e];
|
||||
if (freeEntry.length >= byteLength && vertexOffset + (vertexCount - 1) <= 65535) {
|
||||
entry = freeEntry;
|
||||
bid = i;
|
||||
eid = e;
|
||||
break;
|
||||
|
||||
@@ -0,0 +1,71 @@
|
||||
/*
|
||||
Copyright (c) 2026 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.
|
||||
*/
|
||||
|
||||
/** A CSS family expression, distinct from an asset's raw font name. */
|
||||
export type CssFontFamily = string & { readonly __cssFontFamily: unique symbol };
|
||||
|
||||
export const DEFAULT_FONT_FAMILY = 'Arial' as CssFontFamily;
|
||||
|
||||
/** Serialize one raw family name as a CSS string, preserving literal quotes and commas. */
|
||||
export function quoteFontFamily (name: string): CssFontFamily {
|
||||
let result = '"';
|
||||
for (const character of name) {
|
||||
const code = character.codePointAt(0)!;
|
||||
if (code === 0 || (code >= 0xD800 && code <= 0xDFFF)) {
|
||||
result += '\uFFFD';
|
||||
} else if (code <= 0x1F || code === 0x7F) {
|
||||
result += `\\${code.toString(16)} `;
|
||||
} else if (character === '"' || character === '\\') {
|
||||
result += `\\${character}`;
|
||||
} else {
|
||||
result += character;
|
||||
}
|
||||
}
|
||||
return `${result}"` as CssFontFamily;
|
||||
}
|
||||
|
||||
/** A simple generated alias is already a CSS identifier and cannot be a reserved family keyword. */
|
||||
export function serializeFontFamily (name: string): CssFontFamily {
|
||||
// Some Canvas implementations only recognize the bare alias registered by the font loader.
|
||||
return /^[A-Za-z_][A-Za-z0-9_-]*_LABEL$/.test(name) ? name as CssFontFamily : quoteFontFamily(name);
|
||||
}
|
||||
|
||||
interface FontFamilySource {
|
||||
readonly useSystemFont: boolean;
|
||||
readonly fontFamily: string;
|
||||
readonly font: { readonly _nativeAsset: unknown } | null;
|
||||
}
|
||||
|
||||
/** Resolve at the component boundary, before measurement, drawing or CSS assignment. */
|
||||
export function getCanvasFontFamily (source: FontFamilySource): CssFontFamily {
|
||||
const system = source.useSystemFont;
|
||||
const value = system ? source.fontFamily : source.font?._nativeAsset;
|
||||
const name = typeof value === 'string' && value ? value : DEFAULT_FONT_FAMILY;
|
||||
return system ? name as CssFontFamily : serializeFontFamily(name);
|
||||
}
|
||||
|
||||
/** Family is already serialized: changing size or style must never quote it again. */
|
||||
export function buildFontDesc (size: number, family: CssFontFamily, bold = false, italic = false): string {
|
||||
return `${italic ? 'italic ' : ''}${bold ? 'bold ' : ''}${size}px ${family}`;
|
||||
}
|
||||
@@ -23,7 +23,7 @@
|
||||
*/
|
||||
|
||||
import { warnID } from '../../core';
|
||||
import { safeMeasureText } from './text-utils';
|
||||
import { buildFontDesc, serializeFontFamily } from './font-family';
|
||||
import downloader from '../../asset/asset-manager/downloader';
|
||||
import factory from '../../asset/asset-manager/factory';
|
||||
import { TTFFont } from '../assets/ttf-font';
|
||||
@@ -31,10 +31,13 @@ import { ccwindow } from '../../core/global-exports';
|
||||
|
||||
const ccdocument = ccwindow.document;
|
||||
|
||||
type FontCallback = (err: Error | null, family?: string) => void;
|
||||
|
||||
interface IFontLoadHandle {
|
||||
fontFamilyName: string;
|
||||
fontDesc: string;
|
||||
refWidth: number;
|
||||
onComplete: ((err: Error | null, data?: any | null) => void);
|
||||
onComplete: FontCallback;
|
||||
startTime: number;
|
||||
}
|
||||
|
||||
@@ -90,9 +93,9 @@ function checkFontLoaded (): void {
|
||||
}
|
||||
|
||||
const oldWidth = fontLoadHandle.refWidth;
|
||||
const fontDesc = `40px ${fontFamily}`;
|
||||
_canvasContext!.font = fontDesc;
|
||||
const newWidth = safeMeasureText(_canvasContext!, _testString, fontDesc);
|
||||
_canvasContext!.font = fontLoadHandle.fontDesc;
|
||||
// Font availability changes while loading; do not cache fallback-font metrics.
|
||||
const newWidth = _canvasContext!.measureText(_testString).width;
|
||||
// loaded successfully
|
||||
if (oldWidth !== newWidth) {
|
||||
_loadingFonts.splice(i, 1);
|
||||
@@ -109,7 +112,7 @@ function checkFontLoaded (): void {
|
||||
}
|
||||
|
||||
// refer to https://github.com/typekit/webfontloader/blob/master/src/core/nativefontwatchrunner.js
|
||||
function nativeCheckFontLoaded (start: number, font: string, callback: ((err: Error | null, data?: any | null) => void)): void {
|
||||
function nativeCheckFontLoaded (start: number, font: string, fontDesc: string, callback: FontCallback): void {
|
||||
const loader = new Promise<void>((resolve, reject) => {
|
||||
const check = (): void => {
|
||||
const now = Date.now();
|
||||
@@ -117,7 +120,7 @@ function nativeCheckFontLoaded (start: number, font: string, callback: ((err: Er
|
||||
if (now - start >= _timeout) {
|
||||
reject();
|
||||
} else {
|
||||
(ccdocument as any).fonts.load(`40px ${font}`).then((fonts) => {
|
||||
(ccdocument as any).fonts.load(fontDesc).then((fonts) => {
|
||||
if (fonts.length >= 1) {
|
||||
resolve();
|
||||
} else {
|
||||
@@ -150,7 +153,7 @@ function nativeCheckFontLoaded (start: number, font: string, callback: ((err: Er
|
||||
});
|
||||
}
|
||||
|
||||
export function loadFont (url: string, options: Record<string, any>, onComplete: ((err: Error | null, data?: any | null) => void)): void {
|
||||
export function loadFont (url: string, options: Record<string, any>, onComplete: FontCallback): void {
|
||||
const fontFamilyName = getFontFamily(url);
|
||||
// Already loaded fonts
|
||||
if (_fontFaces[fontFamilyName]) {
|
||||
@@ -166,17 +169,13 @@ export function loadFont (url: string, options: Record<string, any>, onComplete:
|
||||
}
|
||||
|
||||
// Default width reference to test whether new font is loaded correctly
|
||||
const fontDesc = `40px ${fontFamilyName}`;
|
||||
const familyCss = serializeFontFamily(fontFamilyName);
|
||||
const fontDesc = buildFontDesc(40, familyCss);
|
||||
|
||||
// Setup font face style
|
||||
const fontStyle = ccdocument.createElement('style');
|
||||
fontStyle.type = 'text/css';
|
||||
let fontStr = '';
|
||||
if (Number.isNaN(fontFamilyName)) {
|
||||
fontStr += `@font-face { font-family:${fontFamilyName}; src:`;
|
||||
} else {
|
||||
fontStr += `@font-face { font-family:"${fontFamilyName}"; src:`;
|
||||
}
|
||||
let fontStr = `@font-face { font-family:${familyCss}; src:`;
|
||||
fontStr += `url("${url}");`;
|
||||
fontStyle.textContent = `${fontStr}}`;
|
||||
ccdocument.body.appendChild(fontStyle);
|
||||
@@ -184,7 +183,7 @@ export function loadFont (url: string, options: Record<string, any>, onComplete:
|
||||
// Preload font with div
|
||||
const preloadDiv = ccdocument.createElement('div');
|
||||
const divStyle = preloadDiv.style;
|
||||
divStyle.fontFamily = fontFamilyName;
|
||||
divStyle.fontFamily = familyCss;
|
||||
preloadDiv.innerHTML = '.';
|
||||
divStyle.position = 'absolute';
|
||||
divStyle.left = '-100px';
|
||||
@@ -192,12 +191,14 @@ export function loadFont (url: string, options: Record<string, any>, onComplete:
|
||||
ccdocument.body.appendChild(preloadDiv);
|
||||
|
||||
if (useNativeCheck()) {
|
||||
nativeCheckFontLoaded(Date.now(), fontFamilyName, onComplete);
|
||||
nativeCheckFontLoaded(Date.now(), fontFamilyName, fontDesc, onComplete);
|
||||
} else {
|
||||
const refWidth = safeMeasureText(_canvasContext!, _testString, fontDesc);
|
||||
_canvasContext!.font = fontDesc;
|
||||
const refWidth = _canvasContext!.measureText(_testString).width;
|
||||
// Save loading font
|
||||
const fontLoadHandle = {
|
||||
fontFamilyName,
|
||||
fontDesc,
|
||||
refWidth,
|
||||
onComplete,
|
||||
startTime: Date.now(),
|
||||
@@ -221,9 +222,6 @@ export function getFontFamily (fontHandle: string): string {
|
||||
} else {
|
||||
fontFamilyName = `${fontHandle.substring(slashPos + 1, ttfIndex)}_LABEL`;
|
||||
}
|
||||
if (fontFamilyName.indexOf(' ') !== -1) {
|
||||
fontFamilyName = `"${fontFamilyName}"`;
|
||||
}
|
||||
return fontFamilyName;
|
||||
}
|
||||
|
||||
|
||||
@@ -508,7 +508,7 @@ export class Mesh extends Asset {
|
||||
let dstSize = idxView.length;
|
||||
if (dstStride === 4 && !gfxDevice.hasFeature(Feature.ELEMENT_INDEX_UINT)) {
|
||||
const vertexCount = this._struct.vertexBundles[prim.vertexBundelIndices[0]].view.count;
|
||||
if (vertexCount >= 65536) {
|
||||
if (vertexCount > 65536) { // Uint16 can address 65536 vertices (indices 0–65535)
|
||||
warnID(10001, vertexCount, 65536);
|
||||
continue; // Ignore this primitive
|
||||
} else {
|
||||
|
||||
@@ -172,13 +172,18 @@ export function createMesh (geometry: IGeometry, out?: Mesh, options?: ICreateMe
|
||||
// Fill index buffer.
|
||||
let indexBuffer: ArrayBuffer | null = null;
|
||||
let idxCount = 0;
|
||||
const idxStride = 2;
|
||||
let idxStride = 2;
|
||||
let indexFormat = Format.R16UI;
|
||||
if (geometry.indices) {
|
||||
const { indices } = geometry;
|
||||
idxCount = indices.length;
|
||||
if (indices.some((i) => i > 0xFFFF)) {
|
||||
idxStride = 4;
|
||||
indexFormat = Format.R32UI;
|
||||
}
|
||||
indexBuffer = new ArrayBuffer(idxStride * idxCount);
|
||||
const indexBufferView = new DataView(indexBuffer);
|
||||
writeBuffer(indexBufferView, indices, Format.R16UI);
|
||||
writeBuffer(indexBufferView, indices, indexFormat);
|
||||
}
|
||||
|
||||
// Create primitive.
|
||||
|
||||
@@ -24,7 +24,7 @@
|
||||
import { CULL_MESHOPT, NATIVE_CODE_BUNDLE_MODE } from 'internal:constants';
|
||||
import { ensureWasmModuleReady, instantiateWasm } from 'pal/wasm';
|
||||
|
||||
import { sys, logID, error } from '../../core';
|
||||
import { sys, error, debugID } from '../../core';
|
||||
|
||||
import { game } from '../../game';
|
||||
import { NativeCodeBundleMode } from '../../misc/webassembly-support';
|
||||
@@ -53,7 +53,7 @@ function initDecoderASM (asm_factory: any): Promise<void> {
|
||||
MeshoptDecoder.decodeGltfBuffer = asm_factory.decodeGltfBuffer;
|
||||
MeshoptDecoder.useWorkers = asm_factory.useWorkers;
|
||||
MeshoptDecoder.decodeGltfBufferAsync = asm_factory.decodeGltfBufferAsync;
|
||||
logID(14202);
|
||||
debugID(14202);
|
||||
});
|
||||
}
|
||||
|
||||
@@ -70,7 +70,7 @@ function initDecoderWASM (wasm_factory: any, wasm_url: string): Promise<void> {
|
||||
MeshoptDecoder.decodeGltfBuffer = wasm_factory.decodeGltfBuffer;
|
||||
MeshoptDecoder.useWorkers = wasm_factory.useWorkers;
|
||||
MeshoptDecoder.decodeGltfBufferAsync = wasm_factory.decodeGltfBufferAsync;
|
||||
logID(14203);
|
||||
debugID(14203);
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
@@ -106,6 +106,13 @@ export class BakedSkinningModel extends MorphModel {
|
||||
UBOSkinningTexture.SIZE,
|
||||
));
|
||||
}
|
||||
|
||||
// The animation buffer belongs to the skinning root. Refresh its binding without
|
||||
// rebuilding the instanced attribute block, which would erase custom attribute values.
|
||||
for (let i = 0; i < this._subModels.length; i++) {
|
||||
this._updateLocalDescriptors(i, this._subModels[i].descriptorSet);
|
||||
}
|
||||
this.updateInstancedJointTextureInfo();
|
||||
}
|
||||
|
||||
// Override
|
||||
|
||||
@@ -142,6 +142,7 @@ export class SkinningModel extends MorphModel {
|
||||
}
|
||||
this._bufferIndices = null; this._joints.length = 0;
|
||||
if (!skeleton || !skinningRoot || !mesh) { return; }
|
||||
const prevRealTimeTextureMode = this._realTimeTextureMode;
|
||||
this._realTimeTextureMode = false;
|
||||
if (UBOSkinning.JOINT_UNIFORM_CAPACITY < skeleton.joints.length) { this._realTimeTextureMode = true; }
|
||||
this.transform = skinningRoot;
|
||||
@@ -161,6 +162,15 @@ export class SkinningModel extends MorphModel {
|
||||
if (!jointMaps) { indices.push(index); buffers.push(0); } else { getRelevantBuffers(indices, buffers, jointMaps, index); }
|
||||
this._joints.push({ indices, buffers, bound, target, bindpose, transform });
|
||||
}
|
||||
|
||||
// Rebind recreated joint resources without resetting user-provided instanced attributes.
|
||||
const subModelCount = Math.min(this._subModels.length, this._bufferIndices.length);
|
||||
if (subModelCount && prevRealTimeTextureMode !== this._realTimeTextureMode) {
|
||||
this.onMacroPatchesStateChanged();
|
||||
}
|
||||
for (let i = 0; i < subModelCount; i++) {
|
||||
this._updateLocalDescriptors(i, this._subModels[i].descriptorSet);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -384,10 +384,10 @@ export class ReflectionProbe extends Component {
|
||||
}
|
||||
}
|
||||
}
|
||||
if (this.probeType === ProbeType.PLANAR && this.sourceCamera) {
|
||||
if (!EDITOR_NOT_IN_PREVIEW && this.probeType === ProbeType.PLANAR && this.sourceCamera) {
|
||||
if ((this.sourceCamera.node.hasChangedFlags & TransformBit.TRS)
|
||||
|| !this._sourceCameraPos.equals(this.sourceCamera.node.getWorldPosition())) {
|
||||
this._sourceCameraPos = this.sourceCamera.node.getWorldPosition();
|
||||
this._sourceCameraPos.set(this.sourceCamera.node.getWorldPosition());
|
||||
this.probe.renderPlanarReflection(this.sourceCamera.camera);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -177,21 +177,21 @@ export class SkinnedMeshBatchRenderer extends SkinnedMeshRenderer {
|
||||
@override
|
||||
@visible(false)
|
||||
get mesh (): Mesh | null {
|
||||
return super.mesh;
|
||||
return Reflect.get(SkinnedMeshRenderer.prototype, 'mesh', this);
|
||||
}
|
||||
|
||||
set mesh (val) {
|
||||
super.mesh = val;
|
||||
Reflect.set(SkinnedMeshRenderer.prototype, 'mesh', val, this);
|
||||
}
|
||||
|
||||
@override
|
||||
@visible(false)
|
||||
get skeleton (): Skeleton | null {
|
||||
return super.skeleton;
|
||||
return Reflect.get(SkinnedMeshRenderer.prototype, 'skeleton', this);
|
||||
}
|
||||
|
||||
set skeleton (val) {
|
||||
super.skeleton = val;
|
||||
Reflect.set(SkinnedMeshRenderer.prototype, 'skeleton', val, this);
|
||||
}
|
||||
|
||||
public onLoad (): void {
|
||||
|
||||
@@ -160,7 +160,8 @@ class ClipMotionEval implements MotionEval {
|
||||
|
||||
public overrideClips (context: AnimationGraphBindingContext): void {
|
||||
const { _originalClip: originalClip } = this;
|
||||
const overriding = context.clipOverrides?.get(originalClip);
|
||||
const clipOverrides: any = context.clipOverrides;
|
||||
const overriding: AnimationClip | null = clipOverrides && clipOverrides.get ? clipOverrides.get(originalClip) : null;
|
||||
if (overriding) {
|
||||
this._setClip(overriding, context);
|
||||
}
|
||||
|
||||
@@ -53,6 +53,19 @@ const _windowInfo: IRenderWindowInfo = {
|
||||
renderPassInfo: passInfo,
|
||||
};
|
||||
|
||||
// The legacy limit used only when the GPU capability is unavailable,
|
||||
// e.g. in editor or during asset deserialization.
|
||||
const FALLBACK_MAX_RENDER_TEXTURE_SIZE = 2048;
|
||||
|
||||
/**
|
||||
* @en Gets the maximum render texture size supported by the current GPU, or null if it is unknown.
|
||||
* @zh 获取当前 GPU 支持的最大渲染贴图尺寸,未知时返回 null。
|
||||
*/
|
||||
function getMaxRenderTextureSize (): number | null {
|
||||
const maxTextureSize = deviceManager.gfxDevice?.capabilities.maxTextureSize;
|
||||
return maxTextureSize && maxTextureSize > 0 ? maxTextureSize : null;
|
||||
}
|
||||
|
||||
/**
|
||||
* @en Render texture is a render target for [[Camera]] or [[Canvas]] component,
|
||||
* the render pipeline will use its `RenderWindow` as the target of the rendering process.
|
||||
@@ -111,12 +124,17 @@ export class RenderTexture extends TextureBase {
|
||||
/**
|
||||
* @en Resize the render texture.
|
||||
* @zh 修改渲染贴图的尺寸。
|
||||
* @param width @en The pixel width to resize to, the range is from 1 to 2048. @zh 需要调整到的像素宽度,范围为 1-2048。
|
||||
* @param height @en The pixel height to resize to, the range is from 1 to 2048. @zh 需要调整到的像素高度,范围为 1-2048。
|
||||
* @param width @en The pixel width to resize to, the range is from 1 to the GPU max texture size.
|
||||
* @zh 需要调整到的像素宽度,范围为 1 到当前 GPU 支持的最大贴图尺寸。
|
||||
* @param height @en The pixel height to resize to, the range is from 1 to the GPU max texture size.
|
||||
* @zh 需要调整到的像素高度,范围为 1 到当前 GPU 支持的最大贴图尺寸。
|
||||
* Note: if the GPU limit is unavailable, the legacy 2048 limit is used as a fallback.
|
||||
* @zh 注意:如果无法获取 GPU 上限,则回退到旧的 2048 限制。
|
||||
*/
|
||||
public resize (width: number, height: number): void {
|
||||
this._width = Math.floor(clamp(width, 1, 2048));
|
||||
this._height = Math.floor(clamp(height, 1, 2048));
|
||||
const maxSize = getMaxRenderTextureSize() ?? FALLBACK_MAX_RENDER_TEXTURE_SIZE;
|
||||
this._width = Math.floor(clamp(width, 1, maxSize));
|
||||
this._height = Math.floor(clamp(height, 1, maxSize));
|
||||
if (this._window) {
|
||||
this._window.resize(this._width, this._height);
|
||||
}
|
||||
@@ -214,7 +232,10 @@ export class RenderTexture extends TextureBase {
|
||||
* @deprecated Since v3.7, this is an internal engine interface and you should not call this interface under any circumstances.
|
||||
*/
|
||||
public validate (): boolean {
|
||||
return this.width >= 1 && this.width <= 2048 && this.height >= 1 && this.height <= 2048;
|
||||
const maxSize = getMaxRenderTextureSize();
|
||||
const validLowerBound = this.width >= 1 && this.height >= 1;
|
||||
// If the GPU limit is unknown, only validate the lower bound instead of rejecting a possibly valid asset.
|
||||
return validLowerBound && (maxSize === null || (this.width <= maxSize && this.height <= maxSize));
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -76,10 +76,11 @@ simpleTextureProto._onGFXTextureUpdated = function (gfxTexture) {
|
||||
simpleTextureProto._onAfterAssignImage = function (image) {
|
||||
if (macro.CLEANUP_IMAGE_CACHE) {
|
||||
const deps = dependUtil.getDeps(this._uuid);
|
||||
const index = deps.indexOf(image._uuid);
|
||||
if (index !== -1) {
|
||||
let index = deps.indexOf(image._uuid);
|
||||
while (index !== -1) {
|
||||
js.array.fastRemoveAt(deps, index);
|
||||
image.decRef();
|
||||
index = deps.indexOf(image._uuid);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
@@ -194,10 +194,12 @@ export class SimpleTexture extends TextureBase {
|
||||
|
||||
if (macro.CLEANUP_IMAGE_CACHE) {
|
||||
const deps = dependUtil.getDeps(this._uuid);
|
||||
const index = deps.indexOf(image._uuid);
|
||||
if (index !== -1) {
|
||||
let index = deps.indexOf(image._uuid);
|
||||
while (index !== -1) {
|
||||
js.array.fastRemoveAt(deps, index);
|
||||
image.decRef();
|
||||
// The same UUID may occur more than once; find the next dependency edge.
|
||||
index = deps.indexOf(image._uuid);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -195,8 +195,9 @@ function define (className, baseClass, options): any {
|
||||
renderName = 'render_stage';
|
||||
}
|
||||
// 增加了 hidden: 开头标识,使它最终不会显示在 Editor inspector 的添加组件列表里
|
||||
|
||||
window.EditorExtends && window.EditorExtends.Component.addMenu(cls, `hidden:${renderName}/${className}`, -1);
|
||||
if (window.EditorExtends) {
|
||||
window.EditorExtends.Component.addMenu(cls, `hidden:${renderName}/${className}`, -1);
|
||||
}
|
||||
}
|
||||
|
||||
// Note: `options.ctor` should be the same as `cls` except if
|
||||
|
||||
@@ -69,6 +69,58 @@ export function approx (a: number, b: number, maxDiff?: number): boolean {
|
||||
return mathAbs(a - b) <= maxDiff;
|
||||
}
|
||||
|
||||
/**
|
||||
* @en Tests whether or not the first argument is approximately greater than or equal to the second
|
||||
* @zh 测试第一个参数是否近似大于或等于第二个参数
|
||||
* @param a The first number to test
|
||||
* @param b The second number to test
|
||||
* @param maxDiff Maximum difference (default: EPSILON)
|
||||
* @return True if a is approximately greater than or equal to b, false otherwise
|
||||
*/
|
||||
export function approxGE (a: number, b: number, maxDiff?: number): boolean {
|
||||
maxDiff = maxDiff || EPSILON;
|
||||
return a >= b - maxDiff;
|
||||
}
|
||||
|
||||
/**
|
||||
* @en Tests whether or not the first argument is approximately less than or equal to the second
|
||||
* @zh 测试第一个参数是否近似小于或等于第二个参数
|
||||
* @param a The first number to test
|
||||
* @param b The second number to test
|
||||
* @param maxDiff Maximum difference (default: EPSILON)
|
||||
* @return True if a is approximately less than or equal to b, false otherwise
|
||||
*/
|
||||
export function approxLE (a: number, b: number, maxDiff?: number): boolean {
|
||||
maxDiff = maxDiff || EPSILON;
|
||||
return a <= b + maxDiff;
|
||||
}
|
||||
|
||||
/**
|
||||
* @en Tests whether or not the first argument is approximately greater than the second
|
||||
* @zh 测试第一个参数是否近似大于第二个参数
|
||||
* @param a The first number to test
|
||||
* @param b The second number to test
|
||||
* @param maxDiff Maximum difference (default: EPSILON)
|
||||
* @return True if a is approximately greater than b, false otherwise
|
||||
*/
|
||||
export function approxGT (a: number, b: number, maxDiff?: number): boolean {
|
||||
maxDiff = maxDiff || EPSILON;
|
||||
return a > b + maxDiff;
|
||||
}
|
||||
|
||||
/**
|
||||
* @en Tests whether or not the first argument is approximately less than the second
|
||||
* @zh 测试第一个参数是否近似小于第二个参数
|
||||
* @param a The first number to test
|
||||
* @param b The second number to test
|
||||
* @param maxDiff Maximum difference (default: EPSILON)
|
||||
* @return True if a is approximately less than b, false otherwise
|
||||
*/
|
||||
export function approxLT (a: number, b: number, maxDiff?: number): boolean {
|
||||
maxDiff = maxDiff || EPSILON;
|
||||
return a < b - maxDiff;
|
||||
}
|
||||
|
||||
/**
|
||||
* @en Clamps a value between a minimum float and maximum float value.<br/>
|
||||
* @zh 返回最小浮点数和最大浮点数之间的一个数值。可以使用 clamp 函数将不断变化的数值限制在范围内。
|
||||
|
||||
@@ -45,5 +45,5 @@ export {
|
||||
DebugMode,
|
||||
} from './debug';
|
||||
|
||||
export { screen } from './screen';
|
||||
export { screen, MaxDPR } from './screen';
|
||||
export type { Screen } from './screen';
|
||||
|
||||
@@ -25,12 +25,36 @@
|
||||
THE SOFTWARE.
|
||||
*/
|
||||
|
||||
import { screenAdapter } from 'pal/screen-adapter';
|
||||
import { screenAdapter, IScreenOptions } from 'pal/screen-adapter';
|
||||
import { systemInfo } from 'pal/system-info';
|
||||
import { OS } from '../../../pal/system-info/enum-type';
|
||||
import { legacyCC } from '../global-exports';
|
||||
import { Size } from '../math';
|
||||
import { settings, SettingsCategory } from '../settings';
|
||||
import { error, warn, warnID } from './debug';
|
||||
import { PalScreenEvent } from '../../../pal/screen-adapter/enum-type';
|
||||
import { error, getError, warn, warnID } from './debug';
|
||||
import type { PalScreenEvent } from '../../../pal/screen-adapter/enum-type';
|
||||
|
||||
/**
|
||||
* @en Presets for the Web startup setting `screen.maxDevicePixelRatio`.
|
||||
* Store the preset's numeric value or any finite number >= 1 in the startup settings.
|
||||
* An omitted or null setting keeps the default cap of 2. Effective DPR never exceeds the browser DPR.
|
||||
* Configure before Screen initialization; changing settings afterward does not resize the running game.
|
||||
* Non-Web platforms ignore this setting. Higher caps increase pixel-related rendering costs.
|
||||
* @zh Web 启动配置 `screen.maxDevicePixelRatio` 的预设档位。
|
||||
* 在启动配置中保存预设的数值或任意有限且 >=1 的数字。
|
||||
* 未配置或为 null 时保留默认上限 2,实际 DPR 不超过浏览器 DPR。
|
||||
* 需在 Screen 初始化前配置,之后修改 settings 不会调整运行中游戏的分辨率。
|
||||
* 非 Web 平台忽略该配置;提高上限会增加像素相关的渲染开销。
|
||||
*/
|
||||
export enum MaxDPR {
|
||||
/** @en Cap DPR at 1 to reduce rendering cost. @zh 上限为 1,优先降低渲染开销。 */
|
||||
Performance = 1,
|
||||
/** @en Cap DPR at 2, matching the existing default. @zh 上限为 2,与现有默认策略一致。 */
|
||||
Balanced = 2,
|
||||
/** @en Cap DPR at 4 for higher-density rendering. @zh 上限为 4,允许更高密度渲染。 */
|
||||
Quality = 4,
|
||||
}
|
||||
|
||||
/**
|
||||
* @en The screen API provides an easy way to do some screen managing stuff.
|
||||
* @zh screen 单例对象提供简单的方法来做屏幕管理相关的工作。
|
||||
@@ -40,10 +64,18 @@ export class Screen {
|
||||
* @internal
|
||||
*/
|
||||
public init (): void {
|
||||
// PAL decides whether to consume the setting and validates its value.
|
||||
const maximum = settings.querySettings<number>(SettingsCategory.SCREEN, 'maxDevicePixelRatio');
|
||||
const exactFitScreen = settings.querySettings(SettingsCategory.SCREEN, 'exactFitScreen') ?? true;
|
||||
const orientation = settings.querySettings(SettingsCategory.SCREEN, 'orientation') ?? 'auto';
|
||||
const isHeadlessMode = settings.querySettings(SettingsCategory.RENDERING, 'renderMode') === 3;
|
||||
screenAdapter.init({ exactFitScreen, configOrientation: orientation, isHeadlessMode }, (): void => {
|
||||
const options: IScreenOptions & { maxDevicePixelRatio?: number | null } = {
|
||||
exactFitScreen, configOrientation: orientation, isHeadlessMode,
|
||||
};
|
||||
if (maximum != null) {
|
||||
options.maxDevicePixelRatio = maximum;
|
||||
}
|
||||
screenAdapter.init(options, (): void => {
|
||||
const director = legacyCC.director;
|
||||
if (!director.root?.pipeline) {
|
||||
warnID(1220);
|
||||
@@ -51,6 +83,13 @@ export class Screen {
|
||||
}
|
||||
director.root.pipeline.shadingScale = screenAdapter.resolutionScale;
|
||||
});
|
||||
// Only adapters exposing this capability are expected to apply the setting.
|
||||
// The property check also narrows concrete adapter types in Native TS builds.
|
||||
if (maximum != null
|
||||
&& 'maxDevicePixelRatio' in screenAdapter
|
||||
&& screenAdapter.maxDevicePixelRatio !== maximum) {
|
||||
throw new Error(getError(9205));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -64,6 +103,18 @@ export class Screen {
|
||||
return screenAdapter.devicePixelRatio;
|
||||
}
|
||||
|
||||
/**
|
||||
* @en Controls whether the screen stays on while the app is in the foreground.
|
||||
* Supported on native Android and iOS. Has no effect on other platforms.
|
||||
* @zh 控制应用在前台时是否保持屏幕常亮。仅在 Android 和 iOS 原生平台生效。
|
||||
* @param enabled @en Pass true to keep the screen on or false to restore normal screen timeout. @zh 传入 true 开启常亮,传入 false 恢复系统的自动熄屏行为。
|
||||
*/
|
||||
public setKeepScreenOn (enabled: boolean): void {
|
||||
if (systemInfo.isNative && (systemInfo.os === OS.ANDROID || systemInfo.os === OS.IOS)) {
|
||||
jsb.device.setKeepScreenOn(enabled);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @en Get and set the size of current window in physical pixels.
|
||||
* NOTE:
|
||||
@@ -137,7 +188,11 @@ export class Screen {
|
||||
* @return {Promise|undefined}
|
||||
* @deprecated since v3.3, please use `screen.requestFullScreen(): Promise<void>` instead.
|
||||
*/
|
||||
public requestFullScreen (element: HTMLElement, onFullScreenChange?: (this: Document, ev: any) => any, onFullScreenError?: (this: Document, ev: any) => any): Promise<any> | undefined;
|
||||
public requestFullScreen (
|
||||
element: HTMLElement,
|
||||
onFullScreenChange?: (this: Document, ev: any) => any,
|
||||
onFullScreenError?: (this: Document, ev: any) => any,
|
||||
): Promise<any> | undefined;
|
||||
/**
|
||||
* @en Request to enter full screen mode.
|
||||
* Many browsers forbid to enter full screen mode without an user intended interaction.
|
||||
@@ -150,7 +205,11 @@ export class Screen {
|
||||
* @return {Promise}
|
||||
*/
|
||||
public requestFullScreen (): Promise<void>;
|
||||
public requestFullScreen (element?: HTMLElement, onFullScreenChange?: (this: Document, ev?: any) => any, onFullScreenError?: (this: Document, ev?: any) => any): Promise<any> {
|
||||
public requestFullScreen (
|
||||
element?: HTMLElement,
|
||||
onFullScreenChange?: (this: Document, ev?: any) => any,
|
||||
onFullScreenError?: (this: Document, ev?: any) => any,
|
||||
): Promise<any> {
|
||||
if (arguments.length > 0) {
|
||||
warnID(1400, 'screen.requestFullScreen(element, onFullScreenChange?, onFullScreenError?)', 'screen.requestFullScreen(): Promise');
|
||||
}
|
||||
|
||||
@@ -88,6 +88,14 @@ export abstract class CommandBuffer extends GFXObject {
|
||||
return this._numTris;
|
||||
}
|
||||
|
||||
/**
|
||||
* @en Number of compute dispatches currently recorded.
|
||||
* @zh 计算调度(dispatch)次数。
|
||||
*/
|
||||
get numDispatches (): number {
|
||||
return this._numDispatches;
|
||||
}
|
||||
|
||||
/** @mangle */
|
||||
protected _queue: Queue | null = null;
|
||||
/** @mangle */
|
||||
@@ -95,6 +103,8 @@ export abstract class CommandBuffer extends GFXObject {
|
||||
/** @mangle */
|
||||
protected _numDrawCalls = 0;
|
||||
/** @mangle */
|
||||
protected _numDispatches = 0;
|
||||
/** @mangle */
|
||||
protected _numInstances = 0;
|
||||
/** @mangle */
|
||||
protected _numTris = 0;
|
||||
|
||||
@@ -127,6 +127,14 @@ export abstract class Device {
|
||||
return this._numTris;
|
||||
}
|
||||
|
||||
/**
|
||||
* @en Number of compute dispatches currently recorded.
|
||||
* @zh 计算调度(dispatch)次数。
|
||||
*/
|
||||
get numDispatches (): number {
|
||||
return this._numDispatches;
|
||||
}
|
||||
|
||||
/**
|
||||
* @en Total memory size currently allocated.
|
||||
* @zh 内存状态。
|
||||
@@ -168,6 +176,8 @@ export abstract class Device {
|
||||
/** @mangle */
|
||||
protected _numDrawCalls = 0;
|
||||
/** @mangle */
|
||||
protected _numDispatches = 0;
|
||||
/** @mangle */
|
||||
protected _numInstances = 0;
|
||||
/** @mangle */
|
||||
protected _numTris = 0;
|
||||
|
||||
@@ -47,6 +47,9 @@ export class EmptyBuffer extends Buffer {
|
||||
}
|
||||
}
|
||||
public destroy (): void {}
|
||||
public resize (size: number): void {}
|
||||
public resize (size: number): void {
|
||||
this._size = size;
|
||||
this._count = this._size / this._stride;
|
||||
}
|
||||
public update (buffer: Readonly<BufferSource>, size?: number): void {}
|
||||
}
|
||||
|
||||
@@ -33,7 +33,7 @@ import {
|
||||
} from './webgl-commands';
|
||||
import { IWebGLGPUBuffer, IWebGLGPUBufferView, WebGLIndirectDrawInfos } from './webgl-gpu-objects';
|
||||
import { WebGLDeviceManager } from './webgl-define';
|
||||
import { warnID } from '../../core/platform/debug';
|
||||
import { warn, warnID } from '../../core/platform/debug';
|
||||
|
||||
/** @mangle */
|
||||
export class WebGLBuffer extends Buffer {
|
||||
@@ -48,6 +48,7 @@ export class WebGLBuffer extends Buffer {
|
||||
private _gpuBuffer: IWebGLGPUBuffer | null = null;
|
||||
private _gpuBufferView: IWebGLGPUBufferView | null = null;
|
||||
private _uniformBuffer: Uint8Array | null = null;
|
||||
private _lastFailedSize = 0;
|
||||
|
||||
constructor () {
|
||||
super();
|
||||
@@ -125,9 +126,6 @@ export class WebGLBuffer extends Buffer {
|
||||
const oldSize = this._size;
|
||||
if (oldSize === size) { return; }
|
||||
|
||||
this._size = size;
|
||||
this._count = this._size / this._stride;
|
||||
|
||||
if (this._uniformBuffer) {
|
||||
this._uniformBuffer = new Uint8Array(size);
|
||||
}
|
||||
@@ -140,8 +138,18 @@ export class WebGLBuffer extends Buffer {
|
||||
this._gpuBuffer.size = size;
|
||||
if (size > 0) {
|
||||
WebGLCmdFuncResizeBuffer(WebGLDeviceManager.instance, this._gpuBuffer);
|
||||
WebGLDeviceManager.instance.memoryStatus.bufferSize -= oldSize;
|
||||
WebGLDeviceManager.instance.memoryStatus.bufferSize += size;
|
||||
}
|
||||
this._size = this._gpuBuffer.size;
|
||||
this._count = this._size / this._stride;
|
||||
WebGLDeviceManager.instance.memoryStatus.bufferSize -= oldSize;
|
||||
WebGLDeviceManager.instance.memoryStatus.bufferSize += this._size;
|
||||
if (this._size !== size) {
|
||||
if (this._lastFailedSize !== size) {
|
||||
this._lastFailedSize = size;
|
||||
warn(`WebGLBuffer[${this.objectID}] (usage: ${this._usage}) resize failed to reach requested size: requested ${size} bytes, actual ${this._size} bytes.`);
|
||||
}
|
||||
} else {
|
||||
this._lastFailedSize = 0;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -574,6 +574,8 @@ export function WebGLCmdFuncResizeBuffer (device: WebGLDevice, gpuBuffer: IWebGL
|
||||
} else {
|
||||
gl.bufferData(WebGLConstants.ARRAY_BUFFER, gpuBuffer.size, glUsage);
|
||||
}
|
||||
gpuBuffer.size = gl.getBufferParameter(WebGLConstants.ARRAY_BUFFER, WebGLConstants.BUFFER_SIZE) as number;
|
||||
|
||||
gl.bindBuffer(WebGLConstants.ARRAY_BUFFER, null);
|
||||
stateCache.glArrayBuffer = null;
|
||||
} else if (gpuBuffer.usage & BufferUsageBit.INDEX) {
|
||||
@@ -594,6 +596,8 @@ export function WebGLCmdFuncResizeBuffer (device: WebGLDevice, gpuBuffer: IWebGL
|
||||
} else {
|
||||
gl.bufferData(WebGLConstants.ELEMENT_ARRAY_BUFFER, gpuBuffer.size, glUsage);
|
||||
}
|
||||
gpuBuffer.size = gl.getBufferParameter(WebGLConstants.ELEMENT_ARRAY_BUFFER, WebGLConstants.BUFFER_SIZE) as number;
|
||||
|
||||
gl.bindBuffer(WebGLConstants.ELEMENT_ARRAY_BUFFER, null);
|
||||
stateCache.glElementArrayBuffer = null;
|
||||
} else if (gpuBuffer.usage & BufferUsageBit.UNIFORM) {
|
||||
@@ -630,6 +634,7 @@ export function WebGLCmdFuncUpdateBuffer (
|
||||
gpuBuffer.indirects.setDrawInfo(offset + i, drawInfos[i]);
|
||||
}
|
||||
} else {
|
||||
if (size > gpuBuffer.size) { return; }
|
||||
const buff = buffer as ArrayBuffer;
|
||||
const { gl, stateCache } = device;
|
||||
|
||||
@@ -2702,7 +2707,7 @@ export function WebGLCmdFuncCopyBuffersToTexture (
|
||||
offset.x = regionTexOffset.x === 0 ? 0 : alignTo(regionTexOffset.x, blockSizeWidth);
|
||||
offset.y = regionTexOffset.y === 0 ? 0 : alignTo(regionTexOffset.y, blockSizeHeight);
|
||||
extent.width = regionTexExtentWidth < blockSizeWidth ? regionTexExtentWidth : alignTo(regionTexExtentWidth, blockSizeWidth);
|
||||
extent.height = regionTexExtentHeight < blockSizeHeight ? regionTexExtentWidth
|
||||
extent.height = regionTexExtentHeight < blockSizeHeight ? regionTexExtentHeight
|
||||
: alignTo(regionTexExtentHeight, blockSizeHeight);
|
||||
stride.width = regionBuffStride > 0 ? regionBuffStride : extent.width;
|
||||
stride.height = region.buffTexHeight > 0 ? region.buffTexHeight : extent.height;
|
||||
@@ -2773,7 +2778,7 @@ export function WebGLCmdFuncCopyBuffersToTexture (
|
||||
offset.x = regionTexOffset.x === 0 ? 0 : alignTo(regionTexOffset.x, blockSizeWidth);
|
||||
offset.y = regionTexOffset.y === 0 ? 0 : alignTo(regionTexOffset.y, blockSizeHeight);
|
||||
extent.width = regionTexExtentWidth < blockSizeWidth ? regionTexExtentWidth : alignTo(regionTexExtentWidth, blockSizeWidth);
|
||||
extent.height = regionTexExtentHeight < blockSizeHeight ? regionTexExtentWidth
|
||||
extent.height = regionTexExtentHeight < blockSizeHeight ? regionTexExtentHeight
|
||||
: alignTo(regionTexExtentHeight, blockSizeHeight);
|
||||
stride.width = region.buffStride > 0 ? region.buffStride : extent.width;
|
||||
stride.height = region.buffTexHeight > 0 ? region.buffTexHeight : extent.height;
|
||||
|
||||
@@ -22,7 +22,7 @@
|
||||
THE SOFTWARE.
|
||||
*/
|
||||
|
||||
import { warnID } from '../../core/platform/debug';
|
||||
import { warn, warnID } from '../../core/platform/debug';
|
||||
import { Buffer } from '../base/buffer';
|
||||
import { BufferUsageBit, BufferSource, BufferInfo, BufferViewInfo } from '../base/define';
|
||||
import {
|
||||
@@ -45,6 +45,7 @@ export class WebGL2Buffer extends Buffer {
|
||||
}
|
||||
|
||||
private _gpuBuffer: IWebGL2GPUBuffer | null = null;
|
||||
private _lastFailedSize = 0;
|
||||
|
||||
public initialize (info: Readonly<BufferInfo> | Readonly<BufferViewInfo>): void {
|
||||
if ('buffer' in info) { // buffer view
|
||||
@@ -114,15 +115,22 @@ export class WebGL2Buffer extends Buffer {
|
||||
const oldSize = this._size;
|
||||
if (oldSize === size) { return; }
|
||||
|
||||
this._size = size;
|
||||
this._count = this._size / this._stride;
|
||||
|
||||
if (this._gpuBuffer) {
|
||||
this._gpuBuffer.size = size;
|
||||
if (size > 0) {
|
||||
WebGL2CmdFuncResizeBuffer(WebGL2DeviceManager.instance, this._gpuBuffer);
|
||||
WebGL2DeviceManager.instance.memoryStatus.bufferSize -= oldSize;
|
||||
WebGL2DeviceManager.instance.memoryStatus.bufferSize += size;
|
||||
}
|
||||
this._size = this._gpuBuffer.size;
|
||||
this._count = this._size / this._stride;
|
||||
WebGL2DeviceManager.instance.memoryStatus.bufferSize -= oldSize;
|
||||
WebGL2DeviceManager.instance.memoryStatus.bufferSize += this._size;
|
||||
if (this._size !== size) {
|
||||
if (this._lastFailedSize !== size) {
|
||||
this._lastFailedSize = size;
|
||||
warn(`WebGL2Buffer[${this.objectID}] (usage: ${this._usage}) resize failed to reach requested size: requested ${size} bytes, actual ${this._size} bytes.`);
|
||||
}
|
||||
} else {
|
||||
this._lastFailedSize = 0;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -770,6 +770,8 @@ export function WebGL2CmdFuncResizeBuffer (device: WebGL2Device, gpuBuffer: IWeb
|
||||
} else {
|
||||
gl.bufferData(WebGLConstants.ARRAY_BUFFER, gpuBuffer.size, glUsage);
|
||||
}
|
||||
gpuBuffer.size = gl.getBufferParameter(WebGLConstants.ARRAY_BUFFER, WebGLConstants.BUFFER_SIZE) as number;
|
||||
|
||||
gl.bindBuffer(WebGLConstants.ARRAY_BUFFER, null);
|
||||
cache.glArrayBuffer = null;
|
||||
} else if (gpuBuffer.usage & BufferUsageBit.INDEX) {
|
||||
@@ -790,6 +792,8 @@ export function WebGL2CmdFuncResizeBuffer (device: WebGL2Device, gpuBuffer: IWeb
|
||||
} else {
|
||||
gl.bufferData(WebGLConstants.ELEMENT_ARRAY_BUFFER, gpuBuffer.size, glUsage);
|
||||
}
|
||||
gpuBuffer.size = gl.getBufferParameter(WebGLConstants.ELEMENT_ARRAY_BUFFER, WebGLConstants.BUFFER_SIZE) as number;
|
||||
|
||||
gl.bindBuffer(WebGLConstants.ELEMENT_ARRAY_BUFFER, null);
|
||||
cache.glElementArrayBuffer = null;
|
||||
} else if (gpuBuffer.usage & BufferUsageBit.UNIFORM) {
|
||||
@@ -798,6 +802,8 @@ export function WebGL2CmdFuncResizeBuffer (device: WebGL2Device, gpuBuffer: IWeb
|
||||
}
|
||||
|
||||
gl.bufferData(WebGLConstants.UNIFORM_BUFFER, gpuBuffer.size, glUsage);
|
||||
gpuBuffer.size = gl.getBufferParameter(WebGLConstants.UNIFORM_BUFFER, WebGLConstants.BUFFER_SIZE) as number;
|
||||
|
||||
gl.bindBuffer(WebGLConstants.UNIFORM_BUFFER, null);
|
||||
cache.glUniformBuffer = null;
|
||||
} else if ((gpuBuffer.usage & BufferUsageBit.INDIRECT)
|
||||
@@ -824,6 +830,7 @@ export function WebGL2CmdFuncUpdateBuffer (
|
||||
gpuBuffer.indirects.setDrawInfo(offset + i, drawInfos[i]);
|
||||
}
|
||||
} else {
|
||||
if (size > gpuBuffer.size) { return; }
|
||||
const buff = buffer as ArrayBuffer;
|
||||
const { gl } = device;
|
||||
const cache = device.getStateCache();
|
||||
@@ -2811,7 +2818,7 @@ export function WebGL2CmdFuncCopyBuffersToTexture (
|
||||
offset.x = regionTexOffset.x === 0 ? 0 : alignTo(regionTexOffset.x, blockSizeWidth);
|
||||
offset.y = regionTexOffset.y === 0 ? 0 : alignTo(regionTexOffset.y, blockSizeHeight);
|
||||
extent.width = regionTexExtentWidth < blockSizeWidth ? regionTexExtentWidth : alignTo(regionTexExtentWidth, blockSizeWidth);
|
||||
extent.height = regionTexExtentHeight < blockSizeHeight ? regionTexExtentWidth
|
||||
extent.height = regionTexExtentHeight < blockSizeHeight ? regionTexExtentHeight
|
||||
: alignTo(regionTexExtentHeight, blockSizeHeight);
|
||||
stride.width = regionBuffStride > 0 ? regionBuffStride : extent.width;
|
||||
stride.height = region.buffTexHeight > 0 ? region.buffTexHeight : extent.height;
|
||||
@@ -2883,7 +2890,7 @@ export function WebGL2CmdFuncCopyBuffersToTexture (
|
||||
offset.x = regionTexOffset.x === 0 ? 0 : alignTo(regionTexOffset.x, blockSizeWidth);
|
||||
offset.y = regionTexOffset.y === 0 ? 0 : alignTo(regionTexOffset.y, blockSizeHeight);
|
||||
extent.width = regionTexExtentWidth < blockSizeWidth ? regionTexExtentWidth : alignTo(regionTexExtentWidth, blockSizeWidth);
|
||||
extent.height = regionTexExtentHeight < blockSizeHeight ? regionTexExtentWidth
|
||||
extent.height = regionTexExtentHeight < blockSizeHeight ? regionTexExtentHeight
|
||||
: alignTo(regionTexExtentHeight, blockSizeHeight);
|
||||
extent.depth = 1;
|
||||
stride.width = regionBuffStride > 0 ? regionBuffStride : extent.width;
|
||||
@@ -2965,7 +2972,7 @@ export function WebGL2CmdFuncCopyBuffersToTexture (
|
||||
offset.y = regionTexOffset.y === 0 ? 0 : alignTo(regionTexOffset.y, blockSizeHeight);
|
||||
offset.z = regionTexOffset.z;
|
||||
extent.width = regionTexExtentWidth < blockSizeWidth ? regionTexExtentWidth : alignTo(regionTexExtentWidth, blockSizeWidth);
|
||||
extent.height = regionTexExtentHeight < blockSizeHeight ? regionTexExtentWidth
|
||||
extent.height = regionTexExtentHeight < blockSizeHeight ? regionTexExtentHeight
|
||||
: alignTo(regionTexExtentHeight, blockSizeHeight);
|
||||
extent.depth = regionTexExtent.depth;
|
||||
stride.width = regionBuffStride > 0 ? regionBuffStride : extent.width;
|
||||
@@ -2986,7 +2993,7 @@ export function WebGL2CmdFuncCopyBuffersToTexture (
|
||||
|
||||
if (!isCompressed) {
|
||||
gl.texSubImage3D(
|
||||
WebGLConstants.TEXTURE_2D_ARRAY,
|
||||
WebGLConstants.TEXTURE_3D,
|
||||
mipLevel,
|
||||
offset.x,
|
||||
offset.y,
|
||||
@@ -3000,7 +3007,7 @@ export function WebGL2CmdFuncCopyBuffersToTexture (
|
||||
);
|
||||
} else if (gpuTexture.glInternalFmt !== WebGL2EXT.COMPRESSED_RGB_ETC1_WEBGL as number) {
|
||||
gl.compressedTexSubImage3D(
|
||||
WebGLConstants.TEXTURE_2D_ARRAY,
|
||||
WebGLConstants.TEXTURE_3D,
|
||||
mipLevel,
|
||||
offset.x,
|
||||
offset.y,
|
||||
@@ -3013,7 +3020,7 @@ export function WebGL2CmdFuncCopyBuffersToTexture (
|
||||
);
|
||||
} else { // WEBGL_compressed_texture_etc1
|
||||
gl.compressedTexImage3D(
|
||||
WebGLConstants.TEXTURE_2D_ARRAY,
|
||||
WebGLConstants.TEXTURE_3D,
|
||||
mipLevel,
|
||||
gpuTexture.glInternalFmt,
|
||||
destWidth,
|
||||
@@ -3043,7 +3050,7 @@ export function WebGL2CmdFuncCopyBuffersToTexture (
|
||||
offset.x = regionTexOffset.x === 0 ? 0 : alignTo(regionTexOffset.x, blockSizeWidth);
|
||||
offset.y = regionTexOffset.y === 0 ? 0 : alignTo(regionTexOffset.y, blockSizeHeight);
|
||||
extent.width = regionTexExtentWidth < blockSizeWidth ? regionTexExtentWidth : alignTo(regionTexExtentWidth, blockSizeWidth);
|
||||
extent.height = regionTexExtentHeight < blockSizeHeight ? regionTexExtentWidth
|
||||
extent.height = regionTexExtentHeight < blockSizeHeight ? regionTexExtentHeight
|
||||
: alignTo(regionTexExtentHeight, blockSizeHeight);
|
||||
stride.width = regionBuffStride > 0 ? regionBuffStride : extent.width;
|
||||
stride.height = region.buffTexHeight > 0 ? region.buffTexHeight : extent.height;
|
||||
|
||||
@@ -185,7 +185,7 @@ export class WebGL2Swapchain extends Swapchain {
|
||||
self._canvas = info.windowHandle;
|
||||
|
||||
self._webGL2ContextLostHandler = self._onWebGLContextLost.bind(self);
|
||||
self._canvas.addEventListener(eventWebGLContextLost, self._onWebGLContextLost);
|
||||
self._canvas.addEventListener(eventWebGLContextLost, self._webGL2ContextLostHandler);
|
||||
|
||||
const { instance } = WebGL2DeviceManager;
|
||||
const { gl, capabilities } = instance;
|
||||
|
||||
@@ -40,6 +40,7 @@ import {
|
||||
TextureBlit,
|
||||
DescriptorSetInfo,
|
||||
Format,
|
||||
DispatchInfo,
|
||||
} from '../base/define';
|
||||
import { Framebuffer } from '../base/framebuffer';
|
||||
import { InputAssembler } from '../base/input-assembler';
|
||||
@@ -179,6 +180,7 @@ export class WebGPUCommandBuffer extends CommandBuffer {
|
||||
private _wgpuRenderPass!: WebGPURenderPass;
|
||||
|
||||
private _renderPassFuncQueue: ((renPassEncoder: GPURenderPassEncoder) => void)[] = [];
|
||||
private _computeFuncQueue: ((computePassEncoder: GPUComputePassEncoder) => void)[] = [];
|
||||
|
||||
public initialize (info: CommandBufferInfo): boolean {
|
||||
this._type = info.type;
|
||||
@@ -222,13 +224,16 @@ export class WebGPUCommandBuffer extends CommandBuffer {
|
||||
this._curStencilWriteMask = null;
|
||||
this._curStencilCompareMask = null;
|
||||
this._numDrawCalls = 0;
|
||||
this._numDispatches = 0;
|
||||
this._numInstances = 0;
|
||||
this._numTris = 0;
|
||||
this._computeFuncQueue.length = 0;
|
||||
}
|
||||
|
||||
public end (): void {
|
||||
this._isStateValid = false;
|
||||
this._isInRenderPass = false;
|
||||
this._computeFuncQueue.length = 0;
|
||||
}
|
||||
|
||||
public beginRenderPass (
|
||||
@@ -650,22 +655,20 @@ export class WebGPUCommandBuffer extends CommandBuffer {
|
||||
this.cmdPackage.cmds.concat(cmdPackage.cmds.array);
|
||||
|
||||
this._numDrawCalls += WebGPUCmdBuff._numDrawCalls;
|
||||
this._numDispatches += WebGPUCmdBuff._numDispatches;
|
||||
this._numInstances += WebGPUCmdBuff._numInstances;
|
||||
this._numTris += WebGPUCmdBuff._numTris;
|
||||
}
|
||||
}
|
||||
|
||||
protected bindStates (): void {
|
||||
if (!this._curGPUPipelineState) {
|
||||
return;
|
||||
}
|
||||
const gpuPipelineLayout = this._curGPUPipelineState.gpuPipelineLayout as IWebGPUGPUPipelineLayout;
|
||||
private _prepareDescriptorSets (): void {
|
||||
const wgpuPipLayout = (currPipelineState?.pipelineLayout as WebGPUPipelineLayout);
|
||||
const device = WebGPUDeviceManager.instance;
|
||||
for (let i = 0; i < groupSets.length; i++) {
|
||||
const currSetIdx = groupSets[i];
|
||||
const currDesc = descriptorSets[currSetIdx];
|
||||
if (currDesc && currDesc.gpuDescriptorSet) {
|
||||
// prepare() builds the bind group if it was never created, or rebuilds it on resource change.
|
||||
currDesc.prepare();
|
||||
} else {
|
||||
const currLayout = wgpuPipLayout.setLayouts[currSetIdx];
|
||||
@@ -675,23 +678,13 @@ export class WebGPUCommandBuffer extends CommandBuffer {
|
||||
newDescSet.prepare(true);
|
||||
}
|
||||
}
|
||||
const gpuIA = this._curGPUInputAssembler!;
|
||||
// only 4x MSAA is supported
|
||||
gpuIA.samples = samples > 1 ? 4 : 1;
|
||||
this._curWebGPUPipelineState!.prepare(gpuIA);
|
||||
// ----------------------------wgpu pipline state-----------------------------
|
||||
const wgpuPipeline = this._curGPUPipelineState.nativePipeline as GPURenderPipeline;
|
||||
const pplFunc = (passEncoder: GPURenderPassEncoder): void => {
|
||||
passEncoder.setPipeline(wgpuPipeline);
|
||||
};
|
||||
this._renderPassFuncQueue.push(pplFunc);
|
||||
if (this._curGPUPipelineState.pipelineState?.depthStencil) {
|
||||
const stencilRef = this._curGPUPipelineState.stencilRef;
|
||||
const stencilRefFunc = (passEncoder: GPURenderPassEncoder): void => {
|
||||
passEncoder.setStencilReference(stencilRef);
|
||||
};
|
||||
this._renderPassFuncQueue.push(stencilRefFunc);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Collect the bind groups and dynamic offsets for the currently bound descriptor sets.
|
||||
* Shared by the draw (bindStates) and compute (dispatch) paths.
|
||||
*/
|
||||
private _collectBindGroups (): { wgpuBindGroups: GPUBindGroup[]; wgpuDynOffsets: number[][] } {
|
||||
const currGPUDescSize = groupSets.length;
|
||||
const wgpuBindGroups = new Array<GPUBindGroup>(currGPUDescSize);
|
||||
const wgpuDynOffsets = new Array<number[]>(currGPUDescSize);
|
||||
@@ -703,7 +696,7 @@ export class WebGPUCommandBuffer extends CommandBuffer {
|
||||
wgpuDynOffsets[currSetIdx] = [...this._curDynamicOffsets[currSetIdx]];
|
||||
if (!descObj.dynamicOffsetCount) {
|
||||
wgpuDynOffsets[currSetIdx] = [];
|
||||
} else if (descObj && descObj.dynamicOffsetCount !== wgpuDynOffsets[currSetIdx].length) {
|
||||
} else if (descObj.dynamicOffsetCount !== wgpuDynOffsets[currSetIdx].length) {
|
||||
wgpuDynOffsets[currSetIdx].length = descObj.dynamicOffsetCount;
|
||||
for (let j = 0; j < descObj.dynamicOffsetCount; j++) {
|
||||
const currOffset = wgpuDynOffsets[currSetIdx][j];
|
||||
@@ -719,16 +712,84 @@ export class WebGPUCommandBuffer extends CommandBuffer {
|
||||
}
|
||||
}
|
||||
}
|
||||
return { wgpuBindGroups, wgpuDynOffsets };
|
||||
}
|
||||
|
||||
public dispatch (info: DispatchInfo): void {
|
||||
if (!this._curGPUPipelineState) {
|
||||
return;
|
||||
}
|
||||
// Prepare descriptor sets (same logic as bindStates)
|
||||
this._prepareDescriptorSets();
|
||||
|
||||
// Create compute pipeline
|
||||
this._curWebGPUPipelineState!.prepare(null!);
|
||||
|
||||
const computePipeline = this._curGPUPipelineState.nativePipeline as GPUComputePipeline;
|
||||
|
||||
// Build bind groups for compute pass
|
||||
const { wgpuBindGroups, wgpuDynOffsets } = this._collectBindGroups();
|
||||
|
||||
const func = (passEncoder: GPUComputePassEncoder): void => {
|
||||
passEncoder.setPipeline(computePipeline);
|
||||
const gpuBindGroupSize = wgpuBindGroups.length;
|
||||
for (let i = 0; i < gpuBindGroupSize; i++) {
|
||||
passEncoder.setBindGroup(i, wgpuBindGroups[i], wgpuDynOffsets[i]);
|
||||
}
|
||||
passEncoder.dispatchWorkgroups(info.groupCountX, info.groupCountY, info.groupCountZ);
|
||||
};
|
||||
this._computeFuncQueue.push(func);
|
||||
++this._numDispatches;
|
||||
this._isStateValid = false;
|
||||
}
|
||||
|
||||
public submitComputePass (): void {
|
||||
if (this._computeFuncQueue.length === 0) {
|
||||
return;
|
||||
}
|
||||
const device = WebGPUDeviceManager.instance;
|
||||
const nativeDevice = device.nativeDevice!;
|
||||
const cmdEncoder = nativeDevice.createCommandEncoder();
|
||||
const computePassEncoder = cmdEncoder.beginComputePass();
|
||||
this._computeFuncQueue.forEach((cb) => {
|
||||
cb(computePassEncoder);
|
||||
});
|
||||
computePassEncoder.end();
|
||||
nativeDevice.queue.submit([cmdEncoder.finish()]);
|
||||
this._computeFuncQueue.length = 0;
|
||||
}
|
||||
|
||||
protected bindStates (): void {
|
||||
if (!this._curGPUPipelineState) {
|
||||
return;
|
||||
}
|
||||
const gpuPipelineLayout = this._curGPUPipelineState.gpuPipelineLayout as IWebGPUGPUPipelineLayout;
|
||||
this._prepareDescriptorSets();
|
||||
const gpuIA = this._curGPUInputAssembler!;
|
||||
// only 4x MSAA is supported
|
||||
gpuIA.samples = samples > 1 ? 4 : 1;
|
||||
this._curWebGPUPipelineState!.prepare(gpuIA);
|
||||
// ----------------------------wgpu pipline state-----------------------------
|
||||
const wgpuPipeline = this._curGPUPipelineState.nativePipeline as GPURenderPipeline;
|
||||
const pplFunc = (passEncoder: GPURenderPassEncoder): void => {
|
||||
passEncoder.setPipeline(wgpuPipeline);
|
||||
};
|
||||
this._renderPassFuncQueue.push(pplFunc);
|
||||
const pipelineDesc = this._curGPUPipelineState.pipelineState;
|
||||
if (pipelineDesc && 'depthStencil' in pipelineDesc && pipelineDesc.depthStencil) {
|
||||
const stencilRef = this._curGPUPipelineState.stencilRef;
|
||||
const stencilRefFunc = (passEncoder: GPURenderPassEncoder): void => {
|
||||
passEncoder.setStencilReference(stencilRef);
|
||||
};
|
||||
this._renderPassFuncQueue.push(stencilRefFunc);
|
||||
}
|
||||
const { wgpuBindGroups, wgpuDynOffsets } = this._collectBindGroups();
|
||||
|
||||
const bgfunc = (passEncoder: GPURenderPassEncoder): void => {
|
||||
const gpuBindGroupSize = wgpuBindGroups.length;
|
||||
for (let i = 0; i < gpuBindGroupSize; i++) {
|
||||
let currBindGroup = wgpuBindGroups[i];
|
||||
if (!currBindGroup) {
|
||||
currBindGroup = (device.defaultResource.descSet as WebGPUDescriptorSet).gpuDescriptorSet.bindGroup;
|
||||
}
|
||||
// FIXME: this is a special sentence that 2 in 3 parameters I'm not certain.
|
||||
passEncoder.setBindGroup(i, currBindGroup, wgpuDynOffsets[i]);
|
||||
passEncoder.setBindGroup(i, wgpuBindGroups[i], wgpuDynOffsets[i]);
|
||||
}
|
||||
};
|
||||
this._renderPassFuncQueue.push(bgfunc);
|
||||
|
||||
@@ -35,6 +35,7 @@ import {
|
||||
TextureUsageBit,
|
||||
ShaderStageFlags,
|
||||
DescriptorType,
|
||||
MemoryAccessBit,
|
||||
Color, Rect, Viewport, BufferTextureCopy,
|
||||
SamplerInfo,
|
||||
FormatSize,
|
||||
@@ -1423,11 +1424,15 @@ export function createBindGroupLayoutEntry (currBind: DescriptorSetLayoutBinding
|
||||
|
||||
case DescriptorType.STORAGE_BUFFER:
|
||||
case DescriptorType.DYNAMIC_STORAGE_BUFFER:
|
||||
entry.buffer = {
|
||||
type: 'storage',
|
||||
hasDynamicOffset: type === DescriptorType.DYNAMIC_STORAGE_BUFFER,
|
||||
minBindingSize: undefined,
|
||||
};
|
||||
{
|
||||
const readOnly = (currBind.access & MemoryAccessBit.READ_ONLY) !== 0
|
||||
&& (currBind.access & MemoryAccessBit.WRITE_ONLY) === 0;
|
||||
entry.buffer = {
|
||||
type: readOnly ? 'read-only-storage' : 'storage',
|
||||
hasDynamicOffset: type === DescriptorType.DYNAMIC_STORAGE_BUFFER,
|
||||
minBindingSize: undefined,
|
||||
};
|
||||
}
|
||||
break;
|
||||
|
||||
case DescriptorType.SAMPLER_TEXTURE:
|
||||
|
||||
@@ -170,9 +170,17 @@ export class WebGPUDescriptorSet extends DescriptorSet {
|
||||
if (descType & (DescriptorType.DYNAMIC_STORAGE_BUFFER | DescriptorType.DYNAMIC_UNIFORM_BUFFER)) {
|
||||
this._dynamicOffsets.push(bindIdx);
|
||||
}
|
||||
} else if (descType & DESCRIPTOR_SAMPLER_TYPE) {
|
||||
if ((descType & DescriptorType.SAMPLER) !== DescriptorType.SAMPLER) {
|
||||
// texture
|
||||
} else if (descType & (DESCRIPTOR_SAMPLER_TYPE | DescriptorType.STORAGE_IMAGE)) {
|
||||
const isStorageImage = (descType & DescriptorType.STORAGE_IMAGE) === DescriptorType.STORAGE_IMAGE;
|
||||
if (isStorageImage) {
|
||||
// storage texture (compute read/write): bind the texture view, no sampler
|
||||
let currTex = this._textures[i] as WebGPUTexture;
|
||||
if (!currTex || (currTex.hasChange && !currTex.gpuTexture)) {
|
||||
currTex = device.defaultResource.texture;
|
||||
}
|
||||
this._bindTextureEntry(binding, currTex);
|
||||
} else if ((descType & DescriptorType.SAMPLER) !== DescriptorType.SAMPLER) {
|
||||
// sampled texture
|
||||
let currTex = this._textures[i] as WebGPUTexture;
|
||||
// null or destroyed?
|
||||
if (!currTex || (currTex.hasChange && !currTex.gpuTexture)) {
|
||||
@@ -185,9 +193,9 @@ export class WebGPUDescriptorSet extends DescriptorSet {
|
||||
this._bindTextureEntry(binding, currTex);
|
||||
}
|
||||
|
||||
if (!((descType & DescriptorType.STORAGE_IMAGE) === DescriptorType.STORAGE_IMAGE
|
||||
|| (descType & DescriptorType.INPUT_ATTACHMENT) === DescriptorType.INPUT_ATTACHMENT
|
||||
|| (descType & DescriptorType.TEXTURE) === DescriptorType.TEXTURE)) {
|
||||
if (!isStorageImage
|
||||
&& !((descType & DescriptorType.INPUT_ATTACHMENT) === DescriptorType.INPUT_ATTACHMENT
|
||||
|| (descType & DescriptorType.TEXTURE) === DescriptorType.TEXTURE)) {
|
||||
// sampler
|
||||
const currSampler = (this._samplers[i] || device.defaultResource.sampler) as WebGPUSampler;
|
||||
this._bindSamplerEntry(binding, currSampler);
|
||||
@@ -219,7 +227,12 @@ export class WebGPUDescriptorSet extends DescriptorSet {
|
||||
}
|
||||
|
||||
public prepare (force: boolean = false): void {
|
||||
const breakUpdate = !this._isResourceChange() && !force;
|
||||
const gpuDescriptorSet = this._gpuDescriptorSet;
|
||||
if (!gpuDescriptorSet) {
|
||||
return;
|
||||
}
|
||||
// Rebuild when forced, when the bind group has never been built, or when resources changed.
|
||||
const breakUpdate = gpuDescriptorSet.bindGroup && !this._isResourceChange() && !force;
|
||||
if (breakUpdate) return;
|
||||
this._isDirty = true;
|
||||
this._applyBindGroup();
|
||||
|
||||
@@ -53,7 +53,7 @@ import { WebGPUTexture } from './webgpu-texture';
|
||||
import { DefaultResources, hashCombineNum, hashCombineStr, webGPU, WebGPUDeviceManager } from './define';
|
||||
import {
|
||||
Filter, Format,
|
||||
QueueType, Feature, BufferTextureCopy, Rect, DescriptorSetInfo,
|
||||
QueueType, Feature, BufferTextureCopy, Rect, Size, DescriptorSetInfo,
|
||||
BufferInfo, BufferViewInfo, CommandBufferInfo, DeviceInfo,
|
||||
FramebufferInfo, InputAssemblerInfo, QueueInfo, RenderPassInfo, SamplerInfo,
|
||||
ShaderInfo, PipelineLayoutInfo, DescriptorSetLayoutInfo, TextureInfo, TextureViewInfo, GeneralBarrierInfo, TextureBarrierInfo,
|
||||
@@ -552,6 +552,22 @@ export class WebGPUDevice extends Device {
|
||||
this._caps.max3DTextureSize = limits.maxTextureDimension3D;
|
||||
this._caps.uboOffsetAlignment = limits.minUniformBufferOffsetAlignment;
|
||||
|
||||
// Compute limits are read from the device (not the adapter): no elevated
|
||||
// compute limits are requested, so these are the values validation enforces.
|
||||
const deviceLimits = device.limits;
|
||||
this._caps.maxComputeSharedMemorySize = deviceLimits.maxComputeWorkgroupStorageSize;
|
||||
this._caps.maxComputeWorkGroupInvocations = deviceLimits.maxComputeInvocationsPerWorkgroup;
|
||||
this._caps.maxComputeWorkGroupSize = new Size(
|
||||
deviceLimits.maxComputeWorkgroupSizeX,
|
||||
deviceLimits.maxComputeWorkgroupSizeY,
|
||||
deviceLimits.maxComputeWorkgroupSizeZ,
|
||||
);
|
||||
this._caps.maxComputeWorkGroupCount = new Size(
|
||||
deviceLimits.maxComputeWorkgroupsPerDimension,
|
||||
deviceLimits.maxComputeWorkgroupsPerDimension,
|
||||
deviceLimits.maxComputeWorkgroupsPerDimension,
|
||||
);
|
||||
|
||||
const features = this._adapter!.features;
|
||||
// FIXME: require by query
|
||||
this._multiDrawIndirect = false;
|
||||
@@ -560,6 +576,7 @@ export class WebGPUDevice extends Device {
|
||||
this._features[Feature.ELEMENT_INDEX_UINT] = true;
|
||||
this._features[Feature.INSTANCED_ARRAYS] = true;
|
||||
this._features[Feature.MULTIPLE_RENDER_TARGETS] = true;
|
||||
this._features[Feature.COMPUTE_SHADER] = true;
|
||||
this.initFormatFeatures(features);
|
||||
|
||||
this._queue = this.createQueue(new QueueInfo(QueueType.GRAPHICS));
|
||||
@@ -684,6 +701,7 @@ export class WebGPUDevice extends Device {
|
||||
public present (): void {
|
||||
const queue = (this._queue as unknown as WebGPUQueue);
|
||||
this._numDrawCalls = queue.numDrawCalls;
|
||||
this._numDispatches = queue.numDispatches;
|
||||
this._numInstances = queue.numInstances;
|
||||
this._numTris = queue.numTris;
|
||||
queue.clear();
|
||||
|
||||
@@ -241,8 +241,8 @@ export interface IWebGPUGPUPipelineState {
|
||||
bs: BlendState;
|
||||
dynamicStates: DynamicStateFlagBit[];
|
||||
gpuRenderPass: IWebGPUGPURenderPass | null;
|
||||
pipelineState: GPURenderPipelineDescriptor | undefined;
|
||||
nativePipeline: GPUPipelineBase | undefined;
|
||||
pipelineState: GPURenderPipelineDescriptor | GPUComputePipelineDescriptor | undefined;
|
||||
nativePipeline: GPURenderPipeline | GPUComputePipeline | undefined;
|
||||
}
|
||||
|
||||
export interface IWebGPUGPUDescriptor {
|
||||
|
||||
@@ -26,7 +26,7 @@ import { PipelineState, PipelineStateInfo } from '../base/pipeline-state';
|
||||
import { IWebGPUGPUInputAssembler, IWebGPUGPUPipelineState } from './webgpu-gpu-objects';
|
||||
import { WebGPURenderPass } from './webgpu-render-pass';
|
||||
import { WebGPUShader } from './webgpu-shader';
|
||||
import { BlendOp, CullMode, DynamicStateFlagBit, Format, FormatInfos, PrimitiveMode, ShaderStageFlagBit } from '../base/define';
|
||||
import { BlendOp, CullMode, DynamicStateFlagBit, Format, FormatInfos, PipelineBindPoint, PrimitiveMode, ShaderStageFlagBit } from '../base/define';
|
||||
import { WebGPUPipelineLayout } from './webgpu-pipeline-layout';
|
||||
import {
|
||||
GFXFormatToWGPUFormat,
|
||||
@@ -81,124 +81,156 @@ export class WebGPUPipelineState extends PipelineState {
|
||||
}
|
||||
}
|
||||
|
||||
// colorstates
|
||||
const colorAttachments = this._renderPass.colorAttachments;
|
||||
const colorDescs: GPUColorTargetState[] = [];
|
||||
const colAttachmentSize = colorAttachments.length;
|
||||
const pipelineLayoutObj = info.pipelineLayout as WebGPUPipelineLayout;
|
||||
for (let i = 0; i < colAttachmentSize; i++) {
|
||||
const colDesc: GPUColorTargetState = {
|
||||
format: GFXFormatToWGPUFormat(colorAttachments[i].format),
|
||||
writeMask: WebGPUBlendMask(this._bs.targets[i].blendColorMask),
|
||||
};
|
||||
if (this._bs.targets[i].blend) {
|
||||
colDesc.blend = {
|
||||
color: {
|
||||
dstFactor: WebGPUBlendFactors[this._bs.targets[i].blendDst],
|
||||
operation: WebGPUBlendOps[this._bs.targets[i].blendEq === BlendOp.MAX ? BlendOp.ADD : this._bs.targets[i].blendEq],
|
||||
srcFactor: WebGPUBlendFactors[this._bs.targets[i].blendSrc],
|
||||
},
|
||||
alpha: {
|
||||
dstFactor: WebGPUBlendFactors[this._bs.targets[i].blendDstAlpha],
|
||||
operation: WebGPUBlendOps[this._bs.targets[i].blendAlphaEq === BlendOp.MAX ? BlendOp.ADD : this._bs.targets[i].blendAlphaEq],
|
||||
srcFactor: WebGPUBlendFactors[this._bs.targets[i].blendSrcAlpha],
|
||||
},
|
||||
};
|
||||
}
|
||||
colorDescs.push(colDesc);
|
||||
}
|
||||
|
||||
let vertexStage: GPUProgrammableStage;
|
||||
let fragmentStage: GPUProgrammableStage;
|
||||
const shaderStages = (this._shader as WebGPUShader).gpuShader.gpuStages;
|
||||
const stageSize = shaderStages.length;
|
||||
for (let i = 0; i < stageSize; i++) {
|
||||
if (shaderStages[i].type === ShaderStageFlagBit.VERTEX) { vertexStage = shaderStages[i].gpuShader!; }
|
||||
if (shaderStages[i].type === ShaderStageFlagBit.FRAGMENT) { fragmentStage = shaderStages[i].gpuShader!; }
|
||||
}
|
||||
|
||||
const gpuShader = info.shader as WebGPUShader;
|
||||
const pipelineLayoutObj = info.pipelineLayout as WebGPUPipelineLayout;
|
||||
const shaderStages = gpuShader.gpuShader.gpuStages;
|
||||
|
||||
const shaderAttrs = gpuShader.attributes;
|
||||
const attrsSize = shaderAttrs.length;
|
||||
for (let i = 0; i < attrsSize; i++) {
|
||||
this._locations.set(shaderAttrs[i].name, shaderAttrs[i].location);
|
||||
}
|
||||
const stripTopology = (info.primitive === PrimitiveMode.LINE_STRIP || info.primitive === PrimitiveMode.TRIANGLE_STRIP);
|
||||
const renderPplDesc: GPURenderPipelineDescriptor = {
|
||||
layout: pipelineLayoutObj.gpuPipelineLayout!.nativePipelineLayout,
|
||||
vertex: {
|
||||
module: vertexStage!.module,
|
||||
entryPoint: 'main',
|
||||
buffers: [],
|
||||
},
|
||||
primitive: {
|
||||
topology: WebPUPrimitives[info.primitive],
|
||||
frontFace: this._rs.isFrontFaceCCW ? 'ccw' : 'cw',
|
||||
cullMode: this._rs.cullMode === CullMode.NONE ? 'none' : (this._rs.cullMode === CullMode.FRONT) ? 'front' : 'back',
|
||||
},
|
||||
|
||||
fragment: {
|
||||
module: fragmentStage!.module,
|
||||
entryPoint: 'main',
|
||||
targets: colorDescs,
|
||||
},
|
||||
};
|
||||
if (stripTopology) renderPplDesc.primitive!.stripIndexFormat = 'uint16';
|
||||
|
||||
// depthstencil states
|
||||
let stencilRef = 0;
|
||||
if (this._renderPass.depthStencilAttachment?.format !== Format.UNKNOWN) {
|
||||
const dssDesc = {} as GPUDepthStencilState;
|
||||
dssDesc.format = GFXFormatToWGPUFormat(this._renderPass.depthStencilAttachment!.format);
|
||||
dssDesc.depthWriteEnabled = this._dss.depthWrite;
|
||||
dssDesc.depthCompare = this._dss.depthTest ? WebGPUCompereFunc[this._dss.depthFunc] : 'always';
|
||||
let stencilReadMask = 0;
|
||||
let stencilWriteMask = 0;
|
||||
|
||||
if (this._dss.stencilTestFront) {
|
||||
dssDesc.stencilFront = {
|
||||
compare: WebGPUCompereFunc[this._dss.stencilFuncFront],
|
||||
depthFailOp: WebGPUStencilOp[this._dss.stencilZFailOpFront],
|
||||
passOp: WebGPUStencilOp[this._dss.stencilPassOpFront],
|
||||
failOp: WebGPUStencilOp[this._dss.stencilFailOpFront],
|
||||
};
|
||||
stencilReadMask |= this._dss.stencilReadMaskFront;
|
||||
stencilWriteMask |= this._dss.stencilWriteMaskFront;
|
||||
stencilRef |= this._dss.stencilRefFront;
|
||||
if (info.bindPoint === PipelineBindPoint.COMPUTE) {
|
||||
// ---- Compute Pipeline ----
|
||||
let computeStage: GPUProgrammableStage | undefined;
|
||||
const stageSize = shaderStages.length;
|
||||
for (let i = 0; i < stageSize; i++) {
|
||||
if (shaderStages[i].type === ShaderStageFlagBit.COMPUTE) {
|
||||
computeStage = shaderStages[i].gpuShader!;
|
||||
}
|
||||
}
|
||||
if (this._dss.stencilTestBack) {
|
||||
dssDesc.stencilBack = {
|
||||
compare: WebGPUCompereFunc[this._dss.stencilFuncBack],
|
||||
depthFailOp: WebGPUStencilOp[this._dss.stencilZFailOpBack],
|
||||
passOp: WebGPUStencilOp[this._dss.stencilPassOpBack],
|
||||
failOp: WebGPUStencilOp[this._dss.stencilFailOpBack],
|
||||
};
|
||||
stencilReadMask |= this._dss.stencilReadMaskBack;
|
||||
stencilWriteMask |= this._dss.stencilWriteMaskBack;
|
||||
stencilRef |= this._dss.stencilRefBack;
|
||||
}
|
||||
dssDesc.stencilReadMask = stencilReadMask;
|
||||
dssDesc.stencilWriteMask = stencilWriteMask;
|
||||
dssDesc.depthBias = this._rs.depthBias;
|
||||
dssDesc.depthBiasSlopeScale = this._rs.depthBiasSlop;
|
||||
dssDesc.depthBiasClamp = this._rs.depthBiasClamp;
|
||||
renderPplDesc.depthStencil = dssDesc;
|
||||
}
|
||||
|
||||
this._gpuPipelineState = {
|
||||
gpuPrimitive: WebPUPrimitives[info.primitive],
|
||||
gpuShader: gpuShader.gpuShader,
|
||||
gpuPipelineLayout: pipelineLayoutObj.gpuPipelineLayout,
|
||||
rs: info.rasterizerState,
|
||||
dss: info.depthStencilState,
|
||||
stencilRef,
|
||||
bs: info.blendState,
|
||||
gpuRenderPass: (info.renderPass as WebGPURenderPass).gpuRenderPass,
|
||||
dynamicStates,
|
||||
pipelineState: renderPplDesc,
|
||||
nativePipeline: undefined,
|
||||
};
|
||||
const computeDesc: GPUComputePipelineDescriptor = {
|
||||
layout: pipelineLayoutObj.gpuPipelineLayout!.nativePipelineLayout,
|
||||
compute: computeStage!,
|
||||
};
|
||||
|
||||
this._gpuPipelineState = {
|
||||
gpuPrimitive: 'triangle-list' as GPUPrimitiveTopology,
|
||||
gpuShader: gpuShader.gpuShader,
|
||||
gpuPipelineLayout: pipelineLayoutObj.gpuPipelineLayout,
|
||||
rs: info.rasterizerState,
|
||||
dss: info.depthStencilState,
|
||||
stencilRef: 0,
|
||||
bs: info.blendState,
|
||||
gpuRenderPass: null,
|
||||
dynamicStates,
|
||||
pipelineState: computeDesc,
|
||||
nativePipeline: undefined,
|
||||
};
|
||||
} else {
|
||||
// ---- Render Pipeline ----
|
||||
// colorstates
|
||||
const colorAttachments = this._renderPass.colorAttachments;
|
||||
const colorDescs: GPUColorTargetState[] = [];
|
||||
const colAttachmentSize = colorAttachments.length;
|
||||
for (let i = 0; i < colAttachmentSize; i++) {
|
||||
const colDesc: GPUColorTargetState = {
|
||||
format: GFXFormatToWGPUFormat(colorAttachments[i].format),
|
||||
writeMask: WebGPUBlendMask(this._bs.targets[i].blendColorMask),
|
||||
};
|
||||
if (this._bs.targets[i].blend) {
|
||||
colDesc.blend = {
|
||||
color: {
|
||||
dstFactor: WebGPUBlendFactors[this._bs.targets[i].blendDst],
|
||||
operation: WebGPUBlendOps[this._bs.targets[i].blendEq === BlendOp.MAX ? BlendOp.ADD : this._bs.targets[i].blendEq],
|
||||
srcFactor: WebGPUBlendFactors[this._bs.targets[i].blendSrc],
|
||||
},
|
||||
alpha: {
|
||||
dstFactor: WebGPUBlendFactors[this._bs.targets[i].blendDstAlpha],
|
||||
operation: WebGPUBlendOps[
|
||||
this._bs.targets[i].blendAlphaEq === BlendOp.MAX ? BlendOp.ADD : this._bs.targets[i].blendAlphaEq],
|
||||
srcFactor: WebGPUBlendFactors[this._bs.targets[i].blendSrcAlpha],
|
||||
},
|
||||
};
|
||||
}
|
||||
colorDescs.push(colDesc);
|
||||
}
|
||||
|
||||
let vertexStage: GPUProgrammableStage;
|
||||
let fragmentStage: GPUProgrammableStage;
|
||||
const stageSize = shaderStages.length;
|
||||
for (let i = 0; i < stageSize; i++) {
|
||||
if (shaderStages[i].type === ShaderStageFlagBit.VERTEX) { vertexStage = shaderStages[i].gpuShader!; }
|
||||
if (shaderStages[i].type === ShaderStageFlagBit.FRAGMENT) { fragmentStage = shaderStages[i].gpuShader!; }
|
||||
}
|
||||
|
||||
const shaderAttrs = gpuShader.attributes;
|
||||
const attrsSize = shaderAttrs.length;
|
||||
for (let i = 0; i < attrsSize; i++) {
|
||||
this._locations.set(shaderAttrs[i].name, shaderAttrs[i].location);
|
||||
}
|
||||
const stripTopology = (info.primitive === PrimitiveMode.LINE_STRIP || info.primitive === PrimitiveMode.TRIANGLE_STRIP);
|
||||
const renderPplDesc: GPURenderPipelineDescriptor = {
|
||||
layout: pipelineLayoutObj.gpuPipelineLayout!.nativePipelineLayout,
|
||||
vertex: {
|
||||
module: vertexStage!.module,
|
||||
entryPoint: 'main',
|
||||
buffers: [],
|
||||
},
|
||||
primitive: {
|
||||
topology: WebPUPrimitives[info.primitive],
|
||||
frontFace: this._rs.isFrontFaceCCW ? 'ccw' : 'cw',
|
||||
cullMode: this._rs.cullMode === CullMode.NONE ? 'none' : (this._rs.cullMode === CullMode.FRONT) ? 'front' : 'back',
|
||||
},
|
||||
|
||||
fragment: {
|
||||
module: fragmentStage!.module,
|
||||
entryPoint: 'main',
|
||||
targets: colorDescs,
|
||||
},
|
||||
};
|
||||
if (stripTopology) renderPplDesc.primitive!.stripIndexFormat = 'uint16';
|
||||
|
||||
// depthstencil states
|
||||
let stencilRef = 0;
|
||||
if (this._renderPass.depthStencilAttachment?.format !== Format.UNKNOWN) {
|
||||
const dssDesc = {} as GPUDepthStencilState;
|
||||
dssDesc.format = GFXFormatToWGPUFormat(this._renderPass.depthStencilAttachment!.format);
|
||||
dssDesc.depthWriteEnabled = this._dss.depthWrite;
|
||||
dssDesc.depthCompare = this._dss.depthTest ? WebGPUCompereFunc[this._dss.depthFunc] : 'always';
|
||||
let stencilReadMask = 0;
|
||||
let stencilWriteMask = 0;
|
||||
|
||||
if (this._dss.stencilTestFront) {
|
||||
dssDesc.stencilFront = {
|
||||
compare: WebGPUCompereFunc[this._dss.stencilFuncFront],
|
||||
depthFailOp: WebGPUStencilOp[this._dss.stencilZFailOpFront],
|
||||
passOp: WebGPUStencilOp[this._dss.stencilPassOpFront],
|
||||
failOp: WebGPUStencilOp[this._dss.stencilFailOpFront],
|
||||
};
|
||||
stencilReadMask |= this._dss.stencilReadMaskFront;
|
||||
stencilWriteMask |= this._dss.stencilWriteMaskFront;
|
||||
stencilRef |= this._dss.stencilRefFront;
|
||||
}
|
||||
if (this._dss.stencilTestBack) {
|
||||
dssDesc.stencilBack = {
|
||||
compare: WebGPUCompereFunc[this._dss.stencilFuncBack],
|
||||
depthFailOp: WebGPUStencilOp[this._dss.stencilZFailOpBack],
|
||||
passOp: WebGPUStencilOp[this._dss.stencilPassOpBack],
|
||||
failOp: WebGPUStencilOp[this._dss.stencilFailOpBack],
|
||||
};
|
||||
stencilReadMask |= this._dss.stencilReadMaskBack;
|
||||
stencilWriteMask |= this._dss.stencilWriteMaskBack;
|
||||
stencilRef |= this._dss.stencilRefBack;
|
||||
}
|
||||
dssDesc.stencilReadMask = stencilReadMask;
|
||||
dssDesc.stencilWriteMask = stencilWriteMask;
|
||||
dssDesc.depthBias = this._rs.depthBias;
|
||||
dssDesc.depthBiasSlopeScale = this._rs.depthBiasSlop;
|
||||
dssDesc.depthBiasClamp = this._rs.depthBiasClamp;
|
||||
renderPplDesc.depthStencil = dssDesc;
|
||||
}
|
||||
|
||||
this._gpuPipelineState = {
|
||||
gpuPrimitive: WebPUPrimitives[info.primitive],
|
||||
gpuShader: gpuShader.gpuShader,
|
||||
gpuPipelineLayout: pipelineLayoutObj.gpuPipelineLayout,
|
||||
rs: info.rasterizerState,
|
||||
dss: info.depthStencilState,
|
||||
stencilRef,
|
||||
bs: info.blendState,
|
||||
gpuRenderPass: (info.renderPass as WebGPURenderPass).gpuRenderPass,
|
||||
dynamicStates,
|
||||
pipelineState: renderPplDesc,
|
||||
nativePipeline: undefined,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
protected _getShaderLocation (name: string): number | undefined {
|
||||
@@ -215,9 +247,22 @@ export class WebGPUPipelineState extends PipelineState {
|
||||
if (this._gpuPipelineState!.nativePipeline && !forceUpdate) {
|
||||
return;
|
||||
}
|
||||
const webgpuDevice = (WebGPUDeviceManager.instance);
|
||||
const nativeDevice = webgpuDevice.nativeDevice;
|
||||
|
||||
const pipelineState = this._gpuPipelineState!.pipelineState!;
|
||||
// Compute pipeline: no vertex attributes, no multisample
|
||||
if ('compute' in pipelineState) {
|
||||
const nativePipeline = nativeDevice?.createComputePipeline(
|
||||
pipelineState,
|
||||
);
|
||||
this._gpuPipelineState!.nativePipeline = nativePipeline;
|
||||
return;
|
||||
}
|
||||
|
||||
// Render pipeline
|
||||
const gpuShader = this.shader;
|
||||
const shaderAttrs = gpuShader.attributes;
|
||||
const pipelineState = this._gpuPipelineState!.pipelineState!;
|
||||
const vertexAttrs: GPUVertexBufferLayout[] = [];
|
||||
const emptyPushAttr: string[] = [];
|
||||
const streamCount = ia.gpuVertexBuffers.length;
|
||||
@@ -272,8 +317,6 @@ export class WebGPUPipelineState extends PipelineState {
|
||||
|
||||
pipelineState.vertex.buffers = vertexAttrs;
|
||||
pipelineState.multisample = { count: ia.samples };
|
||||
const webgpuDevice = (WebGPUDeviceManager.instance);
|
||||
const nativeDevice = webgpuDevice.nativeDevice;
|
||||
const nativePipeline = nativeDevice?.createRenderPipeline(pipelineState);
|
||||
this._gpuPipelineState!.nativePipeline = nativePipeline;
|
||||
}
|
||||
|
||||
@@ -29,6 +29,7 @@ import { QueueInfo } from '../base/define';
|
||||
|
||||
export class WebGPUQueue extends Queue {
|
||||
public numDrawCalls = 0;
|
||||
public numDispatches = 0;
|
||||
public numInstances = 0;
|
||||
public numTris = 0;
|
||||
|
||||
@@ -51,6 +52,7 @@ export class WebGPUQueue extends Queue {
|
||||
for (let i = 0; i < cmdBuffSize; i++) {
|
||||
const cmdBuff = cmdBuffs[i] as WebGPUCommandBuffer;
|
||||
this.numDrawCalls += cmdBuff.numDrawCalls;
|
||||
this.numDispatches += cmdBuff.numDispatches;
|
||||
this.numInstances += cmdBuff.numInstances;
|
||||
this.numTris += cmdBuff.numTris;
|
||||
}
|
||||
@@ -59,6 +61,7 @@ export class WebGPUQueue extends Queue {
|
||||
|
||||
public clear (): void {
|
||||
this.numDrawCalls = 0;
|
||||
this.numDispatches = 0;
|
||||
this.numInstances = 0;
|
||||
this.numTris = 0;
|
||||
}
|
||||
|
||||
+13
-5
@@ -24,7 +24,7 @@
|
||||
THE SOFTWARE.
|
||||
*/
|
||||
|
||||
import { EDITOR_NOT_IN_PREVIEW, HTML5, NATIVE } from 'internal:constants';
|
||||
import { EDITOR_NOT_IN_PREVIEW, HTML5, NATIVE, WECHAT } from 'internal:constants';
|
||||
import { AccelerometerInputSource, GamepadInputDevice, HMDInputDevice, HandheldInputDevice,
|
||||
HandleInputDevice, KeyboardInputSource, MouseInputSource, TouchInputSource } from 'pal/input';
|
||||
import { touchManager } from '../../pal/input/touch-manager';
|
||||
@@ -380,9 +380,15 @@ export class Input {
|
||||
}
|
||||
|
||||
if (sys.hasFeature(sys.Feature.EVENT_MOUSE)) {
|
||||
// Game View still needs mouse-to-touch simulation even when INPUT_TOUCH is true.
|
||||
// WeChat PC already maps left mouse clicks to touch events.
|
||||
// https://developers.weixin.qq.com/minigame/dev/guide/open-ability/pc-game.html
|
||||
const shouldSimulateTouch = !(WECHAT && sys.hasFeature(sys.Feature.INPUT_TOUCH));
|
||||
mouseInput.on(InputEventType.MOUSE_DOWN, (event): void => {
|
||||
self._needSimulateTouchMoveEvent = true;
|
||||
self._simulateEventTouch(event);
|
||||
if (shouldSimulateTouch) {
|
||||
self._needSimulateTouchMoveEvent = true;
|
||||
self._simulateEventTouch(event);
|
||||
}
|
||||
self._dispatchEventMouse(event);
|
||||
});
|
||||
mouseInput.on(InputEventType.MOUSE_MOVE, (event): void => {
|
||||
@@ -392,8 +398,10 @@ export class Input {
|
||||
self._dispatchEventMouse(event);
|
||||
});
|
||||
mouseInput.on(InputEventType.MOUSE_UP, (event): void => {
|
||||
self._needSimulateTouchMoveEvent = false;
|
||||
self._simulateEventTouch(event);
|
||||
if (shouldSimulateTouch) {
|
||||
self._needSimulateTouchMoveEvent = false;
|
||||
self._simulateEventTouch(event);
|
||||
}
|
||||
self._dispatchEventMouse(event);
|
||||
});
|
||||
mouseInput.on(InputEventType.MOUSE_WHEEL, (event): void => {
|
||||
|
||||
@@ -24,6 +24,12 @@
|
||||
|
||||
import './intersect';
|
||||
|
||||
// NOTE: the worker subsystem (`./worker`, `./worker-pool`) is deliberately
|
||||
// NOT re-exported here. `cocos/misc` is part of the always-on `base` feature, so anything exported
|
||||
// from this file ships in every build's main bundle. The worker subsystem is exposed through the
|
||||
// optional `worker` and `worker-pool` features instead (see their entries in `exports/` and
|
||||
// cc.config.json). Projects enabling only `worker` do not include the pool scheduler.
|
||||
|
||||
export { Camera } from './camera-component';
|
||||
export { ModelRenderer } from './model-renderer';
|
||||
export { Renderer } from './renderer';
|
||||
|
||||
@@ -0,0 +1,982 @@
|
||||
/*
|
||||
Copyright (c) 2018-2023 Xiamen Yaji Software Co., Ltd.
|
||||
|
||||
http://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 type { IPlatformWorkerBackend } from 'pal/worker';
|
||||
import {
|
||||
WorkerTask, IWorker, getOptimalWorkerCount,
|
||||
getWorkerBackend, resetWorkerBackendCache,
|
||||
} from './worker';
|
||||
import { getError, warnID } from '../core/platform/debug';
|
||||
|
||||
/** Execution state, independent of the host platform. */
|
||||
export type WorkerExecutionMode = 'worker' | 'sync' | 'none';
|
||||
|
||||
/**
|
||||
* @en
|
||||
* Infrastructure failures (a worker that never replies / times out, errors out, fails to spawn, or
|
||||
* speaks a malformed protocol) tolerated before a script-mode pool gives up on the real worker and
|
||||
* degrades to single-threaded execution via `options.fallback`. Kept at 1: each of these signals
|
||||
* means the worker backend is not functioning for this script, so retrying on a real worker would
|
||||
* only fail again — and on the seven single-worker mini-game platforms a retry would also re-occupy
|
||||
* the one worker slot. A task-level computation error (the worker replies `{ ok: false }`) is NOT an
|
||||
* infrastructure failure and never counts toward this.
|
||||
* @zh
|
||||
* 脚本模式的池在放弃真 Worker、降级为 `options.fallback` 单线程执行之前,所能容忍的**基础设施失败**
|
||||
* 次数(Worker 永不回复 / 超时、报错、创建失败、或回发非法协议)。取 1:上述任一信号都意味着该脚本的
|
||||
* Worker 后端不可用,再用真 Worker 重试只会再次失败——而且在 7 个单 Worker 小游戏平台上重试还会重新
|
||||
* 占掉那唯一的槽位。任务级计算错误(Worker 回发 `{ ok: false }`)**不算**基础设施失败,不计入此数。
|
||||
*/
|
||||
const DEGRADE_AFTER_FAILURES = 1;
|
||||
|
||||
/**
|
||||
* @en Options for [[WorkerPool]].
|
||||
* @zh [[WorkerPool]] 的选项。
|
||||
*/
|
||||
export interface WorkerPoolOptions {
|
||||
/**
|
||||
* @en
|
||||
* Maximum number of concurrent workers. Extra tasks are queued and dispatched when a worker frees up.
|
||||
* Default is `1`.
|
||||
* @zh
|
||||
* 并发 Worker 的最大数量。多余的任务会排队,等某个 Worker 空闲后再派发。默认 `1`。
|
||||
*/
|
||||
maxWorkers?: number;
|
||||
/**
|
||||
* @en
|
||||
* Idle release time in milliseconds. An idle worker is terminated after being idle for this long,
|
||||
* to avoid keeping threads (and their memory) alive forever. Set to `0` to never release idle workers.
|
||||
* Default is `1000` (1 second).
|
||||
* @zh
|
||||
* 空闲释放时间(毫秒)。Worker 空闲超过该时长后会被终止,避免线程(及其内存)长期驻留。
|
||||
* 设为 `0` 表示永不释放空闲 Worker。默认 `1000`(1 秒)。
|
||||
*/
|
||||
idleReleaseAfter?: number;
|
||||
/**
|
||||
* @en
|
||||
* Synchronous fallback task (**script mode only**). It must compute the same result as the worker
|
||||
* script's `runTask(args)` from the same `args`. When NO worker backend is available at all —
|
||||
* the platform worker environment is not fully set up ([[checkWorkerScript]] not ready), or the
|
||||
* platform has no worker API (Taobao mini-game, native) and there is no global `Worker` either —
|
||||
* tasks run single-threaded on the main thread with this function instead of rejecting. If omitted
|
||||
* in that situation, `run()` rejects with a descriptive error.
|
||||
* Runtime failures retry non-transferred arguments only. Transferred tasks reject because
|
||||
* ownership has moved; subsequent tasks use this fallback. Fallback computation must be retry-safe.
|
||||
* @zh
|
||||
* 同步降级任务函数(**仅脚本模式**)。它必须与 worker 脚本里的 `runTask(args)` 用相同的 `args`
|
||||
* 算出相同的结果。当所有 Worker 后端都不可用时——平台 Worker 环境未设置完整
|
||||
* ([[checkWorkerScript]] 不 ready),或平台根本没有 Worker API(淘宝小游戏、原生)且也没有全局
|
||||
* `Worker`——任务将用它在主线程**单线程**执行,而不是直接 reject。若此时未提供该函数,
|
||||
* `run()` 会以带说明的错误 reject。
|
||||
* 运行时失败仅重试未移交所有权的参数;已 transfer 的任务拒绝,后续任务仍使用 fallback。
|
||||
* fallback 应为可安全重试的计算逻辑。
|
||||
*/
|
||||
fallback?: WorkerTask;
|
||||
/**
|
||||
* @en
|
||||
* Per-task timeout in milliseconds. When exceeded, the task rejects with a timeout error and the
|
||||
* worker running it is terminated so the pool spawns a fresh one.
|
||||
*
|
||||
* Default is `0` (no timeout). A timeout is the ONLY safety net against a worker that never
|
||||
* replies — a worker script that fails to post back, or a worker silently reclaimed by the
|
||||
* platform. Some platforms make this materially more likely: not every mini-game platform exposes
|
||||
* `onError` (Huawei quick game documents only create/postMessage/onMessage/terminate), so an
|
||||
* internal failure there produces no error event at all.
|
||||
*
|
||||
* Recommended for script mode in production: pick a bound well above your worst-case task duration.
|
||||
* @zh
|
||||
* 单个任务的超时时间(毫秒)。超时后任务以超时错误 reject,运行它的 Worker 会被终止,
|
||||
* 池随后重建一个。
|
||||
*
|
||||
* 默认 `0`(不超时)。超时是对"Worker 永不回复"的**唯一**兜底——比如 Worker 脚本忘记回发结果,
|
||||
* 或 Worker 被平台静默回收。部分平台让这种情况更容易发生:并非每个小游戏平台都暴露 `onError`
|
||||
* (华为快游戏只文档化了 create/postMessage/onMessage/terminate),那里的内部失败根本不会产生错误事件。
|
||||
*
|
||||
* 生产环境的脚本模式建议设置超时:取一个明显高于最坏情况任务耗时的上界。
|
||||
*/
|
||||
timeout?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* @en
|
||||
* A pool of workers bound to a single self-contained task function (function mode) or to a
|
||||
* pre-packaged worker script (script mode — the only way to get a real worker on any mini-game
|
||||
* platform, because they forbid rebuilding a function from source).
|
||||
*
|
||||
* It is designed for *high-frequency* workloads (e.g. per-frame physics / crowd simulation / data processing):
|
||||
* instead of spawning and tearing down a worker for every call — which costs a Blob URL round-trip and
|
||||
* thread startup — the pool keeps a bounded set of workers alive and reuses them, releasing idle workers
|
||||
* after [[WorkerPoolOptions.idleReleaseAfter]].
|
||||
*
|
||||
* IMPORTANT — a pool is not always a source of parallelism. On seven of the nine mini-game platforms
|
||||
* (ByteDance, Alipay, Baidu, Huawei, OPPO, vivo, Xiaomi) and on WeChat V1, the platform allows exactly
|
||||
* ONE worker, so the pool is capped to one worker no matter what `maxWorkers` says. There it is an
|
||||
* **asynchronous offload queue**: it keeps a long task off the main thread, but it cannot run two tasks
|
||||
* at once. Gate features that need true parallelism on
|
||||
* [[getWorkerCapabilities]]`()`.parallel, not on whether a worker exists.
|
||||
*
|
||||
* In function mode, on platforms that cannot build a worker from a serialized string (every mini-game
|
||||
* platform, and native) each task simply runs synchronously on the main thread, so the pool is a
|
||||
* transparent no-op wrapper. To get a real worker on a mini-game platform, use script mode:
|
||||
* `new WorkerPool('workers/my-task/index.js')` — the pool then creates its worker from a pre-packaged
|
||||
* script via `minigame.createWorker` (see the constructor and the bundled template).
|
||||
*
|
||||
* For *CPU-bound* workloads on a genuinely parallel platform, pass [[getOptimalWorkerCount]] as
|
||||
* `maxWorkers` to parallelize across the available cores (leaving one core for the main thread). Note
|
||||
* that `maxWorkers` only matters when you submit several independent tasks concurrently — a single
|
||||
* queued task always uses exactly one worker.
|
||||
*
|
||||
* @zh
|
||||
* 绑定到单个自包含任务函数(函数模式)或预打包 Worker 脚本(脚本模式——这是在任何小游戏平台上获得
|
||||
* 真 Worker 的**唯一**方式,因为它们禁止用源码重建函数)的 Worker 池。
|
||||
*
|
||||
* 它面向*高频*负载(如逐帧的物理模拟、人群模拟、数据处理):与其每次调用都创建再销毁一个 Worker——
|
||||
* 那会付出 Blob URL 往返和线程启动的成本——池会保活一个有上限的 Worker 集合并复用,
|
||||
* 空闲超过 [[WorkerPoolOptions.idleReleaseAfter]] 的 Worker 会被释放。
|
||||
*
|
||||
* **重要——池并不总是并行来源。** 9 个小游戏平台中有 7 个(抖音、支付宝、百度、华为、OPPO、vivo、小米)
|
||||
* 以及微信 V1,平台只允许**恰好 1 个** Worker,因此无论 `maxWorkers` 传什么,池都会被封顶到 1 个。
|
||||
* 在这些平台上它是一个**异步卸载队列**:能把长任务从主线程挪走,但无法同时跑两个任务。
|
||||
* 需要真并行的特性,请以 [[getWorkerCapabilities]]`()`.parallel 为准,而不是以"有没有 Worker"为准。
|
||||
*
|
||||
* 在函数模式下,凡是无法从序列化字符串构建 Worker 的平台(全部小游戏平台、原生),每个任务直接在主线程
|
||||
* 同步执行,因此池是一个透明的空包装。小游戏平台上若要真 Worker,请用脚本模式:
|
||||
* `new WorkerPool('workers/my-task/index.js')`——池会通过 `minigame.createWorker`
|
||||
* 从预打包脚本创建 Worker(参见构造函数与随附模板)。
|
||||
*
|
||||
* 对于*真正可并行*平台上的 *CPU 密集型*负载,可将 [[getOptimalWorkerCount]] 作为 `maxWorkers` 传入,
|
||||
* 跨可用核心并行(给主线程留一个核心)。注意:只有当你*同时*提交多个独立任务时 `maxWorkers` 才起作用——
|
||||
* 单个排队任务始终只用一个 Worker。
|
||||
*
|
||||
* @example
|
||||
* Function mode (Web real-parallel; mini-game / native transparent sync fallback):
|
||||
* ```ts
|
||||
* const pool = new WorkerPool((n: number) => {
|
||||
* let acc = 0;
|
||||
* for (let i = 0; i < n; i++) acc += Math.sqrt(i);
|
||||
* return acc;
|
||||
* }, { maxWorkers: getOptimalWorkerCount(), idleReleaseAfter: 1000 });
|
||||
*
|
||||
* const result = await pool.run([1_000_000]);
|
||||
* // ...
|
||||
* pool.terminate();
|
||||
* ```
|
||||
*
|
||||
* Script mode (a real worker on Web AND every mini-game platform that has one):
|
||||
* ```ts
|
||||
* // Backend chain resolved at construction: platform worker (only when fully set up — see
|
||||
* // checkWorkerScript) → global Worker → single-threaded via options.fallback → run() rejects.
|
||||
* // Pool size is auto-capped by the platform: 1 worker on the seven single-worker platforms and
|
||||
* // WeChat V1; up to maxWorkers on WeChat V2 and Web.
|
||||
* // On WeChat V2 pass an explicit maxWorkers to scale beyond 1 (core count is not detectable there).
|
||||
* const pool = new WorkerPool('workers/heavy-compute/index.js', {
|
||||
* maxWorkers: 4,
|
||||
* // Optional: same computation as the worker script's runTask(args), used single-threaded
|
||||
* // when no worker backend is available at all. Without it, run() would reject there.
|
||||
* fallback: (n: number) => { let acc = 0; for (let i = 0; i < n; i++) acc += Math.sqrt(i); return acc; },
|
||||
* });
|
||||
* const result = await pool.run([1_000_000]);
|
||||
* pool.terminate();
|
||||
* ```
|
||||
*/
|
||||
export class WorkerPool {
|
||||
private readonly _fn: WorkerTask | null;
|
||||
private readonly _script: string | null;
|
||||
private readonly _fallback: WorkerTask | null;
|
||||
private readonly _idleReleaseAfter: number;
|
||||
private readonly _timeout: number;
|
||||
private readonly _explicitMax: number;
|
||||
private _maxWorkers: number;
|
||||
/** Execution state only; platform selection and identity belong to PAL. */
|
||||
private _executionMode: WorkerExecutionMode;
|
||||
private _activeBackend: IPlatformWorkerBackend | null = null;
|
||||
/** Changes only on recheck; runtime degradation stays in the same recovery generation. */
|
||||
private _backendGeneration = 0;
|
||||
private _scriptFailureHint = '';
|
||||
private _backendReason: string;
|
||||
private _workers: PooledWorker[] = [];
|
||||
private _queue: PoolTask[] = [];
|
||||
private _released = false;
|
||||
private _draining = false;
|
||||
private _taskId = 0;
|
||||
/**
|
||||
* @en Consecutive infrastructure failures on the real worker backend. Reset by [[WorkerPool.recheck]].
|
||||
* Reaching [[DEGRADE_AFTER_FAILURES]] triggers degradation to single-threaded sync execution.
|
||||
* @zh 真 Worker 后端上累计的基础设施失败次数。[[WorkerPool.recheck]] 会重置;达到
|
||||
* [[DEGRADE_AFTER_FAILURES]] 即触发降级为单线程同步执行。
|
||||
*/
|
||||
private _infraFailures = 0;
|
||||
/** @en Whether this pool has degraded to single-threaded sync execution. @zh 本池是否已降级为单线程同步执行。 */
|
||||
private _degraded = false;
|
||||
/** @en Guards against spamming the degradation warning (warn at most once per pool). @zh 防止重复刷降级警告(每池至多警告一次)。 */
|
||||
private _degradeWarned = false;
|
||||
/**
|
||||
* @en Guards the CONSTRUCTION-time degradation warning (at most once per pool, even across
|
||||
* [[WorkerPool.recheck]] re-resolutions). @zh 防止重复刷**构造期**降级警告(每池至多一次,即便
|
||||
* [[WorkerPool.recheck]] 反复重解析)。
|
||||
*/
|
||||
private _constructionWarned = false;
|
||||
|
||||
/**
|
||||
* @en
|
||||
* Create a pool from a self-contained function or a packaged script path.
|
||||
* PAL selects a usable script backend and its concurrency limit. When no backend is
|
||||
* available, script tasks use options.fallback; without it, run() rejects with PAL's reason.
|
||||
* Function tasks use a worker when PAL supports them, otherwise they execute inline.
|
||||
* Scripts receive `{ id, args }` and reply with `{ id, ok, value }` or `{ id, ok: false, error }`.
|
||||
* @zh
|
||||
* 使用独立函数或已打包的脚本路径创建任务池。脚本后端的选择和并发上限由 PAL 提供。
|
||||
* 没有可用后端时,脚本任务执行 options.fallback;未提供则携带 PAL 的诊断原因拒绝任务。
|
||||
* 函数任务在 PAL 支持时使用 Worker,否则在主线程执行。
|
||||
* 脚本接收 `{ id, args }`,回复 `{ id, ok, value }` 或 `{ id, ok: false, error }`。
|
||||
*/
|
||||
constructor (fnOrScript: WorkerTask | string, options?: WorkerPoolOptions) {
|
||||
const isScriptMode = typeof fnOrScript === 'string';
|
||||
if (isScriptMode) {
|
||||
if (!fnOrScript) {
|
||||
throw new TypeError(getError(16500));
|
||||
}
|
||||
this._script = fnOrScript;
|
||||
this._fn = null;
|
||||
} else {
|
||||
if (typeof fnOrScript !== 'function') {
|
||||
throw new TypeError(getError(16501));
|
||||
}
|
||||
this._fn = fnOrScript;
|
||||
this._script = null;
|
||||
}
|
||||
|
||||
const rawFallback = options ? options.fallback : undefined;
|
||||
this._fallback = typeof rawFallback === 'function' ? rawFallback : null;
|
||||
|
||||
const rawMax = options ? options.maxWorkers : undefined;
|
||||
// An explicit, valid pool size (>= 1). 0 means "not specified" so we can apply a default below.
|
||||
this._explicitMax = (typeof rawMax === 'number' && Number.isFinite(rawMax) && rawMax >= 1)
|
||||
? Math.floor(rawMax)
|
||||
: 0;
|
||||
|
||||
const rawTimeout = options ? options.timeout : undefined;
|
||||
this._timeout = (typeof rawTimeout === 'number' && Number.isFinite(rawTimeout) && rawTimeout > 0)
|
||||
? rawTimeout
|
||||
: 0;
|
||||
|
||||
// Use `??` so an explicit `0` (meaning "never release idle workers") is preserved.
|
||||
this._idleReleaseAfter = (options && options.idleReleaseAfter !== undefined)
|
||||
? options.idleReleaseAfter
|
||||
: 1000;
|
||||
|
||||
this._executionMode = 'none';
|
||||
this._backendReason = '';
|
||||
this._maxWorkers = 0;
|
||||
this._resolveBackend();
|
||||
}
|
||||
|
||||
/**
|
||||
* @en
|
||||
* (Re-)resolve which execution backend this pool uses, and cap the pool size accordingly.
|
||||
*
|
||||
* Split out of the constructor so [[WorkerPool.recheck]] can run it again later. Resolution is
|
||||
* driven purely by runtime capability, never by a compile-time platform constant — branching on
|
||||
* `WECHAT` is what left seven mini-game platforms with a working `createWorker` falling through to
|
||||
* synchronous execution.
|
||||
* @zh
|
||||
* (重新)解析本池使用哪个执行后端,并据此封顶池大小。
|
||||
*
|
||||
* 从构造函数中拆出,以便 [[WorkerPool.recheck]] 之后能再次调用。解析完全由**运行时能力**驱动,
|
||||
* 绝不依赖编译期平台常量——正是对 `WECHAT` 的分支判断,让 7 个拥有可用 `createWorker` 的
|
||||
* 小游戏平台掉进了同步执行。
|
||||
*/
|
||||
private _resolveBackend (): void {
|
||||
const platform = getWorkerBackend();
|
||||
const explicitMax = this._explicitMax;
|
||||
const desired = explicitMax > 0 ? explicitMax : getOptimalWorkerCount();
|
||||
this._activeBackend = null;
|
||||
this._scriptFailureHint = platform.scriptFailureHint;
|
||||
this._backendReason = '';
|
||||
|
||||
if (this._script) {
|
||||
const resolved = platform.resolveScriptWorker(this._script);
|
||||
if (resolved.backend) {
|
||||
this._executionMode = 'worker';
|
||||
this._activeBackend = resolved.backend;
|
||||
this._scriptFailureHint = resolved.backend.scriptFailureHint;
|
||||
this._maxWorkers = Math.min(desired, resolved.backend.concurrencyLimit);
|
||||
} else if (this._fallback) {
|
||||
this._executionMode = 'sync';
|
||||
this._maxWorkers = 1;
|
||||
this._warnConstructionDegrade(resolved.warnOnFailure, resolved.diagnosis.reason);
|
||||
} else {
|
||||
this._executionMode = 'none';
|
||||
this._maxWorkers = 0;
|
||||
this._backendReason = getError(16504, this._script, resolved.diagnosis.reason);
|
||||
this._warnConstructionDegrade(resolved.warnOnFailure, resolved.diagnosis.reason);
|
||||
}
|
||||
} else if (platform.supportsFunctionWorker) {
|
||||
this._executionMode = 'worker';
|
||||
this._activeBackend = platform;
|
||||
this._maxWorkers = Math.min(explicitMax > 0 ? explicitMax : 1, platform.concurrencyLimit);
|
||||
} else {
|
||||
this._executionMode = 'sync';
|
||||
this._maxWorkers = 1;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @en
|
||||
* Re-probe the platform and re-resolve the execution backend.
|
||||
*
|
||||
* The backend is normally decided once, at construction. That is wrong whenever capability appears
|
||||
* LATER, which really happens:
|
||||
* - the worker script lives in a WeChat subpackage that finishes downloading after the pool was
|
||||
* created — `diagnose()` failed at construction because the file did not exist yet;
|
||||
* - the base library hot-updates, or `wx.env.isSupportStandardWorker` flips as the V2 grey release
|
||||
* rolls out to the device.
|
||||
*
|
||||
* Without this, a pool that probed too early stays locked to `'sync'`/`'none'` for its entire
|
||||
* lifetime even though a real worker is now available.
|
||||
*
|
||||
* Idle executors are retired; busy executors finish their current task and are then retired.
|
||||
* Queued tasks use the newly selected backend, or reject if it is unavailable without a fallback.
|
||||
* Transferred tasks cannot be replayed after failure because ownership has already moved.
|
||||
*
|
||||
* @returns the execution state: `'worker'`, `'sync'` or `'none'`.
|
||||
* @zh
|
||||
* 重新探测平台并重新解析执行后端。
|
||||
*
|
||||
* 后端通常只在构造时决定一次。但只要能力是**之后**才出现的,这就错了,而这确实会发生:
|
||||
* - worker 脚本位于微信分包中,该分包在池创建之后才下载完成——构造时 `diagnose()` 因文件尚不存在而失败;
|
||||
* - 基础库热更新,或随着 V2 灰度推送到该设备,`wx.env.isSupportStandardWorker` 发生翻转。
|
||||
*
|
||||
* 没有这个入口,探测过早的池会在整个生命周期里被锁死在 `'sync'`/`'none'` 上,
|
||||
* 即便真 Worker 现在已经可用。
|
||||
*
|
||||
* 空闲执行器立即释放,忙碌执行器完成当前任务后释放。排队任务交给新后端;
|
||||
* 若新后端不可用且没有 fallback,则拒绝排队任务。已移交所有权的任务失败后不能重放。
|
||||
*
|
||||
* @returns 当前执行状态:`'worker'`、`'sync'` 或 `'none'`。
|
||||
*/
|
||||
public recheck (): WorkerExecutionMode {
|
||||
if (this._released) {
|
||||
return this.backend;
|
||||
}
|
||||
// Give the real worker backend another chance: a subpackage may have finished downloading or
|
||||
// the base library may have hot-updated since we degraded. Reset the failure budget so the
|
||||
// fresh probe starts clean. (_degradeWarned stays sticky to avoid log spam across rechecks.)
|
||||
this._infraFailures = 0;
|
||||
this._degraded = false;
|
||||
// Drop the cached platform probe so the next read reflects the current environment.
|
||||
resetWorkerBackendCache();
|
||||
this._resolveBackend();
|
||||
this._backendGeneration++;
|
||||
|
||||
// New tasks must use the newly resolved backend. Busy workers finish their current
|
||||
// task, but are never reused after this capability check.
|
||||
this._retireWorkers();
|
||||
this._drain();
|
||||
return this.backend;
|
||||
}
|
||||
|
||||
private _retireWorkers (): void {
|
||||
for (let i = this._workers.length - 1; i >= 0; i--) {
|
||||
const worker = this._workers[i];
|
||||
worker.retired = true;
|
||||
if (!worker.busy) {
|
||||
this._workers.splice(i, 1);
|
||||
worker.dispose();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @en Current execution state: worker, synchronous fallback, or unavailable.
|
||||
* @zh 当前执行状态:Worker、主线程同步回退,或不可用。
|
||||
*/
|
||||
public get backend (): WorkerExecutionMode {
|
||||
return this._executionMode;
|
||||
}
|
||||
|
||||
/**
|
||||
* @en
|
||||
* The resolved parallel worker count this pool will actually run tasks on
|
||||
* (already clamped by the platform concurrency limit and the hardware estimate).
|
||||
* Callers doing manual chunking should size their chunk count to this value so that chunks map
|
||||
* 1:1 onto real parallel workers, instead of queueing serially on a single worker (e.g. WeChat V1,
|
||||
* where `concurrencyLimit` is 1) and multiplying the per-frame round-trip latency.
|
||||
* @zh
|
||||
* 池实际会用于并行执行任务的 worker 数(已计入平台并发上限与硬件核数估计)。
|
||||
* 手动分块的调用方应按此值确定分块数,使分块与真实并行 worker 一一对应;否则在单 worker 平台
|
||||
* (如微信 V1,`concurrencyLimit` 为 1)上多块会串行排队,成倍放大每帧往返延迟。
|
||||
*/
|
||||
public get concurrency (): number {
|
||||
return this._maxWorkers;
|
||||
}
|
||||
|
||||
/**
|
||||
* @en
|
||||
* Queue a task and resolve with its return value when it completes.
|
||||
* If a worker is free (or the pool is under `maxWorkers`), the task starts immediately;
|
||||
* otherwise it waits in the queue.
|
||||
* @zh
|
||||
* 排队一个任务,完成时用其返回值 resolve。
|
||||
* 如果有空闲 Worker(或池中 Worker 数未达到 `maxWorkers`),任务立即开始;否则在队列中等待。
|
||||
* @param args Arguments passed to the task function. 传给任务函数的参数。
|
||||
* @param transfer Transferable objects to transfer to the worker. 零拷贝转移到 Worker 的对象。
|
||||
*/
|
||||
public run<TResult = unknown> (args?: unknown[], transfer?: Transferable[]): Promise<TResult> {
|
||||
return new Promise<TResult>((resolve, reject) => {
|
||||
if (this._released) {
|
||||
reject(new Error(getError(16502)));
|
||||
return;
|
||||
}
|
||||
if (this._executionMode === 'none') {
|
||||
// Script mode, but no worker backend is available (WeChat worker not fully set up,
|
||||
// no global Worker) and no options.fallback was provided — we cannot proceed.
|
||||
reject(new Error(this._backendReason || getError(16503)));
|
||||
return;
|
||||
}
|
||||
this._queue.push({
|
||||
args: args || [],
|
||||
transfer: transfer || [],
|
||||
resolve: (value: unknown): void => resolve(value as TResult),
|
||||
reject,
|
||||
});
|
||||
this._drain();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* @en
|
||||
* Terminate all workers immediately and reject all pending tasks.
|
||||
* @zh
|
||||
* 立即终止所有 Worker,并拒绝所有排队中的任务。
|
||||
*/
|
||||
public terminate (): void {
|
||||
if (this._released) {
|
||||
return;
|
||||
}
|
||||
this._released = true;
|
||||
|
||||
const error = new Error(getError(16502));
|
||||
for (const task of this._queue) {
|
||||
task.reject(error);
|
||||
}
|
||||
this._queue.length = 0;
|
||||
|
||||
for (const w of this._workers) {
|
||||
w.dispose();
|
||||
}
|
||||
this._workers.length = 0;
|
||||
}
|
||||
|
||||
private _drain (): void {
|
||||
if (this._released || this._draining) return;
|
||||
this._draining = true;
|
||||
try {
|
||||
if (this._executionMode === 'none') {
|
||||
const pending = this._queue.splice(0);
|
||||
for (const task of pending) task.reject(new Error(this._backendReason));
|
||||
return;
|
||||
}
|
||||
while (this._queue.length > 0) {
|
||||
let worker = this._findIdleWorker();
|
||||
if (!worker && this._workers.length < this._maxWorkers) {
|
||||
try {
|
||||
worker = this._spawnWorker();
|
||||
} catch (err) {
|
||||
// Script-mode worker creation can throw synchronously (e.g. the path is not
|
||||
// packaged into the `workers` directory, or a subpackage has not been downloaded).
|
||||
// Treat it as an infrastructure failure: degrade so we stop respawning a broken
|
||||
// backend, and re-run this task via the fallback when one exists (otherwise reject
|
||||
// it). Keep draining either way so the remaining tasks are not left hanging.
|
||||
const failed = this._queue.shift();
|
||||
this._onInfraFailure(failed || null, err as Error);
|
||||
continue;
|
||||
}
|
||||
if (worker) {
|
||||
this._workers.push(worker);
|
||||
}
|
||||
}
|
||||
if (!worker) {
|
||||
// No free worker and already at maxWorkers: wait for a completion callback.
|
||||
return;
|
||||
}
|
||||
const task = this._queue.shift();
|
||||
if (task) {
|
||||
this._dispatch(worker, task);
|
||||
}
|
||||
}
|
||||
} finally {
|
||||
this._draining = false;
|
||||
}
|
||||
}
|
||||
|
||||
private _findIdleWorker (): PooledWorker | null {
|
||||
for (const w of this._workers) {
|
||||
if (!w.busy && !w.retired) {
|
||||
return w;
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
private _spawnWorker (): PooledWorker {
|
||||
const generation = this._backendGeneration;
|
||||
let worker: IWorker | null = null;
|
||||
let fn = this._fn;
|
||||
if (this._script) {
|
||||
if (this._executionMode === 'worker') {
|
||||
// Use the exact backend PAL selected, so creation matches its concurrency and capabilities.
|
||||
worker = this._activeBackend!.createScriptWorker(this._script);
|
||||
} else {
|
||||
// 'sync' backend (no worker at all): run the user-provided fallback inline.
|
||||
// ('none' never reaches here — run() rejects before queuing.)
|
||||
fn = this._fallback;
|
||||
}
|
||||
} else if (this._executionMode === 'worker') {
|
||||
worker = this._activeBackend!.createFunctionWorker(this._fn!);
|
||||
if (!worker) {
|
||||
// Capability disappeared before creation. Do not silently report a worker pool
|
||||
// while scheduling multiple inline executors.
|
||||
this._executionMode = 'sync';
|
||||
this._maxWorkers = 1;
|
||||
this._retireWorkers();
|
||||
}
|
||||
}
|
||||
// A null `worker` leaves PooledWorker in inline mode → it runs `fn` synchronously.
|
||||
const pooled = new PooledWorker(worker, fn, this._idleReleaseAfter, this._onWorkerIdle.bind(this), this._timeout);
|
||||
// Route infrastructure failures (timeout / onError / malformed reply) on a REAL worker back to
|
||||
// the pool so it can count them and degrade to single-threaded execution instead of hanging.
|
||||
// An inline executor never triggers it, so the callback simply stays unused there.
|
||||
pooled.onInfraFailure = (t: PoolTask, err: Error): void => {
|
||||
// Only faults from before recheck belong to an obsolete backend. Workers retired
|
||||
// by degradation still recover non-transferred tasks in the current generation.
|
||||
if (generation !== this._backendGeneration) t.reject(err);
|
||||
else this._onInfraFailure(t, err);
|
||||
};
|
||||
return pooled;
|
||||
}
|
||||
|
||||
private _dispatch (worker: PooledWorker, task: PoolTask): void {
|
||||
worker.busy = true;
|
||||
worker.cancelIdleTimer();
|
||||
const id = ++this._taskId;
|
||||
worker.onComplete = (): void => {
|
||||
worker.busy = false;
|
||||
if (worker.retired) this._onWorkerIdle(worker);
|
||||
else this._drain();
|
||||
};
|
||||
// Once ownership has been transferred, the original arguments cannot be replayed safely.
|
||||
task.transferred = !worker.isInline && !!this._activeBackend?.supportsTransfer && task.transfer.length > 0;
|
||||
worker.execute(id, task);
|
||||
}
|
||||
|
||||
private _onWorkerIdle (worker: PooledWorker): void {
|
||||
if (this._released) {
|
||||
return;
|
||||
}
|
||||
if (worker.busy) {
|
||||
return;
|
||||
}
|
||||
const idx = this._workers.indexOf(worker);
|
||||
if (idx < 0) {
|
||||
return;
|
||||
}
|
||||
this._workers.splice(idx, 1);
|
||||
worker.dispose();
|
||||
// A worker was freed up (idle-release or failure): re-drain so queued tasks don't stall.
|
||||
this._drain();
|
||||
}
|
||||
|
||||
/**
|
||||
* @internal
|
||||
* Handle an INFRASTRUCTURE failure on a real worker: it timed out, errored, failed to spawn, or
|
||||
* spoke a malformed protocol. These all mean the worker backend is not functioning for this
|
||||
* script — unlike a task-level `{ ok: false }` reply (a genuine computation error), which is
|
||||
* rejected directly and never reaches here.
|
||||
*
|
||||
* Script mode: count the failure and, once [[DEGRADE_AFTER_FAILURES]] is reached, degrade the
|
||||
* WHOLE pool so no further task hangs on the broken backend. With `options.fallback` we switch to
|
||||
* the `'sync'` backend (one inline executor on the main thread) and re-run the failed task through
|
||||
* it, so the caller still gets a result instead of a rejection — the graceful "warn + run
|
||||
* single-threaded" path the engine promises. Without a fallback there is no single-thread path to
|
||||
* degrade to, so we keep the existing evict-and-respawn recovery and reject the task, but warn
|
||||
* loudly so the developer learns the worker is broken and how to fix it.
|
||||
*
|
||||
* Function mode is deliberately EXCLUDED from degradation: its inline path is the SAME `_fn` that
|
||||
* may have just deadlocked inside the worker, so running it on the main thread could move the hang
|
||||
* onto the render thread. There we keep the existing recovery — reject the task, evict, respawn.
|
||||
*
|
||||
* @param task The in-flight task that failed, or `null` when the failure carries no task.
|
||||
* @param error The infrastructure error.
|
||||
*/
|
||||
private _onInfraFailure (task: PoolTask | null, error: Error): void {
|
||||
if (!this._script) {
|
||||
// Function mode: no safe single-thread path (see above). Reject and let _settle evict +
|
||||
// respawn a fresh worker, exactly as before the circuit breaker existed.
|
||||
if (task) {
|
||||
task.reject(error);
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
this._infraFailures++;
|
||||
if (!this._degraded && this._infraFailures >= DEGRADE_AFTER_FAILURES) {
|
||||
this._degraded = true;
|
||||
if (this._fallback) {
|
||||
// Graceful degradation: every future task runs on the main thread via the fallback.
|
||||
this._executionMode = 'sync';
|
||||
this._backendReason = '';
|
||||
this._maxWorkers = 1;
|
||||
// Drop idle real workers so the next dispatch goes to an inline executor, not a
|
||||
// leftover worker on the backend we just gave up on.
|
||||
this._retireWorkers();
|
||||
}
|
||||
this._warnDegrade(error);
|
||||
}
|
||||
|
||||
if (!task) {
|
||||
return;
|
||||
}
|
||||
if (this._executionMode === 'sync' && this._fallback && !task.transferred) {
|
||||
// Re-run the failed task on the main thread. Front of the queue preserves ordering; the
|
||||
// eviction-driven re-drain (runtime failure) or the _drain loop (spawn failure) dispatches
|
||||
// it through an inline executor running the fallback.
|
||||
this._queue.unshift(task);
|
||||
} else {
|
||||
task.reject(error);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @internal
|
||||
* Emit the one-time RUNTIME-degradation warning. `_degradeWarned` is sticky for the pool's
|
||||
* lifetime so repeated failures — or a `recheck()` that re-degrades — never spam the log.
|
||||
*/
|
||||
private _warnDegrade (error: Error): void {
|
||||
if (this._degradeWarned) {
|
||||
return;
|
||||
}
|
||||
this._degradeWarned = true;
|
||||
const script = this._script || '(function)';
|
||||
warnID(this._fallback ? 16505 : 16506, script, error.message, this._scriptFailureHint);
|
||||
}
|
||||
|
||||
/** PAL decides whether unavailable script execution deserves a one-time warning. */
|
||||
private _warnConstructionDegrade (warnOnFailure: boolean, reason: string): void {
|
||||
if (!warnOnFailure || this._constructionWarned) {
|
||||
return;
|
||||
}
|
||||
this._constructionWarned = true;
|
||||
warnID(this._fallback ? 16507 : 16508, this._script || '(function)', reason, this._scriptFailureHint);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @internal
|
||||
*/
|
||||
interface PoolTask {
|
||||
args: unknown[];
|
||||
transfer: Transferable[];
|
||||
transferred?: boolean;
|
||||
resolve: (value: unknown) => void;
|
||||
reject: (reason?: unknown) => void;
|
||||
}
|
||||
|
||||
/**
|
||||
* @internal
|
||||
* A single pooled worker, either backed by a real Web Worker or an inline synchronous executor.
|
||||
*/
|
||||
class PooledWorker {
|
||||
public busy = false;
|
||||
public retired = false;
|
||||
public onComplete: (() => void) | null = null;
|
||||
/**
|
||||
* @internal
|
||||
* Set by the pool: called when an INFRASTRUCTURE failure occurs while a task is in flight — the
|
||||
* worker timed out, errored, or spoke a malformed protocol. The pool counts these and (in script
|
||||
* mode) degrades to single-threaded execution so nothing hangs. Deliberately distinct from a
|
||||
* task-level `{ ok: false }` reply (a genuine computation error), which is rejected directly and
|
||||
* never routed here. Only real workers ever trigger it; an inline executor cannot suffer an
|
||||
* infrastructure failure (a throwing `fallback`/`_fn` is a task-level error).
|
||||
*/
|
||||
public onInfraFailure: ((task: PoolTask, error: Error) => void) | null = null;
|
||||
|
||||
/**
|
||||
* @en
|
||||
* Whether this pooled worker runs tasks INLINE on the calling thread instead of owning a real
|
||||
* worker. True for the `'sync'` backend and for function mode on platforms that cannot rebuild a
|
||||
* function from source. Such an executor is a placeholder, not parallelism — [[WorkerPool.recheck]]
|
||||
* retires the idle ones once a real backend appears.
|
||||
* @zh
|
||||
* 本池化 worker 是否在调用线程上**内联**执行任务,而非持有真正的 worker。
|
||||
* `'sync'` 后端、以及无法从源码重建函数的平台上的函数模式均如此。这类执行器只是占位而非并行——
|
||||
* 一旦真后端出现,[[WorkerPool.recheck]] 会把其中空闲的退役。
|
||||
*/
|
||||
public get isInline (): boolean {
|
||||
return this._worker === null;
|
||||
}
|
||||
|
||||
private readonly _worker: IWorker | null;
|
||||
private readonly _fn: WorkerTask | null;
|
||||
private readonly _idleReleaseAfter: number;
|
||||
private readonly _timeout: number;
|
||||
private readonly _onIdle: (worker: PooledWorker) => void;
|
||||
private _current: PoolTask | null = null;
|
||||
private _currentId = -1;
|
||||
private _idleTimer: ReturnType<typeof setTimeout> | null = null;
|
||||
private _timeoutTimer: ReturnType<typeof setTimeout> | null = null;
|
||||
private _disposed = false;
|
||||
private _failed = false;
|
||||
|
||||
constructor (
|
||||
worker: IWorker | null,
|
||||
fn: WorkerTask | null,
|
||||
idleReleaseAfter: number,
|
||||
onIdle: (worker: PooledWorker) => void,
|
||||
timeout = 0,
|
||||
) {
|
||||
this._worker = worker;
|
||||
this._fn = fn;
|
||||
this._idleReleaseAfter = idleReleaseAfter;
|
||||
this._onIdle = onIdle;
|
||||
this._timeout = timeout > 0 ? timeout : 0;
|
||||
|
||||
if (worker) {
|
||||
// IWorker.onMessage hands back the reply payload directly (the adapter unwraps `e.data`
|
||||
// on Web, and WeChat's `onMessage` already passes `res`), so no MessageEvent here.
|
||||
worker.onMessage((reply: IWorkerReply): void => {
|
||||
this._onMessage(reply);
|
||||
});
|
||||
worker.onError((e: any): void => {
|
||||
this._failed = true;
|
||||
if (this._current) {
|
||||
// Busy: fail the in-flight task; _settle's `_failed` branch then evicts us.
|
||||
this._settle(null, new Error(e && e.message ? String(e.message) : getError(16509)));
|
||||
} else {
|
||||
// Idle: there is no task to settle, but this worker is no longer trustworthy.
|
||||
// It MUST be evicted here — otherwise it stays in the pool with `busy === false`,
|
||||
// the next task gets dispatched onto it, and `postMessage` goes into a black hole
|
||||
// (the task hangs forever, and script mode has no timeout to recover it).
|
||||
// Real triggers: an uncaught async error inside the worker (e.g. a `setInterval`
|
||||
// callback throwing), or WeChat killing the worker process (`onProcessKilled`).
|
||||
this._evict();
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
public execute (id: number, task: PoolTask): void {
|
||||
this._current = task;
|
||||
this._currentId = id;
|
||||
if (!this._worker) {
|
||||
if (!this._fn) {
|
||||
// Script mode without a live worker should never reach here (run()/_drain guard it),
|
||||
// but stay defensive: there is no function to run synchronously, so fail the task.
|
||||
this._settle(null, new Error(getError(16510)));
|
||||
return;
|
||||
}
|
||||
// Inline synchronous fallback (non-Worker platforms, function mode only). This blocks the
|
||||
// main thread, which is the unavoidable behavior when no worker is available.
|
||||
try {
|
||||
const value = this._fn(...task.args);
|
||||
this._settle(value, null);
|
||||
} catch (err) {
|
||||
this._settle(null, err as Error);
|
||||
}
|
||||
return;
|
||||
}
|
||||
// Arm before sending: adapters may synchronously report an error (or a test reply).
|
||||
this.armTimeout();
|
||||
try {
|
||||
this._worker.postMessage({ id, args: task.args }, task.transfer);
|
||||
} catch (err) {
|
||||
this._failed = true;
|
||||
this._settle(null, err instanceof Error ? err : new Error(String(err)));
|
||||
}
|
||||
// Watchdog. Only meaningful for a REAL worker: the inline synchronous path above blocks the
|
||||
// main thread for the whole duration, so a timer could never fire during it anyway.
|
||||
// Without this, a worker that accepts the message and never replies — a script that deadlocks,
|
||||
// an infinite loop, a platform that silently drops the message — leaves the task pending
|
||||
// forever AND leaves that worker parked in the pool with `busy === true`, permanently
|
||||
// shrinking the pool's effective size by one on every occurrence.
|
||||
}
|
||||
|
||||
/**
|
||||
* @internal
|
||||
* Start the per-task watchdog. On expiry the task is failed and this worker is EVICTED (not
|
||||
* merely marked free): an unresponsive worker is indistinguishable from a dead one, so letting
|
||||
* the pool reuse it would just hang the next task too. Eviction routes through `_onIdle`, which
|
||||
* splices us out, disposes us and re-drains the queue onto a freshly spawned worker.
|
||||
*/
|
||||
private armTimeout (): void {
|
||||
if (this._timeout <= 0) {
|
||||
return;
|
||||
}
|
||||
this.cancelTimeoutTimer();
|
||||
const id = this._currentId;
|
||||
this._timeoutTimer = setTimeout(() => {
|
||||
this._timeoutTimer = null;
|
||||
// Ignore a timer that outlived its task (shouldn't happen — _settle cancels it — but a
|
||||
// stale timer firing against a NEW task would fail an innocent one).
|
||||
if (!this._current || this._currentId !== id) {
|
||||
return;
|
||||
}
|
||||
this._failed = true;
|
||||
this._settle(null, new Error(getError(16511, this._timeout)));
|
||||
}, this._timeout);
|
||||
}
|
||||
|
||||
private cancelTimeoutTimer (): void {
|
||||
if (this._timeoutTimer !== null) {
|
||||
clearTimeout(this._timeoutTimer);
|
||||
this._timeoutTimer = null;
|
||||
}
|
||||
}
|
||||
|
||||
public cancelIdleTimer (): void {
|
||||
if (this._idleTimer !== null) {
|
||||
clearTimeout(this._idleTimer);
|
||||
this._idleTimer = null;
|
||||
}
|
||||
}
|
||||
|
||||
public dispose (): void {
|
||||
if (this._disposed) {
|
||||
return;
|
||||
}
|
||||
this._disposed = true;
|
||||
this.cancelIdleTimer();
|
||||
this.cancelTimeoutTimer();
|
||||
if (this._worker) {
|
||||
this._worker.terminate();
|
||||
}
|
||||
if (this._current) {
|
||||
this._current.reject(new Error(getError(16512)));
|
||||
this._current = null;
|
||||
this._currentId = -1;
|
||||
}
|
||||
this.onComplete = null;
|
||||
}
|
||||
|
||||
private _onMessage (reply: IWorkerReply): void {
|
||||
if (!this._current) {
|
||||
return;
|
||||
}
|
||||
// Boundary check: the worker script must speak the engine protocol. A malformed reply means
|
||||
// the packaged file is wrong (not based on the template) — fail loudly with a clear error
|
||||
// instead of letting the task hang forever waiting for a well-formed reply.
|
||||
if (!reply || typeof reply !== 'object'
|
||||
|| typeof reply.id !== 'number'
|
||||
|| typeof reply.ok !== 'boolean') {
|
||||
this._failed = true;
|
||||
this._settle(null, new Error(getError(16513)));
|
||||
return;
|
||||
}
|
||||
// Guard against a stale/late reply from a previous task on the same worker.
|
||||
if (reply.id !== this._currentId) {
|
||||
return;
|
||||
}
|
||||
if (reply.ok) {
|
||||
this._settle(reply.value, null);
|
||||
} else {
|
||||
this._settle(null, new Error(reply.error || getError(16514)));
|
||||
}
|
||||
}
|
||||
|
||||
private _settle (value: unknown, error: Error | null): void {
|
||||
const task = this._current;
|
||||
if (!task) {
|
||||
return;
|
||||
}
|
||||
this._current = null;
|
||||
this._currentId = -1;
|
||||
this.cancelTimeoutTimer();
|
||||
|
||||
if (error) {
|
||||
if (this._failed && this.onInfraFailure) {
|
||||
// Infrastructure failure (timeout / onError / malformed reply): the worker backend
|
||||
// itself is not functioning. Hand the task to the pool, which counts the failure,
|
||||
// degrades script-mode pools to single-threaded execution once the threshold is hit,
|
||||
// and either re-runs this task via the fallback or rejects it.
|
||||
this.onInfraFailure(task, error);
|
||||
} else {
|
||||
// Task-level failure (the worker replied { ok: false }, or an inline fallback/_fn
|
||||
// threw): a genuine computation error, not a broken backend. Reject directly and keep
|
||||
// trusting the worker.
|
||||
task.reject(error);
|
||||
}
|
||||
} else {
|
||||
task.resolve(value);
|
||||
}
|
||||
|
||||
// A worker that reported an uncaught error is not trustworthy for reuse: dispose it so the
|
||||
// pool spawns a fresh one instead of replaying the same failure on every task.
|
||||
if (this._failed) {
|
||||
this._evict();
|
||||
return;
|
||||
}
|
||||
|
||||
// Mark idle (kicking off the idle-release timer) and notify the pool to drain the queue.
|
||||
if (this._idleReleaseAfter > 0 && !this._disposed) {
|
||||
this.cancelIdleTimer();
|
||||
this._idleTimer = setTimeout(() => {
|
||||
this._idleTimer = null;
|
||||
this._onIdle(this);
|
||||
}, this._idleReleaseAfter);
|
||||
}
|
||||
|
||||
if (this.onComplete) {
|
||||
const cb = this.onComplete;
|
||||
this.onComplete = null;
|
||||
cb();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @internal
|
||||
* Retire this worker for good: drop any completion callback, clear the busy flag, and hand
|
||||
* ourselves to the pool's idle hook (which splices us out of `_workers`, calls `dispose()` and
|
||||
* re-drains the queue so queued tasks get a freshly spawned worker).
|
||||
*
|
||||
* Used by BOTH failure paths, which is the whole point of extracting it: `_settle`'s `_failed`
|
||||
* branch (worker died while a task was in flight) and the idle `onError` branch (worker died
|
||||
* while idle). The idle path can never reach the `_settle` branch, because `_settle` returns
|
||||
* early when `_current` is null — routing it here is what stops a dead worker from silently
|
||||
* swallowing the next task.
|
||||
*/
|
||||
private _evict (): void {
|
||||
this.onComplete = null;
|
||||
this.busy = false;
|
||||
this._onIdle(this);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @internal
|
||||
*/
|
||||
interface IWorkerReply {
|
||||
id: number;
|
||||
ok: boolean;
|
||||
value?: unknown;
|
||||
error?: string;
|
||||
}
|
||||
@@ -0,0 +1,413 @@
|
||||
/*
|
||||
Copyright (c) 2018-2023 Xiamen Yaji Software Co., Ltd.
|
||||
|
||||
http://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 { createWorkerBackend } from 'pal/worker';
|
||||
import type { IWorker, IPlatformWorkerBackend, IWorkerCapabilities } from 'pal/worker';
|
||||
import { getError } from '../core/platform/debug';
|
||||
|
||||
export type { IWorker };
|
||||
|
||||
let backend: IPlatformWorkerBackend | undefined;
|
||||
|
||||
/** @internal Shared by capability queries and WorkerPool. */
|
||||
export function getWorkerBackend (): IPlatformWorkerBackend {
|
||||
return backend || (backend = createWorkerBackend());
|
||||
}
|
||||
|
||||
/** @internal Re-probe PAL when a pool explicitly rechecks its capabilities. */
|
||||
export function resetWorkerBackendCache (): void {
|
||||
backend = undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* @en Current Worker capabilities reported by PAL.
|
||||
* @zh PAL 提供的当前 Worker 能力。
|
||||
*/
|
||||
export function getWorkerCapabilities (): IWorkerCapabilities {
|
||||
const current = getWorkerBackend();
|
||||
return {
|
||||
supportsStandardWorker: current.supportsStandardWorker,
|
||||
available: current.concurrencyLimit > 0,
|
||||
parallel: current.concurrencyLimit > 1,
|
||||
concurrencyLimit: current.concurrencyLimit,
|
||||
supportsTransfer: current.supportsTransfer,
|
||||
supportsSharedArrayBuffer: current.supportsSharedArrayBuffer,
|
||||
supportsFunctionWorker: current.supportsFunctionWorker,
|
||||
reason: current.capabilityReason,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* @en
|
||||
* The task function executed inside a Web Worker.
|
||||
*
|
||||
* **Important**: the function must be *self-contained*: it is serialized via `Function.prototype.toString()`
|
||||
* and reconstructed in a fresh global scope inside the worker, so it cannot capture variables from the
|
||||
* enclosing closure, nor reference any engine / scene objects (`Node`, `Component`, `Vec3`, ...).
|
||||
* Only plain data (numbers, strings, arrays, plain objects) and transferable buffers (`ArrayBuffer`,
|
||||
* typed arrays backed by their own buffer) may cross the worker boundary.
|
||||
*
|
||||
* @zh
|
||||
* 在 Web Worker 内执行的任务函数。
|
||||
*
|
||||
* **注意**:函数必须*自包含*——引擎通过 `Function.prototype.toString()` 序列化函数并在 Worker 的全新全局作用域中重建,
|
||||
* 因此它不能捕获外部闭包变量,也不能引用任何引擎 / 场景对象(`Node`、`Component`、`Vec3` 等)。
|
||||
* 只有普通数据(数字、字符串、数组、普通对象)和可转移缓冲区(`ArrayBuffer`、自带缓冲区的类型化数组)可以跨 Worker 边界传递。
|
||||
*
|
||||
* @remarks
|
||||
* @en
|
||||
* The default argument type is `any[]` rather than `unknown[]`, deliberately. Arguments reach the task
|
||||
* through a DYNAMIC array channel — `pool.run([1_000_000])` is `unknown[]`, spread internally as
|
||||
* `fn(...args)` — so the type system can never relate what you pass to `run()` to what your task
|
||||
* declares. An `unknown[]` parameter therefore buys zero safety while breaking the natural spelling:
|
||||
* under `strictFunctionTypes` a concrete `(limit: number) => number` is NOT assignable to
|
||||
* `(...args: unknown[]) => unknown`, so `new WorkerPool(fn, { fallback: countPrimes })` would not
|
||||
* compile. `any[]` restores bivariance and lets the obvious code type-check. Pass explicit type
|
||||
* arguments when you want the stricter shape: `WorkerTask<[number, number], number>`.
|
||||
* @zh
|
||||
* 默认参数类型刻意取 `any[]` 而非 `unknown[]`。参数是通过**动态数组通道**抵达任务函数的——
|
||||
* `pool.run([1_000_000])` 是 `unknown[]`,内部以 `fn(...args)` 展开——因此类型系统永远无法把你传给
|
||||
* `run()` 的东西与任务函数的声明关联起来。于是 `unknown[]` 参数**换不到任何安全性**,却破坏了最自然的写法:
|
||||
* 在 `strictFunctionTypes` 下,具体的 `(limit: number) => number` **不能**赋值给
|
||||
* `(...args: unknown[]) => unknown`,导致 `new WorkerPool(fn, { fallback: countPrimes })` 无法编译。
|
||||
* `any[]` 恢复双变,让显而易见的代码通过类型检查。需要更严格的形状时请显式传类型参数:
|
||||
* `WorkerTask<[number, number], number>`。
|
||||
*/
|
||||
// `any[]` here is a deliberate, documented trade-off — see the remarks above. Do not "fix" it back to
|
||||
// `unknown[]`: that reintroduces a compile error on every concrete task function.
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
export type WorkerTask<TArgs extends any[] = any[], TResult = unknown> = (...args: TArgs) => TResult;
|
||||
|
||||
/**
|
||||
* @en
|
||||
* Detect whether the current environment supports spawning a Web Worker from a serialized function
|
||||
* (i.e. `Worker` constructor + `Blob` + `URL.createObjectURL` are all available).
|
||||
*
|
||||
* This is the capability required by **mode 1** (pure-function workers used by [[WorkerPool]]).
|
||||
* Native platforms run JavaScript inside an embedded engine (V8 / JavaScriptCore)
|
||||
* without the browser host API, and mini-game platforms forbid runtime code evaluation and have no
|
||||
* `Blob` (they use `createWorker` with a packaged script path instead), so both report `false` here
|
||||
* and mode 1 falls back to running synchronously on the main thread. Use [[createWorker]]`(path)`
|
||||
* (mode 2) for a real worker on a mini-game platform.
|
||||
*
|
||||
* NOTE: this answers "can I build a worker from a FUNCTION". It says nothing about whether the
|
||||
* platform has workers at all — for that use [[getWorkerConcurrencyLimit]], which is nonzero on all
|
||||
* nine mini-game platforms except Taobao. Conflating the two is what made a WeChat V2 build report
|
||||
* an optimal worker count of 1.
|
||||
* @zh
|
||||
* 检测当前环境是否支持从序列化函数创建 Web Worker
|
||||
* (即 `Worker` 构造器 + `Blob` + `URL.createObjectURL` 三者齐全)。
|
||||
*
|
||||
* 这是**模式一**([[WorkerPool]] 使用的纯函数 Worker)所需的能力。
|
||||
* 原生平台在嵌入式 JS 引擎(V8 / JavaScriptCore)中运行、没有浏览器宿主 API;小游戏平台禁止运行时代码求值
|
||||
* 且没有 `Blob`(它们用 `createWorker` + 打包脚本路径),因此两者这里都返回 `false`,
|
||||
* 模式一自动降级为主线程同步执行。小游戏平台上若要真正的 Worker,请用 [[createWorker]]`(path)`(模式二)。
|
||||
*
|
||||
* 注意:本函数回答的是"能否从**函数**构建 Worker",与平台到底有没有 Worker 无关——后者请用
|
||||
* [[getWorkerConcurrencyLimit]],除淘宝外它在全部 9 个小游戏平台上都非零。
|
||||
* 把两者混为一谈,正是微信 V2 构建把最优 Worker 数报成 1 的原因。
|
||||
*/
|
||||
export function isWorkerSupported (): boolean {
|
||||
return getWorkerBackend().supportsFunctionWorker;
|
||||
}
|
||||
|
||||
/**
|
||||
* @en
|
||||
* Suggest a sensible worker count for CPU-bound (compute-heavy) tasks.
|
||||
*
|
||||
* The platform's concurrency cap is applied FIRST, because on seven of the nine mini-game platforms
|
||||
* the limit is exactly one worker — a platform restriction, not a hardware one. Only where the
|
||||
* platform allows many (Web, WeChat V2 standard worker) does the hardware estimate apply:
|
||||
* `hardwareConcurrency - 1`, deliberately leaving one logical core for the main thread (rendering +
|
||||
* game logic). This is a *starting point*, not a universal answer: I/O-bound tasks can benefit from
|
||||
* more workers, and tiny per-frame tasks are often better off with `1`.
|
||||
*
|
||||
* Where `navigator.hardwareConcurrency` is unavailable — as is typically the case on mini-game
|
||||
* platforms, which expose device info through their own APIs rather than `navigator` — this
|
||||
* conservatively returns `1`. Size such a pool explicitly instead
|
||||
* (`new WorkerPool(path, { maxWorkers: 4 })`).
|
||||
*
|
||||
* Returns `1` when the platform has no worker at all (native platforms, Taobao), matching the single
|
||||
* inline executor the pool falls back to.
|
||||
*
|
||||
* @zh
|
||||
* 为 CPU 密集型(重计算)任务推荐一个合理的 Worker 数量。
|
||||
*
|
||||
* **平台并发上限优先**,因为 9 个小游戏平台中有 7 个上限恰好是 1 个 Worker——这是平台限制而非硬件限制。
|
||||
* 只有平台允许多 Worker 时(Web、微信 V2 标准 Worker)才采用硬件估算:`hardwareConcurrency - 1`,
|
||||
* 刻意给主线程(渲染 + 游戏逻辑)留一个逻辑核。这是一个*起点*,不是普适答案:I/O 型任务可以开更多 Worker,
|
||||
* 而每帧的小任务往往用 `1` 个更合适。
|
||||
*
|
||||
* 当 `navigator.hardwareConcurrency` 不可用时——**包括全部小游戏平台**(它们都不暴露 `navigator`)——
|
||||
* 保守返回 `1`。这类平台请显式指定池大小(`new WorkerPool(path, { maxWorkers: 4 })`)。
|
||||
*
|
||||
* 平台完全不支持 Worker 时(原生平台、淘宝)返回 `1`,与池降级使用的单个内联执行器一致。
|
||||
*
|
||||
* @example
|
||||
* ```ts
|
||||
* const pool = new WorkerPool(myPureFn, {
|
||||
* maxWorkers: getOptimalWorkerCount(),
|
||||
* });
|
||||
* ```
|
||||
*/
|
||||
export function getOptimalWorkerCount (): number {
|
||||
const limit = getWorkerBackend().concurrencyLimit;
|
||||
// No worker at all: the pool can only ever run one inline executor.
|
||||
if (limit === 0) {
|
||||
return 1;
|
||||
}
|
||||
// A hard platform cap (the seven single-worker mini-game platforms) wins over any hardware estimate.
|
||||
// NOTE: the previous implementation reached this answer only by accident — it short-circuited on
|
||||
// `isWorkerSupported()`, which tests FUNCTION-mode capability (Worker + Blob + URL). A WeChat V2
|
||||
// runtime has real multi-worker support but no Blob, so it was misreported as capped at 1.
|
||||
if (limit !== Infinity) {
|
||||
return limit;
|
||||
}
|
||||
const hc = getWorkerBackend().hardwareConcurrency;
|
||||
return Math.max(1, Math.floor(hc) - 1);
|
||||
}
|
||||
|
||||
/**
|
||||
* @en
|
||||
* Whether the mini-game runtime supports the **standard (WeChat V2) worker**: multiple concurrent
|
||||
* workers, `SharedArrayBuffer`, transfer lists in `postMessage`, `OffscreenCanvas`, etc.
|
||||
*
|
||||
* This is a WeChat-only capability today (detected via `minigame.env.isSupportStandardWorker`), but it
|
||||
* is expressed as a backend capability rather than a platform check, so the answer stays correct if
|
||||
* another platform later ships a standard worker.
|
||||
*
|
||||
* V2 is in grey release, so this MUST be checked at runtime before relying on any V2-only capability.
|
||||
* It safely returns `false` (i.e. fall back to the single-worker generation) when:
|
||||
* - the platform is not a mini-game platform at all (Web / native);
|
||||
* - the platform has no `env.isSupportStandardWorker` (every non-WeChat mini-game platform);
|
||||
* - `minigame.env` is undefined (old base library);
|
||||
* - running in the WeChat devtools (V2 is not supported there yet).
|
||||
*
|
||||
* Without V2 the hard constraints are: at most **1** concurrent worker, data is structured-cloned
|
||||
* (no transfer), and no platform API / rendering inside the worker.
|
||||
* @zh
|
||||
* 小游戏运行时是否支持**标准(微信 V2)Worker**:多并发 Worker、`SharedArrayBuffer`、
|
||||
* `postMessage` 的 transfer 列表、`OffscreenCanvas` 等。
|
||||
*
|
||||
* 目前这是微信独有的能力(通过 `minigame.env.isSupportStandardWorker` 检测),但它被表达为后端能力
|
||||
* 而非平台判断,因此将来若其他平台也推出标准 Worker,这里的答案依然正确。
|
||||
*
|
||||
* V2 仍在灰度,因此依赖任何 V2 能力前**必须**运行时检测。以下情况安全返回 `false`(即回退到单 Worker 代际):
|
||||
* - 根本不是小游戏平台(Web / 原生);
|
||||
* - 平台没有 `env.isSupportStandardWorker`(所有非微信小游戏平台);
|
||||
* - `minigame.env` 为 undefined(旧基础库);
|
||||
* - 微信开发者工具中运行(V2 暂不支持)。
|
||||
*
|
||||
* 无 V2 时的硬约束:最多 **1** 个并发 Worker、数据走结构化克隆(无 transfer)、Worker 内无平台 API / 渲染。
|
||||
*/
|
||||
export function isSupportStandardWorker (): boolean {
|
||||
return getWorkerBackend().supportsStandardWorker;
|
||||
}
|
||||
|
||||
/**
|
||||
* @en Result of [[checkWorkerScript]]: whether the platform worker environment is fully set up for a script path.
|
||||
* @zh [[checkWorkerScript]] 的结果:平台 Worker 环境对某脚本路径是否设置完整。
|
||||
*/
|
||||
export interface IWorkerScriptStatus {
|
||||
/**
|
||||
* @en Whether a worker can be used for this path. Only when `true` should you go the worker route.
|
||||
* @zh 该路径能否使用 Worker。仅当为 `true` 时才应走 Worker 路线。
|
||||
*/
|
||||
ready: boolean;
|
||||
/**
|
||||
* @en Worker version: `2` = standard (WeChat V2) worker, `1` = single-worker generation, `0` = unavailable.
|
||||
* @zh Worker 版本:`2` = 标准(微信 V2)Worker,`1` = 单 Worker 代际,`0` = 不可用。
|
||||
*/
|
||||
version: 0 | 1 | 2;
|
||||
/**
|
||||
* @en Human-readable reason when not ready (empty string when ready). Suitable for error messages.
|
||||
* @zh 不可用时的原因说明(可用时为空字符串),可直接用于报错信息。
|
||||
*/
|
||||
reason: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* @en
|
||||
* Check whether the platform's worker environment is **fully set up** for the given script path.
|
||||
*
|
||||
* "Fully set up" means ALL of the following hold:
|
||||
* 1. the platform exposes a worker API at all (`minigame.createWorker`, or a global `Worker`);
|
||||
* 2. the path is valid: a non-empty **relative** path ending with `.js` (mini-game platforms reject
|
||||
* absolute paths and non-JS files);
|
||||
* 3. on mini-game platforms, the file **actually exists** in the code package (verified via
|
||||
* `minigame.getFileSystemManager().accessSync`) and is **not empty** (best-effort `statSync`).
|
||||
* A missing file usually means it was not placed in the workers directory declared in
|
||||
* `game.json` (WeChat) / `manifest.json` (quick game) / `app.json`, or its subpackage has not
|
||||
* been downloaded yet.
|
||||
*
|
||||
* When `ready` is `true`, `version` tells you which worker generation you got (`2` = WeChat standard
|
||||
* multi-worker, `1` = single-worker generation). When `ready` is `false`, `reason` explains why, and
|
||||
* callers should fall back to a standard Web `Worker` (if any), then to synchronous execution.
|
||||
* @zh
|
||||
* 检查平台的 Worker 环境对给定脚本路径是否**设置完整**。
|
||||
*
|
||||
* "设置完整"指以下条件全部成立:
|
||||
* 1. 平台确实暴露了 Worker API(`minigame.createWorker`,或全局 `Worker`);
|
||||
* 2. 路径合法:非空、**相对路径**、以 `.js` 结尾(小游戏平台会拒绝绝对路径与非 JS 文件);
|
||||
* 3. 在小游戏平台上,文件**确实存在**于代码包中(通过 `minigame.getFileSystemManager().accessSync`
|
||||
* 校验)且**非空**(尽力而为的 `statSync`)。文件缺失通常意味着它没被放进 `game.json`(微信)/
|
||||
* `manifest.json`(快游戏)/ `app.json` 声明的 workers 目录,或所在分包尚未下载。
|
||||
*
|
||||
* `ready` 为 `true` 时,`version` 表明拿到的 Worker 代际(`2` = 微信标准多 Worker,`1` = 单 Worker 代际)。
|
||||
* `ready` 为 `false` 时,`reason` 说明原因,调用方应降级到标准 Web `Worker`(若有),再不行就同步执行。
|
||||
*/
|
||||
export function checkWorkerScript (path: string): IWorkerScriptStatus {
|
||||
return getWorkerBackend().diagnose(path);
|
||||
}
|
||||
|
||||
/**
|
||||
* @en
|
||||
* The maximum number of worker instances that can run **concurrently** on the current platform.
|
||||
*
|
||||
* - Web (global `Worker`): effectively unlimited → `Infinity`.
|
||||
* - WeChat **V2** standard worker (`env.isSupportStandardWorker`): multiple workers → `Infinity`.
|
||||
* - WeChat V1, ByteDance, Alipay, Baidu, and the quick-game family (Huawei / OPPO / vivo / Xiaomi):
|
||||
* only ONE worker at a time → `1`.
|
||||
* - Taobao mini-game and native platforms (no worker API at all) → `0`.
|
||||
*
|
||||
* A cap of `1` means the platform has a worker but no parallelism: [[WorkerPool]] there is an
|
||||
* **asynchronous offload queue** — it frees the main thread from a long task, but it cannot run two
|
||||
* tasks at once. [[WorkerPool]] in **script mode** (`new WorkerPool(path)`) already caps its pool size
|
||||
* per platform automatically (via [[checkWorkerScript]]), so it never tries to create more workers
|
||||
* than the platform allows — creating a second worker on a single-worker platform fails.
|
||||
*
|
||||
* Do NOT pass this result directly as `maxWorkers`: where it returns `Infinity` the pool treats that
|
||||
* as "not specified". Pass a concrete number instead:
|
||||
* ```ts
|
||||
* const pool = new WorkerPool('workers/my-task/index.js', { maxWorkers: 4 });
|
||||
* ```
|
||||
* @zh
|
||||
* 当前平台上能够**并发**运行的 worker 实例数量上限。
|
||||
*
|
||||
* - Web(全局 `Worker`):实际上无限制 → `Infinity`。
|
||||
* - 微信 **V2** 标准 Worker(`env.isSupportStandardWorker`):支持多 Worker → `Infinity`。
|
||||
* - 微信 V1、抖音、支付宝、百度,以及快游戏家族(华为 / OPPO / vivo / 小米):同一时刻仅 1 个 → `1`。
|
||||
* - 淘宝小游戏与原生平台(完全没有 Worker API)→ `0`。
|
||||
*
|
||||
* 上限为 `1` 意味着平台有 Worker 但**没有并行能力**:此时 [[WorkerPool]] 是一个**异步卸载队列**——
|
||||
* 它能把长任务从主线程挪走,但无法同时跑两个任务。[[WorkerPool]] **脚本模式**(`new WorkerPool(path)`)
|
||||
* 已通过 [[checkWorkerScript]] 自动按平台封顶池大小,不会创建超过平台允许的 Worker 数——
|
||||
* 在单 Worker 平台上创建第二个会失败。
|
||||
*
|
||||
* 不要把本函数的返回值直接传给 `maxWorkers`:返回 `Infinity` 时池会将其视为"未指定"。请传具体数值:
|
||||
* ```ts
|
||||
* const pool = new WorkerPool('workers/my-task/index.js', { maxWorkers: 4 });
|
||||
* ```
|
||||
*/
|
||||
export function getWorkerConcurrencyLimit (): number {
|
||||
return getWorkerBackend().concurrencyLimit;
|
||||
}
|
||||
|
||||
/**
|
||||
* @en
|
||||
* Create a worker from a packaged script path (**mode 2**), aligned with `minigame.createWorker`.
|
||||
* - Mini-game platforms (all nine): `minigame.createWorker(path)` — the script must live in the
|
||||
* packaged workers directory declared in `game.json` (WeChat) / `manifest.json` (quick game) /
|
||||
* `app.json`; if it is in a subpackage, download that subpackage first.
|
||||
* - Web: `new Worker(path)` (the script must be same-origin).
|
||||
*
|
||||
* Unlike mode 1, this works on mini-game platforms because the worker code is a real packaged file
|
||||
* rather than a runtime-serialized string (which those platforms forbid). The returned [[IWorker]]
|
||||
* exposes the WeChat-aligned messaging API, and the caller defines its own message protocol
|
||||
* (no envelope is imposed).
|
||||
*
|
||||
* Platform order matters and is decided by the backend, not by a platform constant: on a mini-game
|
||||
* build the mini-game worker is tried first, and only if it is not fully set up (script missing,
|
||||
* subpackage not yet downloaded, base library too old) does it fall through to a global `Worker`
|
||||
* (which some devtools environments provide), then to a precise error.
|
||||
* @zh
|
||||
* 从打包好的脚本路径创建 Worker(**模式二**),对齐 `minigame.createWorker`。
|
||||
* - 小游戏平台(全部 9 个):`minigame.createWorker(path)`——脚本须位于 `game.json`(微信)/
|
||||
* `manifest.json`(快游戏)/ `app.json` 声明的 workers 目录内;若在分包中,需先下载该分包。
|
||||
* - Web:`new Worker(path)`(脚本需同源)。
|
||||
*
|
||||
* 与模式一不同,这在小游戏平台上可用,因为 Worker 代码是真实打包文件而非运行时序列化字符串
|
||||
* (那些平台禁止后者)。返回的 [[IWorker]] 暴露对齐微信的消息 API,协议由调用方自定义(不强加信封)。
|
||||
*
|
||||
* 平台顺序很重要,且由后端而非平台常量决定:小游戏构建下优先尝试小游戏 Worker,只有当它未完全就绪时
|
||||
* (脚本缺失、分包未下载、基础库过旧)才降级到全局 `Worker`(部分开发者工具环境提供),再不行就精确报错。
|
||||
* @internal
|
||||
*/
|
||||
function createWorkerFromPath (path: string): IWorker {
|
||||
if (typeof path !== 'string' || !path) {
|
||||
throw new TypeError(getError(16515));
|
||||
}
|
||||
return getWorkerBackend().createScriptWorker(path);
|
||||
}
|
||||
|
||||
/**
|
||||
* @en
|
||||
* Create a worker. The signature is aligned with the mini-game `createWorker`:
|
||||
*
|
||||
* - `createWorker(path: string)` → **mode 2**: a worker loaded from a packaged script. Web uses
|
||||
* `new Worker(path)`; every mini-game platform that has a worker uses
|
||||
* `minigame.createWorker(path)` (WeChat / ByteDance / Alipay / Baidu / Huawei / OPPO / vivo /
|
||||
* Xiaomi). Works on all of them.
|
||||
* - `createWorker(fn: WorkerTask)` → **mode 1**: a worker built from a self-contained function
|
||||
* (**Web only**). On mini-game platforms and native this throws, because they forbid rebuilding a
|
||||
* function from source — use [[WorkerPool]] instead, which automatically falls back to
|
||||
* synchronous execution there.
|
||||
*
|
||||
* Both return an [[IWorker]] (`postMessage` / `onMessage` / `onError` / `terminate`). Check
|
||||
* [[getWorkerCapabilities]] first if you need to know whether the platform has a worker at all
|
||||
* (Taobao mini-game and native do not).
|
||||
* @zh
|
||||
* 创建一个 Worker,签名对齐小游戏的 `createWorker`:
|
||||
*
|
||||
* - `createWorker(path: string)` → **模式二**:从打包脚本加载 Worker。Web 用 `new Worker(path)`;
|
||||
* 每个有 Worker 的小游戏平台用 `minigame.createWorker(path)`(微信 / 抖音 / 支付宝 / 百度 / 华为 /
|
||||
* OPPO / vivo / 小米),两端都可用。
|
||||
* - `createWorker(fn: WorkerTask)` → **模式一**:从自包含函数构建 Worker(**仅 Web**)。
|
||||
* 小游戏平台与原生下会抛错,因为它们禁止用源码重建函数——请改用 [[WorkerPool]],
|
||||
* 它在这些平台会自动降级为同步执行。
|
||||
*
|
||||
* 两者都返回 [[IWorker]](`postMessage` / `onMessage` / `onError` / `terminate`)。若需要先知道平台
|
||||
* 到底有没有 Worker(淘宝小游戏与原生没有),请先查 [[getWorkerCapabilities]]。
|
||||
*
|
||||
* @example
|
||||
* ```ts
|
||||
* // Mode 2: your own packaged worker script (Web + all worker-capable mini-game platforms).
|
||||
* const worker = cc.createWorker('workers/my-worker/index.js');
|
||||
* worker.onMessage((res) => { console.log(res); });
|
||||
* worker.postMessage({ cmd: 'compute', data });
|
||||
* worker.terminate();
|
||||
* ```
|
||||
*/
|
||||
export function createWorker (path: string): IWorker;
|
||||
export function createWorker (fn: WorkerTask): IWorker;
|
||||
export function createWorker (pathOrFn: string | WorkerTask): IWorker {
|
||||
if (typeof pathOrFn === 'function') {
|
||||
const w = getWorkerBackend().createFunctionWorker(pathOrFn);
|
||||
if (!w) {
|
||||
throw new Error(getError(16516));
|
||||
}
|
||||
return w;
|
||||
}
|
||||
return createWorkerFromPath(pathOrFn);
|
||||
}
|
||||
@@ -52,6 +52,7 @@ class Particle {
|
||||
public pos = new Vec2(0, 0);
|
||||
public startPos = new Vec2(0, 0);
|
||||
public color = new Color(0, 0, 0, 255);
|
||||
public curColor = { r: 0, g: 0, b: 0, a: 255 };
|
||||
public deltaColor = { r: 0, g: 0, b: 0, a: 255 };
|
||||
public size = 0;
|
||||
public deltaSize = 0;
|
||||
@@ -81,6 +82,8 @@ const pool = new ParticlePool((par: Particle): void => {
|
||||
par.pos.set(Vec2.ZERO);
|
||||
par.startPos.set(Vec2.ZERO);
|
||||
par.color.set(0, 0, 0, 255);
|
||||
par.curColor.r = par.curColor.g = par.curColor.b = 0;
|
||||
par.curColor.a = 255;
|
||||
par.deltaColor.r = par.deltaColor.g = par.deltaColor.b = 0;
|
||||
par.deltaColor.a = 255;
|
||||
par.size = 0;
|
||||
@@ -111,6 +114,7 @@ export class Simulator {
|
||||
private elapsed = 0;
|
||||
private emitCounter = 0;
|
||||
private _worldRotation = 0;
|
||||
private _parentAlpha = 0.0;
|
||||
private declare sys: ParticleSystem2D;
|
||||
|
||||
constructor (system) {
|
||||
@@ -169,10 +173,10 @@ export class Simulator {
|
||||
const endColor = psys.endColor;
|
||||
const endColorVar = psys.endColorVar;
|
||||
|
||||
particle.color.r = sr = clamp(startColor.r + startColorVar.r * (random() - 0.5) * 2, 0, 255);
|
||||
particle.color.g = sg = clamp(startColor.g + startColorVar.g * (random() - 0.5) * 2, 0, 255);
|
||||
particle.color.b = sb = clamp(startColor.b + startColorVar.b * (random() - 0.5) * 2, 0, 255);
|
||||
particle.color.a = sa = clamp(startColor.a + startColorVar.a * (random() - 0.5) * 2, 0, 255);
|
||||
particle.curColor.r = sr = clamp(startColor.r + startColorVar.r * (random() - 0.5) * 2, 0, 255);
|
||||
particle.curColor.g = sg = clamp(startColor.g + startColorVar.g * (random() - 0.5) * 2, 0, 255);
|
||||
particle.curColor.b = sb = clamp(startColor.b + startColorVar.b * (random() - 0.5) * 2, 0, 255);
|
||||
particle.curColor.a = sa = clamp(startColor.a + startColorVar.a * (random() - 0.5) * 2, 0, 255);
|
||||
particle.deltaColor.r = (clamp(endColor.r + endColorVar.r * (random() - 0.5) * 2, 0, 255) - sr) / timeToLive;
|
||||
particle.deltaColor.g = (clamp(endColor.g + endColorVar.g * (random() - 0.5) * 2, 0, 255) - sg) / timeToLive;
|
||||
particle.deltaColor.b = (clamp(endColor.b + endColorVar.b * (random() - 0.5) * 2, 0, 255) - sb) / timeToLive;
|
||||
@@ -329,6 +333,14 @@ export class Simulator {
|
||||
Vec4.toArray(vbuf, _col, offset + 32);
|
||||
}
|
||||
|
||||
private _updateColor (): void {
|
||||
const selfNode = this.sys.node;
|
||||
const parentNode = selfNode.parent;
|
||||
const uiProps = selfNode._uiProps;
|
||||
const parentOpacity = parentNode ? parentNode._uiProps.opacity : 1.0;
|
||||
this._parentAlpha = uiProps.localOpacity * parentOpacity;
|
||||
}
|
||||
|
||||
public step (dt: number): void {
|
||||
const assembler = this.sys.assembler as Particle2DAssembler;
|
||||
const psys = this.sys;
|
||||
@@ -379,6 +391,8 @@ export class Simulator {
|
||||
this.updateUVs();
|
||||
}
|
||||
|
||||
this._updateColor();
|
||||
|
||||
// Used to reduce memory allocation / creation within the loop
|
||||
let particleIdx = 0;
|
||||
while (particleIdx < particles.length) {
|
||||
@@ -431,10 +445,15 @@ export class Simulator {
|
||||
}
|
||||
|
||||
// color
|
||||
particle.color.r += particle.deltaColor.r * dt;
|
||||
particle.color.g += particle.deltaColor.g * dt;
|
||||
particle.color.b += particle.deltaColor.b * dt;
|
||||
particle.color.a += particle.deltaColor.a * dt;
|
||||
particle.curColor.r += particle.deltaColor.r * dt;
|
||||
particle.curColor.g += particle.deltaColor.g * dt;
|
||||
particle.curColor.b += particle.deltaColor.b * dt;
|
||||
particle.curColor.a += particle.deltaColor.a * dt;
|
||||
|
||||
particle.color.r = particle.curColor.r;
|
||||
particle.color.g = particle.curColor.g;
|
||||
particle.color.b = particle.curColor.b;
|
||||
particle.color.a = particle.curColor.a * this._parentAlpha;
|
||||
|
||||
// size
|
||||
particle.size += particle.deltaSize * dt;
|
||||
|
||||
@@ -797,7 +797,7 @@ export class ParticleSystem2D extends UIRenderer {
|
||||
}
|
||||
|
||||
private _startPreview (): void {
|
||||
if (this._preview) {
|
||||
if (!this._preview) {
|
||||
this.resetSystem();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -23,7 +23,7 @@
|
||||
*/
|
||||
|
||||
import { ccclass, type, serializable, editable, range } from 'cc.decorator';
|
||||
import { repeat } from '../core/math';
|
||||
import { approxGE, approxLT, repeat } from '../core/math';
|
||||
import CurveRange from './animator/curve-range';
|
||||
import type { ParticleSystem } from './particle-system';
|
||||
|
||||
@@ -108,7 +108,7 @@ export default class Burst {
|
||||
let preFrameTime = repeat(psys.time - psys.startDelay.evaluate(0, 1), psys.duration) - dt;
|
||||
preFrameTime = (preFrameTime > 0.0) ? preFrameTime : 0.0;
|
||||
const curFrameTime = repeat(psys.time - psys.startDelay.evaluate(0, 1), psys.duration);
|
||||
if (this._curTime >= preFrameTime && this._curTime < curFrameTime) {
|
||||
if (approxGE(this._curTime, preFrameTime) && approxLT(this._curTime, curFrameTime)) {
|
||||
psys.emit(this.count.evaluate(this._curTime / psys.duration, 1), dt - (curFrameTime - this._curTime));
|
||||
this._curTime += this.repeatInterval;
|
||||
--this._remainingCount;
|
||||
|
||||
@@ -110,7 +110,7 @@ export default class ShapeModule {
|
||||
*/
|
||||
@displayOrder(6)
|
||||
@tooltip('i18n:shapeModule.arc')
|
||||
@visible(function (this: ShapeModule) {
|
||||
@visible(function selectArc (this: ShapeModule) {
|
||||
const subset: Array<keyof typeof ParticleShapeType> = ['Cone', 'Circle'];
|
||||
const enumName = getShapeTypeEnumName(this.shapeType);
|
||||
return subset.includes(enumName);
|
||||
@@ -131,7 +131,7 @@ export default class ShapeModule {
|
||||
*/
|
||||
@displayOrder(5)
|
||||
@tooltip('i18n:shapeModule.angle')
|
||||
@visible(function (this: ShapeModule) {
|
||||
@visible(function selectAngle (this: ShapeModule) {
|
||||
const subset: Array<keyof typeof ParticleShapeType> = ['Cone'];
|
||||
const enumName = getShapeTypeEnumName(this.shapeType);
|
||||
return subset.includes(enumName);
|
||||
@@ -208,7 +208,7 @@ export default class ShapeModule {
|
||||
@serializable
|
||||
@displayOrder(2)
|
||||
@tooltip('i18n:shapeModule.emitFrom')
|
||||
@visible(function (this: ShapeModule) {
|
||||
@visible(function selectEmitFrom (this: ShapeModule) {
|
||||
const subset: Array<keyof typeof ParticleShapeType> = ['Box', 'Cone', 'Sphere', 'Hemisphere'];
|
||||
const enumName = getShapeTypeEnumName(this.shapeType);
|
||||
return subset.includes(enumName);
|
||||
@@ -216,8 +216,8 @@ export default class ShapeModule {
|
||||
public emitFrom = ParticleEmitLocation.Volume;
|
||||
|
||||
/**
|
||||
* @en Align particle with particle direction.
|
||||
* @zh 根据粒子的初始方向决定粒子的移动方向。
|
||||
* @en Align the particle's negative Z axis with its initial emission direction, then apply start rotation.
|
||||
* @zh 将粒子的负 Z 轴对齐到初始发射方向,再叠加初始旋转。
|
||||
*/
|
||||
@serializable
|
||||
@displayOrder(16)
|
||||
@@ -258,7 +258,7 @@ export default class ShapeModule {
|
||||
@serializable
|
||||
@displayOrder(3)
|
||||
@tooltip('i18n:shapeModule.radius')
|
||||
@visible(function (this: ShapeModule) {
|
||||
@visible(function selectRadius (this: ShapeModule) {
|
||||
const subset: Array<keyof typeof ParticleShapeType> = ['Circle', 'Cone', 'Sphere', 'Hemisphere'];
|
||||
const enumName = getShapeTypeEnumName(this.shapeType);
|
||||
return subset.includes(enumName);
|
||||
@@ -278,7 +278,7 @@ export default class ShapeModule {
|
||||
@serializable
|
||||
@displayOrder(4)
|
||||
@tooltip('i18n:shapeModule.radiusThickness')
|
||||
@visible(function (this: ShapeModule) {
|
||||
@visible(function selectRadiusThickness (this: ShapeModule) {
|
||||
const subset: Array<keyof typeof ParticleShapeType> = ['Circle', 'Cone', 'Sphere', 'Hemisphere'];
|
||||
const enumName = getShapeTypeEnumName(this.shapeType);
|
||||
return subset.includes(enumName);
|
||||
@@ -293,7 +293,7 @@ export default class ShapeModule {
|
||||
@serializable
|
||||
@displayOrder(7)
|
||||
@tooltip('i18n:shapeModule.arcMode')
|
||||
@visible(function (this: ShapeModule) {
|
||||
@visible(function selectArcMode (this: ShapeModule) {
|
||||
const subset: Array<keyof typeof ParticleShapeType> = ['Cone', 'Circle'];
|
||||
const enumName = getShapeTypeEnumName(this.shapeType);
|
||||
return subset.includes(enumName);
|
||||
@@ -304,11 +304,12 @@ export default class ShapeModule {
|
||||
* @en Control arc spread for Cone and circle shape.
|
||||
* @zh 控制可能产生粒子的弧周围的离散间隔。
|
||||
*/
|
||||
@visible(function noArc (this: ShapeModule) { return this.arcMode !== ParticleArcMode.Random; }) // Bug fix: Hide this input when arcMode is random
|
||||
// Bug fix: Hide this input when arcMode is random
|
||||
@visible(function noArc (this: ShapeModule) { return this.arcMode !== ParticleArcMode.Random; })
|
||||
@serializable
|
||||
@displayOrder(9)
|
||||
@tooltip('i18n:shapeModule.arcSpread')
|
||||
@visible(function (this: ShapeModule) {
|
||||
@visible(function selectArcSpread (this: ShapeModule) {
|
||||
const subset: Array<keyof typeof ParticleShapeType> = ['Cone', 'Circle'];
|
||||
const enumName = getShapeTypeEnumName(this.shapeType);
|
||||
return subset.includes(enumName);
|
||||
@@ -319,13 +320,14 @@ export default class ShapeModule {
|
||||
* @en Emit speed around arc (available for Cone and Circle).
|
||||
* @zh 粒子沿圆周发射的速度。
|
||||
*/
|
||||
// Bug fix: Hide this input when arcMode is random
|
||||
@type(CurveRange)
|
||||
@visible(function noArc (this: ShapeModule) { return this.arcMode !== ParticleArcMode.Random; }) // Bug fix: Hide this input when arcMode is random
|
||||
@visible(function noArc (this: ShapeModule) { return this.arcMode !== ParticleArcMode.Random; })
|
||||
@range([0, 1])
|
||||
@serializable
|
||||
@displayOrder(10)
|
||||
@tooltip('i18n:shapeModule.arcSpeed')
|
||||
@visible(function (this: ShapeModule) {
|
||||
@visible(function selectArcSpeed (this: ShapeModule) {
|
||||
const subset: Array<keyof typeof ParticleShapeType> = ['Cone', 'Circle'];
|
||||
const enumName = getShapeTypeEnumName(this.shapeType);
|
||||
return subset.includes(enumName);
|
||||
@@ -340,7 +342,7 @@ export default class ShapeModule {
|
||||
@serializable
|
||||
@displayOrder(11)
|
||||
@tooltip('i18n:shapeModule.length')
|
||||
@visible(function (this: ShapeModule) {
|
||||
@visible(function selectCone (this: ShapeModule) {
|
||||
const subset: Array<keyof typeof ParticleShapeType> = ['Cone'];
|
||||
const enumName = getShapeTypeEnumName(this.shapeType);
|
||||
return subset.includes(enumName);
|
||||
@@ -354,7 +356,7 @@ export default class ShapeModule {
|
||||
@serializable
|
||||
@displayOrder(12)
|
||||
@tooltip('i18n:shapeModule.boxThickness')
|
||||
@visible(function (this: ShapeModule) {
|
||||
@visible(function selectBox (this: ShapeModule) {
|
||||
const subset: Array<keyof typeof ParticleShapeType> = ['Box'];
|
||||
const enumName = getShapeTypeEnumName(this.shapeType);
|
||||
return subset.includes(enumName);
|
||||
@@ -445,6 +447,7 @@ export default class ShapeModule {
|
||||
if (this.arcMode === ParticleArcMode.Random) {
|
||||
return randomRange(0, this._arc);
|
||||
}
|
||||
/* eslint-disable-next-line max-len */
|
||||
let angle = this.totalAngle + 2 * Math.PI * this.arcSpeed.evaluate(this.particleSystem!.time, 1)! * (this.particleSystem!.time - this.lastTime);
|
||||
this.totalAngle = angle;
|
||||
if (this.arcSpread !== 0) {
|
||||
|
||||
+10
-1
@@ -25,7 +25,7 @@
|
||||
import { ccclass, help, executeInEditMode, menu, tooltip, displayOrder, type, serializable,
|
||||
range, visible, override, displayName } from 'cc.decorator';
|
||||
import { Material, Texture2D } from '../asset/assets';
|
||||
import { Vec3, cclegacy, Vec4, Vec2, CCBoolean } from '../core';
|
||||
import { Vec3, cclegacy, Vec4, Vec2, CCBoolean, Color } from '../core';
|
||||
import { LineModel } from './models/line-model';
|
||||
import { builtinResMgr } from '../asset/asset-manager';
|
||||
import CurveRange from './animator/curve-range';
|
||||
@@ -296,6 +296,15 @@ export class Line extends ModelRenderer {
|
||||
}
|
||||
}
|
||||
|
||||
public updateColor (): void {
|
||||
if (this._color) {
|
||||
if (this._models[0]) {
|
||||
const lineModel = this._models[0] as LineModel;
|
||||
lineModel.addLineVertexData(this._positions, this._width, this._color);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
protected _onMaterialModified (index: number, material: Material | null): void {
|
||||
super._onMaterialModified(index, material);
|
||||
const matIns = this.getMaterialInstance(0);
|
||||
|
||||
+14
-4
@@ -29,7 +29,8 @@ import { Vec2, Vec3 } from '../core/math';
|
||||
* @zh 此类生成噪声纹理。
|
||||
*/
|
||||
export class ParticleNoise {
|
||||
private permutation: number[] = [151, 160, 137, 91, 90, 15,
|
||||
private static readonly DEFAULT_PERMUTATION: readonly number[] = [
|
||||
151, 160, 137, 91, 90, 15,
|
||||
131, 13, 201, 95, 96, 53, 194, 233, 7, 225, 140, 36, 103, 30, 69, 142, 8, 99, 37, 240, 21, 10, 23,
|
||||
190, 6, 148, 247, 120, 234, 75, 0, 26, 197, 62, 94, 252, 219, 203, 117, 35, 11, 32, 57, 177, 33,
|
||||
88, 237, 149, 56, 87, 174, 20, 125, 136, 171, 168, 68, 175, 74, 165, 71, 134, 139, 48, 27, 166,
|
||||
@@ -44,9 +45,19 @@ export class ParticleNoise {
|
||||
138, 236, 205, 93, 222, 114, 67, 29, 24, 72, 243, 141, 128, 195, 78, 66, 215, 61, 156, 180,
|
||||
];
|
||||
|
||||
private static build512 (src: readonly number[] | number[]): Uint8Array {
|
||||
const p = new Uint8Array(512);
|
||||
for (let i = 0; i < 256; i++) { p[256 + i] = p[i] = src[i]; }
|
||||
return p;
|
||||
}
|
||||
|
||||
private permutation: number[] = ParticleNoise.DEFAULT_PERMUTATION as number[];
|
||||
private permutation512: Uint8Array = ParticleNoise.build512(ParticleNoise.DEFAULT_PERMUTATION);
|
||||
|
||||
constructor (permutation?: number[]) {
|
||||
if (permutation) {
|
||||
this.permutation = permutation;
|
||||
this.permutation = permutation.slice();
|
||||
this.permutation512 = ParticleNoise.build512(this.permutation);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -61,8 +72,7 @@ export class ParticleNoise {
|
||||
* @returns @en Texture pixel generated. @zh 返回生成的噪声纹理值。
|
||||
*/
|
||||
public noise (x: number, y: number, z: number, min = 0, max = 1): number {
|
||||
const p: number[] = new Array(512);
|
||||
for (let i = 0; i < 256; i++) { p[256 + i] = p[i] = this.permutation[i]; }
|
||||
const p: Uint8Array = this.permutation512;
|
||||
|
||||
const X = Math.floor(x) & 255; // FIND UNIT CUBE THAT
|
||||
const Y = Math.floor(y) & 255; // CONTAINS POINT.
|
||||
|
||||
@@ -42,7 +42,7 @@ import VelocityOvertimeModule from './animator/velocity-overtime';
|
||||
import Burst from './burst';
|
||||
import ShapeModule from './emitter/shape-module';
|
||||
import { ParticleCullingMode, ParticleSpace } from './enum';
|
||||
import { particleEmitZAxis } from './particle-general-function';
|
||||
import { isCurveTwoValues, particleEmitZAxis } from './particle-general-function';
|
||||
import ParticleSystemRenderer from './renderer/particle-system-renderer-data';
|
||||
import TrailModule from './renderer/trail';
|
||||
import { ParticleSystemRendererBase } from './renderer/particle-system-renderer-base';
|
||||
@@ -55,6 +55,9 @@ import { director, DirectorEvent } from '../game/director';
|
||||
|
||||
const _world_mat = new Mat4();
|
||||
const _world_rol = new Quat();
|
||||
const _emitDirection = new Vec3();
|
||||
const _alignRotation = new Quat();
|
||||
const _startRotation = new Quat();
|
||||
|
||||
const superMaterials = Object.getOwnPropertyDescriptor(Renderer.prototype, 'sharedMaterials')!;
|
||||
|
||||
@@ -141,7 +144,7 @@ export class ParticleSystem extends ModelRenderer {
|
||||
@range([0, Number.POSITIVE_INFINITY])
|
||||
@displayOrder(10)
|
||||
@tooltip('i18n:particle_system.startSizeY')
|
||||
@visible(function (this: ParticleSystem): boolean { return this.startSize3D; })
|
||||
@visible(function (this: ParticleSystem): boolean { return this.startSize3D; }) // eslint-disable-line func-names, comma-dangle
|
||||
public startSizeY = new CurveRange();
|
||||
|
||||
/**
|
||||
@@ -153,7 +156,7 @@ export class ParticleSystem extends ModelRenderer {
|
||||
@range([0, Number.POSITIVE_INFINITY])
|
||||
@displayOrder(10)
|
||||
@tooltip('i18n:particle_system.startSizeZ')
|
||||
@visible(function (this: ParticleSystem): boolean { return this.startSize3D; })
|
||||
@visible(function (this: ParticleSystem): boolean { return this.startSize3D; }) // eslint-disable-line func-names, comma-dangle
|
||||
public startSizeZ = new CurveRange();
|
||||
|
||||
/**
|
||||
@@ -184,7 +187,7 @@ export class ParticleSystem extends ModelRenderer {
|
||||
@radian
|
||||
@displayOrder(12)
|
||||
@tooltip('i18n:particle_system.startRotationX')
|
||||
@visible(function (this: ParticleSystem): boolean { return this.startRotation3D; })
|
||||
@visible(function (this: ParticleSystem): boolean { return this.startRotation3D; }) // eslint-disable-line func-names, comma-dangle
|
||||
public startRotationX = new CurveRange();
|
||||
|
||||
/**
|
||||
@@ -196,7 +199,7 @@ export class ParticleSystem extends ModelRenderer {
|
||||
@radian
|
||||
@displayOrder(12)
|
||||
@tooltip('i18n:particle_system.startRotationY')
|
||||
@visible(function (this: ParticleSystem): boolean { return this.startRotation3D; })
|
||||
@visible(function (this: ParticleSystem): boolean { return this.startRotation3D; }) // eslint-disable-line func-names, comma-dangle
|
||||
public startRotationY = new CurveRange();
|
||||
|
||||
/**
|
||||
@@ -233,8 +236,8 @@ export class ParticleSystem extends ModelRenderer {
|
||||
public startLifetime = new CurveRange();
|
||||
|
||||
/**
|
||||
* @en Particle system duration time.
|
||||
* @zh 粒子系统运行时间。
|
||||
* @en Particle system emitter duration time.
|
||||
* @zh 粒子系统发射器运行时间。
|
||||
*/
|
||||
@serializable
|
||||
@displayOrder(0)
|
||||
@@ -1376,6 +1379,14 @@ export class ParticleSystem extends ModelRenderer {
|
||||
self._textureAnimationModule.init(particle);
|
||||
}
|
||||
|
||||
const alignToDirection = self._shapeModule?.enable && self._shapeModule.alignToDirection;
|
||||
if (alignToDirection) {
|
||||
Vec3.copy(_emitDirection, particle.velocity);
|
||||
if (self._simulationSpace === ParticleSpace.World) {
|
||||
Vec3.transformQuat(_emitDirection, _emitDirection, _world_rol);
|
||||
}
|
||||
}
|
||||
|
||||
const curveStartSpeed = self.startSpeed.evaluate(loopDelta, rand)!;
|
||||
Vec3.multiplyScalar(particle.velocity, particle.velocity, curveStartSpeed);
|
||||
|
||||
@@ -1392,6 +1403,17 @@ export class ParticleSystem extends ModelRenderer {
|
||||
} else {
|
||||
particle.startEuler.set(0, 0, self.startRotationZ.evaluate(loopDelta, rand));
|
||||
}
|
||||
if (alignToDirection && _emitDirection.lengthSqr() > 0) {
|
||||
// Align before applying start rotation, in simulation space. Use the
|
||||
// shape direction so zero start speed still has a defined orientation.
|
||||
Vec3.normalize(_emitDirection, _emitDirection);
|
||||
Quat.rotationTo(_alignRotation, particleEmitZAxis, _emitDirection);
|
||||
const r2d = 180 / Math.PI;
|
||||
Quat.fromEuler(_startRotation, particle.startEuler.x * r2d, particle.startEuler.y * r2d, particle.startEuler.z * r2d);
|
||||
Quat.multiply(_startRotation, _alignRotation, _startRotation);
|
||||
Quat.toEuler(particle.startEuler, _startRotation);
|
||||
particle.startEuler.multiplyScalar(1 / r2d);
|
||||
}
|
||||
particle.rotation.set(particle.startEuler);
|
||||
|
||||
// apply startSize.
|
||||
@@ -1455,16 +1477,18 @@ export class ParticleSystem extends ModelRenderer {
|
||||
|
||||
if (!self._isEmitting) return;
|
||||
|
||||
const randTime = isCurveTwoValues(self.rateOverTime) ? pseudoRandom(randomRangeInt(0, bits.INT_MAX)) : 1;
|
||||
// emit by rateOverTime
|
||||
self._emitRateTimeCounter += self.rateOverTime.evaluate(self._time / self.duration, 1)! * dt;
|
||||
self._emitRateTimeCounter += self.rateOverTime.evaluate(self._time / self.duration, randTime)! * dt;
|
||||
if (self._emitRateTimeCounter > 1) {
|
||||
const emitNum = Math.floor(self._emitRateTimeCounter);
|
||||
self._emitRateTimeCounter -= emitNum;
|
||||
self.emit(emitNum, dt);
|
||||
}
|
||||
|
||||
const randDist = isCurveTwoValues(self.rateOverDistance) ? pseudoRandom(randomRangeInt(0, bits.INT_MAX)) : 1;
|
||||
// emit by rateOverDistance
|
||||
const rateOverDistance = self.rateOverDistance.evaluate(self._time / self.duration, 1)!;
|
||||
const rateOverDistance = self.rateOverDistance.evaluate(self._time / self.duration, randDist)!;
|
||||
if (rateOverDistance > 0) {
|
||||
Vec3.copy(self._oldWPos, self._curWPos);
|
||||
self.node.getWorldPosition(self._curWPos);
|
||||
|
||||
@@ -69,6 +69,7 @@ const CC_USE_EMBEDDED_ALPHA = 'CC_USE_EMBEDDED_ALPHA';
|
||||
|
||||
const CC_RENDER_MODE = 'CC_RENDER_MODE';
|
||||
const ROTATION_OVER_TIME_MODULE_ENABLE = 'ROTATION_OVER_TIME_MODULE_ENABLE';
|
||||
const USE_NORMAL_MAP = 'USE_NORMAL_MAP';
|
||||
const INSTANCE_PARTICLE = 'CC_INSTANCE_PARTICLE';
|
||||
const RENDER_MODE_BILLBOARD = 0;
|
||||
const RENDER_MODE_STRETCHED_BILLBOARD = 1;
|
||||
@@ -336,7 +337,16 @@ export default class ParticleSystemRendererCPU extends ParticleSystemRendererBas
|
||||
return;
|
||||
}
|
||||
|
||||
if (this._alignSpace === ParticleAlignmentSpace.Local) {
|
||||
const ps = this._particleSystem;
|
||||
if (mode === ParticleRenderMode.Mesh && ps?._shapeModule?.enable && ps._shapeModule.alignToDirection) {
|
||||
// Aligned particle rotations are already in simulation space. The mesh
|
||||
// shader only needs the remaining simulation-to-world rotation.
|
||||
if (ps.simulationSpace === ParticleSpace.Local) {
|
||||
ps.node.getWorldRotation(_node_rot);
|
||||
} else {
|
||||
_node_rot.set(0, 0, 0, 1);
|
||||
}
|
||||
} else if (this._alignSpace === ParticleAlignmentSpace.Local) {
|
||||
this._particleSystem?.node.getRotation(_node_rot);
|
||||
} else if (this._alignSpace === ParticleAlignmentSpace.World) {
|
||||
this._particleSystem?.node.getWorldRotation(_node_rot);
|
||||
@@ -393,9 +403,11 @@ export default class ParticleSystemRendererCPU extends ParticleSystemRendererBas
|
||||
}
|
||||
ps.node.getWorldMatrix(_tempWorldTrans);
|
||||
const mat: Material | null = ps.getMaterialInstance(0) || this._defaultMat;
|
||||
const pass = mat!.passes[0];
|
||||
this.doUpdateScale(pass);
|
||||
this.doUpdateRotation(pass);
|
||||
const pass = mat?.passes[0];
|
||||
if (pass) {
|
||||
this.doUpdateScale(pass);
|
||||
this.doUpdateRotation(pass);
|
||||
}
|
||||
|
||||
this._updateList.forEach((value: IParticleModule, key: string): void => {
|
||||
// TODO(cjh): Bug here? _updateList is a Map, the old code uses `this._updateList['some_key'] = some_value;`
|
||||
@@ -686,7 +698,8 @@ export default class ParticleSystemRendererCPU extends ParticleSystemRendererBas
|
||||
this._renderInfo!.mainTexture = shareMaterial.getProperty('mainTexture', 0) as Texture2D;
|
||||
}
|
||||
|
||||
if (ps.sharedMaterial == null && this._defaultMat == null) {
|
||||
// Renderer can destroy the cached instance when replacing a preview material.
|
||||
if (ps.sharedMaterial == null && (!this._defaultMat || !this._defaultMat.passes.length)) {
|
||||
_matInsInfo.parent = builtinResMgr.get<Material>('default-particle-material');
|
||||
_matInsInfo.owner = this._particleSystem;
|
||||
_matInsInfo.subModelIdx = 0;
|
||||
@@ -699,6 +712,11 @@ export default class ParticleSystemRendererCPU extends ParticleSystemRendererBas
|
||||
}
|
||||
}
|
||||
const mat: Material = ps.getMaterialInstance(0) || this._defaultMat!;
|
||||
// A custom material may still have an invalid or unavailable effect.
|
||||
if (!mat || !mat.passes.length) {
|
||||
warn('Particle material has no render passes. Check its effect import and selected technique.');
|
||||
return;
|
||||
}
|
||||
if (ps.simulationSpace === ParticleSpace.World) {
|
||||
this._defines[CC_USE_WORLD_SPACE] = true;
|
||||
} else {
|
||||
@@ -745,8 +763,18 @@ export default class ParticleSystemRendererCPU extends ParticleSystemRendererBas
|
||||
const roationModule = this._particleSystem._rotationOvertimeModule;
|
||||
enable = roationModule ? roationModule.enable : false;
|
||||
this._defines[ROTATION_OVER_TIME_MODULE_ENABLE] = enable;
|
||||
// Explicitly clear the override when the material omits the disabled macro.
|
||||
const materialDefines = (shareMaterial || mat.parent || mat).passes[0]?.defines;
|
||||
this._defines[USE_NORMAL_MAP] = !!materialDefines?.[USE_NORMAL_MAP];
|
||||
|
||||
this._defines[INSTANCE_PARTICLE] = this._useInstance;
|
||||
|
||||
const matIns: MaterialInstance | null = ps.getMaterialInstance(0);
|
||||
if (matIns === null || matIns === undefined) {
|
||||
ps.setSharedMaterial(mat.parent, 0); // set material[0] as material for ui-mesh-renderer to use
|
||||
ps.setMaterialInstance(mat, 0);
|
||||
}
|
||||
|
||||
mat.recompileShaders(this._defines);
|
||||
if (this._model) {
|
||||
this._model.updateMaterial(mat);
|
||||
@@ -766,7 +794,7 @@ export default class ParticleSystemRendererCPU extends ParticleSystemRendererBas
|
||||
this._trailDefines[CC_USE_WORLD_SPACE] = false;
|
||||
}
|
||||
let mat: Material | null = ps.getMaterialInstance(1);
|
||||
if (mat === null && this._defaultTrailMat === null) {
|
||||
if (mat === null && (!this._defaultTrailMat || !this._defaultTrailMat.passes.length)) {
|
||||
_matInsInfo.parent = builtinResMgr.get<Material>('default-trail-material');
|
||||
_matInsInfo.owner = this._particleSystem;
|
||||
_matInsInfo.subModelIdx = 1;
|
||||
@@ -776,6 +804,13 @@ export default class ParticleSystemRendererCPU extends ParticleSystemRendererBas
|
||||
_matInsInfo.subModelIdx = 0;
|
||||
}
|
||||
mat = mat || this._defaultTrailMat!;
|
||||
|
||||
const matIns: MaterialInstance | null = ps.getMaterialInstance(1);
|
||||
if (matIns === null || matIns === undefined) {
|
||||
ps.setSharedMaterial(mat.parent, 1); // set material[1] as trail material for ui-mesh-renderer to use
|
||||
ps.setMaterialInstance(mat, 1);
|
||||
}
|
||||
|
||||
const texture = mat.getProperty('mainTexture', 0) as Texture2D | null;
|
||||
if (texture && texture.isAlphaAtlas) {
|
||||
this._trailDefines[CC_USE_EMBEDDED_ALPHA] = true;
|
||||
|
||||
@@ -61,6 +61,7 @@ const RENDER_MODE_MESH = 4;
|
||||
|
||||
const COLOR_OVER_TIME_MODULE_ENABLE = 'COLOR_OVER_TIME_MODULE_ENABLE';
|
||||
const ROTATION_OVER_TIME_MODULE_ENABLE = 'ROTATION_OVER_TIME_MODULE_ENABLE';
|
||||
const USE_NORMAL_MAP = 'USE_NORMAL_MAP';
|
||||
const SIZE_OVER_TIME_MODULE_ENABLE = 'SIZE_OVER_TIME_MODULE_ENABLE';
|
||||
const VELOCITY_OVER_TIME_MODULE_ENABLE = 'VELOCITY_OVER_TIME_MODULE_ENABLE';
|
||||
const FORCE_OVER_TIME_MODULE_ENABLE = 'FORCE_OVER_TIME_MODULE_ENABLE';
|
||||
@@ -229,7 +230,7 @@ export default class ParticleSystemRendererGPU extends ParticleSystemRendererBas
|
||||
this.initShaderUniform(mat);
|
||||
mat.recompileShaders(this._defines);
|
||||
if (this._model) {
|
||||
this._model.setSubModelMaterial(0, mat);
|
||||
this._model.updateMaterial(mat);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -265,7 +266,16 @@ export default class ParticleSystemRendererGPU extends ParticleSystemRendererBas
|
||||
return;
|
||||
}
|
||||
|
||||
if (this._alignSpace === ParticleAlignmentSpace.Local) {
|
||||
const ps = this._particleSystem;
|
||||
if (mode === ParticleRenderMode.Mesh && ps?._shapeModule?.enable && ps._shapeModule.alignToDirection) {
|
||||
// Aligned particle rotations are already in simulation space. The mesh
|
||||
// shader only needs the remaining simulation-to-world rotation.
|
||||
if (ps.simulationSpace === ParticleSpace.Local) {
|
||||
ps.node.getWorldRotation(_node_rot);
|
||||
} else {
|
||||
_node_rot.set(0, 0, 0, 1);
|
||||
}
|
||||
} else if (this._alignSpace === ParticleAlignmentSpace.Local) {
|
||||
this._particleSystem?.node.getRotation(_node_rot);
|
||||
} else if (this._alignSpace === ParticleAlignmentSpace.World) {
|
||||
this._particleSystem?.node.getWorldRotation(_node_rot);
|
||||
@@ -363,6 +373,9 @@ export default class ParticleSystemRendererGPU extends ParticleSystemRendererBas
|
||||
}
|
||||
|
||||
const pass = mat.passes[0];
|
||||
if (!pass) {
|
||||
return;
|
||||
}
|
||||
_tempVec4.x = this._particleSystem.time;
|
||||
_tempVec4.y = dt;
|
||||
pass.setUniform(this._uTimeHandle, _tempVec4);
|
||||
@@ -375,6 +388,13 @@ export default class ParticleSystemRendererGPU extends ParticleSystemRendererBas
|
||||
|
||||
public initShaderUniform (mat: Material): void {
|
||||
const pass = mat.passes[0];
|
||||
if (!pass) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Explicitly clear the override when the material omits the disabled macro.
|
||||
const materialDefines = (this._particleSystem?.sharedMaterial || mat.parent || mat).passes[0]?.defines;
|
||||
this._defines[USE_NORMAL_MAP] = !!materialDefines?.[USE_NORMAL_MAP];
|
||||
|
||||
this._uTimeHandle = pass.getHandle('u_timeDelta');
|
||||
this._uRotHandle = pass.getHandle('u_worldRot');
|
||||
@@ -597,7 +617,8 @@ export default class ParticleSystemRendererGPU extends ParticleSystemRendererBas
|
||||
this._renderInfo!.mainTexture = shareMaterial.getProperty('mainTexture', 0) as Texture2D;
|
||||
}
|
||||
|
||||
if (ps.sharedMaterial == null && this._defaultMat == null) {
|
||||
// Recreate the fallback if its passes have been destroyed.
|
||||
if (ps.sharedMaterial == null && (!this._defaultMat || !this._defaultMat.passes.length)) {
|
||||
_matInsInfo.parent = builtinResMgr.get<Material>('default-particle-gpu-material');
|
||||
_matInsInfo.owner = ps;
|
||||
_matInsInfo.subModelIdx = 0;
|
||||
@@ -610,6 +631,11 @@ export default class ParticleSystemRendererGPU extends ParticleSystemRendererBas
|
||||
}
|
||||
}
|
||||
const mat: Material | null = ps.getMaterialInstance(0) || this._defaultMat!;
|
||||
// A custom material may still have an invalid or unavailable effect.
|
||||
if (!mat || !mat.passes.length) {
|
||||
warn('Particle material has no render passes. Check its effect import and selected technique.');
|
||||
return;
|
||||
}
|
||||
|
||||
ps.node.getWorldMatrix(_tempWorldTrans);
|
||||
|
||||
|
||||
@@ -102,7 +102,7 @@ class TrailSegment {
|
||||
}
|
||||
if (this.start === -1) {
|
||||
this.start = 0;
|
||||
this.end = 1;
|
||||
this.end = 1 % this.trailElements.length;
|
||||
return this.trailElements[0];
|
||||
}
|
||||
if (this.start === this.end) {
|
||||
@@ -128,20 +128,25 @@ class TrailSegment {
|
||||
p: Particle,
|
||||
dt: number,
|
||||
): void {
|
||||
const end = this.start >= this.end ? this.end + this.trailElements.length : this.end;
|
||||
for (let i = this.start; i < end; i++) {
|
||||
if (this.start === -1) return;
|
||||
const count = this.count();
|
||||
const start = this.start;
|
||||
let removed = 0;
|
||||
for (let i = start; i < start + count; i++) {
|
||||
if (f(target, this.trailElements[i % this.trailElements.length], p, dt)) {
|
||||
this.start++;
|
||||
this.start %= this.trailElements.length;
|
||||
removed++;
|
||||
}
|
||||
}
|
||||
if (this.start === end) {
|
||||
if (removed === count) {
|
||||
this.start = -1;
|
||||
this.end = -1;
|
||||
}
|
||||
}
|
||||
|
||||
public count (): number {
|
||||
if (this.start === -1) return 0;
|
||||
if (this.start < this.end) {
|
||||
return this.end - this.start;
|
||||
} else {
|
||||
@@ -182,7 +187,11 @@ export default class TrailModule {
|
||||
}
|
||||
if (val && !this._enable) {
|
||||
this._enable = val;
|
||||
if (this._particleSystem!.processor) this._particleSystem!.processor.updateTrailMaterial();
|
||||
if (this._particleSystem?.processor) this._particleSystem.processor.updateTrailMaterial();
|
||||
}
|
||||
if (!this._particleSystem) {
|
||||
this._enable = val;
|
||||
return;
|
||||
}
|
||||
if (val && !this._trailModel) {
|
||||
this._createModel();
|
||||
@@ -377,7 +386,10 @@ export default class TrailModule {
|
||||
if (this.lifeTime.getMax() < 1.0) {
|
||||
warnID(6036);
|
||||
}
|
||||
this._trailNum = Math.ceil(psTime * Math.ceil(this.lifeTime.getMax()) * 60 * (psRate * duration + burstCount));
|
||||
let pCount: number = psRate * duration; // potential particle count
|
||||
pCount = ps.prewarm ? pCount * 2 : pCount; // if prewarm we need double space
|
||||
pCount = pCount > ps.capacity ? ps.capacity : pCount; // max particle count is less/equal than capacity
|
||||
this._trailNum = Math.ceil(psTime * Math.ceil(this.lifeTime.getMax()) * 60 * (pCount + burstCount));
|
||||
this._trailSegments = new Pool(
|
||||
(): TrailSegment => new TrailSegment(10),
|
||||
Math.ceil(psRate * duration),
|
||||
@@ -394,7 +406,7 @@ export default class TrailModule {
|
||||
}
|
||||
|
||||
public onDisable (): void {
|
||||
this._particleTrail.clear();
|
||||
this.clear();
|
||||
this._detachFromScene();
|
||||
}
|
||||
|
||||
@@ -420,6 +432,7 @@ export default class TrailModule {
|
||||
}
|
||||
|
||||
public destroy (): void {
|
||||
this.clear();
|
||||
this.destroySubMeshData();
|
||||
if (this._trailModel) {
|
||||
director.root!.destroyModel(this._trailModel);
|
||||
@@ -438,17 +451,14 @@ export default class TrailModule {
|
||||
}
|
||||
|
||||
public clear (): void {
|
||||
if (this.enable) {
|
||||
const trailIter = this._particleTrail.values();
|
||||
let trail = trailIter.next();
|
||||
while (!trail.done) {
|
||||
trail.value.clear();
|
||||
trail = trailIter.next();
|
||||
}
|
||||
this._particleTrail.clear();
|
||||
this.updateRenderData();
|
||||
if (this._trailModel) this._trailModel.enabled = false;
|
||||
for (const trail of this._particleTrail.values()) {
|
||||
trail.clear();
|
||||
this._trailSegments?.free(trail);
|
||||
}
|
||||
this._particleTrail.clear();
|
||||
this.vbOffset = 0;
|
||||
this.ibOffset = 0;
|
||||
if (this._trailModel) this._trailModel.enabled = false;
|
||||
}
|
||||
|
||||
public updateMaterial (): void {
|
||||
@@ -502,7 +512,7 @@ export default class TrailModule {
|
||||
}
|
||||
if (lastSeg) {
|
||||
trail.iterateElement(this, this._updateTrailElement, p, scaledDt);
|
||||
if (Vec3.squaredDistance(lastSeg.position, _temp_vec3) < this._minSquaredDistance) {
|
||||
if (trail.count() > 0 && Vec3.squaredDistance(lastSeg.position, _temp_vec3) < this._minSquaredDistance) {
|
||||
return;
|
||||
}
|
||||
}
|
||||
@@ -513,6 +523,8 @@ export default class TrailModule {
|
||||
|
||||
Vec3.copy(lastSeg.position, _temp_vec3);
|
||||
lastSeg.lifetime = 0;
|
||||
lastSeg.direction = 0;
|
||||
lastSeg.velocity.set(0, 0, 0);
|
||||
if (this.widthFromParticle) {
|
||||
lastSeg.width = p.size.x * this.widthRatio.evaluate(0, 1)!;
|
||||
} else {
|
||||
@@ -523,6 +535,7 @@ export default class TrailModule {
|
||||
if (trailNum === 2) {
|
||||
const lastSecondTrail = trail.getElement(trail.end - 2)!;
|
||||
Vec3.subtract(lastSecondTrail.velocity, lastSeg.position, lastSecondTrail.position);
|
||||
Vec3.normalize(lastSecondTrail.velocity, lastSecondTrail.velocity);
|
||||
} else if (trailNum > 2) {
|
||||
const lastSecondTrail = trail.getElement(trail.end - 2)!;
|
||||
const lastThirdTrail = trail.getElement(trail.end - 3)!;
|
||||
@@ -554,14 +567,28 @@ export default class TrailModule {
|
||||
public updateRenderData (): void {
|
||||
this.vbOffset = 0;
|
||||
this.ibOffset = 0;
|
||||
for (const p of this._particleTrail.keys()) {
|
||||
const trailSeg = this._particleTrail.get(p)!;
|
||||
let vertexCount = 0;
|
||||
for (const trail of this._particleTrail.values()) {
|
||||
if (trail.count() > 0) vertexCount += (trail.count() + 1) * 2;
|
||||
}
|
||||
// Initialization preallocates the estimated capacity; grow only if that estimate is exceeded.
|
||||
if (vertexCount > this._iaVertCount) {
|
||||
if (!this._ensureBufferCapacity(Math.min(vertexCount, 65536))) {
|
||||
// Do not upload or draw with a partially resized pair of GPU buffers.
|
||||
this.updateIA(0);
|
||||
if (this._trailModel) this._trailModel.enabled = false;
|
||||
return;
|
||||
}
|
||||
}
|
||||
for (const [p, trailSeg] of this._particleTrail) {
|
||||
if (trailSeg.start === -1) {
|
||||
continue;
|
||||
}
|
||||
const indexOffset = this.vbOffset * 4 / this._vertSize;
|
||||
const end = trailSeg.start >= trailSeg.end ? trailSeg.end + trailSeg.trailElements.length : trailSeg.end;
|
||||
const trailNum = end - trailSeg.start;
|
||||
// Uint16 indices cannot address vertices beyond this limit.
|
||||
if (indexOffset + (trailNum + 1) * 2 > 65536) continue;
|
||||
// const lastSegRatio = vec3.distance(trailSeg.getTailElement()!.position, p.position) / this._minParticleDistance;
|
||||
const textCoordSeg = 1 / (trailNum /* - 1 + lastSegRatio */);
|
||||
const startSegEle = trailSeg.trailElements[trailSeg.start];
|
||||
@@ -653,11 +680,13 @@ export default class TrailModule {
|
||||
const subModels = this._trailModel && this._trailModel.subModels;
|
||||
if (subModels && subModels.length > 0) {
|
||||
const subModel = subModels[0];
|
||||
subModel.inputAssembler.vertexBuffers[0].update(this._vbF32!);
|
||||
subModel.inputAssembler.indexBuffer!.update(this._iBuffer!);
|
||||
if (count > 0) {
|
||||
subModel.inputAssembler.vertexBuffers[0].update(this._vbF32!, this.vbOffset * 4);
|
||||
subModel.inputAssembler.indexBuffer!.update(this._iBuffer!, count * Uint16Array.BYTES_PER_ELEMENT);
|
||||
}
|
||||
subModel.inputAssembler.firstIndex = 0;
|
||||
subModel.inputAssembler.indexCount = count;
|
||||
subModel.inputAssembler.vertexCount = this._iaVertCount;
|
||||
subModel.inputAssembler.vertexCount = this.vbOffset * 4 / this._vertSize;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -673,8 +702,31 @@ export default class TrailModule {
|
||||
this._trailModel = (cclegacy.director.root as Root).createModel(scene.Model);
|
||||
}
|
||||
|
||||
private _ensureBufferCapacity (vertexCount: number): boolean {
|
||||
if (vertexCount <= this._iaVertCount) return true;
|
||||
if (!this._subMeshData) return false;
|
||||
const capacity = Math.min(65536, Math.max(vertexCount, this._iaVertCount * 2));
|
||||
const vertexBytes = capacity * this._vertSize;
|
||||
const indexBytes = capacity * 3 * Uint16Array.BYTES_PER_ELEMENT;
|
||||
const vertexBuffer = this._subMeshData.vertexBuffers[0];
|
||||
const indexBuffer = this._subMeshData.indexBuffer!;
|
||||
if (vertexBuffer.size < vertexBytes) vertexBuffer.resize(vertexBytes);
|
||||
if (indexBuffer.size < indexBytes) indexBuffer.resize(indexBytes);
|
||||
if (vertexBuffer.size < vertexBytes || indexBuffer.size < indexBytes) return false;
|
||||
|
||||
// Commit CPU storage and capacity only after both GPU allocations succeed.
|
||||
const buffer = new ArrayBuffer(vertexBytes);
|
||||
this._vbF32 = new Float32Array(buffer);
|
||||
this._vbUint32 = new Uint32Array(buffer);
|
||||
this._iBuffer = new Uint16Array(capacity * 3);
|
||||
this._iaVertCount = capacity;
|
||||
this._iaIndexCount = this._iBuffer.length;
|
||||
return true;
|
||||
}
|
||||
|
||||
private rebuild (): void {
|
||||
const self = this;
|
||||
// Preserve the full estimate from onInit instead of relying on runtime buffer growth.
|
||||
const device: Device = director.root!.device;
|
||||
const vertexBuffer = device.createBuffer(new BufferInfo(
|
||||
BufferUsageBit.VERTEX | BufferUsageBit.TRANSFER_DST,
|
||||
@@ -712,6 +764,7 @@ export default class TrailModule {
|
||||
|
||||
private _updateTrailElement (module: TrailModule, trailEle: ITrailElement, p: Particle, dt: number): boolean {
|
||||
trailEle.lifetime += dt;
|
||||
if (module._trailLifetime <= 0 || trailEle.lifetime > module._trailLifetime) return true;
|
||||
if (module.colorFromParticle) {
|
||||
trailEle.color.set(p.color);
|
||||
trailEle.color.multiply(module.colorOvertime.evaluate(1.0 - p.remainingLifetime / p.startLifetime, 1));
|
||||
|
||||
+24
-17
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
Copyright (c) 2025 Xiamen Yaji Software Co., Ltd.
|
||||
Copyright (c) 2024 Xiamen Yaji Software Co., Ltd.
|
||||
|
||||
https://www.cocos.com/
|
||||
|
||||
@@ -21,29 +21,36 @@
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
*/
|
||||
import { PhysicsContact, b2ContactExtends } from './physics-contact';
|
||||
|
||||
import { EventAcceleration } from '../../../cocos/input/types';
|
||||
import { InputEventType } from '../../../cocos/input/types/event-enum';
|
||||
|
||||
export type AccelerometerCallback = (res: EventAcceleration) => void;
|
||||
|
||||
export class AccelerometerInputSource {
|
||||
|
||||
constructor () {
|
||||
const contactMap = new Map<b2ContactExtends, PhysicsContact>();
|
||||
const pools: PhysicsContact[] = [];
|
||||
|
||||
export class PhysicsContactManager {
|
||||
static get (b2contact: b2ContactExtends): PhysicsContact {
|
||||
let c = pools.pop();
|
||||
if (!c) {
|
||||
c = new PhysicsContact();
|
||||
}
|
||||
c.init(b2contact);
|
||||
contactMap.set(b2contact, c);
|
||||
return c;
|
||||
}
|
||||
|
||||
|
||||
public start (): void {
|
||||
|
||||
static find (b2contact: b2ContactExtends): PhysicsContact | null {
|
||||
return contactMap.get(b2contact) ?? null;
|
||||
}
|
||||
public stop (): void {
|
||||
|
||||
static put (b2contact: b2ContactExtends): void {
|
||||
const c = contactMap.get(b2contact);
|
||||
if (!c) return;
|
||||
pools.push(c);
|
||||
c.reset();
|
||||
contactMap.delete(b2contact);
|
||||
}
|
||||
public setInterval (intervalInMileseconds: number): void {
|
||||
|
||||
}
|
||||
public on (eventType: InputEventType, callback: AccelerometerCallback, target?: any): void {
|
||||
|
||||
static clear (): void {
|
||||
contactMap.clear();
|
||||
pools.length = 0;
|
||||
}
|
||||
}
|
||||
@@ -31,8 +31,6 @@ export type b2ContactExtends = b2jsb.Contact & {
|
||||
m_userData: any
|
||||
}
|
||||
|
||||
const pools: PhysicsContact[] = [];
|
||||
|
||||
// temp world manifold
|
||||
const pointCache = [new Vec2(), new Vec2()];
|
||||
|
||||
@@ -74,25 +72,6 @@ const impulse: IPhysics2DImpulse = {
|
||||
};
|
||||
|
||||
export class PhysicsContact implements IPhysics2DContact {
|
||||
static get (b2contact: b2ContactExtends): PhysicsContact {
|
||||
let c = pools.pop();
|
||||
|
||||
if (!c) {
|
||||
c = new PhysicsContact();
|
||||
}
|
||||
|
||||
c.init(b2contact);
|
||||
return c;
|
||||
}
|
||||
|
||||
static put (b2contact: b2ContactExtends): void {
|
||||
const c: PhysicsContact = b2contact.m_userData as PhysicsContact;
|
||||
if (!c) return;
|
||||
|
||||
pools.push(c);
|
||||
c.reset();
|
||||
}
|
||||
|
||||
colliderA: Collider2D | null = null;
|
||||
colliderB: Collider2D | null = null;
|
||||
|
||||
@@ -108,16 +87,13 @@ export class PhysicsContact implements IPhysics2DContact {
|
||||
}
|
||||
|
||||
init (b2contact: b2ContactExtends): void {
|
||||
this._b2contact = b2contact;
|
||||
this.colliderA = (b2contact.GetFixtureA().m_userData as b2Shape2D).collider;
|
||||
this.colliderB = (b2contact.GetFixtureB().m_userData as b2Shape2D).collider;
|
||||
this.disabled = false;
|
||||
this.disabledOnce = false;
|
||||
this._impulse = null!;
|
||||
|
||||
this._inverted = false;
|
||||
|
||||
this._b2contact = b2contact;
|
||||
b2contact.m_userData = this;
|
||||
}
|
||||
|
||||
reset (): void {
|
||||
@@ -130,7 +106,6 @@ export class PhysicsContact implements IPhysics2DContact {
|
||||
this.disabled = false;
|
||||
this._impulse = null!;
|
||||
|
||||
this._b2contact.m_userData = null;
|
||||
this._b2contact = null!;
|
||||
}
|
||||
|
||||
|
||||
@@ -36,6 +36,7 @@ import { PhysicsContactListener } from './platform/physics-contact-listener';
|
||||
import { PhysicsAABBQueryCallback } from './platform/physics-aabb-query-callback';
|
||||
import { PhysicsRayCastCallback } from './platform/physics-ray-cast-callback';
|
||||
import { PhysicsContact, b2ContactExtends } from './physics-contact';
|
||||
import { PhysicsContactManager } from './physics-contact-manager';
|
||||
import { Contact2DType, Collider2D, RaycastResult2D } from '../framework';
|
||||
import { b2Shape2D } from './shapes/shape-2d';
|
||||
import { PhysicsDebugDraw } from './platform/physics-debug-draw';
|
||||
@@ -140,7 +141,7 @@ export class b2PhysicsWorld implements IPhysicsWorld {
|
||||
|
||||
if (!v) {
|
||||
if (this._debugGraphics) {
|
||||
this._debugGraphics.node.parent = null;
|
||||
this._debugGraphics.clear();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -444,22 +445,22 @@ export class b2PhysicsWorld implements IPhysicsWorld {
|
||||
}
|
||||
|
||||
_onBeginContact (b2contact: b2ContactExtends): void {
|
||||
const c = PhysicsContact.get(b2contact);
|
||||
const c = PhysicsContactManager.get(b2contact);
|
||||
c.emit(Contact2DType.BEGIN_CONTACT);
|
||||
}
|
||||
|
||||
_onEndContact (b2contact: b2ContactExtends): void {
|
||||
const c = b2contact.m_userData as PhysicsContact;
|
||||
const c = PhysicsContactManager.find(b2contact);
|
||||
if (!c) {
|
||||
return;
|
||||
}
|
||||
c.emit(Contact2DType.END_CONTACT);
|
||||
|
||||
PhysicsContact.put(b2contact);
|
||||
PhysicsContactManager.put(b2contact);
|
||||
}
|
||||
|
||||
_onPreSolve (b2contact: b2ContactExtends): void {
|
||||
const c = b2contact.m_userData as PhysicsContact;
|
||||
const c = PhysicsContactManager.find(b2contact);
|
||||
if (!c) {
|
||||
return;
|
||||
}
|
||||
@@ -468,7 +469,7 @@ export class b2PhysicsWorld implements IPhysicsWorld {
|
||||
}
|
||||
|
||||
_onPostSolve (b2contact: b2ContactExtends, impulse: b2jsb.ContactImpulse): void {
|
||||
const c: PhysicsContact = b2contact.m_userData as PhysicsContact;
|
||||
const c = PhysicsContactManager.find(b2contact);
|
||||
if (!c) {
|
||||
return;
|
||||
}
|
||||
@@ -478,4 +479,7 @@ export class b2PhysicsWorld implements IPhysicsWorld {
|
||||
c.emit(Contact2DType.POST_SOLVE);
|
||||
c._setImpulse(null);
|
||||
}
|
||||
clearContacts (): void {
|
||||
PhysicsContactManager.clear();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -34,8 +34,8 @@ export class b2CircleShape extends b2Shape2D implements ICircleShape {
|
||||
|
||||
_worldPosition = new Vec2();
|
||||
get worldPosition (): Vec2 {
|
||||
const p = (this._shapes[0] as b2jsb.CircleShape).m_p;
|
||||
return this._worldPosition.set(p.x * PHYSICS_2D_PTM_RATIO, p.y * PHYSICS_2D_PTM_RATIO);
|
||||
const comp = this.collider as CircleCollider2D;
|
||||
return Vec2.transformMat4(this._worldPosition, comp.offset, comp.node.worldMatrix);
|
||||
}
|
||||
|
||||
_createShapes (scaleX: number, scaleY: number, relativePositionX: number, relativePositionY: number): any[] {
|
||||
|
||||
@@ -26,7 +26,7 @@ import { instantiateWasm, ensureWasmModuleReady } from 'pal/wasm';
|
||||
import { BUILD, LOAD_BOX2D_MANUALLY, NATIVE_CODE_BUNDLE_MODE } from 'internal:constants';
|
||||
|
||||
import { game } from '../../game';
|
||||
import { error, sys, IVec2Like, log } from '../../core';
|
||||
import { error, sys, IVec2Like, log, debug } from '../../core';
|
||||
import { NativeCodeBundleMode } from '../../misc/webassembly-support';
|
||||
|
||||
// eslint-disable-next-line import/no-mutable-exports
|
||||
@@ -148,7 +148,7 @@ function initWasm (wasmFactory, wasmUrl: string): Promise<void> {
|
||||
}).catch((err) => reject(errorMessage(err)));
|
||||
},
|
||||
}).then((Instance: any) => {
|
||||
log('[box2d]:box2d wasm lib loaded.');
|
||||
debug('[box2d]:box2d wasm lib loaded.');
|
||||
B2 = Instance;
|
||||
}).then(resolve).catch((err: any) => reject(errorMessage(err)));
|
||||
});
|
||||
@@ -158,7 +158,7 @@ function initAsm (asmFactory): Promise<void> {
|
||||
return new Promise<void>((resolve, reject) => {
|
||||
const errorMessage = (err: any): string => `[box2d]: box2d asm lib load failed: ${err}`;
|
||||
asmFactory().then((instance: any) => {
|
||||
log('[box2d]:box2d asm lib loaded.');
|
||||
debug('[box2d]:box2d asm lib loaded.');
|
||||
B2 = instance;
|
||||
}).then(resolve).catch((err: any) => reject(errorMessage(err)));
|
||||
});
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
/*
|
||||
Copyright (c) 2024 Xiamen Yaji Software Co., Ltd.
|
||||
https://www.cocos.com/
|
||||
*/
|
||||
import { B2ObjectType, getTSObjectFromWASMObjectPtr } from './instantiated';
|
||||
import { PhysicsContact } from './physics-contact';
|
||||
|
||||
const pools: PhysicsContact[] = [];
|
||||
|
||||
export class PhysicsContactManager {
|
||||
static get (b2contact: number): PhysicsContact {
|
||||
let c = pools.pop();
|
||||
if (!c) {
|
||||
c = new PhysicsContact();
|
||||
}
|
||||
c.init(b2contact);
|
||||
return c;
|
||||
}
|
||||
static find (b2contact: number): PhysicsContact | null {
|
||||
return getTSObjectFromWASMObjectPtr<PhysicsContact>(B2ObjectType.Contact, b2contact);
|
||||
}
|
||||
|
||||
static put (b2contact: number): void {
|
||||
const c = getTSObjectFromWASMObjectPtr<PhysicsContact>(B2ObjectType.Contact, b2contact);
|
||||
if (!c) return;
|
||||
|
||||
pools.push(c);
|
||||
c.reset();
|
||||
}
|
||||
|
||||
static clear (): void {
|
||||
pools.length = 0;
|
||||
}
|
||||
}
|
||||
@@ -29,7 +29,7 @@ import { Collider2D, Contact2DType, PhysicsSystem2D } from '../framework';
|
||||
import { B2Shape2D } from './shapes/shape-2d';
|
||||
import { IPhysics2DContact, IPhysics2DImpulse, IPhysics2DManifoldPoint, IPhysics2DWorldManifold } from '../spec/i-physics-contact';
|
||||
|
||||
const pools: PhysicsContact[] = [];
|
||||
/* pools moved to PhysicsContactManager */
|
||||
|
||||
// temp world manifold
|
||||
const pointCache = [new Vec2(), new Vec2()];
|
||||
@@ -62,24 +62,7 @@ const impulse: IPhysics2DImpulse = {
|
||||
|
||||
/** @mangle */
|
||||
export class PhysicsContact implements IPhysics2DContact {
|
||||
static get (b2contact: number): PhysicsContact {
|
||||
let c = pools.pop();
|
||||
|
||||
if (!c) {
|
||||
c = new PhysicsContact();
|
||||
}
|
||||
|
||||
c.init(b2contact);
|
||||
return c;
|
||||
}
|
||||
|
||||
static put (b2contact: number): void {
|
||||
const c = getTSObjectFromWASMObjectPtr<PhysicsContact>(B2ObjectType.Contact, b2contact);
|
||||
if (!c) return;
|
||||
|
||||
pools.push(c);
|
||||
c.reset();
|
||||
}
|
||||
/* static get/put/clear moved to PhysicsContactManager */
|
||||
|
||||
colliderA: Collider2D | null = null;
|
||||
colliderB: Collider2D | null = null;
|
||||
|
||||
@@ -35,7 +35,7 @@ import { B2RigidBody2D } from './rigid-body';
|
||||
import { PhysicsContactListener } from './platform/physics-contact-listener';
|
||||
import { PhysicsAABBQueryCallback } from './platform/physics-aabb-query-callback';
|
||||
import { PhysicsRayCastCallback } from './platform/physics-ray-cast-callback';
|
||||
import { PhysicsContact } from './physics-contact';
|
||||
import { PhysicsContactManager } from './physics-contact-manager';
|
||||
import { Contact2DType, Collider2D, RaycastResult2D } from '../framework';
|
||||
import { B2Shape2D } from './shapes/shape-2d';
|
||||
import { PhysicsDebugDraw } from './platform/physics-debug-draw';
|
||||
@@ -82,6 +82,16 @@ export class B2PhysicsWorld implements IPhysicsWorld {
|
||||
PhysicsContactListener._PreSolve = this._onPreSolve;
|
||||
PhysicsContactListener._PostSolve = this._onPostSolve;
|
||||
this._contactListener = B2.ContactListener.implement(PhysicsContactListener.callback);
|
||||
const orgRegisterContactFixture = this._contactListener.registerContactFixture.bind(this._contactListener);
|
||||
this._contactListener.registerContactFixture = (contactFixture: number): void => {
|
||||
PhysicsContactListener.registerContactFixture(contactFixture);
|
||||
orgRegisterContactFixture(contactFixture);
|
||||
};
|
||||
const orgUnregisterContactFixture = this._contactListener.unregisterContactFixture.bind(this._contactListener);
|
||||
this._contactListener.unregisterContactFixture = (contactFixture: number): void => {
|
||||
PhysicsContactListener.unregisterContactFixture(contactFixture);
|
||||
orgUnregisterContactFixture(contactFixture);
|
||||
};
|
||||
this._world.SetContactListener(this._contactListener);
|
||||
|
||||
this._aabbQueryCallback = B2.QueryCallback.implement(PhysicsAABBQueryCallback.callback);
|
||||
@@ -104,7 +114,7 @@ export class B2PhysicsWorld implements IPhysicsWorld {
|
||||
|
||||
if (!v) {
|
||||
if (this._debugGraphics) {
|
||||
this._debugGraphics.node.parent = null;
|
||||
this._debugGraphics.clear();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -427,22 +437,22 @@ export class B2PhysicsWorld implements IPhysicsWorld {
|
||||
}
|
||||
|
||||
_onBeginContact (b2contact: number): void {
|
||||
const c = PhysicsContact.get(b2contact);
|
||||
const c = PhysicsContactManager.get(b2contact);
|
||||
c.emit(Contact2DType.BEGIN_CONTACT);
|
||||
}
|
||||
|
||||
_onEndContact (b2contact: number): void {
|
||||
const c = getTSObjectFromWASMObjectPtr<PhysicsContact>(B2ObjectType.Contact, b2contact);
|
||||
const c = PhysicsContactManager.find(b2contact);
|
||||
if (!c) {
|
||||
return;
|
||||
}
|
||||
c.emit(Contact2DType.END_CONTACT);
|
||||
|
||||
PhysicsContact.put(b2contact);
|
||||
PhysicsContactManager.put(b2contact);
|
||||
}
|
||||
|
||||
_onPreSolve (b2contact: number): void {
|
||||
const c = getTSObjectFromWASMObjectPtr<PhysicsContact>(B2ObjectType.Contact, b2contact);
|
||||
const c = PhysicsContactManager.find(b2contact);
|
||||
if (!c) {
|
||||
return;
|
||||
}
|
||||
@@ -451,7 +461,7 @@ export class B2PhysicsWorld implements IPhysicsWorld {
|
||||
}
|
||||
|
||||
_onPostSolve (b2contact: number, impulse: number): void {
|
||||
const c = getTSObjectFromWASMObjectPtr<PhysicsContact>(B2ObjectType.Contact, b2contact);
|
||||
const c = PhysicsContactManager.find(b2contact);
|
||||
if (!c) {
|
||||
return;
|
||||
}
|
||||
@@ -461,4 +471,8 @@ export class B2PhysicsWorld implements IPhysicsWorld {
|
||||
c.emit(Contact2DType.POST_SOLVE);
|
||||
c._setImpulse(0);
|
||||
}
|
||||
|
||||
clearContacts (): void {
|
||||
PhysicsContactManager.clear();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -22,37 +22,56 @@
|
||||
THE SOFTWARE.
|
||||
*/
|
||||
|
||||
import { B2 } from '../instantiated';
|
||||
|
||||
type BeginContactCallback = (contact: number) => void;
|
||||
type EndContactCallback = (contact: number) => void;
|
||||
type PreSolveCallback = (contact: number, oldManifold: number) => void;
|
||||
type PostSolveCallback = (contact: number, impulse: number) => void;
|
||||
|
||||
export class PhysicsContactListener {
|
||||
static _contactFixtures: Set<number> = new Set<number>();
|
||||
static _BeginContact: BeginContactCallback | null = null;
|
||||
static _EndContact: EndContactCallback | null = null;
|
||||
static _PreSolve: PreSolveCallback | null = null;
|
||||
static _PostSolve: PostSolveCallback | null = null;
|
||||
static _shouldReportContacts: Set<number> = new Set<number>();
|
||||
|
||||
static BeginContact (contact: number): void {
|
||||
if (this._BeginContact) {
|
||||
if (!this._BeginContact) return;
|
||||
const fixtureA = B2.ContactGetFixtureA(contact) as number;
|
||||
const fixtureB = B2.ContactGetFixtureB(contact) as number;
|
||||
const fixtures = this._contactFixtures;
|
||||
this._shouldReportContacts.delete(contact);
|
||||
|
||||
if (fixtures.has(fixtureA) || fixtures.has(fixtureB)) {
|
||||
this._shouldReportContacts.add(contact);
|
||||
this._BeginContact(contact);
|
||||
}
|
||||
}
|
||||
|
||||
static EndContact (contact: number): void {
|
||||
if (this._EndContact) {
|
||||
if (this._EndContact && this._shouldReportContacts.has(contact)) {
|
||||
this._shouldReportContacts.delete(contact);
|
||||
this._EndContact(contact);
|
||||
}
|
||||
}
|
||||
|
||||
static PreSolve (contact: number, oldManifold: number): void {
|
||||
if (this._PreSolve) {
|
||||
if (this._PreSolve && this._shouldReportContacts.has(contact)) {
|
||||
this._PreSolve(contact, oldManifold);
|
||||
}
|
||||
}
|
||||
static registerContactFixture (fixture: number): void {
|
||||
this._contactFixtures.add(fixture);
|
||||
}
|
||||
|
||||
static unregisterContactFixture (fixture: number): void {
|
||||
this._contactFixtures.delete(fixture);
|
||||
}
|
||||
|
||||
static PostSolve (contact: number, impulse: number): void {
|
||||
if (this._PostSolve) {
|
||||
if (this._PostSolve && this._shouldReportContacts.has(contact)) {
|
||||
this._PostSolve(contact, impulse);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -37,8 +37,8 @@ export class B2CircleShape extends B2Shape2D implements ICircleShape {
|
||||
|
||||
_worldPosition = new Vec2();
|
||||
get worldPosition (): Vec2 {
|
||||
const p = B2.CircleShapeGetPosition(this._shapes[0]) as B2.Vec2;
|
||||
return this._worldPosition.set(p.x * PHYSICS_2D_PTM_RATIO, p.y * PHYSICS_2D_PTM_RATIO);
|
||||
const comp = this.collider as CircleCollider2D;
|
||||
return Vec2.transformMat4(this._worldPosition, comp.offset, comp.node.worldMatrix);
|
||||
}
|
||||
|
||||
_createShapes (scaleX: number, scaleY: number, relativePositionX: number, relativePositionY: number): number[] { //B2.CircleShape[]
|
||||
|
||||
+26
-15
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
Copyright (c) 2025 Xiamen Yaji Software Co., Ltd.
|
||||
Copyright (c) 2024 Xiamen Yaji Software Co., Ltd.
|
||||
|
||||
https://www.cocos.com/
|
||||
|
||||
@@ -21,25 +21,36 @@
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
*/
|
||||
import { PhysicsContact, b2ContactExtends } from './physics-contact';
|
||||
|
||||
import { EventTarget } from '../../../cocos/core/event';
|
||||
import { EventTouch, Touch as CCTouch } from '../../../cocos/input/types';
|
||||
import { InputEventType } from '../../../cocos/input/types/event-enum';
|
||||
const contactMap = new Map<b2ContactExtends, PhysicsContact>();
|
||||
const pools: PhysicsContact[] = [];
|
||||
|
||||
export type TouchCallback = (res: EventTouch) => void;
|
||||
|
||||
export class TouchInputSource {
|
||||
private _eventTarget: EventTarget = new EventTarget();
|
||||
|
||||
constructor () {
|
||||
export class PhysicsContactManager {
|
||||
static get (b2contact: b2ContactExtends): PhysicsContact {
|
||||
let c = pools.pop();
|
||||
if (!c) {
|
||||
c = new PhysicsContact();
|
||||
}
|
||||
c.init(b2contact);
|
||||
contactMap.set(b2contact, c);
|
||||
return c;
|
||||
}
|
||||
|
||||
|
||||
public dispatchEventsInCache (): void {
|
||||
|
||||
static find (b2contact: b2ContactExtends): PhysicsContact | null {
|
||||
return contactMap.get(b2contact) ?? null;
|
||||
}
|
||||
|
||||
public on (eventType: InputEventType, callback: TouchCallback, target?: any): void {
|
||||
this._eventTarget.on(eventType, callback, target);
|
||||
static put (b2contact: b2ContactExtends): void {
|
||||
const c = contactMap.get(b2contact);
|
||||
if (!c) return;
|
||||
pools.push(c);
|
||||
c.reset();
|
||||
contactMap.delete(b2contact);
|
||||
}
|
||||
|
||||
static clear (): void {
|
||||
contactMap.clear();
|
||||
pools.length = 0;
|
||||
}
|
||||
}
|
||||
@@ -33,8 +33,6 @@ export type b2ContactExtends = b2.Contact & {
|
||||
m_userData: any;
|
||||
}
|
||||
|
||||
const pools: PhysicsContact[] = [];
|
||||
|
||||
// temp world manifold
|
||||
const pointCache = [new Vec2(), new Vec2()];
|
||||
|
||||
@@ -68,25 +66,6 @@ const impulse: IPhysics2DImpulse = {
|
||||
|
||||
/** @mangle */
|
||||
export class PhysicsContact implements IPhysics2DContact {
|
||||
static get (b2contact: b2ContactExtends): PhysicsContact {
|
||||
let c = pools.pop();
|
||||
|
||||
if (!c) {
|
||||
c = new PhysicsContact();
|
||||
}
|
||||
|
||||
c.init(b2contact);
|
||||
return c;
|
||||
}
|
||||
|
||||
static put (b2contact: b2ContactExtends): void {
|
||||
const c: PhysicsContact = b2contact.m_userData as PhysicsContact;
|
||||
if (!c) return;
|
||||
|
||||
pools.push(c);
|
||||
c.reset();
|
||||
}
|
||||
|
||||
colliderA: Collider2D | null = null;
|
||||
colliderB: Collider2D | null = null;
|
||||
|
||||
@@ -111,7 +90,6 @@ export class PhysicsContact implements IPhysics2DContact {
|
||||
this._inverted = false;
|
||||
|
||||
this._b2contact = b2contact;
|
||||
b2contact.m_userData = this;
|
||||
}
|
||||
|
||||
reset (): void {
|
||||
@@ -124,7 +102,6 @@ export class PhysicsContact implements IPhysics2DContact {
|
||||
this.disabled = false;
|
||||
this._impulse = null;
|
||||
|
||||
this._b2contact!.m_userData = null;
|
||||
this._b2contact = null;
|
||||
}
|
||||
|
||||
|
||||
@@ -39,6 +39,7 @@ import { PhysicsDebugDraw } from './platform/physics-debug-draw';
|
||||
import { Node, find, Layers } from '../../scene-graph';
|
||||
import { director } from '../../game';
|
||||
import type { Graphics } from '../../2d/components/graphics';
|
||||
import { PhysicsContactManager } from './physics-contact-manager';
|
||||
|
||||
const tempVec3 = new Vec3();
|
||||
const tempVec2_1 = new Vec2();
|
||||
@@ -99,7 +100,7 @@ export class b2PhysicsWorld implements IPhysicsWorld {
|
||||
|
||||
if (!v) {
|
||||
if (this._debugGraphics) {
|
||||
this._debugGraphics.node.parent = null;
|
||||
this._debugGraphics.clear();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -414,22 +415,22 @@ export class b2PhysicsWorld implements IPhysicsWorld {
|
||||
}
|
||||
|
||||
_onBeginContact (b2contact: b2ContactExtends): void {
|
||||
const c = PhysicsContact.get(b2contact);
|
||||
const c = PhysicsContactManager.get(b2contact);
|
||||
c.emit(Contact2DType.BEGIN_CONTACT);
|
||||
}
|
||||
|
||||
_onEndContact (b2contact: b2ContactExtends): void {
|
||||
const c = b2contact.m_userData as PhysicsContact;
|
||||
const c = PhysicsContactManager.find(b2contact);
|
||||
if (!c) {
|
||||
return;
|
||||
}
|
||||
c.emit(Contact2DType.END_CONTACT);
|
||||
|
||||
PhysicsContact.put(b2contact);
|
||||
PhysicsContactManager.put(b2contact);
|
||||
}
|
||||
|
||||
_onPreSolve (b2contact: b2ContactExtends): void {
|
||||
const c = b2contact.m_userData as PhysicsContact;
|
||||
const c = PhysicsContactManager.find(b2contact);
|
||||
if (!c) {
|
||||
return;
|
||||
}
|
||||
@@ -438,7 +439,7 @@ export class b2PhysicsWorld implements IPhysicsWorld {
|
||||
}
|
||||
|
||||
_onPostSolve (b2contact: b2ContactExtends, impulse: b2.ContactImpulse): void {
|
||||
const c: PhysicsContact = b2contact.m_userData as PhysicsContact;
|
||||
const c = PhysicsContactManager.find(b2contact);
|
||||
if (!c) {
|
||||
return;
|
||||
}
|
||||
@@ -448,4 +449,7 @@ export class b2PhysicsWorld implements IPhysicsWorld {
|
||||
c.emit(Contact2DType.POST_SOLVE);
|
||||
c._setImpulse(null);
|
||||
}
|
||||
clearContacts (): void {
|
||||
PhysicsContactManager.clear();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -37,8 +37,8 @@ export class b2CircleShape extends b2Shape2D implements ICircleShape {
|
||||
|
||||
_worldPosition = new Vec2();
|
||||
get worldPosition (): Vec2 {
|
||||
const p = (this._shapes[0] as b2.CircleShape).m_p;
|
||||
return this._worldPosition.set(p.x * PHYSICS_2D_PTM_RATIO, p.y * PHYSICS_2D_PTM_RATIO);
|
||||
const comp = this.collider as CircleCollider2D;
|
||||
return Vec2.transformMat4(this._worldPosition, comp.offset, comp.node.worldMatrix);
|
||||
}
|
||||
|
||||
_createShapes (scaleX: number, scaleY: number, relativePositionX: number, relativePositionY: number): any[] {
|
||||
|
||||
@@ -285,4 +285,6 @@ export class BuiltinPhysicsWorld implements IPhysicsWorld {
|
||||
raycast (p1: IVec2Like, p2: IVec2Like, type: ERaycast2DType): RaycastResult2D[] {
|
||||
return [];
|
||||
}
|
||||
clearContacts (): void {
|
||||
}
|
||||
}
|
||||
|
||||
@@ -27,7 +27,7 @@ import { EDITOR, DEBUG, TEST, EDITOR_NOT_IN_PREVIEW } from 'internal:constants';
|
||||
import { IRigidBody2D } from '../spec/i-rigid-body';
|
||||
import { IBoxShape, ICircleShape, IPolygonShape, IBaseShape } from '../spec/i-physics-shape';
|
||||
import { IPhysicsWorld } from '../spec/i-physics-world';
|
||||
import { errorID, log } from '../../core';
|
||||
import { debug, errorID, log } from '../../core';
|
||||
import { ECollider2DType, EJoint2DType } from './physics-types';
|
||||
import { IJoint2D, IDistanceJoint, ISpringJoint, IFixedJoint, IMouseJoint,
|
||||
IRelativeJoint, ISliderJoint, IWheelJoint, IHingeJoint } from '../spec/i-physics-joint';
|
||||
@@ -110,7 +110,7 @@ export interface IPhysicsSelector {
|
||||
}
|
||||
|
||||
function register (id: IPhysicsEngineId, wrapper: IPhysicsWrapperObject): void {
|
||||
if (!EDITOR && !TEST) log(`[PHYSICS2D]: register ${id}.`);
|
||||
if (!EDITOR && !TEST) debug(`[PHYSICS2D]: register ${id}.`);
|
||||
selector.backend[id] = wrapper;
|
||||
if (!selector.physicsWorld || selector.id === id) {
|
||||
const mutableSelector = selector as Mutable<IPhysicsSelector>;
|
||||
@@ -124,12 +124,12 @@ function switchTo (id: IPhysicsEngineId): void {
|
||||
const mutableSelector = selector as Mutable<IPhysicsSelector>;
|
||||
if (selector.physicsWorld && id !== selector.id && selector.backend[id] != null) {
|
||||
//selector.physicsWorld.destroy();//todo
|
||||
if (!TEST) log(`[PHYSICS2D]: switch from ${selector.id} to ${id}.`);
|
||||
if (!TEST) debug(`[PHYSICS2D]: switch from ${selector.id} to ${id}.`);
|
||||
mutableSelector.id = id;
|
||||
mutableSelector.wrapper = selector.backend[id];
|
||||
mutableSelector.physicsWorld = createPhysicsWorld();
|
||||
} else {
|
||||
if (!EDITOR && !TEST) log(`[PHYSICS2D]: using ${mutableSelector.id}.`);
|
||||
if (!EDITOR && !TEST) debug(`[PHYSICS2D]: using ${mutableSelector.id}.`);
|
||||
mutableSelector.physicsWorld = createPhysicsWorld();
|
||||
}
|
||||
}
|
||||
@@ -165,6 +165,7 @@ const ENTIRE_WORLD: IPhysicsWorld = {
|
||||
testPoint: FUNC,
|
||||
testAABB: FUNC,
|
||||
drawDebug: FUNC,
|
||||
clearContacts: FUNC,
|
||||
};
|
||||
|
||||
export function checkPhysicsModule (obj: any): boolean {
|
||||
|
||||
@@ -381,8 +381,12 @@ export class PhysicsSystem2D extends Eventify(System) {
|
||||
static constructAndRegister (): void {
|
||||
director.registerSystem(PhysicsSystem2D.ID, PhysicsSystem2D.instance, SystemPriority.LOW);
|
||||
}
|
||||
clearContacts (): void {
|
||||
this.physicsWorld.clearContacts();
|
||||
}
|
||||
}
|
||||
|
||||
if (!BUILD || !LOAD_BOX2D_MANUALLY) {
|
||||
director.once(DirectorEvent.INIT, (): void => { PhysicsSystem2D.constructAndRegister(); });
|
||||
director.once(DirectorEvent.RESET, (): void => { PhysicsSystem2D.instance.clearContacts(); });
|
||||
}
|
||||
|
||||
@@ -38,4 +38,5 @@ export interface IPhysicsWorld {
|
||||
testPoint (p: Vec2): readonly Collider2D[];
|
||||
testAABB (rect: Rect): readonly Collider2D[];
|
||||
drawDebug (): void;
|
||||
clearContacts (): void;
|
||||
}
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
import { ensureWasmModuleReady, instantiateWasm } from 'pal/wasm';
|
||||
import { BUILD, LOAD_BULLET_MANUALLY, NATIVE_CODE_BUNDLE_MODE } from 'internal:constants';
|
||||
import { game } from '../../game';
|
||||
import { error, log, sys } from '../../core';
|
||||
import { debug, error, sys } from '../../core';
|
||||
import { NativeCodeBundleMode } from '../../misc/webassembly-support';
|
||||
import type { BulletCache } from './bullet-cache';
|
||||
|
||||
@@ -106,7 +106,7 @@ function initWASM (wasmFactory, wasmUrl: string): Promise<void> {
|
||||
}).catch((err) => reject(errorMessage(err)));
|
||||
},
|
||||
}).then((instance: any) => {
|
||||
log('[bullet]:bullet wasm lib loaded.');
|
||||
debug('[bullet]:bullet wasm lib loaded.');
|
||||
bt = instance as Bullet.instance;
|
||||
globalThis.Bullet = bt as any;
|
||||
}).then(resolve).catch((err: any) => reject(errorMessage(err)));
|
||||
@@ -117,7 +117,7 @@ function initASM (asmFactory): Promise<void> {
|
||||
if (asmFactory != null) {
|
||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-return
|
||||
return asmFactory().then((instance: any) => {
|
||||
log('[bullet]:bullet asm lib loaded.');
|
||||
debug('[bullet]:bullet asm lib loaded.');
|
||||
bt = instance as Bullet.instance;
|
||||
});
|
||||
} else {
|
||||
|
||||
@@ -35,7 +35,7 @@ import {
|
||||
import { IPhysicsWorld } from '../spec/i-physics-world';
|
||||
import { IRigidBody } from '../spec/i-rigid-body';
|
||||
import { IBoxCharacterController, ICapsuleCharacterController } from '../spec/i-character-controller';
|
||||
import { errorID, IVec3Like, warn, cclegacy, log } from '../../core';
|
||||
import { errorID, IVec3Like, warn, cclegacy, debug } from '../../core';
|
||||
import { EColliderType, EConstraintType, ECharacterControllerType } from './physics-enum';
|
||||
import { PhysicsMaterial } from '.';
|
||||
|
||||
@@ -125,7 +125,7 @@ function updateLegacyMacro (id: string): void {
|
||||
}
|
||||
|
||||
function register (id: IPhysicsEngineId, wrapper: IPhysicsWrapperObject): void {
|
||||
if (!EDITOR && !TEST) log(`[PHYSICS]: register ${id}.`);
|
||||
if (!EDITOR && !TEST) debug(`[PHYSICS]: register ${id}.`);
|
||||
selector.backend[id] = wrapper;
|
||||
if (!selector.physicsWorld || selector.id === id) {
|
||||
updateLegacyMacro(id);
|
||||
@@ -147,13 +147,13 @@ function switchTo (id: IPhysicsEngineId): void {
|
||||
const mutableSelector = selector as Mutable<IPhysicsSelector>;
|
||||
if (selector.physicsWorld && id !== selector.id && selector.backend[id] != null) {
|
||||
selector.physicsWorld.destroy();
|
||||
if (!TEST) log(`[PHYSICS]: switch from ${selector.id} to ${id}.`);
|
||||
if (!TEST) debug(`[PHYSICS]: switch from ${selector.id} to ${id}.`);
|
||||
updateLegacyMacro(id);
|
||||
mutableSelector.id = id;
|
||||
mutableSelector.wrapper = selector.backend[id];
|
||||
mutableSelector.physicsWorld = createPhysicsWorld();
|
||||
} else {
|
||||
if (!EDITOR && !TEST) log(`[PHYSICS]: using ${id}.`);
|
||||
if (!EDITOR && !TEST) debug(`[PHYSICS]: using ${id}.`);
|
||||
mutableSelector.physicsWorld = createPhysicsWorld();
|
||||
}
|
||||
if (worldInitData) {
|
||||
@@ -185,7 +185,7 @@ export function constructDefaultWorld (data: IWorldInitData): void {
|
||||
if (!worldInitData) worldInitData = data;
|
||||
if (!selector.runInEditor) return;
|
||||
if (!selector.physicsWorld) {
|
||||
if (!TEST) log(`[PHYSICS]: using ${selector.id}.`);
|
||||
if (!TEST) debug(`[PHYSICS]: using ${selector.id}.`);
|
||||
const mutableSelector = selector as Mutable<IPhysicsSelector>;
|
||||
const world = mutableSelector.physicsWorld = createPhysicsWorld();
|
||||
world.setGravity(worldInitData.gravity);
|
||||
|
||||
@@ -60,6 +60,7 @@ interface IProfilerState {
|
||||
frame: ICounterOption;
|
||||
fps: ICounterOption;
|
||||
draws: ICounterOption;
|
||||
dispatches: ICounterOption;
|
||||
instances: ICounterOption;
|
||||
tricount: ICounterOption;
|
||||
logic: ICounterOption;
|
||||
@@ -73,6 +74,7 @@ interface IProfilerState {
|
||||
const _profileInfo = {
|
||||
fps: { desc: `Framerate (FPS)`, below: 30, average: _average, isInteger: true },
|
||||
draws: { desc: 'Draw call', isInteger: true },
|
||||
dispatches: { desc: 'Dispatch call', isInteger: true },
|
||||
frame: { desc: 'Frame time (ms)', min: 0, max: 50, average: _average },
|
||||
instances: { desc: 'Instance Count', isInteger: true },
|
||||
tricount: { desc: 'Triangle', isInteger: true },
|
||||
@@ -586,6 +588,8 @@ export class Profiler extends System {
|
||||
|
||||
const device = this._device!;
|
||||
(profilerStats.draws.counter as PerfCounter).value = device.numDrawCalls;
|
||||
// Native (JSB) devices expose no dispatch stats yet; WebGPU does. Treat missing as 0.
|
||||
(profilerStats.dispatches.counter as PerfCounter).value = device.numDispatches ?? 0;
|
||||
(profilerStats.instances.counter as PerfCounter).value = device.numInstances;
|
||||
(profilerStats.bufferMemory.counter as PerfCounter).value = device.memoryStatus.bufferSize / (1024 * 1024);
|
||||
(profilerStats.textureMemory.counter as PerfCounter).value = device.memoryStatus.textureSize / (1024 * 1024);
|
||||
|
||||
@@ -31,7 +31,7 @@ import { murmurhash2_32_gc, errorID, assertID, cclegacy, warnID } from '../../co
|
||||
import {
|
||||
BufferUsageBit, DynamicStateFlagBit, DynamicStateFlags, Feature, GetTypeSize, MemoryUsageBit, PrimitiveMode, Type, Color,
|
||||
BlendState, BlendTarget, Buffer, BufferInfo, BufferViewInfo, DepthStencilState, DescriptorSet,
|
||||
DescriptorSetInfo, DescriptorSetLayout, Device, RasterizerState, Sampler, Texture, Shader, PipelineLayout, deviceManager, UniformBlock,
|
||||
DescriptorSetInfo, DescriptorSetLayout, Device, RasterizerState, Sampler, SampleCount, Texture, Shader, PipelineLayout, deviceManager, UniformBlock,
|
||||
} from '../../gfx';
|
||||
import { EffectAsset } from '../../asset/assets/effect-asset';
|
||||
import { IProgramInfo, programLib } from './program-lib';
|
||||
@@ -139,6 +139,28 @@ export class Pass {
|
||||
if (bsInfo.isA2C !== undefined) { bs.isA2C = bsInfo.isA2C; }
|
||||
if (bsInfo.isIndepend !== undefined) { bs.isIndepend = bsInfo.isIndepend; }
|
||||
if (bsInfo.blendColor !== undefined) { bs.blendColor = bsInfo.blendColor as Color; }
|
||||
|
||||
// A2C (Alpha to Coverage) requires MSAA to be effective.
|
||||
// Without multiple subsamples, A2C behaves like alpha-test at ~0.5 and should be disabled.
|
||||
// Disable A2C when neither the pass nor the global framebuffer has MSAA enabled:
|
||||
// - passWantsMultisample: pass explicitly requests isMultisample
|
||||
// - globalMsaaEnabled: swapchain has MSAA (native: colorTexture.samples > X1;
|
||||
// WebGL: antialias from gl.getContextAttributes(), since WebGL
|
||||
// MSAA is controlled at context level, not texture level)
|
||||
if (bs.isA2C) {
|
||||
const gfxDevice = deviceManager.gfxDevice as any;
|
||||
const gl: WebGL2RenderingContext | WebGLRenderingContext | null = gfxDevice.gl || null;
|
||||
const ctxAttrs = gl && gl.getContextAttributes();
|
||||
const antialias: boolean = !!(ctxAttrs && ctxAttrs.antialias);
|
||||
const passWantsMultisample = (info.rasterizerState && info.rasterizerState.isMultisample === true);
|
||||
const swapchain = deviceManager.swapchain;
|
||||
const colorTex = swapchain && swapchain.colorTexture;
|
||||
const msaaDisabled = (!colorTex || (colorTex && colorTex.samples <= SampleCount.X1))
|
||||
|| !antialias || !passWantsMultisample;
|
||||
if (msaaDisabled) {
|
||||
bs.isA2C = false;
|
||||
}
|
||||
}
|
||||
}
|
||||
pass._rs.assign(info.rasterizerState as RasterizerState);
|
||||
pass._dss.assign(info.depthStencilState as DepthStencilState);
|
||||
|
||||
@@ -21,12 +21,14 @@
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
*/
|
||||
import { DEBUG } from 'internal:constants';
|
||||
import { screenAdapter } from 'pal/screen-adapter';
|
||||
import { Orientation } from '../../../pal/screen-adapter/enum-type';
|
||||
import {
|
||||
TextureType, TextureUsageBit, Format, RenderPass, Texture, Framebuffer,
|
||||
RenderPassInfo, Device, TextureInfo, FramebufferInfo, Swapchain, SurfaceTransform, TextureFlagBit, TextureFlags,
|
||||
} from '../../gfx';
|
||||
import { warn } from '../../core/platform/debug';
|
||||
import { Root } from '../../root';
|
||||
import { Camera } from '../scene';
|
||||
|
||||
@@ -41,7 +43,10 @@ export interface IRenderWindowInfo {
|
||||
externalFlag?: TextureFlags; // external texture type normal or oes
|
||||
}
|
||||
|
||||
const orientationMap: Record<Orientation, SurfaceTransform> = {
|
||||
// NOTE: `Orientation` is a flag enum whose composite members (LANDSCAPE, AUTO) are never
|
||||
// actual runtime orientations, so this map intentionally only covers the physical ones.
|
||||
// It is therefore typed as Partial rather than a total Record<Orientation, ...>.
|
||||
const orientationMap: Partial<Record<Orientation, SurfaceTransform>> = {
|
||||
[Orientation.PORTRAIT]: SurfaceTransform.IDENTITY,
|
||||
[Orientation.LANDSCAPE_RIGHT]: SurfaceTransform.ROTATE_90,
|
||||
[Orientation.PORTRAIT_UPSIDE_DOWN]: SurfaceTransform.ROTATE_180,
|
||||
@@ -253,7 +258,11 @@ export class RenderWindow {
|
||||
*/
|
||||
public resize (width: number, height: number): void {
|
||||
if (this._swapchain) {
|
||||
this._swapchain.resize(width, height, orientationMap[screenAdapter.orientation]);
|
||||
const surfaceTransform = orientationMap[screenAdapter.orientation];
|
||||
if (DEBUG && surfaceTransform === undefined) {
|
||||
warn(`Unexpected screen orientation: ${screenAdapter.orientation}`);
|
||||
}
|
||||
this._swapchain.resize(width, height, surfaceTransform || SurfaceTransform.IDENTITY);
|
||||
this._width = this._swapchain.width;
|
||||
this._height = this._swapchain.height;
|
||||
} else {
|
||||
|
||||
@@ -91,6 +91,9 @@ export class PointLight extends Light {
|
||||
* @en The luminance of the light source in LDR mode.
|
||||
* @zh LDR 模式下光源的亮度。
|
||||
*/
|
||||
get luminanceLDR (): number {
|
||||
return this._luminanceLDR;
|
||||
}
|
||||
set luminanceLDR (value: number) {
|
||||
this._luminanceLDR = value;
|
||||
}
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user