AddWritableImageSource

Introduced

v5.0

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. The 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.

Scripting Syntax

oReturn = AddWritableImageSource( [FileName], [Name], [Width], [Height], [Type], [UseExisting] );

Return Value

Returns the new image source (a Source object).

Parameters

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

Default Value: User is prompted to indicate the filename and location.

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: siRenderChannelColorType

UseExisting Boolean True to use existing image files.

Default Value: False

See Also

CreateImageClip AddImageClip SIAddWritableImageSource siRenderChannelType Clip.Source