Skip to content

Expose bound texture layer count via NativeEngine.getTextureLayerCount #1733

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
bghgary wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Expose bound texture layer count via NativeEngine.getTextureLayerCount #1733

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6f26e4f
Expose bound texture layer count via NativeEngine.getTextureLayerCount
bghgary Jun 2, 2026
7aa2d93
Add integration test for wrapNativeTexture layer-count population
bghgary Jun 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Apps/UnitTests/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ set(BABYLONJS_MATERIALS_ASSETS

set(TEST_ASSETS
"JavaScript/dist/tests.externalTexture.deviceLoss.js"
"JavaScript/dist/tests.externalTexture.layerCount.js"
"JavaScript/dist/tests.externalTexture.msaa.js"
"JavaScript/dist/tests.externalTexture.render.js"
"JavaScript/dist/tests.javaScript.all.js"
Expand All @@ -26,6 +27,7 @@ set(SOURCES
"Source/App.cpp"
"Source/Tests.ExternalTexture.cpp"
"Source/Tests.ExternalTexture.DeviceLoss.cpp"
"Source/Tests.ExternalTexture.LayerCount.cpp"
"Source/Tests.ExternalTexture.Msaa.cpp"
"Source/Tests.ExternalTexture.Render.cpp"
"Source/Tests.JavaScript.cpp"
Expand Down
154 changes: 154 additions & 0 deletions Apps/UnitTests/JavaScript/dist/tests.externalTexture.layerCount.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
/******/ (() => { // webpackBootstrap
/******/ "use strict";
/******/ var __webpack_modules__ = ({

/***/ "@babylonjs/core"
/*!**************************!*\
!*** external "BABYLON" ***!
\**************************/
(module) {

module.exports = BABYLON;

/***/ }

/******/ });
/************************************************************************/
/******/ // The module cache
/******/ var __webpack_module_cache__ = {};
/******/
/******/ // The require function
/******/ function __webpack_require__(moduleId) {
/******/ // Check if module is in cache
/******/ var cachedModule = __webpack_module_cache__[moduleId];
/******/ if (cachedModule !== undefined) {
/******/ return cachedModule.exports;
/******/ }
/******/ // Check if module exists (development only)
/******/ if (__webpack_modules__[moduleId] === undefined) {
/******/ var e = new Error("Cannot find module '" + moduleId + "'");
/******/ e.code = 'MODULE_NOT_FOUND';
/******/ throw e;
/******/ }
/******/ // Create a new module (and put it into the cache)
/******/ var module = __webpack_module_cache__[moduleId] = {
/******/ // no module.id needed
/******/ // no module.loaded needed
/******/ exports: {}
/******/ };
/******/
/******/ // Execute the module function
/******/ __webpack_modules__[moduleId](module, module.exports, __webpack_require__);
/******/
/******/ // Return the exports of the module
/******/ return module.exports;
/******/ }
/******/
/************************************************************************/
/******/ /* webpack/runtime/compat get default export */
/******/ (() => {
/******/ // getDefaultExport function for compatibility with non-harmony modules
/******/ __webpack_require__.n = (module) => {
/******/ var getter = module && module.__esModule ?
/******/ () => (module['default']) :
/******/ () => (module);
/******/ __webpack_require__.d(getter, { a: getter });
/******/ return getter;
/******/ };
/******/ })();
/******/
/******/ /* webpack/runtime/define property getters */
/******/ (() => {
/******/ // define getter functions for harmony exports
/******/ __webpack_require__.d = (exports, definition) => {
/******/ for(var key in definition) {
/******/ if(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {
/******/ Object.defineProperty(exports, key, { enumerable: true, get: definition[key] });
/******/ }
/******/ }
/******/ };
/******/ })();
/******/
/******/ /* webpack/runtime/hasOwnProperty shorthand */
/******/ (() => {
/******/ __webpack_require__.o = (obj, prop) => (Object.prototype.hasOwnProperty.call(obj, prop))
/******/ })();
/******/
/******/ /* webpack/runtime/make namespace object */
/******/ (() => {
/******/ // define __esModule on exports
/******/ __webpack_require__.r = (exports) => {
/******/ if(typeof Symbol !== 'undefined' && Symbol.toStringTag) {
/******/ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
/******/ }
/******/ Object.defineProperty(exports, '__esModule', { value: true });
/******/ };
/******/ })();
/******/
/************************************************************************/
var __webpack_exports__ = {};
// This entry needs to be wrapped in an IIFE because it needs to be isolated against other modules in the chunk.
(() => {
/*!*************************************************!*\
!*** ./src/tests.externalTexture.layerCount.ts ***!
\*************************************************/
__webpack_require__.r(__webpack_exports__);
/* harmony import */ var _babylonjs_core__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! @babylonjs/core */ "@babylonjs/core");
/* harmony import */ var _babylonjs_core__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__webpack_require__.n(_babylonjs_core__WEBPACK_IMPORTED_MODULE_0__);
// JS-side scaffolding for Tests.ExternalTexture.LayerCount.cpp.
//
// Verifies that wrapNativeTexture auto-populates is2DArray/depth/baseDepth on the wrapped
// InternalTexture from the native layer count:
// - BN exposes getTextureLayerCount(handle) (BabylonJS/BabylonNative#1733), reporting the *bound*
// layer count: 1 for a single-slice view (layerIndex set), else the underlying array size.
// - BJS wrapNativeTexture consumes it (BabylonJS/Babylon.js#18535): layers > 1 -> is2DArray=true,
// baseDepth=depth=layers; layers == 1 -> left as a plain 2D texture.
// C++ wraps whole-array, single-slice, and single-layer native textures and asserts the values
// reported back here.




var engine;

function getEngine() {
if (!engine) {
engine = new _babylonjs_core__WEBPACK_IMPORTED_MODULE_0__.NativeEngine();
// This test never renders; don't wait on async shader compilation.
delete engine.getCaps().parallelShaderCompile;
}
return engine;
}









// Wraps the given native texture and returns the layer-related InternalTexture fields, plus the raw
// native layer count so C++ can tell "binding missing" / "BJS too old" from a real failure.
function inspectWrappedTexture(nativeTexture) {
var e = getEngine();
// getTextureLayerCount is a binding on the raw native engine (_engine), which is private and not
// yet in the shipped @babylonjs/core types; wrapNativeTexture reads it internally via this._engine.
var nativeEngine = e._engine;
var hasBinding = !!nativeEngine && typeof nativeEngine.getTextureLayerCount === "function";
var rawLayerCount = hasBinding ? nativeEngine.getTextureLayerCount(nativeTexture) : -1;
var internalTexture = e.wrapNativeTexture(nativeTexture);
return {
hasBinding: hasBinding,
rawLayerCount: rawLayerCount,
is2DArray: !!internalTexture.is2DArray,
depth: internalTexture.depth,
baseDepth: internalTexture.baseDepth
};
}

globalThis.inspectWrappedTexture = inspectWrappedTexture;
})();

/******/ })()
;
53 changes: 53 additions & 0 deletions Apps/UnitTests/JavaScript/src/tests.externalTexture.layerCount.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
// JS-side scaffolding for Tests.ExternalTexture.LayerCount.cpp.
//
// Verifies that wrapNativeTexture auto-populates is2DArray/depth/baseDepth on the wrapped
// InternalTexture from the native layer count:
// - BN exposes getTextureLayerCount(handle) (BabylonJS/BabylonNative#1733), reporting the *bound*
// layer count: 1 for a single-slice view (layerIndex set), else the underlying array size.
// - BJS wrapNativeTexture consumes it (BabylonJS/Babylon.js#18535): layers > 1 -> is2DArray=true,
// baseDepth=depth=layers; layers == 1 -> left as a plain 2D texture.
// C++ wraps whole-array, single-slice, and single-layer native textures and asserts the values
// reported back here.

import { NativeEngine } from "@babylonjs/core";
import type { InternalTexture } from "@babylonjs/core";

let engine: NativeEngine | undefined;

function getEngine(): NativeEngine {
if (!engine) {
engine = new NativeEngine();
// This test never renders; don't wait on async shader compilation.
delete engine.getCaps().parallelShaderCompile;
}
return engine;
}

interface WrappedTextureInfo {
hasBinding: boolean;
rawLayerCount: number;
is2DArray: boolean;
depth: number;
baseDepth: number;
}

// Wraps the given native texture and returns the layer-related InternalTexture fields, plus the raw
// native layer count so C++ can tell "binding missing" / "BJS too old" from a real failure.
function inspectWrappedTexture(nativeTexture: unknown): WrappedTextureInfo {
const e = getEngine();
// getTextureLayerCount is a binding on the raw native engine (_engine), which is private and not
// yet in the shipped @babylonjs/core types; wrapNativeTexture reads it internally via this._engine.
const nativeEngine = (e as any)._engine;
const hasBinding = !!nativeEngine && typeof nativeEngine.getTextureLayerCount === "function";
const rawLayerCount = hasBinding ? nativeEngine.getTextureLayerCount(nativeTexture) : -1;
const internalTexture: InternalTexture = e.wrapNativeTexture(nativeTexture);
return {
hasBinding,
rawLayerCount,
is2DArray: !!internalTexture.is2DArray,
depth: internalTexture.depth,
baseDepth: internalTexture.baseDepth,
};
}

(globalThis as any).inspectWrappedTexture = inspectWrappedTexture;
1 change: 1 addition & 0 deletions Apps/UnitTests/JavaScript/webpack.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ module.exports = {
"tests.shaderCompilation.comprehensiveGLSL": './src/tests.shaderCompilation.comprehensiveGLSL.ts',
"tests.externalTexture.msaa": './src/tests.externalTexture.msaa.ts',
"tests.externalTexture.deviceLoss": './src/tests.externalTexture.deviceLoss.ts',
"tests.externalTexture.layerCount": './src/tests.externalTexture.layerCount.ts',
},
externals: {
"@babylonjs/core": "BABYLON",
Expand Down
151 changes: 151 additions & 0 deletions Apps/UnitTests/Source/Tests.ExternalTexture.LayerCount.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
#include <gtest/gtest.h>

#include <Babylon/AppRuntime.h>
#include <Babylon/Graphics/Device.h>
#include <Babylon/Polyfills/Console.h>
#include <Babylon/Polyfills/Window.h>
#include <Babylon/Plugins/NativeEngine.h>
#include <Babylon/Plugins/ExternalTexture.h>
#include <Babylon/ScriptLoader.h>

#include "Helpers.h"

#include <cstdlib>
#include <future>
#include <iostream>
#include <optional>

extern Babylon::Graphics::Configuration g_deviceConfig;

namespace
{
constexpr uint32_t TEX_SIZE = 64;

struct WrappedTextureInfo
{
bool hasBinding = false;
int rawLayerCount = -1;
bool is2DArray = false;
uint32_t depth = 0;
uint32_t baseDepth = 0;
};
}

// End-to-end test for wrapNativeTexture's array-layer population across the BN/BJS boundary:
// * BN exposes getTextureLayerCount(handle) (BabylonJS/BabylonNative#1733). It reports the *bound*
// layer count: the single-slice view count when an ExternalTexture is wrapped with a layerIndex,
// otherwise the underlying array size.
// * BJS wrapNativeTexture consumes it (BabylonJS/Babylon.js#18535): layers > 1 -> is2DArray=true,
// baseDepth=depth=layers; layers == 1 -> a plain 2D texture.
// Wraps three ExternalTextures and asserts the resulting InternalTexture layer flags:
// (A) arraySize=2, no layerIndex -> whole array -> layerCount 2, is2DArray=true, depth=baseDepth=2.
// (B) arraySize=2, layerIndex=0 -> single slice -> layerCount 1, is2DArray=false.
// This mirrors a host wrapping one slice of an NV12 array per video plane, and guards
// against regressing a single array slice into a 2D array.
// (C) arraySize=1, no layerIndex -> single layer -> layerCount 1, is2DArray=false.
// Skips cleanly when the native binding or the consuming BJS change is absent so it stays green
// across the cross-repo landing order.
TEST(ExternalTexture, WrapNativeTextureLayerCount)
{
#if defined(SKIP_EXTERNAL_TEXTURE_TESTS) || defined(SKIP_RENDER_TESTS)
GTEST_SKIP();
#else
Babylon::Graphics::Device device{g_deviceConfig};

Babylon::AppRuntime::Options options{};
options.UnhandledExceptionHandler = [](const Napi::Error& error) {
std::cerr << "[Uncaught Error] " << Napi::GetErrorString(error) << std::endl;
std::quick_exit(1);
};
Babylon::AppRuntime runtime{options};

runtime.Dispatch([&device](Napi::Env env) {
env.Global().Set("globalThis", env.Global());
device.AddToJavaScript(env);
Babylon::Polyfills::Console::Initialize(env, [](const char* message, auto) {
std::cout << message << std::endl;
});
Babylon::Polyfills::Window::Initialize(env);
Babylon::Plugins::NativeEngine::Initialize(env);
});

Babylon::ScriptLoader loader{runtime};
loader.LoadScript("app:///Assets/babylon.max.js");
loader.LoadScript("app:///Assets/tests.externalTexture.layerCount.js");

// Creates a native texture with the requested array size, wraps it via the synchronous
// CreateForJavaScript (optionally selecting a single array layer), runs wrapNativeTexture on the
// JS side, and returns the layer-related InternalTexture fields it reports. CreateForJavaScript
// requires an active frame, so the whole wrap is bracketed by Start/FinishRenderingCurrentFrame.
auto inspect = [&](uint32_t arraySize, std::optional<uint16_t> layerIndex) -> WrappedTextureInfo {
device.StartRenderingCurrentFrame();

auto nativeTexture = Helpers::CreateTexture(
device.GetPlatformInfo().Device, TEX_SIZE, TEX_SIZE, arraySize, false);
Babylon::Plugins::ExternalTexture externalTexture{nativeTexture};

std::promise<WrappedTextureInfo> resultPromise;
loader.Dispatch([&externalTexture, layerIndex, &resultPromise](Napi::Env env) {
try
{
auto jsNativeTexture = externalTexture.CreateForJavaScript(env, layerIndex);
auto result = env.Global()
.Get("inspectWrappedTexture")
.As<Napi::Function>()
.Call({jsNativeTexture})
.As<Napi::Object>();
WrappedTextureInfo wti{};
wti.hasBinding = result.Get("hasBinding").ToBoolean();
wti.rawLayerCount = result.Get("rawLayerCount").ToNumber().Int32Value();
wti.is2DArray = result.Get("is2DArray").ToBoolean();
wti.depth = result.Get("depth").ToNumber().Uint32Value();
wti.baseDepth = result.Get("baseDepth").ToNumber().Uint32Value();
resultPromise.set_value(wti);
}
catch (...)
{
resultPromise.set_exception(std::current_exception());
}
});

auto info = resultPromise.get_future().get();
device.FinishRenderingCurrentFrame();

Helpers::DestroyTexture(nativeTexture);
return info;
};

// --- (A) Multi-layer texture wrapped as the whole array ---
const WrappedTextureInfo arrayInfo = inspect(2, std::nullopt);

if (!arrayInfo.hasBinding)
{
GTEST_SKIP() << "engine.getTextureLayerCount is unavailable -- requires Babylon Native with "
"BabylonJS/BabylonNative#1733.";
}

EXPECT_EQ(arrayInfo.rawLayerCount, 2) << "Whole-array wrap should report the native array size.";

if (arrayInfo.rawLayerCount == 2 && !arrayInfo.is2DArray)
{
GTEST_SKIP() << "wrapNativeTexture did not populate is2DArray from the layer count -- requires "
"@babylonjs/core with BabylonJS/Babylon.js#18535.";
}

EXPECT_TRUE(arrayInfo.is2DArray) << "Whole-array wrap should be is2DArray=true.";
EXPECT_EQ(arrayInfo.depth, 2u) << "Whole-array depth should equal the native layer count.";
EXPECT_EQ(arrayInfo.baseDepth, 2u) << "Whole-array baseDepth should equal the native layer count.";

// --- (B) Same array, wrapped as a single slice (layerIndex=0): one slice of an NV12-style array ---
const WrappedTextureInfo sliceInfo = inspect(2, static_cast<uint16_t>(0));

EXPECT_EQ(sliceInfo.rawLayerCount, 1) << "Single-slice view should report 1 bound layer, not the array size.";
EXPECT_FALSE(sliceInfo.is2DArray) << "Single-slice view must not be flagged is2DArray.";

// --- (C) Single-layer texture ---
const WrappedTextureInfo singleInfo = inspect(1, std::nullopt);

EXPECT_EQ(singleInfo.rawLayerCount, 1) << "Single-layer texture should report 1 layer.";
EXPECT_FALSE(singleInfo.is2DArray) << "Single-layer texture should not be flagged is2DArray.";
#endif
}
Loading