Class Gallery

It's just an encapsuled class for maku.js, which is a powerful bridge between HTML and WebGL.

Demo: https://kokomi-playground.vercel.app/entries/#imageMouseWave

Hierarchy (view full)

Component
- Gallery
  - InfiniteGallery

Index

Constructors

constructor

new Gallery(base, config?): Gallery
Parameters
- base: Base
- config: Partial<GalleryConfig> = {}
Returns Gallery
Overrides Component.constructor
- Defined in src/web/gallery.ts:76

Properties

base

base: Base

container

container: Scene

elList

elList: HTMLIVCElement[]

emitter

emitter: Emitter<any>

fragmentShader

fragmentShader: string

isRectAutoRefreshed

isRectAutoRefreshed: boolean

isScrollPositionSync

isScrollPositionSync: boolean

makuConfig

makuConfig: MakuConfig

makuGroup

makuGroup: null | MakuGroup

makuMaterial

makuMaterial: null | ShaderMaterial

materialParams

materialParams: AllMaterialParams

scroller

scroller: null | Scroller

uniformInjector

uniformInjector: UniformInjector

uniforms

uniforms: {
[uniform: string]: THREE.IUniform<any>;
}

useSelfScroller

useSelfScroller: boolean

vertexShader

vertexShader: string

Methods

addExisting

addExisting(): Promise<void>
Returns Promise<void>
Overrides Component.addExisting
- Defined in src/web/gallery.ts:112

checkImagesLoaded

checkImagesLoaded(): Promise<unknown>
Returns Promise<unknown>
- Defined in src/web/gallery.ts:222

emit

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

iterate

iterate(cb): void
Parameters
- cb: ((maku: Maku, i: number) => void)
  - - (maku, i): void
    - Parameters
      maku: Maku
      i: number
      Returns void
Returns void
- Defined in src/web/gallery.ts:240

off

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

on

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

update

update(time): void
Parameters
- time: number
Returns void
Overrides Component.update
- Defined in src/web/gallery.ts:174

Class Gallery

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Gallery

Properties

base

container

elList

emitter

fragmentShader

isRectAutoRefreshed

isScrollPositionSync

makuConfig

makuGroup

makuMaterial

materialParams

scroller

uniformInjector

uniforms

useSelfScroller

vertexShader

Methods

addExisting

Returns Promise<void>

checkImagesLoaded

Returns Promise<unknown>

emit

Parameters

Returns void

iterate

Parameters

Parameters

Returns void

Returns void

off

Parameters

Returns void

on

Parameters

Returns void

update

Parameters

Returns void

Settings

On This Page