{"id":20350049,"url":"https://github.com/webbestmaster/smoke-fading","last_synced_at":"2025-08-30T18:10:07.694Z","repository":{"id":89686965,"uuid":"73547060","full_name":"webbestmaster/smoke-fading","owner":"webbestmaster","description":null,"archived":false,"fork":false,"pushed_at":"2016-11-17T20:02:46.000Z","size":6915,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-04T16:34:52.893Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/webbestmaster.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-11-12T10:51:13.000Z","updated_at":"2016-11-12T15:21:44.000Z","dependencies_parsed_at":null,"dependency_job_id":"48698274-2efa-4f59-b316-13003f09f89b","html_url":"https://github.com/webbestmaster/smoke-fading","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/webbestmaster/smoke-fading","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webbestmaster%2Fsmoke-fading","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webbestmaster%2Fsmoke-fading/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webbestmaster%2Fsmoke-fading/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webbestmaster%2Fsmoke-fading/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/webbestmaster","download_url":"https://codeload.github.com/webbestmaster/smoke-fading/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webbestmaster%2Fsmoke-fading/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272885393,"owners_count":25009627,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-30T02:00:09.474Z","response_time":77,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-14T22:28:44.815Z","updated_at":"2025-08-30T18:10:07.673Z","avatar_url":"https://github.com/webbestmaster.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [Smoke-Fading](https://github.com/webbestmaster/smoke-fading#readme) *0.1.0*\n\n\u003e PIXI fading plugin\n\n\n### www/js/our-plugin/smoke-fading.js\n\n\n#### ImageOverlay([options]) \n\n\n\n\n\n\n##### Parameters\n\n- **options** `Object`  *Optional* - options for constructor\n- **options.bg** `String`  *Optional* - path to background image, you can use .initializeBackgroundImage()\n- **options.fg** `String`   - path to foreground image, you can use .initializeForegroundImage()\n- **options.masks** `Array.\u0026lt;Array\u0026gt;`  *Optional* - array of masks, you can use .addMask()\n- **options.masksi** `Array.\u0026lt;Array\u0026gt;`  *Optional* - one mask\n- **options.masksij** `String`  *Optional* - path to one mask image\n- **options.options** `Object`  *Optional* - options of masks, you can use .addMask() with options\n- **options.options.flipX\u0026#x3D;true|false-will** `Boolean`  *Optional* be get random] - need to flip by X axis\n- **options.options.flipY\u0026#x3D;true|false-will** `Boolean`  *Optional* be get random] - need to flip by Y axis\n- **options.options.isInvert\u0026#x3D;false** `Boolean`  *Optional* - need to invert white/black of mask\n- **options.success** `Function`  *Optional* - callback on success\n- **options.error** `Function`  *Optional* - callback on error\n\n\n\n\n##### Returns\n\n\n- `Void`\n\n\n\n#### ImageOverlay._parseOptions(options)  *private method*\n\n\n\n\n\n\n##### Parameters\n\n- **options**   - see @constructor\n\n\n\n\n##### Returns\n\n\n- `Void`\n\n\n\n#### ImageOverlay._defineDefaultProperties()  *private method*\n\n\n\n\n\n\n\n\n##### Returns\n\n\n- `Void`\n\n\n\n#### ImageOverlay.destroy() \n\nDestroy object\n\n\n\n\n\n\n##### Returns\n\n\n- `Void`\n\n\n\n#### ImageOverlay._update()  *private method*\n\nUpdate canvas, should be call by ticker only\n\n\n\n\n\n\n##### Returns\n\n\n- `Void`\n\n\n\n#### ImageOverlay._silentUpdate()  *private method*\n\nUpdate canvas with any side effect\n\n\n\n\n\n\n##### Returns\n\n\n- `Void`\n\n\n\n#### ImageOverlay.addMask(pathToImageList, options) \n\nAdd one mask to list of masks\n\n\n\n\n##### Parameters\n\n- **pathToImageList** `Array`   - array of paths to images\n- **options**   - see @constructor\n\n\n\n\n##### Returns\n\n\n- `Promise`   \n\n\n\n#### ImageOverlay.parseBeginEndMaskIndex(frameIndex) \n\nGet mask's frame by alias\n\n\n\n\n##### Parameters\n\n- **frameIndex** `String` `Number`   - alias of mask's index\n\n\n\n\n##### Returns\n\n\n- `Number`   \n\n\n\n#### ImageOverlay.playMask(frameIndex, frameIndexStep) \n\n\n\n\n\n\n##### Parameters\n\n- **frameIndex** `String` `Number`   - start mask's index\n- **frameIndexStep** `Number`   - step of increasing mask's index\n\n\n\n\n##### Returns\n\n\n- `Promise`   - resolve on end play\n\n\n\n#### ImageOverlay.drawMaskIndex(index) \n\n\n\n\n\n\n##### Parameters\n\n- **index** `Number`   \n\n\n\n\n##### Returns\n\n\n- `Void`\n\n\n\n#### ImageOverlay._initializeMaskSprite(pathToImage, options)  *private method*\n\n\n\n\n\n\n##### Parameters\n\n- **pathToImage** `String`   \n- **options** `Object`   - see @constructor options.options\n\n\n\n\n##### Returns\n\n\n- `Promise`   \n\n\n\n#### ImageOverlay._updateMask()  *private method*\n\nRedraw mask to draw opn canvas\n\n\n\n\n\n\n##### Returns\n\n\n- `Void`\n\n\n\n#### ImageOverlay._initializeTicker()  *private method*\n\n\n\n\n\n\n\n\n##### Returns\n\n\n- `Void`\n\n\n\n#### ImageOverlay._destroyTicker()  *private method*\n\n\n\n\n\n\n\n\n##### Returns\n\n\n- `Void`\n\n\n\n#### ImageOverlay.initializeImage(pathToImage) \n\nCreate and define texture from image\n\n\n\n\n##### Parameters\n\n- **pathToImage** `String`   \n\n\n\n\n##### Returns\n\n\n- `Promise`   \n\n\n\n#### ImageOverlay.initializeBackgroundImage(pathToImage) \n\n\n\n\n\n\n##### Parameters\n\n- **pathToImage** `String`   \n\n\n\n\n##### Returns\n\n\n- `Promise`   \n\n\n\n#### ImageOverlay.initializeForegroundImage(pathToImage) \n\n\n\n\n\n\n##### Parameters\n\n- **pathToImage** `String`   \n\n\n\n\n##### Returns\n\n\n- `Promise`   \n\n\n\n#### ImageOverlay.setRenderSize(width, height) \n\n\n\n\n\n\n##### Parameters\n\n- **width** `Number`   - new renderer width\n- **height** `Number`   - new renderer height\n\n\n\n\n##### Returns\n\n\n- `Void`\n\n\n\n#### ImageOverlay.addSprite(sprite, zIndex) \n\nAdd new sprite to container\n\n\n\n\n##### Parameters\n\n- **sprite** `PIXI.Sprite`   \n- **zIndex** `Number`   \n\n\n\n\n##### Returns\n\n\n- `Void`\n\n\n\n#### ImageOverlay._cleanContainer()  *private method*\n\nRemove all sprites from container\n\n\n\n\n\n\n##### Returns\n\n\n- `Void`\n\n\n\n#### ImageOverlay._fitToRenderSize(sprite)  *private method*\n\nResize sprite to render size\n\n\n\n\n##### Parameters\n\n- **sprite** `PIXI.Sprite`   \n\n\n\n\n##### Returns\n\n\n- `Void`\n\n\n\n#### ImageOverlay._executePlayEndCallback()  *private method*\n\n\n\n\n\n\n\n\n##### Returns\n\n\n- `Void`\n\n\n\n#### ImageOverlay.getCanvas() \n\n\n\n\n\n\n\n\n##### Returns\n\n\n- `HTMLElement`   - canvas\n\n\n\n#### ImageOverlay.defineCurrentWorkingMaskIndex() \n\nDefine index of working mask\n\n\n\n\n\n\n##### Returns\n\n\n- `Void`\n\n\n\n#### ImageOverlay.undefineCurrentWorkingMaskIndex() \n\nIf _currentWorkingMaskIndex === null, _currentWorkingMaskIndex will defined on next play\n\n\n\n\n\n\n##### Returns\n\n\n- `Void`\n\n\n\n#### getRandomBetween(start, stop) \n\nRandom from range [start, stop)\n\n\n\n\n##### Parameters\n\n- **start** `Number`   \n- **stop** `Number`   \n\n\n\n\n##### Returns\n\n\n- `number`   \n\n\n\n#### ImageOverlay.utils.createPixel(color, opacity) \n\nCreate 1x1 pixel\n\n\n\n\n##### Parameters\n\n- **color**   \n- **opacity**   \n\n\n\n\n##### Returns\n\n\n- `String`   - base64\n\n\n\n#### ImageOverlay.utils.loadImage(imagePath) \n\n\n\n\n\n\n##### Parameters\n\n- **imagePath**   \n\n\n\n\n##### Returns\n\n\n- `Promise`   \n\n\n\n#### ImageOverlay.utils.invertImage(imagePath) \n\nCreate new image with inverted RGB only, not Alpha\n\n\n\n\n##### Parameters\n\n- **imagePath**   \n\n\n\n\n##### Returns\n\n\n- `String`   - base64\n\n\n\n\n*Documentation generated with [doxdox](https://github.com/neogeek/doxdox).*\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebbestmaster%2Fsmoke-fading","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebbestmaster%2Fsmoke-fading","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebbestmaster%2Fsmoke-fading/lists"}