Security News
Bun 1.2 Released with 90% Node.js Compatibility and Built-in S3 Object Support
Bun 1.2 enhances its JavaScript runtime with 90% Node.js compatibility, built-in S3 and Postgres support, HTML Imports, and faster, cloud-first performance.
pixi-viewport
Advanced tools
A highly configurable viewport/2D camera designed to work with pixi.js. Features include dragging, pinch-to-zoom, mouse wheel zooming, decelerated dragging, follow target, snap to point, snap to zoom, clamping, bouncing on edges, and move on mouse edges.
A highly configurable viewport/2D camera designed to work with pixi.js.
Features include dragging, pinch-to-zoom, mouse wheel zooming, decelerated dragging, follow target, animate, snap to point, snap to zoom, clamping, bouncing on edges, and move on mouse edges. See the live examples below to try out all of these features.
All features are configurable and removable, so set up the viewport to be exactly what you need.
Moves pixi-viewport to pixi.js v8+ - sorry for the confusion.
Moves pixi-viewport to pixi.js v7.2+.
NOTE: there is a breaking change since in pixi.js v7.2 interactive
(boolean) was deprecated in favor of eventMode
.
Moves pixi-viewport to pixi.js v7 (thanks @cuire!).
NOTE: there is a breaking change since pixi-viewport moved to pixi's new event system. options.interaction
is removed and you need pass options.events
to the viewport for it to work properly. The events object can be found at pixi's renderer.events
or app.renderer.events
.
const viewport = new Viewport({ events: renderer.events });
// or
// const viewport = new Viewport({ events: app.renderer.events });
This project was migrated to Typescript (thanks @ShukantPal!). All functionality should be the same. The live Example has been updated.
https://pixi-viewport.github.io/pixi-viewport/jsdoc/
import * as PIXI from "pixi.js";
import { Viewport } from "pixi-viewport";
// or with require
// const PIXI = require('pixi.js')
// const Viewport = require('pixi-viewport').Viewport
const app = new PIXI.Application();
document.body.appendChild(app.view);
// create viewport
const viewport = new Viewport({
screenWidth: window.innerWidth,
screenHeight: window.innerHeight,
worldWidth: 1000,
worldHeight: 1000,
events: app.renderer.events, // the interaction module is important for wheel to work properly when renderer.view is placed or scaled
});
// add the viewport to the stage
app.stage.addChild(viewport);
// activate plugins
viewport.drag().pinch().wheel().decelerate();
// add a red box
const sprite = viewport.addChild(new PIXI.Sprite(PIXI.Texture.WHITE));
sprite.tint = 0xff0000;
sprite.width = sprite.height = 100;
sprite.position.set(100, 100);
yarn add pixi-viewport
or
npm i pixi-viewport
or grab the latest release and use it:
<script src="/directory-to-file/pixi.js"></script>
<script src="/directory-to-file/viewport.min.js"></script>
<!-- or <script type="module" src="/directory-to-file/esm/viewport.es.js"></script> -->
<script>
const Viewport = new pixi_viewport.Viewport(options);
</script>
Viewport needs to be imported or required as follows:
import { Viewport } from "pixi-viewport";
// or
const Viewport = require("pixi-viewport").Viewport;
Plugins have been moved to their own object:
// viewport.pausePlugin('drag')
viewport.plugins.pause("drag");
// viewport.resumePlugin('drag')
viewport.plugins.resume("drag");
// viewport.removePlugin('drag')
viewport.plugins.remove("drag");
// viewport.userPlugin('name', plugin, index)
viewport.plugins.add("name", plugin, index);
PRs are more than welcome!
If you liked pixi-viewport, please try my other open source libraries:
MIT License (c) 2024 YOPEY YOPEY LLC by David Figatner (david@yopeyopey.com)
FAQs
A highly configurable viewport/2D camera designed to work with pixi.js. Features include dragging, pinch-to-zoom, mouse wheel zooming, decelerated dragging, follow target, snap to point, snap to zoom, clamping, bouncing on edges, and move on mouse edges.
The npm package pixi-viewport receives a total of 19,121 weekly downloads. As such, pixi-viewport popularity was classified as popular.
We found that pixi-viewport demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Bun 1.2 enhances its JavaScript runtime with 90% Node.js compatibility, built-in S3 and Postgres support, HTML Imports, and faster, cloud-first performance.
Security News
Biden's executive order pushes for AI-driven cybersecurity, software supply chain transparency, and stronger protections for federal and open source systems.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.