# pixi-gl-core

> A set of tidy little pixi objects that make working with WebGL simpler

Latest version **1.1.4** (published 2017-11-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install pixi-gl-core
pnpm add pixi-gl-core
yarn add pixi-gl-core
bun add pixi-gl-core
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.4 |
| Published | 2017-11-20 |
| First published | 2016-05-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 85 |
| Author | Mathew Groves |
| Maintainers | bigtimebuddy, doormat23 |
| Keywords | Pixi, WebGL, Shader |

## Links

- npm: https://www.npmjs.com/package/pixi-gl-core
- Repository: https://github.com/pixijs/pixi-gl-core
- Homepage: https://github.com/pixijs/pixi-gl-core#readme
- Issues: https://github.com/pixijs/pixi-gl-core/issues
- npm.io page: https://npm.io/package/pixi-gl-core

## Recent versions

- 1.1.4 (latest) — 2017-11-20
- 2.0.0-alpha (next) — 2017-11-04
- 1.1.3 — 2017-11-15
- 1.1.2 — 2017-11-04
- 1.1.0 — 2017-01-31
- 1.0.3 — 2016-11-03
- 1.0.2 — 2016-05-26
- 1.0.1 — 2016-05-26
- 1.0.0 — 2016-05-26

## README

# PIXI GL Core

[![Build Status](https://travis-ci.org/pixijs/pixi-gl-core.svg?branch=master)](https://travis-ci.org/pixijs/pixi-gl-core)

A set of tidy little pixi objects that make working with WebGL simpler.

They are used under the hood in [Pixi v4](http://pixijs.com). They should also give more users the ability to do more advanced stuff with WebGL in v4 too.

See the components in action [here](http://dev.goodboydigital.com/client/goodboy/million/). 

## Installing

Installing using [NPM](https://npmjs.com):

```bash
npm install pixi-gl-core --save
```

## Usage

Including using Node:

```js
var gl = require('pixi-gl-core');
```

Including in the Browser:

```html
<canvas id="stage"></canvas>
<script src="node_modules/pixi-gl-core/bin/pixi-gl-core.min.js"></script>
<script>
    try 
    {
        var context = pixi.gl.createContext(document.getElementById('stage'));
    }
    catch(e)
    {
        console.error("Unable to create WebGL context");
    }
</script>
```

## Rebuilding

After install NPM module with `npm install`, build using:

```bash
npm run build
```

To run a watch, development command.

```bash
npm run watch
```

To generate the documention.

```bash
npm run doc
```

To deploy the documention to the gh-pages branch:

```bash
npm run deploy
```

## Documentation

The API documentation can be found [here](http://pixijs.github.io/pixi-gl-core/).

## License

This content is released under the [MIT License](http://opensource.org/licenses/MIT).

---
_Source: https://npm.io/package/pixi-gl-core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._