From 197755a243d730dfd813a798a452c889b008dff1 Mon Sep 17 00:00:00 2001 From: Martin Valigursky Date: Tue, 30 Jan 2024 09:30:06 +0000 Subject: [PATCH] Expose docs for GSplatResource and GSplatComponent --- src/framework/parsers/gsplat-resource.js | 7 +++++++ src/index.js | 2 ++ 2 files changed, 9 insertions(+) diff --git a/src/framework/parsers/gsplat-resource.js b/src/framework/parsers/gsplat-resource.js index 655cc837945..aca4d28e73c 100644 --- a/src/framework/parsers/gsplat-resource.js +++ b/src/framework/parsers/gsplat-resource.js @@ -3,6 +3,11 @@ import { Entity } from '../entity.js'; import { GSplatInstance } from '../../scene/gsplat/gsplat-instance.js'; import { GSplat } from '../../scene/gsplat/gsplat.js'; +/** + * The resource for the gsplat asset type. + * + * @category Graphics + */ class GSplatResource { /** * @type {import('../../platform/graphics/graphics-device.js').GraphicsDevice} @@ -74,6 +79,8 @@ class GSplatResource { } /** + * Instantiates an entity with a {@link GSplatComponent}. + * * @param {import('../../scene/gsplat/gsplat-material.js').SplatMaterialOptions} [options] - The options. * @returns {Entity} The entity with {@link GSplatComponent}. */ diff --git a/src/index.js b/src/index.js index 5ad3b0ea95a..01026bb01b6 100644 --- a/src/index.js +++ b/src/index.js @@ -215,6 +215,7 @@ export { ElementComponentSystem } from './framework/components/element/system.js export { ElementDragHelper } from './framework/components/element/element-drag-helper.js'; export { Entity } from './framework/entity.js'; export { EntityReference } from './framework/utils/entity-reference.js'; +export { GSplatComponent } from './framework/components/gsplat/component.js'; export { GSplatComponentSystem } from './framework/components/gsplat/system.js'; export { ImageElement } from './framework/components/element/image-element.js'; export * from './framework/components/joint/constants.js'; @@ -315,6 +316,7 @@ export { CssHandler } from './framework/handlers/css.js'; export { CubemapHandler } from './framework/handlers/cubemap.js'; export { FolderHandler } from './framework/handlers/folder.js'; export { FontHandler } from './framework/handlers/font.js'; +export { GSplatResource } from './framework/parsers/gsplat-resource.js'; export { HierarchyHandler } from './framework/handlers/hierarchy.js'; export { HtmlHandler } from './framework/handlers/html.js'; export { JsonHandler } from './framework/handlers/json.js';