samien
/
three.js
mirror of https://github.com/mrdoob/three.js.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128
							<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="utf-8">
	<title>EXRExporter - Three.js Docs</title>
	<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
	<script src="../scripts/highlight.min.js"></script>
	<link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
	<link type="text/css" rel="stylesheet" href="../styles/page.css">
</head>
<body>
	<h1 translate="no">EXRExporter</h1>
		<section>
			<header>
				<div class="class-description"><p>An exporter for EXR.</p>
<p>EXR ( Extended Dynamic Range) is an <a href="https://github.com/AcademySoftwareFoundation/openexr" target="_blank" rel="noopener">open format specification</a>
for professional-grade image storage format of the motion picture industry. The purpose of
format is to accurately and efficiently represent high-dynamic-range scene-linear image data
and associated metadata. The library is widely used in host application software where accuracy
is critical, such as photorealistic rendering, texture access, image compositing, deep compositing,
and DI.</p></div>
				<h2>Code Example</h2>
				<div translate="no"><pre><code class="language-js">const exporter = new EXRExporter();
const result = await exporter.parse( renderer, options );
</code></pre></div>
			</header>
			<article>
				<h2 class="subsection-title">Import</h2>
				<p><span translate="no">EXRExporter</span> is an addon, and must be imported explicitly, see <a href="https://threejs.org/manual/#en/installation" target="_blank" rel="noopener">Installation#Addons</a>.</p>
				<pre><code class="language-js">import { EXRExporter } from 'three/addons/exporters/EXRExporter.js';</code></pre>
				<div class="container-overview">
					<h2>Constructor</h2>
					<h3 class="name name-method" id="EXRExporter" translate="no">new <a href="#EXRExporter">EXRExporter</a><span class="signature">()</span> </h3>
					<div class="method">
					</div>
				</div>
				<h2 class="subsection-title">Methods</h2>
					<h3 class="name name-method" id="parse" translate="no">.<a href="#parse">parse</a><span class="signature">( arg1 : <span class="param-type"><a href="DataTexture.html">DataTexture</a> | <a href="WebGPURenderer.html">WebGPURenderer</a> | <a href="WebGLRenderer.html">WebGLRenderer</a></span>, arg2 : <span class="param-type"><a href="EXRExporter.html#~Options">EXRExporter~Options</a> | <a href="RenderTarget.html">RenderTarget</a></span>, arg3 : <span class="param-type"><a href="EXRExporter.html#~Options">EXRExporter~Options</a></span> )</span><span class="type-signature"> : Promise.&lt;Uint8Array></span> <span class="type-signature">(async) </span></h3>
					<div class="method">
						<div class="description">
							<p>This method has two variants.</p>
<ul>
<li>When exporting a data texture, it receives two parameters. The texture and the exporter options.</li>
<li>When exporting a render target (e.g. a PMREM), it receives three parameters. The renderer, the
render target and the exporter options.</li>
</ul>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>arg1</strong>
									</td>
									<td class="description last">
										<p>The data texture to export or a renderer.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong>arg2</strong>
									</td>
									<td class="description last">
										<p>The exporter options or a render target.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong>arg3</strong>
									</td>
									<td class="description last">
										<p>The exporter options.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A Promise that resolves with the exported EXR.</dt>
						</dl>
					</div>
				<h2 class="subsection-title">Type Definitions</h2>
				<div class="member">
					<h3 class="name" id="~Options" translate="no">.<a href="#~Options">Options</a> </h3>
					<div class="description">
						<p>Export options of <code>EXRExporter</code>.</p>
					</div>
<table class="props">
	<tbody>
		<tr>
				<td class="name">
					<strong>type</strong>
						<br>
<span class="param-type"><a href="global.html#HalfFloatType">HalfFloatType</a></span>
|
<span class="param-type"><a href="global.html#FloatType">FloatType</a></span>
				</td>
			<td class="description last">
				<p>Output data type.</p>
						<p>Default is <code>HalfFloatType</code>.</p>
			</td>
		</tr>
		<tr>
				<td class="name">
					<strong>type</strong>
						<br>
<span class="param-type">NO_COMPRESSION</span>
|
<span class="param-type">ZIP_COMPRESSION</span>
|
<span class="param-type">ZIPS_COMPRESSION</span>
				</td>
			<td class="description last">
				<p>The compression algorithm.</p>
						<p>Default is <code>ZIP_COMPRESSION</code>.</p>
			</td>
		</tr>
	</tbody>
</table>
				</div>
				<h2 class="subsection-title">Source</h2>
				<p>
					<a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/exporters/EXRExporter.js" translate="no" target="_blank" rel="noopener">examples/jsm/exporters/EXRExporter.js</a>
				</p>
			</article>
		</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>