On this page |
husk [options] usd_file [-o image_file]
Tips ¶
-
LinuxとMacOSでは、コマンドラインで
husk
プロセスにSIGUSR1
シグナルを送信(kill -USR1 pid
)することで、現在のレンダリングの スナップショット 画像を強制的に書き出せることができます。
オプション ¶
情報 ¶
--help
このヘルプを表示します。
--version
レンダラーのバージョン文字列をプリントします。
Karma ¶
--properties
Karmaが理解するすべてのレンダリングプロパティの名前とそれらのデフォルト値をプリントします。
--property-definition
Karmaが理解するすべてのレンダリングプロパティに関する全情報をプリントします。
--property-definition-file filename
Karmaが理解するすべてのレンダリングプロパティに関する全情報をファイルに保存します。
filename
に-
を指定すると、その情報が標準出力に書き出されます。
--procedurals
すべてのプロシージャル定義をプリントします。
--filters
Karmaが理解するフィルターとOraclesに関する情報をプリントします。
--engine
Karmaレンダリングエンジンをオーバーライドします。オプションはxpu
またはcpu
です。
-p/--pixel-samples samples
ピクセルあたりのサンプル数。
デフォルトは128
です。コマンドラインにこれを指定することで、USDファイル内のすべてのレンダリング設定がオーバーライドされます。
--bucket-size pixels
レンダーバケットのサイズ(単位はピクセル)。
デフォルトは128
です。コマンドラインにこれを指定することで、USDファイル内のすべてのレンダリング設定がオーバーライドされます。
--bucket-order order
画像内で最初にレンダリングされるバケットを決めます。オプションは以下のとおり:
-
middle
- 画像の中央から開始してバケットをレンダリングします。 -
top
- 画像の上側から開始してバケットをレンダリングします。 -
bottom
- 画像の下側から開始してバケットをレンダリングします。 -
left
- 画像の左側から開始してバケットをレンダリングします。 -
right
- 画像の右側から開始してバケットをレンダリングします。
--image-mode mode
--progressive-passes count
--disable-lighting
すべてのライティングを無効にします(これは廃止されました。代わりに--disable-scene-lights
を使用してください)。
--ao-samples samples
アンビエントオクルージョンのサンプル数(ヘッドライトシェーディング)。
デフォルトは0
です。
--ao-distance n
アンビエントオクルージョンのカットオフ距離。デフォルトは1
です。
--lock-random seed
乱数シードとしてフレーム番号の代わりにseedを使用します。
--dicingcamera prim_path
指定したPrimパスのカメラを使ってDicing(賽の目化)します。これを指定しなかった場合、Karmaはレンダーカメラを使ってDicing(賽の目化)します。
--optimize-offline level
現在のところ、このオプションは無効で何の効果もありません。
--convergence-mode mode
Render Settings Primで何も指定されていなかった場合のKarm CPUのデフォルトのConvergence(収束)モードを指定します。オプションは以下のとおり:
-
pathtraced
- バウンス毎に最大1本の間接光線。 -
distributed
(廃止) - コンポーネント毎のサンプリング -
variance
- 間接光線の数は、ノイズ評価に基づいて計算されます。
--autoheadlight
このオプションを指定し、且つ、シーン内にライトが存在しなかった場合、Karmaはレンダリング時にヘッドライトを追加します。
--baking-info
画像をレンダリングするのではなく、代わりにベイクに関する情報(UDIMタイルのリスト、Ptexテクスチャの生成に必要な画像の数)をプリントします。
USD ¶
--usd-input filepath
レンダリングするUSDシーンファイル。
--resolver-context arg
ステージを処理するためにAsset Resolverコンテキストの初期化に使用されるファイル。
--resolver-context-string arg
ステージを処理するためにAsset Resolverコンテキストの初期化に使用される文字列。
オプションの引数は、特定のURL接頭辞を担当するAsset Resolverを構成するならば'url=string'
の形式で、
デフォルトのAsset Resolverを構成するならば'string'
の形式で指定してください。
--variant-fallback arg
バリアントセットが含まれているPrimsに対して、そのバリアントセットの明示的なバリアント選択がない場合に使用されるデフォルトのバリアント選択。
オプションの引数は、'set=value1,value2'
の形式で指定してください。
--list-settings
シーン内のRender Settings Primに関する情報をプリントします。
--list-cameras
シーン内のカメラに関する情報をプリントします。
--list-renderers
利用可能なすべてのHydraレンダーデリゲートのリストをプリントします。
--headlight style
ステージ上にライトが見つからなかった場合、husk
はhusd/huskheadlight.py
コールでヘッドライトを追加します。オプションは以下のとおり:
-
none
: ヘッドライトは作成されません。 -
distant
: カメラの位置にディスタントヘッドライトを作成します。 -
dome
: ドームヘッドライトを作成します。 このオプションのデフォルト値は、HOUDINI_HUSK_DEFAULT_HEADLIGHT
環境変数で指定します。
--purpose tokens
レンダリングするPurpose(s)。
ここには、Purposeをカンマで区切ったリストを指定します。デフォルトはgeometry,render
です。
--complexity token
レンダリングするジオメトリの複雑さ。オプションはlow
、medium
、high
、veryhigh
または0から8までの整数です。
--mask arg
Limit stage population to these prims, their descendants and ancestors. To specify multiple paths, use either commas or spaces.
--disable-scene-materials
Disable all materials in the scene. This option applies to all render delegates.
--disable-scene-lights
Disable all lights in the scene. This option applies to all render delegates.
--disable-motionblur
disableMotionBlur
レンダー設定を上書きして、強制的にシャッターの閉時間をシャッターの開時間と同じにします。
これによって、実質的にモーションブラーが無効になります。
--disable-delegate-products
ほとんどのレンダープロダクトには出力としてラスターファイルがあります。 デリゲートレンダープロダクトは、非ラスタープロダクト(Deep画像、チェックポイントファイル、フォトンマップなど)を表現する際に使用します。 このオプションは、デリゲートレンダープロダクトを無効にし、ラスター出力のみを生成します。
--disable-dummy-raster-product
When there are no raster products detected, husk will normally create a “dummy” raster product.
This may happen when all products are something other than “raster” products.
This dummy raster is largely ignored by husk (setting the product name to husk:null_raster
), though some delegates may throw errors without any raster products.
This option prevents the creation of the dummy raster product if needed for this special case.
-s/--settings prim_path
指定したPrimパスのRenderSettings
を使ってレンダリングします。
--prerender-script python_file
レンダリングする前に、指定したPythonスクリプトを実行します。
このスクリプト内でstage
変数を使用することで、レンダリングされるUSDステージを参照することができます。
このスクリプトは、USDファイルが読み込まれた後からSettings Primを読み込む前/レンダリング前の間で実行されます。
python_file
引数は複数の引数に解析されます。
スペースを含んだ引数を適切に引用符で閉じるように注意してください。
hou.frame()
関数はレンダリングされる最初のフレーム小数点を返します。
コマンドラインにアクセスする必要がある場合、husk_command
変数からコマンドラインが利用可能です。
Before the render process starts, (i.e. the prerender
stage), husk
analyzes the render settings primitive and partitions the render products.
For example, it’s possible that a single render settings primitive renders two render products that use different cameras.
Since the delegate can only render a single camera at a time, husk
splits this single render into two separate render tasks (one for each render product). This partitioning is done after the prerender-script
.
In contrast to prerender-script
, the preframe-script
is called before each frame is rendered.
However, if the preframe-script
tries to change the render camera on a render product, this is impossible since husk
has already split the render tasks by the time frames start rendering.
Imagine the preframe-script
only changed the camera on the second frame in a sequence.
--preframe-script python_file
各フレームがレンダリングされる前に、指定したPythonスクリプトを実行します。
このスクリプト内でstage
変数を使用することで、レンダリングされるUSDステージを参照することができます。
settings
変数には、レンダー設定の辞書が格納されます。
このスクリプトは、USDファイルが読み込まれた後からSettings Primを読み込む前/レンダリング前の間で実行されます。
python_file
引数は複数の引数に解析されます。
スペースを含んだ引数を適切に引用符で閉じるように注意してください。
hou.frame()
関数はレンダリングされる最初のフレーム小数点を返します。
huskコマンドラインは、husk_command
変数を使用することでアクセス可能です。
--postframe-script python_file
各フレームがレンダリングされた後に、指定したPythonスクリプトを実行します。
stage
変数とhusk_command
変数とsettings
変数が利用可能であり、hou.frame()
はレンダリングされたフレーム小数点を返します。
--postrender-script python_file
すべてのフレームがレンダリングされた後に、指定したPythonスクリプトを実行します。
stage
変数が利用可能であり、hou.frame()
は最後にレンダリングされたフレーム小数点を返します。
--allowed-procedurals arg
Control which procedurals should be allowed to contribute to the final USD stage. Valid options are
none
: no procedurals
basic
: graph procedurals that only generate curves and points
all
: all procedurals (may require Houdini Engine license)
Default is basic
.
--capture-procedurals
Save the result of any expanded procedurals
--procedurals-capture-directory path
Directory to store expanded procedurals. Default is $HOUDINI_TEMP_DIR
.
--usd-trace method
USDのトレース関数を有効にします。
method
は、そのレポートの方法を決めます:
report
– 各関数の時間とサンプル数をプリントします。
timing
– 各関数の経過した時間をプリントします。
chrome
– Chromeトレースフォーマットでの閲覧に適したJSON出力を生成します。このオプションには、ログファイルの出力を指定する--usd-chrome-file
オプションが必要です。
このオプションを有効にするとパフォーマンスに大きく影響を与えることに注意してください。
--usd-chrome-file filename
--usd-trace method
オプションとこのオプションの両方でUSDのトレース関数が有効になり、このオプションでは、JSONトレース情報が保存されるファイル名を指定します。
RenderSettingsオーバーライド ¶
コマンドラインに以下のオプションを指定することで、USDファイル内のすべてのレンダー設定がオーバーライドされます。
-c/--camera prim_path
レンダリングするカメラのPrimパス。
-o/--output file_path
出力画像ファイルのパス。ここには特定のローカル変数を含めることができます:
$F
現行フレーム番号。
$FN
桁数固定の現行フレーム番号。この桁数はF
の後に指定します。例えば、$F4
は現行フレーム番号を4桁に広げます(例えば、0001
)。
$FF
浮動小数点フレーム。これは、(モーションブラーやシミュレーションのように)フレーム間で評価されるエクスプレッションに関して$F
と値が異なります。
$N
現在レンダリングされているフレームの“順序”番号です(例えば、フレーム範囲の最初のフレーム番号が40
だったとしても、1枚目のフレームをレンダリングすると$N
は必ず1
になり、2枚目のフレームをレンダリングすると$N
は必ず2
になります)。
<F>
, <FF>
, <F4>
$F
, $FF
, $F4
と同じです。
%d
, %g
, %04d
$F
, $FF
, $F4
と同じです。
複数のRender Productが存在する場合、ファイル名をカンマで区切ったリストを使用することで、画像をオーバーライドすることができます。
-r/--res width height
レンダリング画像の幅と高さ(単位はピクセル。例えば、--res 1280 720
)。
-S/--res-scale percent
指定したパーセンテージで出力画像をスケールします。
例えば、--res-scale 25
は画像を1/4サイズで出力し、--res-scale 250
は画像を2.5倍サイズで出力します。
--pixel-aspect float
ピクセルのアスペクト比(ピクセル高さに対するピクセル幅の比率)、デフォルトは1
(正方形ピクセル)。
--make-output-path
出力画像の親ディレクトリがまだ存在しなければ、そのディレクトリを作成します。
-f/--frame n
開始フレーム番号。デフォルトは1
。
-n/--frame-count n
レンダリングするフレームの数(開始フレームを含む)。デフォルトは1
。
-i/--frame-inc n
フレーム増分。デフォルトは1
。
--fps n
ステージに定義されている秒あたりのフレーム数を上書きします。
この値がhoudini:fps
レンダー設定としてレンダーデリゲートに渡され、Velocityモーションブラーを計算する時にオプションで使用することができます。
レンダリング ¶
-R/--renderer token
代替のHydraクライアントを使ってレンダリングします。
--delegate-options string
選択したレンダーデリゲート固有のオプションのリスト。
-j/--threads n
スレッド数。0
は、すべてのプロセッサを使用し、-1
は、1個を除くすべてのプロセッサを使用することを意味します。
--fast-exit 0|1
これを0
に設定すると、USDシーンとHydraインターフェースが完全に切り離されます。
--restart-delegate
n
通常では、huskはUSD差分オペレーションを使用して複数フレームのレンダリングを効率化します。
デリゲートがフレーム間で処理内容を共有できるようにするために、フレーム間で変化したシーンデータのみがそのデリゲートに伝達されます。
このオプションを使用すると、レンダーデリゲートがn
フレーム毎に再起動されます。
例えば、1
を指定すると、レンダーデリゲートはフレーム毎に再起動されます。
3
を指定すると、USD差分オペレーションが3フレーム分使用され、次に4フレーム目をレンダリングする前にデリゲートを再起動します。
0
の値(デフォルト)は、デリゲートがまったく再起動されません。
デリゲートの再起動はシーンの再構築を伴うので、このオプションを使用するとパフォーマンスに大きく影響を与えるため、本当に必要な場合にのみ使用してください。
--snapshot sec
sec秒おきに、レンダリングされた現行状態の画像のスナップショットを保存します。-1
は、スナップショットを無効にします。デフォルトは-1
。
--snapshot-path path
スナップショット画像の保存先のパスを上書きします。
--snapshot-suffix suffix
スナップショット画像を保存する際に画像ファイル名に足される接尾辞を指定します。
このデフォルトは_part
です。
空っぽの文字列を設定すると、husk
は最終出力画像名をスナップショット画像名として使用するようになります。
--snapshot-save-mode mode
通常では、スナップショットはレンダリングの進捗を示すのに使用され、レンダリングが完了すると削除されます。 このオプションは、この挙動を制御することができます。指定可能な値:
off
画像のレンダリングが終了したら、スナップショット部分的画像を削除します。
number
各スナップショットを番号付きの連番ファイルとして保存します。これによって、レンダリングのスナップショットの進捗を確認することができます。
--slap-comp slapcomp
Apex COP network to run on the image.
This option can occur multiple times and each operation is run in sequence.
The slapcomp
string specifies a path to the Apex graph, but can also have encoded options.
Options are encoded using: path_to_graph?option=value&option2=value2
.
Possible options are:
name
Provide an identifier for this slap-comp operation
mapinput
Maps an AOV (RenderVar) name to the corresponding Apex graph input name. This option may be specified multiple times.
mapoutput
Maps an AOV (RenderVar) name to the corresponding Apex graph output name. This option may be specified multiple times.
For example, if there’s an AOV “C” being rendered, but the Apex Graph has an input “Cin” and an output “Cout”, the argument might look like: --slap-comp path_to_cop.geo?mapinput=Cin:C&mapoutput=Cout=C
.
--exrmode mode
-1
HOUDINI_OIIO_EXR
変数を使用します。
0
クラシックドライバを使用します。
1
改良されたドライバを使用します。
--ocio arg
Use OCIO to transform color when saving images.
The values are 1
or 0
. When using OCIO, the file rules and RenderVar properties will be used to determine the color space.
When OCIO is disabled, this will fallback to Houdini’s intrinsic assumptions about image format color spaces.
--autocrop pattern
一部の画像フォーマット(OpenEXR)は、 データウィンドウ に対応しています。これは、画像の全体サイズの一部に対してピクセルデータのみを保存します。 このオプションは、そのデータウィンドウを自動的にAOV(またはAOVsリストのすべてのAOV)内のゼロでない値を含んだ矩形領域のみにトリムすることができます。
例えば、husk --autocrop C,A
は、データウィンドウをC
(カラー)とA
(アルファ)のAOV内のどちらかでゼロでないピクセルを含んだ最小矩形にトリムします。
デフォルトは空っぽの文字列で、自動トリムをしないことを意味します。
*
はすべてのAOVを指定することができます。
MacとLinuxのコマンドライン上では、シェルがアスタリクスを展開しないようにおそらくそれを引用符で閉じる必要があります:husk --autocrop "*"
。
Note
データウィンドウ外のピクセルデータ は画像に 保存されません (データウィンドウとは、実際のデータのトリムであり、表示設定ではありません)。
このオプションは“ゼロ” vs “非ゼロ”の比較でしか動作していないので、“空白”が0
で表現されていない領域には役に立ちません。
例えば、カラーによるトリムは黒の背景でしか動作しません。他の例だと、“最遠”のZ深度値をトリムするのは役に立つかもしれませんが、そのような値はファークリップ平面の深度が設定され、0
ではありません。
これは、ポスト処理として画像に対してiautocrop
を実行することと同様です。
--mplay-monitor aovs
このレンダリングのMPlayモニターを自動的に起動します。
このモニターを使用することで、画像がレンダリングされていく時の進捗状況を観察することができます。
aovsには、MPlayに表示したいAOVをカンマで区切ったリストを指定します。
例えば、--mplay-monitor C
は(ディスクに書き出される画像が複数のAOVを含んでいたとしても)カラー平面のみを表示します。
--mplay-monitor C,N,diffuse
オプションは、検査用にC
, N
, diffuse
の平面をMPlayに送信します。
選択したAOVsをモニターに表示するには、ディスクに保存される画像の中にそれらのAOVsが必ず存在している必要があります。
aovsに単一のハイフンを指定すると(例えば、--mplay-monitor -
)、すべてのAOVsがモニターに送信されます。
Warning
モニターを閉じるとレンダリングが終了します。
--mplay-scale scale
MPlayでのレンダリングのスケールを指定します。
これは、モニターもMPlayレンダープロダクトも含みます。
現在のところ、scale引数の値はディスクにレンダリングされる画像の10から100パーセントに制限されています。
MPlay画像はポイントフィルターがかかります。
つまり、ソースピクセルのブラーがなくなります。
デフォルトは100
です。
--no-mplay
MPlayへのレンダリングを無効にします。 このオプションは、ディスプレイが付いていないマシン上(ファーム上)でレンダリングする時に役立ちます。
--mplay-update seconds
MPlay画像を更新する秒数。
--mplay-session label
labelで指定されたセッションにMPlayレンダリングを送信します。
--mplay-bgimage image
MPlayの背景に表示する画像を指定します。
--mplay-remotehost hostname:port
MPlayモニタの接続先のリモートホストとソケットポートを指定します。
--mplay-gamma gamma
gammaの値が0より大きければ、MPlayにディスプレイガンマが設定されます。
--mplay-lut lut
MPlayのディスプレイLUTを指定します。
--tile-count xcount ycount
huskは大きな画像を複数のタイルでレンダリングすることができます。
このオプションには、X方向とY方向のタイル数を指定します。
--tile-index
オプションと併用してください。
--tile-index index
単一画像をタイルに分けてレンダリングする時、このオプションにはレンダリングしたいタイルのインデックスを指定します。
このインデックスは0
から始まります。
タイルの数は--tile-count
オプションで決まります。
--tile-suffix suffix
単一画像をタイルに分けてレンダリングする時、このオプションには--tile-index
を使用して展開される画像ファイル名の接尾辞を指定します。
このオプションは-o
オプションと同じルール(例えば、_tile%02d
)を使用します。
タイルインデックスを展開するエクスプレッション内のF
変数はタイルインデックスを表現し、N
変数は(0ではなく1から始まる)1ベースのタイルインデックスを表現します。
--timelimit sec
sec秒を過ぎるとレンダリングがキャンセルされます。デフォルトの-1
は、時間制限なしです。
--timelimit-image
--timelimit-nosave-partial
レンダリングが時間制限を超えると、部分画像を保存しません。
--stdout filename
指定したファイルに標準出力を送信します。
Windowsでは、ファイル名の代わりにconsolewait
またはconsolenowait
を使用することができます。
consolewait
は出力用のコンソールウィンドウを開き、このウィンドウを閉じないと次のフレームがレンダリングされません。
これによって、高速で流れる出力を読むことができるようになりますが、コンソールウィンドウの面倒を見続ける必要があります。
consolenowait
はコンソールウィンドウを開いて、フレームのレンダリングが終わるとすぐにそのウィンドウを閉じます。
レンダリングが遅ければ出力を読むことはできるでしょうが、これは毎フレームでクリックしてウィンドウを閉じる必要がありません。
--stderr filename
:
指定したファイルに標準エラーを送信します。
このファイルは--stdout
で指定するファイルと同じで構いません。
--append-stdout filename
指定したファイルに標準出力を送信し、置換するのではなくてファイルに足します。
--append-stderr filename
指定したファイルに標準エラーを送信し、置換するのではなくてファイルに足します。
--windows-console mode
Windowsでは、このオプションは、リダイレクトオプションを上書きし、出力を表示するコンソールを開きます。
mode
にはwait
またはnowait
のどちらかを指定します。
-V/--verbose level
レンダリング中に何かの情報をプリントします。デフォルトは2
。
0-9
レンダリング統計の詳細度。 詳細度レベルが8以上だとレンダリングパフォーマンスに影響を与える場合がありますので、問題シーンをデバッグする場合にのみ使用してください。
p
VEXプロファイリングを有効にします(パフォーマンスに影響します)。
P
VEXプロファイリングとNANチェックを有効にします(パフォーマンスに大きく影響します)。
a/A
Alfredスタイルの進捗を有効/無効にします。
e/E
経過時間のメッセージを有効/無効にします。
t/T
タイムスタンプのメッセージを有効/無効にします。
--verbose-callback script
Each render delegate can specify a Python script used for verbose feedback in the UsdRenderers.json file. This option allows you to override that script on the command line.
--verbose-callback-interval seconds
Each render delegate specifies the frequency the verbose callback Python script is invoked. This option allows you to override that interval on the command line.
Licensing ¶
以下のオプションは、新しいライセンスシステムを使用している場合にのみ利用可能です。 新しいライセンスシステムの詳細は、このページを参照してください。
--check-licenses license(s)
huskでライセンスがチェックされる時に有効にしたいライセンス。
ライセンスの内部名を使用してください。指定する各ライセンスの間には,
を挟んでください。
--skip-licenses licene(s)
huskでライセンスがチェックされる時に無効にしたいライセンス。
ライセンスの内部名を使用してください。指定する各ライセンスの間には,
を挟んでください。
--list-license-checks
huskでチェックできる利用可能なライセンス、huskでチェックされるライセンスをリストします。
--skip-license-modes mode(s)
huskでライセンスがチェックされる時にスキップしたいライセンスモード。
指定する各モードの間には,
を挟んでください。
commercial
すべてのコマーシャルライセンスのチェックをスキップします。
education
すべての教育ライセンスのチェックをスキップします。
indie
すべてのIndieライセンスのチェックをスキップします。
apprentice
すべてのApprenticeライセンスのチェックをスキップします。
--check-license-modes mode(s)
huskでライセンスがチェックされる時に含めたいライセンスモード。
指定する各モードの間には,
を挟んでください。
commercial
利用可能なすべてのコマーシャルライセンスを含めます。
education
利用可能なすべての教育ライセンスを含めます。
indie
利用可能なすべてのIndieライセンスを含めます。
apprentice
利用可能なすべてのApprenticeライセンスを含めます。
--license-release-delay
Use this option to add a delay to when hserver will release the license once the application is no longer using the license.
--license-max-seat-hold
Use this option to specify the maximum time this application should hold a license seat for. A new license seat is retrieved when the max seat hold occurs. This is a handy option when you want to ensure artists don’t use a given license for longer then they should.
--apprentice
Force an apprentice session.
--indie
Force an indie session.
--core
Force an core session.
--allow-license-retries
Allow the app to continue retrying for a license using an exponential backoff. The app will wait indefinitely for a license and therefore can significantly increase the load on the license server. Use very carefully.