Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace I3JS

Index

References

Enumerations

Interfaces

Type aliases

References

AsyncCompress

Renames and re-exports AsyncGzip

BoxBufferGeometry

Renames and re-exports BoxGeometry

Compress

Renames and re-exports Gzip

ParametricBufferGeometry

Renames and re-exports ParametricGeometry

compress

Renames and re-exports gzip

compressSync

Renames and re-exports gzipSync

Type aliases

ArcballControlsMouseActionMouse

ArcballControlsMouseActionMouse: 0 | 1 | 2 | "WHEEL"

AsyncFlateStreamHandler

AsyncFlateStreamHandler: (err: Error, data: Uint8Array, final: boolean) => void

Type declaration

    • (err: Error, data: Uint8Array, final: boolean): void

    • Handler for asynchronous data (de)compression streams

      Parameters

      • err: Error

        Any error that occurred

      • data: Uint8Array
      • final: boolean

        Whether this is the final block

      Returns void

AsyncGunzipOptions

AsyncGunzipOptions: AsyncOptions

Options for decompressing GZIP data asynchronously

AsyncUnzipOptions

AsyncUnzipOptions: AsyncOptions

Options for asynchronously expanding a ZIP archive

AsyncUnzlibOptions

AsyncUnzlibOptions: AsyncInflateOptions

Options for decompressing Zlib data asynchronously

AsyncZippableFile

AsyncZippableFile: Uint8Array | [Uint8Array, AsyncZipOptions]

A file that can be used to asynchronously create a ZIP archive

BuiltinShaderAttributeName

BuiltinShaderAttributeName: "position" | "normal" | "uv" | "color" | "skinIndex" | "skinWeight" | "instanceMatrix" | "morphTarget0" | "morphTarget1" | "morphTarget2" | "morphTarget3" | "morphTarget4" | "morphTarget5" | "morphTarget6" | "morphTarget7" | "morphNormal0" | "morphNormal1" | "morphNormal2" | "morphNormal3"

ColorRepresentation

ColorRepresentation: I3JS.Color | string | number

EasingFunction

EasingFunction: (amount: number) => number

Type declaration

    • (amount: number): number

    • Parameters

      • amount: number

      Returns number

EventListener

EventListener<E, T, U>: (event: E & { type: T } & { target: U }) => void

Type parameters

  • E

  • T

  • U

Type declaration

    • (event: E & { type: T } & { target: U }): void

    • Parameters

      • event: E & { type: T } & { target: U }

      Returns void

FlateCallback

FlateCallback: (err: Error | string, data: Uint8Array) => void

Type declaration

    • (err: Error | string, data: Uint8Array): void

    • Callback for asynchronous (de)compression methods

      Parameters

      • err: Error | string

        Any error that occurred

      • data: Uint8Array

      Returns void

FlateStreamHandler

FlateStreamHandler: (data: Uint8Array, final: boolean) => void

Type declaration

    • (data: Uint8Array, final: boolean): void

    • Handler for data (de)compression streams

      Parameters

      • data: Uint8Array
      • final: boolean

        Whether this is the final block

      Returns void

GLTFReferenceType

GLTFReferenceType: "materials" | "nodes" | "textures" | "meshes"

GUICallBack

GUICallBack: (event: { controller: GUIController; object: object; property: string; value: any }) => void

Type declaration

    • (event: { controller: GUIController; object: object; property: string; value: any }): void

    • Parameters

      • event: { controller: GUIController; object: object; property: string; value: any }
        • controller: GUIController

          controller that was modified

        • object: object

          object that was modified

        • property: string

          string, name of property

        • value: any

          new value of controller

      Returns void

InterpolationFunction

InterpolationFunction: (v: number[], k: number) => number

Type declaration

    • (v: number[], k: number): number

    • Parameters

      • v: number[]
      • k: number

      Returns number

Matrix3Tuple

Matrix3Tuple: [number, number, number, number, number, number, number, number, number]

Matrix4Tuple

Matrix4Tuple: [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number]

OnNodeBuildBeforeRender

OnNodeBuildBeforeRender: (frame: I3JS.NodeFrame, material: I3JS.Material) => void

Type declaration

PixelFormatGPU

