Given a layered <Image> object representing an array of cubemaps, this function populates the <Int32Array> object submitted to the function with the byte coordinates of the specified cubemap face for the cubemap at the specified array index. For example, in an <Image> that represents an array of five cubemaps, this function can return the byte coordinates of the cubemap's top, bottom, left, right, front or back face for the cubemap at index 0, 1, 2, 3, or 4 in the cubemap array. Non-zero indicates success, and zero indicates failure. The most common cause of failure is providing a cubemap array count or cubemap array index that is out-of-range.
int32 GetFaceCoordinatesFromCubemapArrayImage( Image p_oImage, int32 p_nCubemapArrayLayerCount, int32 p_nCubemapArrayLayerIndex, int32 p_eCubemapFaceName, Int32Array p_aiCoordinates )
| Parameter Type | Parameter Name | Documentation |
|---|---|---|
| <Image> | p_oImage | A pointer to the <Image> object representing the array of cubemaps. |
| int32 | p_nCubemapArrayLayerCount | The total number of layers in the cubemap array. For example: pass in 4 if the <Image> object represents an array of 4 cubemaps. |
| int32 | p_nCubemapArrayLayerIndex | The index of the cubemap for which you wish to acquire the cubemap face's byte coordinates. Must be between 0 and Total Layer Count - 1. |
| int32 | p_eCubemapFaceName | An <int32> representing a value from the CubemapFaceIndices or CubemapFaceNames enumeration. Please see TYPE_SERVICE_ENUMERATION_UTIL.SSL. |
| <Int32Array> | p_aiCoordinates | The <Int32Array> to populate with cubemap face byte coordinates. |
None published. Please look for an example in the Scenome Scripting Language code base.