Class ScreenCamera

This camera can make the pixel unit of a WebGL element equals with one of a HTML Element. If combined with maku.js, you can easily merge HTML with WebGL!

Demo: https://kokomi-js.vercel.app/examples/#screenCamera

Hierarchy (View Summary)

Component
- ScreenCamera

Index

Constructors

Properties

base camera container emitter

Methods

addExisting emit off on update

Constructors

constructor

new ScreenCamera(base: Base, config?: Partial<ScreenCameraConfig>): ScreenCamera
Parameters
- base: Base
- config: Partial<ScreenCameraConfig> = {}
Returns ScreenCamera
Overrides Component.constructor
- Defined in src/camera/screenCamera.ts:20

Properties

base

base: Base

camera

camera: PerspectiveCamera

container

container: Scene

emitter

emitter: Emitter<any>

Methods

addExisting

addExisting(): void
Returns void
Overrides Component.addExisting
- Defined in src/camera/screenCamera.ts:36

emit

emit(type: string, event?: any): void
Parameters
- type: string
- event: any = {}
Returns void
Inherited from Component.emit
- Defined in src/components/component.ts:41

off

off(type: string, handler: any): void
Parameters
- type: string
- handler: any
Returns void
Inherited from Component.off
- Defined in src/components/component.ts:37

on

on(type: string, handler: any): void
Parameters
- type: string
- handler: any
Returns void
Inherited from Component.on
- Defined in src/components/component.ts:33

update

update(time: number): void
Parameters
- time: number
Returns void
Inherited from Component.update
- Defined in src/components/component.ts:29