# xpixmap

> read xpm file for use in [node-x11](https://github.com/sidorares/node-x11)

Latest version **0.0.3** (published 2015-08-13) · 0 weekly downloads

## Install

```sh
npm install xpixmap
pnpm add xpixmap
yarn add xpixmap
bun add xpixmap
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2015-08-13 |
| First published | 2015-08-11 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | klepthys |
| Keywords | x11, xlib, xpixmaps, xpm |

## Links

- npm: https://www.npmjs.com/package/xpixmap
- Repository: http://github.com/klepthys/node-xpm
- Homepage: https://github.com/klepthys/node-xpm
- Issues: https://github.com/klepthys/node-xpm/issues
- npm.io page: https://npm.io/package/xpixmap

## Recent versions

- 0.0.3 (latest) — 2015-08-13
- 0.0.2 — 2015-08-12
- 0.0.1 — 2015-08-11

## README

# node-xpm
read xpm file for use in [node-x11](https://github.com/sidorares/node-x11)

##Usage

Sync version :

    var PixmapFromFile = require("xpixmap");
    var pixmap = new PixmapFromFile("file_path");

Async version :

    var PixmapFromFile = require("xpixmap");
    var map = new PixmapFromFile();
    map.open("file_path",function(err,pixmap){

    })

### options

Only supported option is format. It can be RGBA or BGRA.

Default is BGRA as it's what we need for x11. for html5 canvas, one would use RGBA.


    var pixmap = new PixmapFromFile("file_path",{format:"RGBA"});
    //OR asynchronous :
    var pixmap = new PixmapFromFile({format:"RGBA"});

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