Options
All
  • Public
  • Public/Protected
  • All
V1.7
  • V1.6
  • V1.7
Menu

Namespace "lumin"

Index

Namespaces

Enumerations

Classes

Variables

Functions

Variables

Const EMPTY_STRING

EMPTY_STRING: string

value = ""

Const FPS_DELTA

FPS_DELTA: number

value = 1.0/MAX_CLIENT_FPS

Const INVALID_AUDIO_ID

INVALID_AUDIO_ID: bigint

value = 0n

Const INVALID_CONTROL_ID

INVALID_CONTROL_ID: number

value = -1

Const INVALID_DEVICE_ID

INVALID_DEVICE_ID: number

value = -1

Const INVALID_NODE_ID

INVALID_NODE_ID: bigint

value = 0n

Const INVALID_PHYSICS_ID

INVALID_PHYSICS_ID: bigint

value = 0n

Const INVALID_PRISM_ID

INVALID_PRISM_ID: bigint

value = 0n

Const INVALID_RESOURCE_ID

INVALID_RESOURCE_ID: bigint

value = 0n

Const INVALID_SESSION_ID

INVALID_SESSION_ID: bigint

value = 0n

Const MAT4_IDENTITY

MAT4_IDENTITY: [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number]

value = [1,0,0,0,0,1,0,0,0,0,1,0,0,0,0,1]

Const MAX_CLIENT_FPS

MAX_CLIENT_FPS: number

value = 60.0

Const PCF_INVALID

PCF_INVALID: PCFId

value = [0,0]

Const QUAT_IDENTITY

QUAT_IDENTITY: [number, number, number, number]

value = [1,0,0,0]

Const VEC2_ONE

VEC2_ONE: [number, number]

value = [1,1]

Const VEC2_ZERO

VEC2_ZERO: [number, number]

value = [0,0]

Const VEC3_FORWARD

VEC3_FORWARD: [number, number, number]

value = [0,0,-1]

Const VEC3_ONE

VEC3_ONE: [number, number, number]

value = [1,1,1]

Const VEC3_RIGHT

VEC3_RIGHT: [number, number, number]

value = [1,0,0]

Const VEC3_UP

VEC3_UP: [number, number, number]

value = [0,1,0]

Const VEC3_ZERO

VEC3_ZERO: [number, number, number]

value = [0,0,0]

Const VEC4_ONE

VEC4_ONE: [number, number, number, number]

value = [1,1,1,1]

Const VEC4_ZERO

VEC4_ZERO: [number, number, number, number]

value = [0,0,0,0]

Const kDefaultFetchLimit

kDefaultFetchLimit: number

value = 250

Const kInvalidRequestId

kInvalidRequestId: number

value = -1

Const kMaxAudioChannels

kMaxAudioChannels: number

value = 8

Functions

OAuthOpenWindow

  • Open a secure browser window to perfrom an oauth authentication.

    Will open a special browser window that will be lazy head locked to the user's head movement. The browser window will close once the authentication procedure has been completed.

    priv

    SecureBrowserWindow

    Parameters

    • url: string

      The oauth url to navigate to.

    • cancelUri: string

      The cancel uri called by the browser when users cancels the window.

    Returns DispatchResult

    DispatchResult::kOk or a DispatchResult error code

OAuthRegisterSchema

  • OAuthRegisterSchema(schema: string, schemaHandler: ((arg0: string) => void) | null): DispatchResult
  • Register a unique schema for OAuth redirect handler.

    The caller need to ensure that the schema is unique. If the schema is already registered the function will return an error. The handler will be called once the authorization procedure has been completed. The caller should register two schema callbacks. The first will be for authorization redirect and the second schema will in case the user cancels the authentication.

    priv

    SecureBrowserWindow

    Parameters

    • schema: string

      A unique string that will match the redirect or cancel uri schema.

    • schemaHandler: ((arg0: string) => void) | null

      An std::function that provides the function that is to be called when the schema uri has been invoked.

    Returns DispatchResult

    DispatchResult::kOk or a DispatchResult error code

OAuthUnregisterSchema

  • Unregister a unique schema for OAuth redirect handler.

    priv

    SecureBrowserWindow

    Parameters

    • schema: string

      A unique string that will match the redirect or cancel uri schema.

    Returns DispatchResult

    DispatchResult::kOk or a DispatchResult error code

SubscribeInviteeStatusNotifications

  • subscribe a listener to receive notifications for invitee status updates

    requires

    SocialConnectionsInvitesAccess

    Parameters

    • callable: ((arg0: InviteeStatus) => void) | null

      a callable to invoke with the notification

    Returns RequestStatus

    RequestStatus status of request's submission

ToString

  • ToString(vector: [number, number] | Float32Array): string
  • ToString(size: TextureSize): string
  • ToString(quality: Quality): string

TryOpenApplication

  • Try to open an application that can handle the given URI.

    The user will be presented with a dialog to choose from all applications that registered a matching URI schema in their manifest.

    Parameters

    • uri: string

      The URI to open with a supported application

    Returns DispatchResult

    DispatchResult::kOk or a DispatchResult error code

  • Try to open an application that supports the given mime type or file extension.

    The user will be presented with a dialog to choose from all applications that registered a matching mime type in their manifest. If multiple files are provided in the list, the mime type and extension will be checked on the last one.

    The mime type will be checked first. If it is not provided, the file extension specified in the file name will be used.

    Parameters

    • fileInfoList: Array<FileInfo>

      list of FileInfo objects to pass along to the app. The mime-type or file extension (if mime-type is not provided) will be used to find supported applications.

    Returns DispatchResult

    DispatchResult::kOk or a DispatchResult error code

UnsubscribeInviteeStatusNotifications

Generated using TypeDoc