Skip to content

Latest commit

 

History

History
643 lines (383 loc) · 10.3 KB

jsdocs.md

File metadata and controls

643 lines (383 loc) · 10.3 KB
Raw

Table of Contents

SERVICE_WORKER_PATH

Default Service Worker Path

Type: string

start_pwa_worker

Start PWA Service Worker

Parameters

  • service_worker_path (optional, default SERVICE_WORKER_PATH)

Meta

  • since: 14 May 2020
  • author: Teki Chan

StarryNightGameOverScene

Extends Phaser.Scene

Starry Night Game JS: Game Over Scene
The game over class of this game's scene

Meta

  • since: 13 May 2020
  • author: Teki Chan

preload

create

update

resetGame

Reset the game to the entry screen

toggleSound

Toggle Sound on or off

StarryNightGameScene

Extends Phaser.Scene

Starry Night Game JS: Game Content Scene
The main class of this game's scene

Meta

  • since: 13 May 2020
  • author: Teki Chan

preload

create

updateScore

When Update a Score

Parameters

  • inc any increased score

placeClouds

Place Clouds into the scene

Parameters

  • addScore any flag of adding a score as well or not

flap

Flap Mr. Moon to fly up

getRightmostCloud

Get right most cloud object

update

die

When Mr. Moon hits a cloud or flys over the borders, then dies

toggleSound

Toggle Sound on or off

SETTINGS

Settings of Loading Scene

SETTINGS

Face Filter Settings

StarryNightLoadingScene

Extends Phaser.Scene

Starry Night Game JS: Loading Scene
Starry Night Loading Scene

Meta

  • since: 13 May 2020
  • author: Teki Chan

preload

updateBar

Update Progress Bar by percentage

Parameters

  • percentage any

complete

When the progress bar completed

STARRY_NIGHT_SETTINGS

Starry Night Shared Settings

Meta

  • since: 13 May 2020
  • author: Teki Chan

StarryNightStartScene

Extends Phaser.Scene

Starry Night Game JS: Start Scene
The starting class of this game's scene

Meta

  • since: 13 May 2020
  • author: Teki Chan

preload

create

update

startGame

Start to enter the game and play

cameraGame

Turn to Camera Screen

toggleSound

Toggle Sound on or off

showDetail

Show Detail

gameConfig

Phaser Game Config

game

Starry Night Game JS

Meta

  • since: 13 May 2020
  • author: Teki Chan

PAINTING_OPTIONS

Painting Options

ARTPAINTING

Painting Setting

vanGoghFaceFilter

Face Filter declaration

paintingOptionIdx

Index of Painting Options

setupButtons

Setup buttons in the screen

buildPaintingOption

Build Painting with the current option index

updatePaintingOption

Update Painting with the current option index

ready

Van Gogh Camera JS
Process when jQuery is ready

Meta

  • since: 13 May 2020
  • author: Teki Chan

STATES

possible states of the app. ENUM equivalent

compile_shader

compile a shader

Parameters

  • GL any the WebGL context
  • source any
  • type any
  • typeString any

draw_search

draw in search mode

Parameters

  • GL any the WebGL context
  • FFSPECS any
  • SHPS any
  • detectState any

build_shaderProgram

helper function to build the shader program

Parameters

  • GL any the WebGL context
  • shaderVertexSource any Shader Vertex Source
  • shaderFragmentSource any Shader Fragment Source
  • id any Shader Source ID

VanGoghFaceFilter

Van Gogh Face Filter
Logics for processing human and painting faces.
Acknowledgement of Jeeliz Face Filter Demo

Parameters

  • settings any Face detection setting
  • artPainting any Painting setting
  • doMartPaintingContainer any Container ID of Painting
  • faceCanvasId any Canvas ID of Face

Meta

  • since: 13 May 2020
  • author: Teki Chan

check_isLoaded

Check if label is loaded

Parameters

  • label any Label

main

Main program of this class

start

Start to run the program

update_artPainting

called both at start (start()) and when user change the art painting

Parameters

  • detectState any Detection state

create_textures

Create Textures

build_artPaintingMask

Build mask on Painting

Parameters

  • detectState any Detection state
  • callback any Callback function

build_shps

Build Shader Programs

reset_toVideo

Reset to Video

position_userCropCanvas

Position User Crop Canvas

draw_render

draw final render

Parameters

  • detectState any Detection state

callbackTrack

Callback Track

Parameters

  • detectState any Detection state

saveImage

Save a final image

Parameters

  • _event any Event object

JEEFACEFILTERAPI

Jeeliz Face Filter - https://github.com/jeeliz/jeelizFaceFilter

Copyright 2018 Jeeliz ( https://jeeliz.com )

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

JEEFACEFILTERAPIGEN

Jeeliz Face Filter - https://github.com/jeeliz/jeelizFaceFilter

Copyright 2018 Jeeliz ( https://jeeliz.com )

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.