Skip to content

Commit

Permalink
Expose docs for GSplatResource and GSplatComponent (#6021)
Browse files Browse the repository at this point in the history
Co-authored-by: Martin Valigursky <mvaligursky@snapchat.com>
  • Loading branch information
mvaligursky and Martin Valigursky authored Jan 30, 2024
1 parent bc315e8 commit 5598389
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
7 changes: 7 additions & 0 deletions src/framework/parsers/gsplat-resource.js
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down Expand Up @@ -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}.
*/
Expand Down
2 changes: 2 additions & 0 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down Expand Up @@ -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';
Expand Down

0 comments on commit 5598389

Please sign in to comment.