1USDRECORD(1)                     User Commands                    USDRECORD(1)
2
3
4

NAME

6       usdrecord - manual page for usdrecord 22.05b
7

DESCRIPTION

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