UNPKG

parse-exr

Version:

EXR file parser. Ported from Three.js implementation without depending on it.

github.com/dmnsgn/parse-exr

dmnsgn/parse-exr

92 lines (63 loc) • 4 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# parse-exr [![npm version](https://img.shields.io/npm/v/parse-exr)](https://www.npmjs.com/package/parse-exr) [![stability-stable](https://img.shields.io/badge/stability-stable-green.svg)](https://www.npmjs.com/package/parse-exr) [![npm minzipped size](https://img.shields.io/bundlephobia/minzip/parse-exr)](https://bundlephobia.com/package/parse-exr) [![dependencies](https://img.shields.io/librariesio/release/npm/parse-exr)](https://github.com/dmnsgn/parse-exr/blob/main/package.json) [![types](https://img.shields.io/npm/types/parse-exr)](https://github.com/microsoft/TypeScript) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-fa6673.svg)](https://conventionalcommits.org) [![styled with prettier](https://img.shields.io/badge/styled_with-Prettier-f8bc45.svg?logo=prettier)](https://github.com/prettier/prettier) [![linted with eslint](https://img.shields.io/badge/linted_with-ES_Lint-4B32C3.svg?logo=eslint)](https://github.com/eslint/eslint) [![license](https://img.shields.io/github/license/dmnsgn/parse-exr)](https://github.com/dmnsgn/parse-exr/blob/main/LICENSE.md) EXR file parser. Ported from [Three.js implementation](https://github.com/mrdoob/three.js/blob/dev/examples/jsm/loaders/EXRLoader.js/) without depending on it. [![paypal](https://img.shields.io/badge/donate-paypal-informational?logo=paypal)](https://paypal.me/dmnsgn) [![coinbase](https://img.shields.io/badge/donate-coinbase-informational?logo=coinbase)](https://commerce.coinbase.com/checkout/56cbdf28-e323-48d8-9c98-7019e72c97f3) [![twitter](https://img.shields.io/twitter/follow/dmnsgn?style=social)](https://twitter.com/dmnsgn) ## Installation ```bash npm install parse-exr ``` ## Usage ```js import parseExr from "parse-exr"; const exrData = await (await fetch(url)).arrayBuffer(); const FloatType = 1015; // const HalfFloatType = 1016; const { data, width, height } = parseExr(exrData, FloatType); // => Use the data ``` ## API <!-- api-start --> ## Functions <dl> <dt><a href="#parseExr">parseExr(buffer, [type])</a> ⇒ <code><a href="#EXRData">EXRData</a></code></dt> <dd><p>Parse a buffer and return EXR data</p> </dd> </dl> ## Typedefs <dl> <dt><a href="#EXRData">EXRData</a></dt> <dd></dd> </dl> <a name="parseExr"></a> ## parseExr(buffer, [type]) ⇒ [<code>EXRData</code>](#EXRData) Parse a buffer and return EXR data **Kind**: global function | Param | Type | Default | Description | | ------ | -------------------------------------- | ----------------- | --------------------------------- | | buffer | <code>ArrayBuffer</code> | | | | [type] | <code>1015</code> \| <code>1016</code> | <code>1016</code> | Float (1015) or Half Float (1016) | <a name="EXRData"></a> ## EXRData **Kind**: global typedef **Properties** | Name | Type | Description | | ---------- | ----------------------------------------------------------------- | ------------------------------------- | | header | <code>object</code> | | | width | <code>number</code> | | | height | <code>number</code> | | | data | <code>Uint16Array</code> \| <code>Float32Array</code> | | | format | <code>1023</code> \| <code>1028</code> | RGBAFormat (1023) or RedFormat (1028) | | colorSpace | <code>&quot;&quot;</code> \| <code>&quot;srgb-linear&quot;</code> | | <!-- api-end --> ## License MIT. See [license file](https://github.com/dmnsgn/parse-exr/blob/main/LICENSE.md).