SIAddWritableImageSource

Introduced

v5.0

Categories

file texture

Description

Creates and adds a new writable image Source in the Sources container. The source will create images using the image path given. The files do not have to exist.

Writable image sources are used by lightmaps for example to create an image to receive the lightmap data. Image sources are used by ImageClip objects in order to perform image compositing effects, such as texturing.

Note: This command uses output arguments. C# and some scripting languages (such as JScript, PerlScript and Python) don't support arguments passed by reference so you need to use the best workaround for your situation:

For scripting languages this command returns an ISIVTCollection which you can use to get the output arguments.

For C# you can use the XSIApplication.ExecuteCommand method to call this command. ExecuteCommand packs the output arguments into a C# System.Object containing an Array of the output arguments (see Calling Commands from C#).

Scripting Syntax

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

Parameters

Parameter Type Description
FileName String Full path of the new image source.

Default Value: User is prompted to select a file.

Name String The name to use for the new source.
Width Number The width, in pixels, of the new images.

Default Value: 256

Height Number The height, in pixels, of the new images.

Default Value: 256

Type siRenderChannelType The channel types to restrict this image type to.

Default Value: siRenderChannelType

UseExisting Boolean If a writable image source already exists with the same filename, use that instead.

Default Value: False

Source Source Returns the source

See Also

AddWritableImageSource AddImageClip CreateImageClip siRenderChannelType