SIAddWritableImageSource

SIAddWritableImageSource

導入

v5.0

詳細

ソース コンテナに新しい書き込み可能なイメージ ソースを作成および追加します。 ソースは、指定のイメージ パスを使用してイメージを作成します。このファイルが存在している必要はありません。

書き込み可能なイメージ ソースは、たとえばライトマップ データを受け取るイメージを作成するために、ライトマップが使用します。 イメージ ソースは、テクスチャなどのイメージ合成エフェクトを実行するために、ImageClip オブジェクトによって使用されます。

注: このコマンドは、出力引数を使用します。C# および一部のスクリプト言語(JScript、PerlScript、Python など)は、リファレンスによって渡される引数をサポートしていません。このため、状況に応じた適切な回避策を実行する必要があります。

スクリプト言語の場合、このコマンドは出力引数を取得するために使用できる ISIVTCollection を戻します。

C# の場合は、XSIApplication.ExecuteCommand メソッドを使用してこのコマンドを呼び出すことができます。ExecuteCommand は、出力引数を C# の System.Object (出力引数の Array を含む)にパック化します(詳細については、「C# からのコマンドの呼び出し」を参照)。

スクリプト構文

SIAddWritableImageSource( [FileName], [Name], [Width], [Height], [Type], [UseExisting], [Source] );

パラメータ

パラメータ タイプ 説明
FileName 文字列 新しいイメージ ソースの完全パス

デフォルト値:ユーザがファイルを指定します。

Name 文字列 新しいソースに使用する名前
Width Number 新しいイメージのピクセルの幅。

デフォルト値: 256

Height Number 新しいイメージのピクセルの高さ。

デフォルト値: 256

Type siRenderChannelType イメージ タイプを制御するチャンネル タイプです。

デフォルト値: siRenderChannelType

UseExisting Boolean 書き込み可能なイメージ ソースが同じファイル名ですでに存在する場合は、代わりにそのファイルを使用します。

デフォルト値: False

Source Source ソースを戻します。

関連項目

AddWritableImageSource AddImageClip CreateImageClip siRenderChannelType