Skip to content

create3000/x3d-image

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

x3d-image

NPM Version NPM Downloads DeepScan grade

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 ...]

Options

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

-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.

-o file(s) ...

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

-s WIDTHxHEIGHT

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

-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).

-d delay

Wait the specified number of seconds before generating the image.

-a

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

-e [CANNON, HELIPAD, FOOTPRINT]

Add an EnvironmentLight node to scene, default is "CANNON". Useful when rendering glTF files with PhysicalMaterial nodes.

-v

Show version.

-h

Show help.

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 .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 end environment light.

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

See Also

x3d-image is based on X_ITE, so check it out.