RealityOS Docs and Examples

Appearance

@tmrw-realityos/charm • Docs

@tmrw-realityos/charm / tmrwRooms / NativeEngineAPI

Interface: NativeEngineAPI ​

Methods ​

addCustomViewRP() ​

addCustomViewRP(_0): NativeView

Parameters ​

• _0: EmbindString

Returns ​

NativeView

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:237

createCameraRP() ​

createCameraRP(_0): NativeCameraRP

Parameters ​

• _0: EmbindString

Returns ​

NativeCameraRP

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:238

createScene() ​

createScene(_0): boolean

Parameters ​

• _0: number

Returns ​

boolean

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:219

createSceneRP() ​

createSceneRP(_0): NativeSceneRP

Parameters ​

• _0: EmbindString

Returns ​

NativeSceneRP

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:239

delete() ​

delete(): void

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:242

deleteCameraRP() ​

deleteCameraRP(_0): boolean

Parameters ​

• _0: NativeCameraRP

Returns ​

boolean

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:205

deleteCustomViewRP() ​

deleteCustomViewRP(_0): boolean

Parameters ​

• _0: NativeView

Returns ​

boolean

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:204

deleteSceneRP() ​

deleteSceneRP(_0): void

Parameters ​

• _0: NativeSceneRP

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:203

exitScene() ​

exitScene(_0): boolean

Parameters ​

• _0: number

Returns ​

boolean

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:221

getCameraRP() ​

getCameraRP(): NativeCameraRP

Returns ​

NativeCameraRP

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:197

getDiagnosticsMode() ​

getDiagnosticsMode(): number

Returns ​

number

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:226

getEngineFPS() ​

getEngineFPS(): number

Returns ​

number

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:235

getEngineRP() ​

getEngineRP(): NativeEngineRP

Returns ​

NativeEngineRP

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:200

getGPUTime() ​

getGPUTime(): number

Returns ​

number

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:236

getInput() ​

getInput(): NativeInputAPI

Returns ​

NativeInputAPI

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:195

getMainSceneRP() ​

getMainSceneRP(): NativeSceneRP

Returns ​

NativeSceneRP

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:201

getMainViewRP() ​

getMainViewRP(): NativeViewRP

Returns ​

NativeViewRP

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:199

getPostFXQuality() ​

getPostFXQuality(): number

Returns ​

number

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:230

getRenderer() ​

getRenderer(): string

Returns ​

string

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:241

getRendererRP() ​

getRendererRP(): NativeRendererRP

Returns ​

NativeRendererRP

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:202

getRoom() ​

getRoom(): NativeRoomAPI

Returns ​

NativeRoomAPI

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:196

getShadersQuality() ​

getShadersQuality(): number

Returns ​

number

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:228

getVersion() ​

getVersion(): string

Returns ​

string

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:240

getViewRP() ​

getViewRP(): NativeView

Returns ​

NativeView

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:198

isMaterialPreview() ​

isMaterialPreview(): boolean

Returns ​

boolean

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:215

releaseScene() ​

releaseScene(_0, _1): boolean

Parameters ​

• _0: number

• _1: boolean

Returns ​

boolean

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:220

RenderFrame() ​

RenderFrame(): boolean

Returns ​

boolean

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:208

setDiagnosticsMode() ​

setDiagnosticsMode(_0): void

Parameters ​

• _0: number

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:225

setFeedsAfterCG() ​

setFeedsAfterCG(_0): void

Parameters ​

• _0: boolean

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:211

setMacOSDevice() ​

setMacOSDevice(_0): void

Parameters ​

• _0: boolean

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:218

setMaterialPreview() ​

setMaterialPreview(_0, _1): void

Parameters ​

• _0: NativeMaterial

• _1: boolean

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:214

setMaterialsStreamingMode() ​

setMaterialsStreamingMode(_0): void

Parameters ​

• _0: number

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:224

setMobileDevice() ​

setMobileDevice(_0): void

Parameters ​

• _0: boolean

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:216

setMobileDeviceIOS() ​

setMobileDeviceIOS(_0): void

Parameters ​

• _0: boolean

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:217

setNativeMenu() ​

setNativeMenu(_0): void

Parameters ​

• _0: boolean

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:209

setNativeStats() ​

setNativeStats(_0): void

Parameters ​

• _0: boolean

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:210

setPostFXQuality() ​

setPostFXQuality(_0): void

Parameters ​

• _0: number

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:231

setProfiler() ​

setProfiler(_0): void

Parameters ​

• _0: boolean

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:212

setProfileStallsThreshold() ​

setProfileStallsThreshold(_0): void

Parameters ​

• _0: number

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:234

setRenderQuality() ​

setRenderQuality(_0): void

Parameters ​

• _0: number

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:232

setROSPopup() ​

setROSPopup(_0): void

Parameters ​

• _0: number

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:222

setShadersQuality() ​

setShadersQuality(_0): void

Parameters ​

• _0: number

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:229

setStreamingMode() ​

setStreamingMode(_0): void

Parameters ​

• _0: number

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:223

setTrackMode() ​

setTrackMode(_0): void

Parameters ​

• _0: boolean

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:213

setViewport() ​

setViewport(_0): void

Parameters ​

• _0: vec2

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:233

setWireFrameMode() ​

setWireFrameMode(_0): void

Parameters ​

• _0: number

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:227

Update() ​

Update(): boolean

Returns ​

boolean

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:206

UpdateFrame() ​

UpdateFrame(): boolean

Returns ​

boolean

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:207