renderer.js
wrapper for pixi.js renderer with automatic loop & clean/dirty settings
simple example
const Renderer = require('yy-renderer)
const renderer = new Renderer()
const sprite = renderer.addChild(new PIXI.Sprite(PIXI.Texture.WHITE))
sprite.tint = 0xff0000
sprite.width = sprite.height = 100
// starts renderer loop
renderer.start()
// do stuff
// sets renderer to dirty to update during next frame
renderer.dirty = true
Live Example
https://davidfig.github.io/renderer/
Installation
npm i yy-renderer
API Reference
/** * Wrapper for a pixi.js Renderer * @param * @param * @param * * @param * @param * @param * * @param * @param * @param * * @param * @param * * @param * @param * @param * @param * @param * @param * @param * * @param * @param * * @param * @param * * @event each(elapsed, Loop, elapsedInLoop) * @event start(Loop) * @event stop(Loop) */ /** * create FPS meter and render indicator * @param */ createDebug(options) /** * immediately render without checking dirty flag */ render() /** * counts visible objects */ countObjects() /** * sets the background color * @param */ background(color) /** * adds object to stage * @param * @param */ add(object, to) /** * alias for add * @param */ addChild(object) /** * alias for add * @param * @param */ addChildTo(object, to) /** * remove child from stage * @param */ removeChild(object) /** * clears the stage */ clear() /** * resize * @param */ resize(force) /** * returns the smaller of the width/height based * @return */ dimensionSmall() /** * returns the larger of the width/height based * @return */ dimensionBig() /** * getter/setter to change desired FPS of renderer */ get fps() /** * Add a listener for a given event to yy-loop * @param * @param * @param * @returns */ on() /** * Add a one-time listener for a given event to yy-loop * @param * @param * @param * @returns * @public */ once() /** * start the internal loop * @returns */ start() /** * stop the internal loop * @inherited from yy-loop * @returns */ stop()
license
MIT License
(c) 2017 YOPEY YOPEY LLC by David Figatner