1USDRECORD(1) User Commands USDRECORD(1)
2
6 usdrecord - manual page for usdrecord 23.08
7
9 Warning: in _DiscoverPlugins at line 207 of /build‐
10 dir/build/BUILD/OpenUSD-23.08/pxr/imaging/hf/pluginRegistry.cpp --
11 Plugin HdEmbreeRendererPlugin type information incomplete Warning: in
12 _DiscoverPlugins at line 207 of /build‐
13 dir/build/BUILD/OpenUSD-23.08/pxr/imaging/hf/pluginRegistry.cpp --
14 Plugin HdStormRendererPlugin type information incomplete usage: us‐
15 drecord [-h] [--mask PRIMPATH[,PRIMPATH...]]
16 [--purposes PURPOSE[,PURPOSE...]] [--disableGpu] [--camera CAM‐
18 ERA] [--defaultTime | --frames FRAMESPEC[,FRAMESPEC...]]
19 [--complexity {low,medium,high,veryhigh}] [--colorCorrectionMode
20 {disabled,sRGB,openColorIO}] [--renderer {}] [--imageWidth IM‐
21 AGEWIDTH] usdFilePath outputImagePath
22 Generates images from a USD file
24 positional arguments:
26 usdFilePath
27 USD file to record
28 outputImagePath
30 Output image path. For frame ranges, the path must contain ex‐
31 actly one frame number placeholder of the form "###" or
32 "###.###". Note that the number of hash marks is variable in
33 each group.
34 options:
36 -h, --help
37 show this help message and exit
38 --mask PRIMPATH[,PRIMPATH...]
40 Limit stage population to these prims, their descendants and an‐
41 cestors. To specify multiple paths, either use commas with no
42 spaces or quote the argument and separate paths by commas and/or
43 spaces.
44 --purposes PURPOSE[,PURPOSE...]
46 Specify which UsdGeomImageable purposes should be included in
47 the renders. The "default" purpose is automatically included, so
48 you need specify only the *additional* purposes. If you want
49 more than one extra purpose, either use commas with no spaces or
50 quote the argument and separate purposes by commas and/or spa‐
51 ces.
52 --disableGpu
54 Indicates if the GPU should not be used for rendering. If set
55 this not only restricts renderers to those which only run on the
56 CPU, but additionally it will prevent any tasks that require the
57 GPU from being invoked.
58 --camera CAMERA, -cam CAMERA
60 Which camera to use - may be given as either just the camera's
61 prim name (i.e. just the last element in the prim path), or as a
62 full prim path. Note that if only the prim name is used and more
63 than one camera exists with that name, which one is used will
64 effectively be random (default=main_cam)
65 --defaultTime, -d
67 explicitly operate at the Default time code (the default behav‐
68 ior is to operate at the Earliest time code)
69 --frames FRAMESPEC[,FRAMESPEC...], -f FRAMESPEC[,FRAMESPEC...]
71 specify FrameSpec(s) of the time codes to operate on - A Frame‐
72 Spec consists of up to three floating point values for the start
73 time code, end time code, and stride of a time code range. A
74 single time code can be specified, or a start and end time code
75 can be specified separated by a colon (:). When a start and end
76 time code are specified, the stride may optionally be specified
77 as well, separating it from the start and end time codes with
78 (x). Multiple FrameSpecs can be combined as a comma-separated
79 list. The following are examples of valid FrameSpecs: 123 -
80 101:105 - 105:101 - 101:109x2 - 101:110x2 - 101:104x0.5
81 --complexity {low,medium,high,veryhigh}, -c {low,medium,high,veryhigh}
83 level of refinement to use (default=low)
84 --colorCorrectionMode {disabled,sRGB,openColorIO}, -color {dis‐
86 abled,sRGB,openColorIO}
87 the color correction mode to use (default=sRGB)
88 --renderer {}, -r {}
90 Hydra renderer plugin to use when generating images
91 --imageWidth IMAGEWIDTH, -w IMAGEWIDTH
93 Width of the output image. The height will be computed from this
94 value and the camera's aspect ratio (default=960)
95usdrecord 23.08 November 2023 USDRECORD(1)