API reference
API reference
Select your platform
No SDKs available
No versions available

com.meta.spatial.runtime

Package-level declarations

Types

NameSummary
enum AlphaMode : Enum<AlphaMode>
data class Anchor(var handle: Long, var uuid: UUID)
class AnimationTrack(val id: Int, val name: String, val length: Float)
interface AssetFetcher
enum BlendFactor : Enum<BlendFactor>
Defines the coefficient to multiply in layer blending. "Source" refers to the layer you are currently compositing and "destination" refers to whatever is already in the buffer.
enum BlendMode : Enum<BlendMode>
object ButtonBits
class ButtonClickEventArgs(val hitInfo: HitInfo, val dataModel: DataModel) : EventArgs
class ButtonDownEventArgs(val hitInfo: HitInfo, val button: ControllerButton, val dataModel: DataModel) : EventArgs
class ButtonHoverEventArgs(val isStart: Boolean, val dataModel: DataModel) : EventArgs
class ButtonHoverMoveEventArgs(val hitInfo: HitInfo, val dataModel: DataModel) : EventArgs
class ButtonReleaseEventArgs(val hitInfo: HitInfo, val button: ControllerButton, val dataModel: DataModel) : EventArgs
data class ControllerPose(val pose: Pose, val flags: Int)
represents a Controller pose. A controller has side information beyond a pose
class CylinderLayerConfig(var radius: Float, var alphaBlend: LayerAlphaBlend? = null, var colorScaleBias: LayerColorScaleBias? = null, var zIndex: Int = 0) : LayerConfig
Layer config for a single-sided, cylindrical surface
enum DepthTest : Enum<DepthTest>
enum DepthWrite : Enum<DepthWrite>
class EquirectLayerConfig(var radius: Float, var centralHorizontalAngle: Float = (2.0 * Math.PI).toFloat(), var upperVerticalAngle: Float = (Math.PI / 2).toFloat(), var lowerVerticalAngle: Float = -(Math.PI / 2).toFloat(), var alphaBlend: LayerAlphaBlend? = null, var colorScaleBias: LayerColorScaleBias? = null, var zIndex: Int = 0) : LayerConfig
Layer config for a single-sided, surface projected on the inside of a sphere
enum Filter : Enum<Filter>
class HitInfo(val entity: Entity?, val sceneObjectHandle: Long, val nodeId: Int, val meshElementId: Int, val distance: Float, val point: Vector3, val normal: Vector3, val textureCoordinate: Vector2)
interface InputListener
class LastMotionInfo(val lastX: Float, val lastY: Float, val pressed: Boolean)
data class LayerAlphaBlend(val sourceFactorColor: BlendFactor, val destinationFactorColor: BlendFactor, val sourceFactorAlpha: BlendFactor, val destinationFactorAlpha: BlendFactor)
Defines the coefficients of how to blend the layer (using an add operation). "Source" refers to the layer you are currently compositing and "destination" refers to whatever is already in the buffer. This compositing can be modeled by:
class LayerColorScaleBias(var scale: Vector4, var bias: Vector4)
open class LayerConfig(var alphaBlend: LayerAlphaBlend? = null, var colorScaleBias: LayerColorScaleBias? = null, var zIndex: Int = 0, var secure: Boolean = false)
class NativeResultException(val errorCode: Int) : Exception
data class PanelConfigOptions(var layoutHeightInPx: Int = 0, var layoutWidthInPx: Int = 0, var layoutHeightInDp: Float = 0.0f, var layoutWidthInDp: Float = 0.0f, var layoutDpi: Int = DEFAULT_DPI, var height: Float = 1.0f * 3f / 4f, var width: Float = 1.0f, var radiusForCylinderOrSphere: Float = MAX_RADIUS, var pivotOffsetHeight: Float = 0.5f, var pivotOffsetWidth: Float = 0.5f, var fractionOfScreen: Float = 0.5f, var mips: Int = 4, var samplerConfig: SamplerConfig = DEFAULT_PANEL_SAMPLER, var unlit: Boolean = true, var includeGlass: Boolean = true, var stereoMode: StereoMode = StereoMode.None, var alphaMode: AlphaMode = AlphaMode.MASKED, var forceSceneTexture: Boolean = false, var clickButtons: Int = DEFAULT_CLICK_BUTTONS, var panelShader: String = "", var effectShader: String = "", var sceneMeshCreator: PanelShapeConfig.(texture: SceneTexture) -> SceneMesh? = null, var layerConfig: LayerConfig? = null, var panelShapeType: PanelShapeType = PanelShapeType.QUAD, var enableTransparent: Boolean = false, var enableLayer: Boolean = false, var themeResourceId: Int = 0) : PanelShapeConfig
Configuration options for the panel. This is used to configure the panel’s size, shape, resolution, mesh creator, and other properties. This is used to create the panel’s SceneObject.
open class PanelDisplay(ctx: <Error class: unknown class>, val panelSurface: PanelSurface, surfaceDPI: Int, getView: (<Error class: unknown class>) -> <Error class: unknown class>? = null, intent: <Error class: unknown class>? = null, themeResourceId: Int = 0, onAutoReleased: () -> Unit? = null)
class PanelInputListener(ctx: SpatialContext, clickButtons: Int, scene_: Scene) : InputListener
class PanelShapeconstructor(scene: Scene, options: PanelConfigOptions2, val panelSurface: PanelSurface, sceneObject: SceneObject, var config: PanelShapeConfig? = null)
open class PanelShapeConfig(var pivotOffsetHeight: Float = 0.5f, var pivotOffsetWidth: Float = 0.5f, var fractionOfScreen: Float = 0.5f, var height: Float = 1.0f * 3f / 4f, var width: Float = 1.0f, var radiusForCylinderOrSphere: Float = MAX_RADIUS, var unlit: Boolean = true, var includeGlass: Boolean = true, var stereoMode: StereoMode = StereoMode.None, var alphaMode: AlphaMode = AlphaMode.HOLE_PUNCH, var forceSceneTexture: Boolean = true, var panelShader: String = SceneMaterial.HOLE_PUNCH_PANEL_SHADER, var sceneMeshCreator: PanelShapeConfig.(texture: SceneTexture) -> SceneMesh? = null, var layerConfig: LayerConfig? = LayerConfig(), var panelShapeType: PanelShapeType = PanelShapeType.QUAD, var enableTransparent: Boolean = true, var enableLayer: Boolean = true)
class PanelSurface(scene: Scene, val widthInPx: Int, val heightInPx: Int, mips: Int, samplerConfig: SamplerConfig = PanelConfigOptions.DEFAULT_PANEL_SAMPLER, useSwapchain: Boolean, useTexture: Boolean, fragmentShader: String = "", val isProtected: Boolean = false)
class PointerEvent(val source: Entity, val type: Int, val hitInfo: HitInfo, val scrollInfo: Vector2 = Vector2(), val semanticType: Int = SemanticType.Unknown.id, val pointerType: Int = 0)
Data class representing a pointer event.
enum PointerEventType : Enum<PointerEventType>
Enum class representing different types of pointer events.
class QuadLayerConfig(var alphaBlend: LayerAlphaBlend? = null, var colorScaleBias: LayerColorScaleBias? = null, var zIndex: Int = 0) : LayerConfig
Layer config for a flat, single-sided, rectangular surface
data class RenderConfiguration(val suggestRenderSizeScale: Float = 1.0f)
data class SamplerConfig(val minFilter: Filter = Filter.LINEAR, val magFilter: Filter = Filter.LINEAR, val mipmapMode: Filter = Filter.LINEAR, val addressModeU: AddressMode = AddressMode.REPEAT, val addressModeV: AddressMode = AddressMode.REPEAT, val lodBias: Float = 0.0f)
class Scene(val handle: Long)
Scene class for representing the 3D scene. This class provides methods for querying the
class SceneCylinderLayer(scene: Scene, swapChain: SceneSwapchain, radius: Float, centralAngle: Float, aspectRatio: Float, pivotX: Float, pivotY: Float, stereoMode: StereoMode, sceneObject: SceneObject) : SceneLayer
class SceneEquirectLayer(scene: Scene, swapChain: SceneSwapchain, radius: Float, centralHorizontalAngle: Float, upperVerticalAngle: Float, lowerVerticalAngle: Float, pivotX: Float, pivotY: Float, stereoMode: StereoMode, sceneObject: SceneObject) : SceneLayer
abstract class SceneLayer(scene_: Scene, id_: Int)
class SceneMaterialAttribute(val name: String, val type: SceneMaterialDataType)
class SceneMesh
open class SceneObject
This class represents a 3D geometric object in the scene.
class SceneQuadLayer(scene: Scene, swapChain: SceneSwapchain, dimW: Float, dimH: Float, pivotX: Float, pivotY: Float, stereoMode: StereoMode, sceneObject: SceneObject) : SceneLayer
enum SemanticType : Enum<SemanticType>
Enum class representing different semantic types for pointer events.
enum SortOrder : Enum<SortOrder>
enum StereoMode : Enum<StereoMode>
open class VrActivity
VrActivity serves as the base class inherited by AppSystemActivity, which should be used for creating Spatial Activities instead of directly subclassing VrActivity. This class provides essential functionalities required by all Meta Spatial applications, including:
open class VrService

Properties

NameSummary
errorCodeMap
val errorCodeMap: Map<Int, NativeResult>
Did you find this page helpful?
Thumbs up icon
Thumbs down icon