Provides script language access to C++ objects of this type. This data interface is provided for compatibility purposes only, and should not be used in new code. Please see the <ArrayViewT> data interfaces such as <Float32ArrayView>, the <Image> object data interfaces such as as Image::GetFloat32View, and array algorithms data interfaces such as Float32ArrayAlgorithms::Copy for equivalent functionality.
| Class Hierarchy | Type » ImageDataTransfer |
Function members are as follows:
| Return Type | Function Name | Documentation |
|---|---|---|
| int32 | AddLayerToImage | 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. |
| int32 | CloneImage | Clones the source <Image> into the destination <Image>. |
| int32 | CopyImage | Copies bytes from a source <Image> object to a destination <Image> object. This is a 'safe' wrapper around memcpy(). Non-zero indicates success, zero indicates failure. The most common cause of failure is providing byte coordinates that go out of range for either the source <Image> object or destination <Image> object. For example, given a destination <Image> object that is 32 pixels high by 32 pixels wide with 4 bytes per pixel, we have a total by count of 4096 bytes. We can only write from byte 0 to byte 4095, but if we set the start byte to 4000 and try to write 1025 bytes into the destination <Image> object, the internal call to memcpy() would result in a crash. In this case, the function will fail after performing bounds-checking on the input values and memcpy() will never be called. |
| int32 | ExtractColor1555Array | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractColor1555ArrayFromRegion | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractColor4444Array | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractColor4444ArrayFromRegion | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractColor565Array | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractColor565ArrayFromRegion | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractColor888Array | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractColor888ArrayFromRegion | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractColorArray | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractColorArrayFromRegion | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractFloat16Array | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractFloat16ArrayFromRegion | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractFloat16VectorArray | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractFloat32Array | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractFloat32ArrayFromRegion | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractFloat32MatrixArray | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractFloat32MatrixArrayFromRegion | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractFloat32VectorArray | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractFloat64Array | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractFloat64ArrayFromRegion | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractFloat64VectorArray | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractFloat64VectorArrayFromRegion | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractInt16Array | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractInt16ArrayFromRegion | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractInt16VectorArray | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractInt32Array | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractInt32ArrayFromRegion | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractInt32VectorArray | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractInt32VectorArrayFromRegion | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractInt8Array | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractInt8ArrayFromRegion | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractInt8VectorArray | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractUint16Array | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractUint16ArrayFromRegion | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractUint16VectorArray | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractUint32Array | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractUint32ArrayFromRegion | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractUint32VectorArray | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractUint32VectorArrayFromRegion | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractUint8Array | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractUint8ArrayFromRegion | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | ExtractUint8VectorArray | Populates the destination array with the data in the source <Image> object. If the destination array does not have sufficient memory, an allocation will occur. This can be thought of as 'packing' the destination array object with the contents of the source <Image> object. If the source <Image> object has more bytes than the destination array object, then the destination array object may contain truncated values depending on how the size of the destination array object aligns with the size of the source <Image> object. If the source <Image> object has fewer bytes than the destination array object, any remaining elements in the array object will retain their original values. Finally, data is deep copied, which means the memory in the source <Image> object remains unchanged and there is no memory ownership transfer or change. Non-zero indicates success, zero indicates failure. |
| int32 | InterleaveChannels | Obsolete. Prefer <ImageFormatConverter> data interfaces such as ImageFormatConverter::InterleaveBytes, ImageFormatConverter::InterleaveHalfs, or ImageFormatConverter::InterleaveFloats. |
| int32 | PackColor1555Array | Deep copies the data from a source array object to a destination <Image> object. The source array remains unchanged and the <Image> object and array objects retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). Non-zero indicates success, zero indicates failure. |
| int32 | PackColor4444Array | Deep copies the data from a source array object to a destination <Image> object. The source array remains unchanged and the <Image> object and array objects retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). Non-zero indicates success, zero indicates failure. |
| int32 | PackColor565Array | Deep copies the data from a source array object to a destination <Image> object. The source array remains unchanged and the <Image> object and array objects retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). Non-zero indicates success, zero indicates failure. |
| int32 | PackColor888Array | Deep copies the data from a source array object to a destination <Image> object. The source array remains unchanged and the <Image> object and array objects retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). Non-zero indicates success, zero indicates failure. |
| int32 | PackColorArray | Deep copies the data from a source array object to a destination <Image> object. The source array remains unchanged and the <Image> object and array objects retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). Non-zero indicates success, zero indicates failure. |
| int32 | PackFloat16Array | Deep copies the data from the source array object to a destination <Image> object. The source array remains unchanged and the <Image> object and array objects retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). Non-zero indicates success, zero indicates failure. |
| int32 | PackFloat16VectorArray | Deep copies the data from the source array object to a destination <Image> object. The source array remains unchanged and the <Image> object and array objects retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). Non-zero indicates success, zero indicates failure. |
| int32 | PackFloat32Array | Deep copies the data from the source array object to a destination <Image> object. The source array remains unchanged and the <Image> object and array objects retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). Non-zero indicates success, zero indicates failure. |
| int32 | PackFloat32MatrixArray | Deep copies the data from a source array object to a destination <Image> object. The source array remains unchanged and the <Image> object and array objects retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). Non-zero indicates success, zero indicates failure. |
| int32 | PackFloat32VectorArray | Deep copies the data from a source object to a destination <Image> object. The source array remains unchanged and the <Image> object and array objects retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). Non-zero indicates success, zero indicates failure. |
| int32 | PackFloat64Array | Deep copies the data from the source array object to a destination <Image> object. The source array remains unchanged and the <Image> object and array objects retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). Non-zero indicates success, zero indicates failure. |
| int32 | PackFloat64VectorArray | Deep copies the data from a source object to a destination <Image> object. The source array remains unchanged and the <Image> object and array objects retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). Non-zero indicates success, zero indicates failure. |
| int32 | PackInt16Array | Deep copies the data from the source array object to a destination <Image> object. The source array remains unchanged and the <Image> object and array objects retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). Non-zero indicates success, zero indicates failure. |
| int32 | PackInt16VectorArray | Deep copies the data from the source array object to a destination <Image> object. The source array remains unchanged and the <Image> object and array objects retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). Non-zero indicates success, zero indicates failure. |
| int32 | PackInt32Array | Deep copies the data from the source array object to a destination <Image> object. The source array remains unchanged and the <Image> object and array objects retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). Non-zero indicates success, zero indicates failure. |
| int32 | PackInt32VectorArray | Deep copies the data from a source object to a destination <Image> object. The source array remains unchanged and the <Image> object and array objects retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). Non-zero indicates success, zero indicates failure. |
| int32 | PackInt8Array | Deep copies the data from the source array object to a destination <Image> object. The source array remains unchanged and the <Image> object and array objects retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). Non-zero indicates success, zero indicates failure. |
| int32 | PackInt8VectorArray | Deep copies the data from the source array object to a destination <Image> object. The source array remains unchanged and the <Image> object and array objects retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). Non-zero indicates success, zero indicates failure. |
| int32 | PackRegionWithColor1555Array | Deep copies the data from the source array object to a region of the destination <Image> object. The source array remains unchanged and the <Image> object and array object retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). This class is often used in concert with ImageTopologyHelper, which has numerous high-level functions for creating coordinate ranges that can be submitted to this function. For example: ImageTopologyHelper.GetCubemapBackFaceCoordinates() returns the byte coordinates of the 'back' face of a cubemap. Non-zero indicates success, zero indicates failure. |
| int32 | PackRegionWithColor4444Array | Deep copies the data from the source array object to a region of the destination <Image> object. The source array remains unchanged and the <Image> object and array object retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). This class is often used in concert with ImageTopologyHelper, which has numerous high-level functions for creating coordinate ranges that can be submitted to this function. For example: ImageTopologyHelper.GetCubemapBackFaceCoordinates() returns the byte coordinates of the 'back' face of a cubemap. Non-zero indicates success, zero indicates failure. |
| int32 | PackRegionWithColor565Array | Deep copies the data from the source array object to a region of the destination <Image> object. The source array remains unchanged and the <Image> object and array object retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). This class is often used in concert with ImageTopologyHelper, which has numerous high-level functions for creating coordinate ranges that can be submitted to this function. For example: ImageTopologyHelper.GetCubemapBackFaceCoordinates() returns the byte coordinates of the 'back' face of a cubemap. Non-zero indicates success, zero indicates failure. |
| int32 | PackRegionWithColor888Array | Deep copies the data from the source array object to a region of the destination <Image> object. The source array remains unchanged and the <Image> object and array object retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). This class is often used in concert with ImageTopologyHelper, which has numerous high-level functions for creating coordinate ranges that can be submitted to this function. For example: ImageTopologyHelper.GetCubemapBackFaceCoordinates() returns the byte coordinates of the 'back' face of a cubemap. Non-zero indicates success, zero indicates failure. |
| int32 | PackRegionWithColorArray | Deep copies the data from the source array object to a region of the destination <Image> object. The source array remains unchanged and the <Image> object and array object retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). This class is often used in concert with ImageTopologyHelper, which has numerous high-level functions for creating coordinate ranges that can be submitted to this function. For example: ImageTopologyHelper.GetCubemapBackFaceCoordinates() returns the byte coordinates of the 'back' face of a cubemap. Non-zero indicates success, zero indicates failure. |
| int32 | PackRegionWithFloat16Array | Deep copies the data from the source array object to a region of the destination <Image> object. The source array remains unchanged and the <Image> object and array object retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). This class is often used in concert with ImageTopologyHelper, which has numerous high-level functions for creating coordinate ranges that can be submitted to this function. For example: ImageTopologyHelper.GetCubemapBackFaceCoordinates() returns the byte coordinates of the 'back' face of a cubemap. Non-zero indicates success, zero indicates failure. |
| int32 | PackRegionWithFloat32Array | Deep copies the data from the source array object to a region of the destination <Image> object. The source array remains unchanged and the <Image> object and array object retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). This class is often used in concert with ImageTopologyHelper, which has numerous high-level functions for creating coordinate ranges that can be submitted to this function. For example: ImageTopologyHelper.GetCubemapBackFaceCoordinates() returns the byte coordinates of the 'back' face of a cubemap. Non-zero indicates success, zero indicates failure. |
| int32 | PackRegionWithFloat32MatrixArray | Deep copies the data from the source array object to a region of the destination <Image> object. The source array remains unchanged and the <Image> object and array object retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). This class is often used in concert with ImageTopologyHelper, which has numerous high-level functions for creating coordinate ranges that can be submitted to this function. For example: ImageTopologyHelper.GetCubemapBackFaceCoordinates() returns the byte coordinates of the 'back' face of a cubemap. Non-zero indicates success, zero indicates failure. |
| int32 | PackRegionWithFloat64Array | Deep copies the data from the source array object to a region of the destination <Image> object. The source array remains unchanged and the <Image> object and array object retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). This class is often used in concert with ImageTopologyHelper, which has numerous high-level functions for creating coordinate ranges that can be submitted to this function. For example: ImageTopologyHelper.GetCubemapBackFaceCoordinates() returns the byte coordinates of the 'back' face of a cubemap. Non-zero indicates success, zero indicates failure. |
| int32 | PackRegionWithFloat64VectorArray | Deep copies the data from the source array object to a region of the destination <Image> object. The source array remains unchanged and the <Image> object and array object retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). This class is often used in concert with ImageTopologyHelper, which has numerous high-level functions for creating coordinate ranges that can be submitted to this function. For example: ImageTopologyHelper.GetCubemapBackFaceCoordinates() returns the byte coordinates of the 'back' face of a cubemap. Non-zero indicates success, zero indicates failure. |
| int32 | PackRegionWithInt16Array | Deep copies the data from the source array object to a region of the destination <Image> object. The source array remains unchanged and the <Image> object and array object retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). This class is often used in concert with ImageTopologyHelper, which has numerous high-level functions for creating coordinate ranges that can be submitted to this function. For example: ImageTopologyHelper.GetCubemapBackFaceCoordinates() returns the byte coordinates of the 'back' face of a cubemap. Non-zero indicates success, zero indicates failure. |
| int32 | PackRegionWithInt32Array | Deep copies the data from the source array object to a region of the destination <Image> object. The source array remains unchanged and the <Image> object and array object retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). This class is often used in concert with ImageTopologyHelper, which has numerous high-level functions for creating coordinate ranges that can be submitted to this function. For example: ImageTopologyHelper.GetCubemapBackFaceCoordinates() returns the byte coordinates of the 'back' face of a cubemap. Non-zero indicates success, zero indicates failure. |
| int32 | PackRegionWithInt32VectorArray | Deep copies the data from the source array object to a region of the destination <Image> object. The source array remains unchanged and the <Image> object and array object retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). This class is often used in concert with ImageTopologyHelper, which has numerous high-level functions for creating coordinate ranges that can be submitted to this function. For example: ImageTopologyHelper.GetCubemapBackFaceCoordinates() returns the byte coordinates of the 'back' face of a cubemap. Non-zero indicates success, zero indicates failure. |
| int32 | PackRegionWithInt8Array | Deep copies the data from the source array object to a region of the destination <Image> object. The source array remains unchanged and the <Image> object and array object retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). This class is often used in concert with ImageTopologyHelper, which has numerous high-level functions for creating coordinate ranges that can be submitted to this function. For example: ImageTopologyHelper.GetCubemapBackFaceCoordinates() returns the byte coordinates of the 'back' face of a cubemap. Non-zero indicates success, zero indicates failure. |
| int32 | PackRegionWithUint16Array | Deep copies the data from the source array object to a region of the destination <Image> object. The source array remains unchanged and the <Image> object and array object retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). This class is often used in concert with ImageTopologyHelper, which has numerous high-level functions for creating coordinate ranges that can be submitted to this function. For example: ImageTopologyHelper.GetCubemapBackFaceCoordinates() returns the byte coordinates of the 'back' face of a cubemap. Non-zero indicates success, zero indicates failure. |
| int32 | PackRegionWithUint32Array | Deep copies the data from the source array object to a region of the destination <Image> object. The source array remains unchanged and the <Image> object and array object retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). This class is often used in concert with ImageTopologyHelper, which has numerous high-level functions for creating coordinate ranges that can be submitted to this function. For example: ImageTopologyHelper.GetCubemapBackFaceCoordinates() returns the byte coordinates of the 'back' face of a cubemap. Non-zero indicates success, zero indicates failure. |
| int32 | PackRegionWithUint32VectorArray | Deep copies the data from the source array object to a region of the destination <Image> object. The source array remains unchanged and the <Image> object and array object retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). This class is often used in concert with ImageTopologyHelper, which has numerous high-level functions for creating coordinate ranges that can be submitted to this function. For example: ImageTopologyHelper.GetCubemapBackFaceCoordinates() returns the byte coordinates of the 'back' face of a cubemap. Non-zero indicates success, zero indicates failure. |
| int32 | PackRegionWithUint8Array | Deep copies the data from the source array object to a region of the destination <Image> object. The source array remains unchanged and the <Image> object and array object retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). This class is often used in concert with ImageTopologyHelper, which has numerous high-level functions for creating coordinate ranges that can be submitted to this function. For example: ImageTopologyHelper.GetCubemapBackFaceCoordinates() returns the byte coordinates of the 'back' face of a cubemap. Non-zero indicates success, zero indicates failure. |
| int32 | PackUint16Array | Deep copies the data from a source object to a destination <Image> object. The source array remains unchanged and the <Image> object and array objects retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). Non-zero indicates success, zero indicates failure. |
| int32 | PackUint16VectorArray | Deep copies the data from the source array object to a destination <Image> object. The source array remains unchanged and the <Image> object and array objects retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). Non-zero indicates success, zero indicates failure. |
| int32 | PackUint32Array | Deep copies the data from the source array object to a destination <Image> object. The source array remains unchanged and the <Image> object and array objects retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). Non-zero indicates success, zero indicates failure. |
| int32 | PackUint32VectorArray | Deep copies the data from a source object to a destination <Image> object. The source array remains unchanged and the <Image> object and array objects retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). Non-zero indicates success, zero indicates failure. |
| int32 | PackUint8Array | Deep copies the data from the source array object to a destination <Image> object. The source array remains unchanged and the <Image> object and array objects retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). Non-zero indicates success, zero indicates failure. |
| int32 | PackUint8VectorArray | Deep copies the data from the source array object to a destination <Image> object. The source array remains unchanged and the <Image> object and array objects retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). Non-zero indicates success, zero indicates failure. |