pixijs / docs Goto Github PK

My workflow:

1. Go to docs page, e.g. https://pixijs.download/release/docs/PIXI.Ticker.html
2. Search for it in the examples repo, e.g. https://github.com/pixijs/examples/search?q=Ticker.shared&type=

Would be cool if the docs page automatically linked to the example pages.

"A RenderTexture takes a snapshot of any Display Object given to its render method."

• http://pixijs.github.io/docs/PIXI.RenderTexture.html

But there is no render() method on RenderTexture (anymore?), and the example code uses the PIXI renderer instead, passing the RenderTexture as an argument.

index.html lists this code as a basic usage example:

// You can use either `new PIXI.WebGLRenderer`, `new PIXI.CanvasRenderer`, or `PIXI.autoDetectRenderer`
// which will try to choose the best renderer for the environment you are in.
var renderer = new PIXI.WebGLRenderer(800, 600);

// The renderer will create a canvas element for you that you can then insert into the DOM.
document.body.appendChild(renderer.view);

// You need to create a root container that will hold the scene you want to draw.
var stage = new PIXI.Container();

// load the texture we need
PIXI.loader.add('bunny', 'bunny.png').load(function (loader, resources) {
    // This creates a texture from a 'bunny.png' image.
    var bunny = new PIXI.Sprite(resources.bunny.texture);

    // Setup the position and scale of the bunny
    bunny.position.x = 400;
    bunny.position.y = 300;

    bunny.scale.x = 2;
    bunny.scale.y = 2;

    // Add the bunny to the scene we are building.
    stage.addChild(bunny);

    // kick off the animation loop (defined below)
    animate();
});

function animate() {
    // start the timer for the next animation loop
    requestAnimationFrame(animate);

    // each frame we spin the bunny around a bit
    bunny.rotation += 0.01;

    // this is the main render call that makes pixi draw your container and its children.
    renderer.render(stage);
}

However this code won't run; the bunny variable isn't properly scoped so it's not accessible inside animate().

I'm interested in working on some of the pixi.js documentation, especially with v3 on the way. I've put together a very simplistic skeleton for how docs could look. http://mreinstein.github.io/pixijs-docs

prototype goals:

• consolidate examples, API docs, and tutorials into one place
• adopt a clean, simple visual interface
• provide a place where examples are not just code but include line-by-line descriptions to gently ease people into features

I've basically taken the doc code from three.js and adapted it for pixi, since I think it's a really elegant starting point, and it's MIT licensed.

I'd like to get feedback from some people before I invest much more time in this. If this is something that we like, I'm happy to keep working on it. :)

What's done:

• the basic example has been added, with descriptions on what each line is doing.
• the skeleton framework for linking pages into table of contents, searching, pretty printing,etc.

What's not done:

• None of the links to examples are populated
• none of the API reference docs are tied in to actual docs yet
• running examples should be embedded at the bottom of each one.

hi ,guy! I am trying to use pixi.But I don't know how many events that the sprite or others has.I can't find events list in http://pixijs.github.io/docs/PIXI.Sprite.html. So can you show me the event list?I need it.