AddLayerToImage Data Member Function

Adds a layer to an <Image>, where a layer refers to layered texture topology and does not refer to a particular channel of the <Image>. For example, given a destination <Image> object that is 1024 pixels wide and 1024 pixels high, after adding a source <Image> layer that is also 1024 pixels wide and 1024 pixels high, the destination <Image> will be 1024 pixels wide and 2048 pixels high. All new layer <Image> objects must match the size of the initial object. Please note that the <Image> object representing the new layer is not altered by this function and no memory ownership changes occur because the underlying data is deep copied. Non-zero indicates success, zero indicates failure.

Prototype

int32 AddLayerToImage( Image p_oDestination, Image p_oNewLayer )

Parameters

Parameter Type Parameter Name Documentation
<Image>p_oDestinationA pointer to the destination <Image> object that will receive the new <Image> layer.
<Image>p_oNewLayerA pointer to the source <Image> object representing the new <Image> layer.

Examples

Copy Text To Clipboard

None published. Please look for an example in the Scenome Scripting Language code base.