<ImageTopologyHelper> Data Interface

Provides script language access to C++ objects of this type.

Class HierarchyType » ImageTopologyHelper

Function Members

Function members are as follows:

Return Type Function Name Documentation
int32AreImageDimensions1DReturns true if the <Image> width and height can be used by a <Texture> that has been configured to represent a 1D sampler/image.
int32AreImageDimensions1DArrayReturns true if the <Image> width and height can be used by a <Texture> that has been configured to represent a 1D array sampler/image.
int32AreImageDimensions2DReturns true if the <Image> width and height can be used by a <Texture> that has been configured to represent a 2D sampler/image.
int32AreImageDimensions2DArrayReturns true if the <Image> width and height can be used by a <Texture> that has been configured to represent a 2D array sampler/image.
int32AreImageDimensions3DReturns true if the <Image> width and height can be used by a <Texture> that has been configured to represent a 3D sampler/image.
int32AreImageDimensionsCubemapReturns true if the <Image> width and height can be used by a <Texture> that has been configured to represent a cubemap sampler/image.
int32AreImageDimensionsCubemapArrayReturns true if the <Image> width and height can be used by a <Texture> that has been configured to represent a cubemap array sampler/image.
int32AreImageDimensionsHorizontalRectangleReturns true if and only if the <Image> is a horizontal rectangle. For example: if the <Image> object dimensions are 32x8.
int32AreImageDimensionsSquareReturns true if and only if the <Image> is a square. For example: if the <Image> object dimensions are 32x32.
int32AreImageDimensionsVerticalRectangleReturns true if and only if the <Image> is a vertical rectangle. For example: if the <Image> object dimensions are 8x32.
int32GetCubemapArrayBackFaceCoordinatesGiven 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.
int32GetCubemapArrayBottomFaceCoordinatesGiven 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.
int32GetCubemapArrayFrontFaceCoordinatesGiven 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.
int32GetCubemapArrayLeftFaceCoordinatesGiven 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.
int32GetCubemapArrayRightFaceCoordinatesGiven 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.
int32GetCubemapArrayTopFaceCoordinatesGiven 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.
int32GetCubemapBackFaceCoordinatesGiven 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.
int32GetCubemapBottomFaceCoordinatesGiven 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.
int32GetCubemapFrontFaceCoordinatesGiven 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.
int32GetCubemapLeftFaceCoordinatesGiven 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.
int32GetCubemapRightFaceCoordinatesGiven 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.
int32GetCubemapTopFaceCoordinatesGiven 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.
int32GetFaceCoordinatesFromCubemapArrayImageGiven 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.
int32GetFaceCoordinatesFromCubemapImageGiven 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.
int32GetLayerCoordinatesFrom1DArrayImageGiven 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.
int32GetLayerCoordinatesFrom2DArrayImageGiven 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.
int32GetLayerCoordinatesFrom3DImageGiven 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.
int32GetLayerCoordinatesFromCubemapArrayImageGiven 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.
int32GetSliceHeightReturns 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.
int32GetSliceWidthReturns the width in pixels of a single slice of a layered texture. This will be the same as the width of the <Texture> object.
int32IsImage1DReturns 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.
int32IsImage1DArrayReturns 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.
int32IsImage2DReturns 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.
int32IsImage2DArrayReturns 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.
int32IsImage3DReturns 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.
int32IsImageCubemapReturns 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.
int32IsImageCubemapArrayReturns 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.
int32IsImageHorizontalRectangleReturns 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.
int32IsImageSquareReturns true if and only if the <Texture> object's render dimensions are square. For example: if the <Texture> object render dimensions are 32x32.
int32IsImageVerticalRectangleReturns 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.
int32IsSampler1DReturns true if the <Texture> object and its underlying <Image> object are correctly configured to represent a 1D sampler such as sampler1D, usampler1D, or isampler1D.
int32IsSampler1DArrayReturns 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.
int32IsSampler2DReturns true if the <Texture> object and its underlying <Image> object are correctly configured to represent a 2D sampler such as sampler2D, usampler2D, or isampler2D.
int32IsSampler2DArrayReturns 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.
int32IsSampler3DReturns true if the <Texture> object and its underlying <Image> object are correctly configured to represent a 3D sampler such as sampler3D, usampler3D, or isampler3D.
int32IsSamplerCubemapReturns true if the <Texture> object and its underlying <Image> object are correctly configured to represent a cubemap sampler such as samplerCube, usamplerCube, or isamplerCube.
int32IsSamplerCubemapArrayReturns 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.
int32IsSamplerHorizontalRectangleReturns 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.
int32IsSamplerSquareReturns true if and only if the <Texture> object's render dimensions are square. For example: if the <Texture> object render dimensions are 32x32.
int32IsSamplerVerticalRectangleReturns 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.
int32Make1DMakes a <Texture> and underlying <Image> object that represents a 1D texture.
int32Make1DArrayMakes a <Texture> and underlying <Image> object that represents a 1D array texture.
int32Make2DMakes a <Texture> and underlying <Image> object that represents a 2D texture.
int32Make2DArrayMakes a <Texture> and underlying <Image> object that represents a 2D array texture.
int32Make3DMakes a <Texture> and underlying <Image> object that represents a 3D volume texture.
int32MakeCubemapMakes a <Texture> and underlying <Image> object that represents a cubemap texture.
int32MakeCubemapArrayMakes a <Texture> and underlying <Image> object that represents a cubemap array texture.