PixelFormatGPU: "ALPHA" | "RGB" | "RGBA" | "LUMINANCE" | "LUMINANCE_ALPHA" | "RED_INTEGER" | "R8" | "R8_SNORM" | "R8I" | "R8UI" | "R16I" | "R16UI" | "R16F" | "R32I" | "R32UI" | "R32F" | "RG8" | "RG8_SNORM" | "RG8I" | "RG8UI" | "RG16I" | "RG16UI" | "RG16F" | "RG32I" | "RG32UI" | "RG32F" | "RGB565" | "RGB8" | "RGB8_SNORM" | "RGB8I" | "RGB8UI" | "RGB16I" | "RGB16UI" | "RGB16F" | "RGB32I" | "RGB32UI" | "RGB32F" | "RGB9_E5" | "SRGB8" | "R11F_G11F_B10F" | "RGBA4" | "RGBA8" | "RGBA8_SNORM" | "RGBA8I" | "RGBA8UI" | "RGBA16I" | "RGBA16UI" | "RGBA16F" | "RGBA32I" | "RGBA32UI" | "RGBA32F" | "RGB5_A1" | "RGB10_A2" | "RGB10_A2UI" | "SRGB8_ALPHA8" | "DEPTH_COMPONENT16" | "DEPTH_COMPONENT24" | "DEPTH_COMPONENT32F" | "DEPTH24_STENCIL8" | "DEPTH32F_STENCIL8"

StringStreamHandler

StringStreamHandler: (data: string, final: boolean) => void

Type declaration

    • (data: string, final: boolean): void

    • Handler for string generation streams

      Parameters

      • data: string
      • final: boolean

        Whether this is the final block

      Returns void

UnzipCallback

UnzipCallback: (err: Error | string, data: Unzipped) => void

Type declaration

    • (err: Error | string, data: Unzipped): void

    • Callback for asynchronous ZIP decompression

      Parameters

      • err: Error | string

        Any error that occurred

      • data: Unzipped

      Returns void

UnzipFileHandler

UnzipFileHandler: (file: UnzipFile) => void

Type declaration

    • Handler for streaming ZIP decompression

      Parameters

      • file: UnzipFile

        The file that was found in the archive

      Returns void

Vector2Tuple

Vector2Tuple: [number, number]

Vector3Tuple

Vector3Tuple: [number, number, number]

Vector4Tuple

Vector4Tuple: [number, number, number, number]

XRAnchorSet

XRAnchorSet: Set<XRAnchor>

XRAnimationLoopCallback

XRAnimationLoopCallback: (time: number, frame?: XRFrame) => void

Type declaration

    • (time: number, frame?: XRFrame): void

    • Parameters

      • time: number
      • Optional frame: XRFrame

      Returns void

XRControllerEventType

XRControllerEventType: XREventType | "disconnected" | "connected"

XREnvironmentBlendMode

XREnvironmentBlendMode: "opaque" | "additive" | "alpha-blend"

XREventType

XREventType: "end" | "select" | "selectstart" | "selectend" | "squeeze" | "squeezestart" | "squeezeend" | "inputsourceschange"

XREye

XREye: "none" | "left" | "right"

XRFrameRequestCallback

XRFrameRequestCallback: (time: number, frame: XRFrame) => void

Type declaration

    • (time: number, frame: XRFrame): void

    • Parameters

      Returns void

XRHandModelHandedness

XRHandModelHandedness: "left" | "right"

XRHandedness

XRHandedness: "none" | "left" | "right"

XRPlaneSet

XRPlaneSet: Set<XRPlane>

XRReferenceSpaceType

XRReferenceSpaceType: "viewer" | "local" | "local-floor" | "bounded-floor" | "unbounded"

XRSessionMode

XRSessionMode: "inline" | "immersive-vr" | "immersive-ar"

XRTargetRayMode

XRTargetRayMode: "gaze" | "tracked-pointer" | "screen"

XRVisibilityState

XRVisibilityState: "visible" | "visible-blurred" | "hidden"

ZippableFile

ZippableFile: Uint8Array | [Uint8Array, ZipOptions]

A file that can be used to create a ZIP archive

ZlibOptions

ZlibOptions: DeflateOptions

Options for compressing data into a Zlib format

Generated using TypeDoc