x3d-image

Render image files from X3D.

Synopsis

You can run x3d-image without installing it using npx:

npx x3d-image [options] -i input-file -o output-file [-i input-file -o output-file ...]

Overview

x3d-image is a command-line tool, based on X_ITE, that renders image files from X3D (Extensible 3D) and other 3D file formats. It allows users to convert 3D scenes into 2D images, supporting various input formats. Output can be in PNG or JPEG formats.

Options

x3d-image interprets the following options when it is invoked:

-a

Modify the current view so that all objects fit in view volume.

-b color

Set background to specified color. Color can be any X3D RGBA color or any CSS color. Use PNG as output image format for transparent backgrounds.

-c [SRGB, LINEAR_WHEN_PHYSICAL_MATERIAL, LINEAR]

The color space in which color calculations take place.

-d delay

Wait the specified number of seconds before generating the image.

-e extension(s) ...

Set output file extension(s), e.g. ".x3dv" or ".tidy.x3d". The output file will have the same basename as the input file. Use either "-e" or "-o".

-g

Whether to use a logarithmic depth buffer. It may be necessary to use this if dealing with huge differences in scale in a single scene. It is automatically enabled if a GeoViewpoint is bound.

-h

Show help.

-i file(s) ...

Set input file(s). This can be either a local file path or a URL. If there are less input files than output files, the last input file is used for the remaining output files.

-l

Log output filenames to stdout.

-m [NONE, ACES_NARKOWICZ, ACES_HILL, ACES_HILL_EXPOSURE_BOOST, KHR_PBR_NEUTRAL]

Whether tone mapping should be applied.

-n

Whether to use order independent transparency rendering technique.

-o file(s) ...

Set output file(s). This can be either a PNG or JPEG file.

-q quality

A Number between 0 and 1 indicating the image quality to be used when creating images using file formats that support lossy compression (such as JPEG).

-r rotation

Creates a parent group with the model as children and sets the specified X3D rotation value.

-s WIDTHxHEIGHT

Set image size in pixels, default is '1280x720'.

-t [CHAR_SPACING, SCALING]

Controls how Text.length and Text.maxExtent are handled. Either by adjusting char spacing or by scaling text letters.

-v

Show version.

-w [CANNON, HELIPAD, FOOTPRINT]

Add an EnvironmentLight node to scene. Useful when rendering glTF files with PhysicalMaterial nodes.

-x exposure

The exposure of an image describes the amount of light that is captured.

Supported Input File Types

| Encoding | File Extension | MIME Type | |------------------|----------------|-----------------| | X3D XML | .x3d, .x3dz | model/x3d+xml | | X3D JSON | .x3dj, .x3djz | model/x3d+json | | X3D Classic VRML | .x3dv, .x3dvz | model/x3d+vrml | | VRML 2.0 | .wrl, .wrz | model/vrml | | glTF | .gltf, .glb | model/gltf+json | | Wavefront OBJ | .obj | model/obj | | STL | .stl | model/stl | | PLY | .ply | model/ply | | SVG Document | .svg, .svgz | image/svg+xml |

Supported Output File Types

| Encoding | File Extension | MIME Type | |----------|----------------|------------| | PNG | .png | image/png | | JPEG | .jpg, .jpeg | image/jpeg |

Examples

Render a JPEG image from X3D with size 1600x900.

$ npx x3d-image -s 1600x900 -i file.x3d -o file.jpg

Render two PNG images from two X3D files.

$ npx x3d-image -s 1600x900 -i file1.x3d -o file1.png -i file2.x3d -o file2.png

Render image of glTF file with view-all and environment light.

$ npx x3d-image -a -w CANNON -i file.gltf -e .png

See Also

• x3d-tidy — X3D converter, beautifier and minimizer