Debian Codegraph @

website/bin/exrenvmap.rst

raw
1 ..
2 SPDX-License-Identifier: BSD-3-Clause
3 Copyright Contributors to the OpenEXR Project.
4
5 exrenvmap
6 #########
7
8 ::
9
10 exrenvmap [options] infile outfile
11
12 Description
13 -----------
14
15 Convert an OpenEXR latitude-longitude environment map
16 into a cube-face environment map or vice versa.
17 Reads an environment map image from infile, converts
18 it, and stores the result in outfile.
19
20 If the input file name contains a '%' character, then an
21 input cube-face environment map is assembled from six
22 square sub-images that represent the six faces of the cube.
23 The names of the six image files are generated by replacing
24 the % with +X, -X, +Y, -Y, +Z and -Z respectively.
25
26 If the output file name contains a '%' character and
27 the program has been instructed to produce a cube-face
28 environment map, then the output image is split into six
29 square sub-images that are saved in six separate output
30 files. The names of the files are generated by replacing
31 the % with +X, -X, +Y, -Y, +Z and -Z respectively.
32
33 Options:
34 --------
35
36 .. describe:: -o
37
38 produces a ONE_LEVEL output file (default)
39
40 .. describe:: -m
41
42 produces a MIPMAP_LEVELS output file (-m has
43 no effect if the output image is split into
44 multiple files)
45
46 .. describe:: -c
47
48 the output file will be a cube-face environment
49 map (default)
50
51 .. describe:: -l
52
53 the output file will be a latitude-longitude
54 environment map
55
56 .. describe:: -ci
57
58 the input file is interpreted as a cube-face
59 environment map, regardless of its envmap
60 attribute
61
62 .. describe:: -li
63
64 the input file is interpreted as a latitude-
65 longitude environment map, regardless of its
66 envmap attribute (-li has no effect if the
67 input image is assembled from multiple files)
68
69 .. describe:: -w x
70
71 sets the width of the output image to x pixels
72 (default is 256). The height of the output image
73 will be x*6 pixels for a cube-face map, or x/2
74 pixels for a latitude-longitude map.
75
76 .. describe:: -f r n
77
78 sets the antialiasing filter radius to r
79 (default is 1.0) and the sampling rate to
80 n by n (default is 5 by 5). Increasing r
81 makes the output image blurrier; decreasing r
82 makes the image sharper but may cause aliasing.
83 Increasing n improves antialiasing, but
84 generating the output image takes longer.
85
86 .. describe:: -b
87
88 blurs the environment map image by applying a
89 180-degree-wide filter kernel such that point-
90 sampling the blurred image at a location that
91 corresponds to 3D direction N returns the color
92 that a white diffuse reflector with surface
93 normal N would have if it was illuminated using
94 the original non-blurred image.
95 Generating the blurred image can be fairly slow.
96
97 .. describe:: -t x y
98
99 sets the output file's tile size to x by y pixels
100 (default is 64 by 64)
101
102 .. describe:: -p t b
103
104 if the input image is a latitude-longitude map,
105 pad the image at the top and bottom with t*h
106 and b*h extra scan lines, where h is the height
107 of the input image. This is useful for images
108 from 360-degree panoramic scans that cover
109 less than 180 degrees vertically.
110
111 .. describe:: -d
112
113 sets level size rounding to ROUND_DOWN (default)
114
115 .. describe:: -u
116
117 sets level size rounding to ROUND_UP
118
119 .. describe:: -z x
120
121 sets the data compression method to x
122 (none/rle/zip/piz/pxr24/b44/b44a/dwaa/dwab,
123 default is zip)
124
125 .. describe:: -v
126
127 verbose mode
128
129 .. describe:: -h, --help
130
131 print this message
132
133 .. describe:: --version
134
135 print version information
136