Provides script language access to C++ objects of this type.
| Class Hierarchy | Type » ImageFormatQuery |
Function members are as follows:
| Return Type | Function Name | Documentation |
|---|---|---|
| int32 | CanBindFormat | Populates an <Int32Array> with Image_Pixel_Format enumeration values that the specified sampler type can bind. |
| int32 | GetBaseFormat | Returns the base, single-channel format for the queried format. For example, returns IPF_FP32 if you query IPF_FP32x2, IPF_FP32x3, or IPF_FP32x4. |
| int32 | GetBindableAs | Populates an <Int32Array> with enumeration values that refer to sampler types that an <Image> is bindable as. |
| int32 | GetBitsFromFormat | Returns the Image_Bits_Per_Format enumeration that defines the number of bits per pixel ( ex: 8, 16, 32, 64 ) for a particular image format. This refers to the Image_Bits_Per_Format enumeration. Please see APP_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. IBPF_None is the first constant in the enumeration. |
| int32 | GetBitsPerFormat | Returns the Image_Bits_Per_Format enumeration that defines the number of bits per pixel for a particular image format. This refers to the Image_Bits_Per_Format enumeration. Please see APP_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. IBPF_None is the first constant in the enumeration. |
| int32 | GetBytesFromFormat | Returns the Image_Bytes_Per_Format enumeration that defines the number of bytes per pixel ( ex: 1, 2, 4, 8 ) for a particular image format. This refers to the Image_Bytes_Per_Format enumeration. Please see APP_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. IBYF_None is the first constant in the enumeration. |
| int32 | GetBytesPerChannel | Returns the Image_Bytes_Per_Channel enumeration that defines the number of bytes per channel ( ex: 1, 2, 4 ) for a particular image format. This refers to the Image_Bytes_Per_Channel enumeration. Please see APP_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. IBPC_None is the first constant in the enumeration. |
| int32 | GetBytesPerFormat | Returns the Image_Bytes_Per_Format enumeration that defines the number of bytes per pixel ( ex: 1, 2, 4, 8 ) for a particular image format. This refers to the Image_Bytes_Per_Format enumeration. Please see APP_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. IBYF_None is the first constant in the enumeration. |
| int32 | GetCpuDataTypeIndex | Returns a numeric index for an OpenGL constant. For example: the symbol value of GL_UNSIGNED_BYTE is 0x1401. If the value 0x1401 is submitted to this function, the value 0 is returned. The 0 value corresponds to an index in the CpuDataType enumeration. Please see APP_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. Note that this function is used to map OpenGL constant values to property items, and is not part of the graphics API interfaces. |
| int32 | GetCpuMemoryLayoutIndex | Returns a numeric index for an OpenGL constant. For example: the symbol value of GL_RED is 0x1903. If the value 0x1903 is submitted to this function, the value 0 is returned. The 0 value corresponds to an index in the CpuMemoryLayout enumeration. Please see APP_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. Note that this function is used to map OpenGL constant values to property items, and is not part of the graphics API interfaces. |
| int32 | GetFloat16Format | Returns the 16-bit floating point format for the number of channels. For example, if you submit a query value of 2, this function returns IPF_FP16x2. |
| int32 | GetFloat32Format | Returns the 32-bit floating point format for the number of channels. For example, if you submit a query value of 2, this function returns IPF_FP16x2. |
| string | GetFormatFamily | Returns a string containing the format family such as "FP16" or "FP32" or "8888_ARGB". |
| int32 | GetFormatFromQualifier | Returns the Image_Pixel_Format value associated with a particular GLSL format layout qualifier such as rg8 or rgba8i. For example, the declarations layout( rg8 ) or layout( rgba8i ) can only bind specific pixel formats. Returns the appropriate format. |
| float64 | GetFormatMax | Returns the common and useful default maximum value for the specified image pixel format. |
| float64 | GetFormatMin | Returns the common and useful default minimum value for the specified image pixel format. |
| int32 | GetGlColorFormat | Return the OpenGL® color format associated with the Simdify API pixel format. |
| int32 | GetGlComponents | Return the OpenGL® color component associated with the Simdify API pixel format. |
| int32 | GetGlImageFormat | Return the OpenGL® image format associated with the Simdify API pixel format. |
| int32 | GetGlPixelFormat | Return the OpenGL® pixel format associated with the Simdify API pixel format. |
| int32 | GetGpuMemoryLayoutIndex | Returns a numeric index for an OpenGL constant. For example: the symbol value of GL_R8 is 0x8229. If the value 0x8229 is submitted to this function, the value 0 is returned. The 0 value corresponds to an index in the GpuMemoryLayout enumeration. Please see APP_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. Note that this function is used to map OpenGL constant values to property items, and is not part of the graphics API interfaces. |
| float64 | GetImageFormatMax | Returns the common and useful default maximum value for the specified image pixel format. |
| float64 | GetImageFormatMin | Returns the common and useful default minimum value for the specified image pixel format. |
| int32 | GetImageSamplerType | Returns an image sampler type such as image2D for the specified Image_Pixel_Format and ImageTopology. Please see APP_SERVICE_ENUMERATION_UTIL.SSL. |
| int32 | GetImageSamplerTypes | Populates an <Int32Array> with enumerated constants for all image sampler types ( such as image2D or imageCube ) that can bind the format. Please see SamplerTypeNone() in APP_SERVICE_ENUMERATION_UTIL.SSL for more information. |
| int32 | GetLinearFormat | Returns true if the pixel format is linear. |
| int32 | GetPixelFormatForGlInternalFormat | Returns a Simdify pixel format such as IPF_FP32x4 that is compatible with an OpenGL internal format such as GL_R8. This value refers to the GLInternalFormat enumeration. Please see APP_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. Note that this function is used to map OpenGL constant values to property items, and is not part of the graphics API interfaces. |
| int32 | GetQualifierFromFormat | Returns a value from the GLSL_ImageQualifier enumeration that reflects the format layout qualifier for the specified Image_Pixel_Format constant. |
| string | GetSamplerDeclaration | Returns a sampler declaration that matches the query parameters. |
| int32 | GetSamplerDeclarationComponents | Populates a <StrList> with a sampler declaration that matches the query parameters. Each component of the declaration is stored in a separate <Str> object in the <StrList>. |
| int32 | GetScalarsFromFormat | Returns the Image_Scalars_Per_Format enumeration that defines the number of scalar primitives per pixel ( ex: 1, 2, 3, 4 ) for a particular image format. This refers to the Image_Scalars_Per_Format enumeration. Please see APP_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. ISPF_None is the first constant in the enumeration. |
| int32 | GetScalarsPerFormat | Returns the Image_Scalars_Per_Format enumeration that defines the number of scalar primitives per pixel ( ex: 1, 2, 3, 4 ) for a particular image format. This refers to the Image_Scalars_Per_Format enumeration. Please see APP_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. ISPF_None is the first constant in the enumeration. |
| int32 | GetStandardSamplerType | Returns a standard sampler type such as sampler2D for the specified Image_Pixel_Format and ImageTopology. Please see APP_SERVICE_ENUMERATION_UTIL.SSL. |
| int32 | GetStandardSamplerTypes | Populates an <Int32Array> with enumerated constants for all standard sampler types ( such as sampler2D or samplerCube ) that can bind the format. Please see SamplerTypeNone() in APP_SERVICE_ENUMERATION_UTIL.SSL for more information. |
| int32 | IsAny16BitIntegralFormat | Returns true if the specified format is any 16-bit signed/unsigned integral format. |
| int32 | IsAny32BitIntegralFormat | Returns true if the specified format is any 32-bit signed/unsigned integral format. |
| int32 | IsAny8BitIntegralFormat | Returns true if the specified format is any 8-bit signed/unsigned integral format. |
| int32 | IsBgraFormat | Returns true if the specified Image_Pixel_Format value represents a pixel format, such as IPF_8888_ARGB, that uses BGRA byte ordering. |
| int32 | IsBgraImage | Returns true if the specified <Image> object represents any pixel format, such as IPF_8888_ARGB, that uses BGRA byte ordering. |
| int32 | IsFixedPointFormat | Returns true if the format is any fixed-point format. All fixed-point formats as are as follows: IPF_8_I, IPF_8_A, IPF_1555_ARGB, IPF_565_RGB, IPF_888_RGB, IPF_8888_ARGB, IPF_4444_ARGB, IPF_8_Stencil, IPF_8_UI, IPF_16_UI, IPF_32_UI, IPF_64_UI, IPF_96_UI, IPF_128_UI. |
| int32 | IsFixedPointImage | Returns true if the <Image> object uses any fixed-point format. All fixed-point formats as are as follows: IPF_8_I, IPF_8_A, IPF_1555_ARGB, IPF_565_RGB, IPF_888_RGB, IPF_8888_ARGB, IPF_4444_ARGB, IPF_8_Stencil, IPF_8_UI, IPF_16_UI, IPF_32_UI, IPF_64_UI, IPF_96_UI, IPF_128_UI. |
| int32 | IsFixedPointSignedFormat | Returns true if the format is any signed, fixed-point format. For example: returns true if IPF_I8 is submitted to this function. |
| int32 | IsFixedPointSignedImage | Returns true if the <Image> is fixed point and signed. For example: returns true if an <Image> object of pixel format IPF_I8 is submitted to this function. |
| int32 | IsFixedPointUnsignedFormat | Returns true if the format is any unsigned, fixed-point format. For example: returns true if IPF_UI8 is submitted to this function. |
| int32 | IsFixedPointUnsignedImage | Returns true if the <Image> is fixed point and unsigned. For example: returns true if an <Image> object of pixel format IPF_UI8 is submitted to this function. |
| int32 | IsFloat16Format | Returns true if the format is any 16-bit floating point format. For example: returns true if IPF_FP16 is submitted to this function. |
| int32 | IsFloat16Image | Returns true if the <Image> any 16-bit floating point format. For example: returns true if an <Image> object of pixel format IPF_FP16 is submitted to this function. |
| int32 | IsFloat32Format | Returns true if the format is any 32-bit floating point format. For example: returns true if IPF_FP32 is submitted to this function. |
| int32 | IsFloat32Image | Returns true if the <Image> is any 32-bit floating point format. For example: returns true if an <Image> object of pixel format IPF_FP32 is submitted to this function. |
| int32 | IsFloat32VectorFormat | Returns true if the pixel format submitted to this function is associated with the GLSL vec4 type. For example, if sampling a texture with this pixel format returns vec4. |
| int32 | IsFloatFormat | Returns true if the format is any floating point format. For example: returns true if IPF_FP16x2 or IPF_FP32 are submitted to this function. |
| int32 | IsFloatImage | Returns true if the <Image> is any floating point format. For example: returns true if an <Image> object of pixel format IPF_FP16x2 or IPF_FP32 are submitted to this function. |
| int32 | IsInt16Format | Returns true if the format is any 16-bit integer format. For example: returns true if IPF_I16 is submitted to this function. |
| int32 | IsInt16Image | Returns true if the <Image> any 16-bit integer format. For example: returns true if an <Image> object of pixel format IPF_I16 is submitted to this function. |
| int32 | IsInt32Format | Returns true if the format is any 32-bit integer format. For example: returns true if IPF_I32 is submitted to this function. |
| int32 | IsInt32Image | Returns true if the <Image> is any 32-bit integer format. For example: returns true if an <Image> object of pixel format IPF_I32 is submitted to this function. |
| int32 | IsInt32VectorFormat | Returns true if the pixel format submitted to this function is associated with the GLSL ivec4 type. For example, if sampling a texture with this pixel format returns ivec4. |
| int32 | IsInt8Format | Returns true if the format is any 8-bit integer format. For example: returns true if IPF_I8 is submitted to this function. |
| int32 | IsInt8Image | Returns true if the <Image> is any 8-bit integer format. For example: returns true if an <Image> object of pixel format IPF_I8 is submitted to this function. |
| int32 | IsNormalizedFormat | Returns true if the format is any normalized format. For example: returns true if IPF_I8N or IPF_I16Nx2 are submitted to this function. |
| int32 | IsNormalizedInt16Format | Returns true if the pixel format is any 16-bit normalized int format. |
| int32 | IsNormalizedInt8Format | Returns true if the pixel format is any 8-bit normalized int format. |
| int32 | IsPackedFormat | Returns true if the format uses packed and/or reinterpreted bit patterns. All packed formats are as follows: IPF_1555_ARGB, IPF_565_RGB, IPF_4444_ARGB, IPF_1010102_ARGB. |
| int32 | IsPackedImage | Returns true if the <Image> object uses packed and/or reinterpreted bit patterns. All packed formats are as follows: IPF_1555_ARGB, IPF_565_RGB, IPF_4444_ARGB, IPF_1010102_ARGB. |
| int32 | IsRgbFormat | Returns true if the format is 888_RGB. Otherwise returns false. |
| int32 | IsRgbImage | Returns true if the format is 888_RGB. Otherwise returns false. |
| int32 | IsRgbaFormat | Returns true if the specified Image_Pixel_Format value represents a pixel format, such as IPF_FP32x2, that uses RGBA byte ordering. |
| int32 | IsRgbaImage | Returns true if the specified <Image> object has a pixel format, such as IPF_FP32x2, that uses RGBA byte ordering. |
| int32 | IsSignedFormat | Returns true if the specified Image_Pixel_Format value represents a signed format such as IPF_I8, IPF_I16, or IPF_I32. |
| int32 | IsSignedImage | Returns true if the specified <Image> object has a pixel format, such as IPF_I8, IPF_I16, or IPF_I32, that uses signed values. |
| int32 | IsUint16Format | Returns true if the format is any 16-bit unsigned integer format. For example: returns true if IPF_UI16 is submitted to this function. |
| int32 | IsUint16Image | Returns true if the <Image> is any 16-bit unsigned integer format. For example: returns true if an <Image> object of pixel format IPF_UI16 is submitted to this function. |
| int32 | IsUint32Format | Returns true if the format is any 32-bit unsigned integer format. For example: returns true if IPF_UI32 is submitted to this function. |
| int32 | IsUint32Image | Returns true if the <Image> is any 32-bit unsigned integer format. For example: returns true if an <Image> object of pixel format IPF_UI32 is submitted to this function. |
| uint32 | IsUint32VectorFormat | Returns true if the pixel format submitted to this function is associated with the GLSL uvec4 type. For example, if sampling a texture with this pixel format returns uvec4. |
| int32 | IsUint8Format | Returns true if the format is any 8-bit unsigned integer format. For example: returns true if IPF_UI8 is submitted to this function. |
| int32 | IsUint8Image | Returns true if the <Image> is any 8-bit unsigned integer format. For example: returns true if an <Image> object of pixel format IPF_UI8 is submitted to this function. |
| int32 | IsUnsignedFormat | Returns true if the specified Image_Pixel_Format value represents an unsigned format such as IPF_UI8, IPF_UI16, or IPF_UI32. |
| int32 | IsUnsignedImage | Returns true if the specified <Image> object has a pixel format, such as IPF_UI8, IPF_UI16, or IPF_UI32, that uses unsigned values. |
| int32 | IsVideoFormat | Returns true if the pixel format submitted is any of IPF_YUV420P, IPF_NV12, or IPF_YUYV. |