| 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に関する情報をプリントします。
-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
すべてのライティングを無効にします。
--ao-samples samples
アンビエントオクルージョンのサンプル数(ヘッドライトシェーディング)。
デフォルトは0です。
--ao-distance n
アンビエントオクルージョンのカットオフ距離。デフォルトは1です。
--lock-random seed
乱数シードとしてフレーム番号の代わりにseedを使用します。
--dicingcamera prim_path
指定したPrimパスのカメラを使ってDicing(賽の目化)します。これを指定しなかった場合、Karmaはレンダーカメラを使ってDicing(賽の目化)します。
--optimize-offline level
現在のところ、このオプションは無効で何の効果もありません。
USD
--usd-input filepath
レンダリングするUSDシーンファイル。
--list-settings
シーン内のRender Settings Primに関する情報をプリントします。
--list-cameras
シーン内のカメラに関する情報をプリントします。
--list-renderers
利用可能なすべてのHydraレンダーデリゲートのリストをプリントします。
--purpose tokens
レンダリングするPurpose(s)。
ここには、Purposeをカンマで区切ったリストを指定します。デフォルトはgeometry,renderです。
--complexity token
レンダリングするジオメトリの複雑さ。選択肢はlow、medium、high、veryhighです。
--disable-motionblur
instantaneousShutterレンダー設定を上書きして、強制的にシャッターの閉時間をシャッターの開時間と同じにします。
これによって、実質的にモーションブラーが無効になります。
--disable-delegate-products
ほとんどのレンダープロダクトには出力としてラスターファイルがあります。 デリゲートレンダープロダクトは、非ラスタープロダクト(Deep画像、チェックポイントファイル、フォトンマップなど)を表現する際に使用します。 このオプションは、デリゲートレンダープロダクトを無効にし、ラスター出力のみを生成します。
-s/--settings prim_path
指定したPrimパスのRenderSettingsを使ってレンダリングします。
--prerender-script python_file
レンダリングする前に、指定したPythonスクリプトを実行します。
このスクリプト内でstage変数を使用することで、レンダリングされるUSDステージを参照することができます。
このスクリプトは、USDファイルが読み込まれた後からSettings Primを読み込む前/レンダリング前の間で実行されます。
python_file引数は複数の引数に解析されます。
スペースを含んだ引数を適切に引用符で閉じるように注意してください。
hou.frame()関数はレンダリングされる最初のフレーム小数点を返します。
--preframe-script python_file
各フレームがレンダリングされる前に、指定したPythonスクリプトを実行します。
このスクリプト内でstage変数を使用することで、レンダリングされるUSDステージを参照することができます。
settings変数には、レンダー設定の辞書が格納されます。
このスクリプトは、USDファイルが読み込まれた後からSettings Primを読み込む前/レンダリング前の間で実行されます。
python_file引数は複数の引数に解析されます。
スペースを含んだ引数を適切に引用符で閉じるように注意してください。
hou.frame()関数はレンダリングされる最初のフレーム小数点を返します。
--postframe-script python_file
各フレームがレンダリングされた後に、指定したPythonスクリプトを実行します。
stage変数とsettings変数が利用可能であり、hou.frame()はレンダリングされたフレーム小数点を返します。
--postrender-script python_file
すべてのフレームがレンダリングされた後に、指定したPythonスクリプトを実行します。
stage変数が利用可能であり、hou.frame()は最後にレンダリングされたフレーム小数点を返します。
--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と同じです。
-r/--res width height
レンダリング画像の幅と高さ(単位はピクセル。例えば、--res 1280 720)。
--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は最終出力画像名をスナップショット画像名として使用するようになります。
--exrmode mode
-1
HOUDINI_OIIO_EXR変数を使用します。
0
クラシックドライバを使用します。
1
改良されたドライバを使用します。
--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
モニターを閉じるとレンダリングが終了します。
--no-mplay
MPlayへのレンダリングを無効にします。 このオプションは、ディスプレイが付いていないマシン上(ファーム上)でレンダリングする時に役立ちます。
--mplay-scale scale
MPlayでのレンダリングのスケールを指定します。 これは、モニターもMPlayレンダープロダクトも含みます。 現在のところ、scale引数の値はディスクにレンダリングされる画像の10から100パーセントに制限されています。 MPlay画像はポイントフィルターがかかります。 つまり、ソースピクセルのブラーがなくなります。
--mplay-update seconds
MPlay画像を更新する秒数。
--mplay-session label
labelで指定されたセッションにMPlayレンダリングを送信します。
--mplay-bgimage image
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
タイムスタンプのメッセージを有効/無効にします。
Licensing
以下のオプションは、新しいライセンスシステムを使用している場合にのみ利用可能です。 新しいライセンスシステムの詳細は、このページを参照してください。
--list-license-checks
huskでチェックできる利用可能なライセンス、huskでチェックされるライセンスをリストします。
--check-licenses license(s)
huskでライセンスがチェックされる時に有効にしたいライセンス。
ライセンスの内部名を使用してください。指定する各ライセンスの間には,を挟んでください。
--skip-licenses licene(s)
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ライセンスを含めます。