Provides script language access to C++ objects of this type.
| Class Hierarchy | Type » ImageTopologyHelper |
Function members are as follows:
| Return Type | Function Name | Documentation |
|---|---|---|
| int32 | AreImageDimensions1D | Returns true if the <Image> width and height can be used by a <Texture> that has been configured to represent a 1D sampler/image. |
| int32 | AreImageDimensions1DArray | Returns true if the <Image> width and height can be used by a <Texture> that has been configured to represent a 1D array sampler/image. |
| int32 | AreImageDimensions2D | Returns true if the <Image> width and height can be used by a <Texture> that has been configured to represent a 2D sampler/image. |
| int32 | AreImageDimensions2DArray | Returns true if the <Image> width and height can be used by a <Texture> that has been configured to represent a 2D array sampler/image. |
| int32 | AreImageDimensions3D | Returns true if the <Image> width and height can be used by a <Texture> that has been configured to represent a 3D sampler/image. |
| int32 | AreImageDimensionsCubemap | Returns true if the <Image> width and height can be used by a <Texture> that has been configured to represent a cubemap sampler/image. |
| int32 | AreImageDimensionsCubemapArray | Returns true if the <Image> width and height can be used by a <Texture> that has been configured to represent a cubemap array sampler/image. |
| int32 | AreImageDimensionsHorizontalRectangle | Returns true if and only if the <Image> is a horizontal rectangle. For example: if the <Image> object dimensions are 32x8. |
| int32 | AreImageDimensionsSquare | Returns true if and only if the <Image> is a square. For example: if the <Image> object dimensions are 32x32. |
| int32 | AreImageDimensionsVerticalRectangle | Returns true if and only if the <Image> is a vertical rectangle. For example: if the <Image> object dimensions are 8x32. |
| int32 | ComputeLayerFaceCountFromDims | Computes the layer face count from the dimensions of the <Texture>. |
| int32 | GetCompatibleImageTypes | Populates an <Int32Array> with values of compatible texture binding types. This refers to binding types for image samplers such as image2D, image3D, and imageCube, that the <Texture> object can be bound as. The values stored in the <Int32Array> refer to the TextureType enumeration. Please see APP_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. |
| int32 | GetCompatibleSamplerTypes | Populates an <Int32Array> with values of compatible texture binding types. This refers to binding types for standard samplers such as sampler2D, sampler3D, and samplerCube, that the <Texture> object can be bound as. The values stored in the <Int32Array> refer to the TextureType enumeration. Please see APP_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. |
| int32 | GetCubemapArrayBackFaceCoordinates | 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 cubemap's 'back' face for the cubemap at the specified array index. For example, in an <Image> that represents an array of five cubemaps, this function returns the byte coordinates of the cubemap '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 | GetCubemapArrayBottomFaceCoordinates | 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 cubemap's 'bottom' face for the cubemap at the specified array index. For example, in an <Image> that represents an array of five cubemaps, this function returns the byte coordinates of the cubemap 'bottom' face for the cubemap atindex 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 index that is out-of-range. |
| int32 | GetCubemapArrayFrontFaceCoordinates | 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 cubemap's 'front' face for the cubemap at the specified array index. For example, in an <Image> that represents an array of five cubemaps, this function returns the byte coordinates of the cubemap 'front' 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 | GetCubemapArrayLeftFaceCoordinates | 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 cubemap's 'left' face for the cubemap at the specified array index. For example, in an <Image> that represents an array of five cubemaps, this function returns the byte coordinates of the cubemap 'left' 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 | GetCubemapArrayRightFaceCoordinates | 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 cubemap's 'right' face for the cubemap at the specified array index. For example, in an <Image> that represents an array of five cubemaps, this function returns the byte coordinates of the cubemap 'right' 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 | GetCubemapArrayTopFaceCoordinates | 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 cubemap's 'top' face for the cubemap at the specified array index. For example, in an <Image> that represents an array of five cubemaps, this function returns the byte coordinates of the cubemap 'top' 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 | GetCubemapBackFaceCoordinates | Given a layered <Image> object representing a cubemap, this function populates the <Int32Array> object submitted to the function with the byte coordinates of the cubemap's 'back' face. Non-zero indicates success, and zero indicates failure. The most common cause of failure is submitting an image with a pixel height that is not divisible evenly by 6. |
| int32 | GetCubemapBottomFaceCoordinates | Given a layered <Image> object representing a cubemap, this function populates the <Int32Array> object submitted to the function with the byte coordinates of the cubemap's 'bottom' face. Non-zero indicates success, and zero indicates failure. The most common cause of failure is submitting an image with a pixel height that is not divisible evenly by 6. |
| int32 | GetCubemapFrontFaceCoordinates | Given a layered <Image> object representing a cubemap, this function populates the <Int32Array> object submitted to the function with the byte coordinates of the cubemap's 'face' face. Non-zero indicates success, and zero indicates failure. The most common cause of failure is submitting an image with a pixel height that is not divisible evenly by 6. |
| int32 | GetCubemapLeftFaceCoordinates | Given a layered <Image> object representing a cubemap, this function populates the <Int32Array> object submitted to the function with the byte coordinates of the cubemap's 'left' face. Non-zero indicates success, and zero indicates failure. The most common cause of failure is submitting an image with a pixel height that is not divisible evenly by 6. |
| int32 | GetCubemapRightFaceCoordinates | Given a layered <Image> object representing a cubemap, this function populates the <Int32Array> object submitted to the function with the byte coordinates of the cubemap's 'right' face. Non-zero indicates success, and zero indicates failure. The most common cause of failure is submitting an image with a pixel height that is not divisible evenly by 6. |
| int32 | GetCubemapTopFaceCoordinates | Given a layered <Image> object representing a cubemap, this function populates the <Int32Array> object submitted to the function with the byte coordinates of the cubemap's 'top' face. Non-zero indicates success, and zero indicates failure. The most common cause of failure is submitting an image with a pixel height that is not divisible evenly by 6. |
| int32 | GetFaceCoordinatesFromCubemapArrayImage | 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 | GetFaceCoordinatesFromCubemapImage | Given a layered <Image> object representing a cubemap, this function populates the <Int32Array> object submitted to the function with the byte coordinates of the cubemap's 'top', 'bottom', 'left', 'right', 'front', or 'back' face. Non-zero indicates success, and zero indicates failure. The most common cause of failure is submitting an image with a pixel height that is not divisible evenly by 6. |
| int32 | GetLayerCoordinatesFrom1DArrayImage | Given a layered <Image> object representing an array of images, this function populates the <Int32Array> object submitted to the function with the byte coordinates of the specified <Image> layer. Non-zero indicates success, and zero indicates failure. The most common cause of failure is submitting a bad layer count or bad layer index value. |
| int32 | GetLayerCoordinatesFrom2DArrayImage | Given a layered <Image> object representing an array of images, this function populates the <Int32Array> object submitted to the function with the byte coordinates of the specified <Image> layer. Non-zero indicates success, and zero indicates failure. The most common cause of failure is submitting a bad layer count or bad layer index value. |
| int32 | GetLayerCoordinatesFrom3DImage | Given a layered <Image> object representing an array of images comprising a volume, this function populates the <Int32Array> object submitted to the function with the byte coordinates of the specified <Image> layer. Non-zero indicates success, and zero indicates failure. The most common cause of failure is submitting a bad layer count or bad layer index value. |
| int32 | GetLayerCoordinatesFromCubemapArrayImage | 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 entire layer formed by all six cubemap faces. Non-zero indicates success, and zero indicates failure. The most common cause of failure is submitting a bad layer count or bad layer index value. |
| int32 | GetLayerCount | Returns the layer count for the specified <Texture>. This is the number of layers in the <Texture>, although the <Texture> itself may have a greater number of layer faces than is indicated by the layer count. |
| int32 | GetLayerFaceCount | Returns the total number of layer faces for the specified <Texture>. The total number of layer faces may be greater than the array count. For example: a cubemap array may have two cubemaps, so its layer count would be 2. However, its layer face count would be 12. |
| int32 | GetMaxLayerFaceIndex | Returns the maximum layer face index, which is the number of layer faces - 1. |
| int32 | GetMaxLayerIndex | Returns the maximum layer index, which is the number of layers - 1. |
| int32 | GetSliceHeight | Returns the height in pixels of a single slice of a layered texture. This means a single layer-face. For example: the height in pixels of a single layer-face of a 2D array texture, or the height in pixels of a single layer face of a cubemap array. In the case of a cubemap array, the layer-face refers to a single face of a single cubemap in the array. Finally, this value is always computed using the render height as the basis, and not the actual height in pixels specified by the <Texture> object's internal <Image> object. |
| int32 | GetSliceWidth | Returns the width in pixels of a single slice of a layered texture. This will be the same as the width of the <Texture> object. |
| int32 | Has1DArrayTextureDims | Returns true if the <Texture> has dimensions that are compatible with being bound as a 1D array texture. |
| int32 | Has1DTextureDims | Returns true if the <Texture> has dimensions that are compatible with being bound as a 1D texture. |
| int32 | Has2DArrayTextureDims | Returns true if the <Texture> has dimensions that are compatible with being bound as a 2D array texture. |
| int32 | Has2DTextureDims | Returns true if the <Texture> has dimensions that are compatible with being bound as a 2D texture. |
| int32 | Has3DTextureDims | Returns true if the <Texture> has dimensions that are compatible with being bound as a 3D texture. |
| int32 | HasCubemapArrayTextureDims | Returns true if the <Texture> has dimensions that are compatible with being bound as a cubemap array texture. |
| int32 | HasCubemapTextureDims | Returns true if the <Texture> has dimensions that are compatible with being bound as a cubemap texture. |
| int32 | IsImage1D | Returns true if the <Texture> object and its underlying <Image> object are correctly configured to represent a 1D image sampler such as image1D, uimage1D, or iimage1D. |
| int32 | IsImage1DArray | Returns true if the <Texture> object and its underlying <Image> object are correctly configured to represent a 1D array image sampler such as image1DArray, uimage1DArray, or iimage1DArray. |
| int32 | IsImage2D | Returns true if the <Texture> object and its underlying <Image> object are correctly configured to represent a 2D image sampler such as image2D, uimage2D, or iimage2D. |
| int32 | IsImage2DArray | Returns true if the <Texture> object and its underlying <Image> object are correctly configured to represent a 2D array image sampler such as image2DArray, uimage2DArray, or iimage2DArray. |
| int32 | IsImage3D | Returns true if the <Texture> object and its underlying <Image> object are correctly configured to represent a 3D image sampler such as image3D, uimage3D, or iimage3D. |
| int32 | IsImageCubemap | Returns true if the <Texture> object and its underlying <Image> object are correctly configured to represent a cubemap image sampler such as imageCube, uimageCube, or iimageCube. |
| int32 | IsImageCubemapArray | Returns true if the <Texture> object and its underlying <Image> object are correctly configured to represent a cubemap array image sampler such as imageCubeArray, uimageCubeArray, or iimageCubeArray. |
| int32 | IsImageHorizontalRectangle | Returns true if and only if the <Texture> object's render dimensions represent a horizontal rectangle. For example: if the <Texture> object's render dimensions are 32x8. |
| int32 | IsImageSquare | Returns true if and only if the <Texture> object's render dimensions are square. For example: if the <Texture> object render dimensions are 32x32. |
| int32 | IsImageVerticalRectangle | Returns true if and only if the <Texture> object's render dimensions represent a vertical rectangle. For example: if the <Texture> object's render dimensions are 8x32. |
| int32 | IsLayeredTexture | Returns true if the <Texture> object is a layered texture. |
| int32 | IsSampler1D | Returns true if the <Texture> object and its underlying <Image> object are correctly configured to represent a 1D sampler such as sampler1D, usampler1D, or isampler1D. |
| int32 | IsSampler1DArray | Returns true if the <Texture> object and its underlying <Image> object are correctly configured to represent a 1D array sampler such as sampler1DArray, usampler1DArray, or isampler1DArray. |
| int32 | IsSampler2D | Returns true if the <Texture> object and its underlying <Image> object are correctly configured to represent a 2D sampler such as sampler2D, usampler2D, or isampler2D. |
| int32 | IsSampler2DArray | Returns true if the <Texture> object and its underlying <Image> object are correctly configured to represent a 2D array sampler such as sampler2DArray, usampler2DArray, or isampler2DArray. |
| int32 | IsSampler3D | Returns true if the <Texture> object and its underlying <Image> object are correctly configured to represent a 3D sampler such as sampler3D, usampler3D, or isampler3D. |
| int32 | IsSamplerCubemap | Returns true if the <Texture> object and its underlying <Image> object are correctly configured to represent a cubemap sampler such as samplerCube, usamplerCube, or isamplerCube. |
| int32 | IsSamplerCubemapArray | Returns true if the <Texture> object and its underlying <Image> object are correctly configured to represent a cubemap array sampler such as samplerCubeArray, usamplereCubeArray, or isamplerCubeArray. |
| int32 | IsSamplerHorizontalRectangle | Returns true if and only if the <Texture> object's render dimensions represent a horizontal rectangle. For example: if the <Texture> object's render dimensions are 32x8. |
| int32 | IsSamplerSquare | Returns true if and only if the <Texture> object's render dimensions are square. For example: if the <Texture> object render dimensions are 32x32. |
| int32 | IsSamplerVerticalRectangle | Returns true if and only if the <Texture> object's render dimensions represent a vertical rectangle. For example: if the <Texture> object's render dimensions are 8x32. |
| int32 | IsTopology1D | Returns true if the <Texture> has any 1D texture binding. |
| int32 | IsTopology1DArray | Returns true if the <Texture> has any 1D array texture binding. |
| int32 | IsTopology2D | Returns true if the <Texture> has any 2D texture binding. |
| int32 | IsTopology2DArray | Returns true if the <Texture> has any 2D array texture binding. |
| int32 | IsTopology3D | Returns true if the <Texture> has any 3D texture binding. |
| int32 | IsTopologyCubemap | Returns true if the <Texture> has any cubemap texture binding. |
| int32 | IsTopologyCubemapArray | Returns true if the <Texture> has any cubemap array texture binding. |
| int32 | Make1D | Makes a <Texture> and underlying <Image> object that represents a 1D texture. |
| int32 | Make1DArray | Makes a <Texture> and underlying <Image> object that represents a 1D array texture. |
| int32 | Make2D | Makes a <Texture> and underlying <Image> object that represents a 2D texture. |
| int32 | Make2DArray | Makes a <Texture> and underlying <Image> object that represents a 2D array texture. |
| int32 | Make3D | Makes a <Texture> and underlying <Image> object that represents a 3D volume texture. |
| int32 | MakeCubemap | Makes a <Texture> and underlying <Image> object that represents a cubemap texture. |
| int32 | MakeCubemapArray | Makes a <Texture> and underlying <Image> object that represents a cubemap array texture. |