README

neutrinoparticles.pixi

The package allows you to render NeutrinoParticles effects in PIXI graphical framework.

PIXI v4 or v5?

Versions 1.x.x are for PIXI v4. go to branch
Versions >=2.0.0 are for PIXI v5. (CURRENT DOCS)

API documentation

For more info about latest API you can check API documentation pages.

For specific library version refer to Releases page.

Installation

You can install the package with npm:

> npm install neutrinoparticles.pixi

Or download pre-built package at Releases page. There are UMD packages which you can use in any environment.

Quick usage

Acquire a package object. Depending on your environment:

HTML

<script src="path/to/neutrinoparticles.pixi/dist/neutrinoparticles.pixi.umd.js"></script>

node.js

var PIXINeutrino = require('neutrinoparticles.pixi')

import * as PIXINeutrino from 'neutrinoparticles.pixi'

PIXINeutrino.registerPlugins();

Specify additional neutrino options when creating PIXI.Application:

let app = new PIXI.Application({
  width: 800,
  height: 600,
  neutrino: {
    texturesBasePath: 'textures/' // Prefix for textures
  }
});

Load effect:

app.loader
    .add('water_stream', 'path/to/effects/water_stream.js', app.neutrino.loadOptions)
    .load((loader, resources) =>
{
  ...

Add effect on the scene:

  ...

  let effect = new PIXINeutrino.Effect(resources.water_stream.effectModel, {
      position: [400, 300, 0]
  });

  app.stage.addChild(effect);

  ...

And make it updating:

  ...

  app.ticker.add((delta) => {
      const msec = delta / PIXI.settings.TARGET_FPMS;
      const sec = msec / 1000.0;

      effect.update(sec);
  });
});

Tutorials

Samples

There are several samples in folder /samples which you can refer to.

Running samples

To run the samples you will need web server running on localhost:80 with a web root on the root repository folder. If you have Python3 installed you can use /start_http_server.sh script to start it.

After server is running you can access the samples by http://localhost/samples/<sample_name>.html

For different web server configuration, please adjust the path above accordingly.

Debug Samples with VSCode

You can use following launch configuration to start debuging of samples:

{
    "name": "Samples in Chrome",
    "type": "chrome",
    "runtimeExecutable": "/path/to/chrome",
    "runtimeArgs": [
        "--incognito",
        "--new-window",
        "--remote-debugging-port=9222",
        "--user-data-dir=remote-profile"
    ],
    "request": "launch",
    "url": "http://localhost/samples/simplest.html",
    "webRoot": "${workspaceFolder}",
    "breakOnLoad": true,
    "sourceMaps": true,
    "port": 9222,
}

To be able to set breakpoint in .html files you will need to enable Allow Breakpoints Everywhere flag in VSCode Settings.

Tests

Running tests

To run tests you can use npm run test command as usual. It will start IBCT (image based comparison tests) in WebGL and Canvas modes. You will need to provide GPU environment to run the tests. It can be hardware video card or software renderer.

Debug with VSCode

You can use following launch configuration to start debugging of main thread of electron-mocha application which perform the tests:

{
    "name": "Debug Tests",
    "type": "node",
    "request": "launch",
    "cwd": "${workspaceRoot}",
    "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/electron-mocha",
    "windows": {
      "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/electron-mocha.cmd"
    },
    "program": "${workspaceRoot}/test/test.js",
    "args": [
        "--require", "@babel/register",
        "--timeout", "999999",
        "--colors",
        "--ibct-expect-dir", "__my_expect__",
        "test/test.js"
    ],
    "console": "integratedTerminal",
    "protocol": "inspector",
}