@3846masa/bmp

!banner

[![npm-badge]][npm]
[![mit-license-badge]][mit-license]

Create a BMP (w/ alpha channel) binary from RGBA raw bytes like ImageData.

- faster than other libraries (e.g. bmp-js)
- tiny size (basic: ~ 500 bytes, webworker: ~ 700 bytes)
- supports alpha channel

Table of Contents

- Usage
- CDN
- Using via bundler
- API
- convert({ width, height, data })
- HTMLCanvasElement.prototype.toBlob(callback, type)
- Contributing
- License

Usage

$3

#### Basic

!basic
[![codesandbox-badge]](https://codesandbox.io/s/github/3846masa/bmp/tree/main/examples/basic)

See ./examples/basic.

``html

`

#### WebWorker

!webworker
[![codesandbox-badge]](https://codesandbox.io/s/github/3846masa/bmp/tree/main/examples/webworker)

See ./examples/webworker.

`html

`

#### No module

!no-module
[![codesandbox-badge]](https://codesandbox.io/s/github/3846masa/bmp/tree/main/examples/canvas-to-blob)

See ./examples/canvas-to-blob.

`html


`

$3

!bundlephobia

`sh
npm i @3846masa/bmp
`

`js
import { convert } from '@3846masa/bmp';
`

API

$3

Convert RGBA raw bytes like ImageData to a BMP binary.

In worker.mjs, this function returns Promise.

| | |
| :--------------- | :------------------------------------ |
| width | number |
| height | number |
| data | Uint8Array \| Uint8ClampedArray |
| options.strict | boolean |
| Returns | Uint8Array \| Promise |

$3

| | |
| :--------- | :-------------------- |
| callback | (blob: Blob) => any |
| type | 'image/bmp'` |

Contributing

PRs accepted.

License

[MIT (c) 3846masa][mit-license]

[npm-badge]: https://flat.badgen.net/npm/v/@3846masa/bmp?icon=npm
[npm]: https://www.npmjs.com/package/@3846masa/bmp
[mit-license-badge]: https://flat.badgen.net/badge/license/MIT/blue
[mit-license]: https://3846masa.mit-license.org
[codesandbox-badge]: https://flat.badgen.net/badge/codesandbox/try%20it/black