<ImageFormatQuery> Data Interface

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

Class HierarchyType » ImageFormatQuery

Function Members

Function members are as follows:

Return Type Function Name Documentation
int32CanBindFormatPopulates an <Int32Array> with Image_Pixel_Format enumeration values that the specified sampler type can bind.
int32GetBaseFormatReturns the base, single-channel format for the queried format. For example, returns IPF_FP32 if you query IPF_FP32x2, IPF_FP32x3, or IPF_FP32x4.
int32GetBindableAsPopulates an <Int32Array> with enumeration values that refer to sampler types that an <Image> is bindable as.
int32GetBitsFromFormatReturns 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 TYPE_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. IBPF_None is the first constant in the enumeration.
int32GetBitsPerFormatReturns 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 TYPE_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. IBPF_None is the first constant in the enumeration.
int32GetBytesFromFormatReturns 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 TYPE_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. IBYF_None is the first constant in the enumeration.
int32GetBytesPerChannelReturns 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 TYPE_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. IBPC_None is the first constant in the enumeration.
int32GetBytesPerFormatReturns 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 TYPE_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. IBYF_None is the first constant in the enumeration.
int32GetFloat16FormatReturns 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.
int32GetFloat32FormatReturns 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.
stringGetFormatFamilyReturns a string containing the format family such as "FP16" or "FP32" or "8888_ARGB".
int32GetFormatFromQualifierReturns 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.
doubleGetFormatMaxReturns the common and useful default maximum value for the specified image pixel format.
doubleGetFormatMinReturns the common and useful default minimum value for the specified image pixel format.
int32GetGlColorFormatReturn the OpenGL® color format associated with the Scenome API pixel format.
int32GetGlComponentsReturn the OpenGL® color component associated with the Scenome API pixel format.
int32GetGlImageFormatReturn the OpenGL® image format associated with the Scenome API pixel format.
int32GetGlPixelFormatReturn the OpenGL® pixel format associated with the Scenome API pixel format.
doubleGetImageFormatMaxReturns the common and useful default maximum value for the specified image pixel format.
doubleGetImageFormatMinReturns the common and useful default minimum value for the specified image pixel format.
int32GetImageSamplerTypeReturns an image sampler type such as image2D for the specified Image_Pixel_Format and ImageTopology. Please see TYPE_SERVICE_ENUMERATION_UTIL.SSL.
int32GetImageSamplerTypesPopulates an <Int32Array> with enumerated constants for all image sampler types ( such as image2D or imageCube ) that can bind the format. Please see SamplerTypeNone() in TYPE_SERVICE_ENUMERATION_UTIL.SSL for more information.
int32GetLinearFormatReturns true if the pixel format is linear.
int32GetQualifierFromFormatReturns a value from the GLSL_ImageQualifier enumeration that reflects the format layout qualifier for the specified Image_Pixel_Format constant.
stringGetSamplerDeclarationReturns a sampler declaration that matches the query parameters.
int32GetSamplerDeclarationComponentsPopulates 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>.
int32GetScalarsFromFormatReturns 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 TYPE_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. ISPF_None is the first constant in the enumeration.
int32GetScalarsPerFormatReturns 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 TYPE_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. ISPF_None is the first constant in the enumeration.
int32GetStandardSamplerTypeReturns a standard sampler type such as sampler2D for the specified Image_Pixel_Format and ImageTopology. Please see TYPE_SERVICE_ENUMERATION_UTIL.SSL.
int32GetStandardSamplerTypesPopulates an <Int32Array> with enumerated constants for all standard sampler types ( such as sampler2D or samplerCube ) that can bind the format. Please see SamplerTypeNone() in TYPE_SERVICE_ENUMERATION_UTIL.SSL for more information.
int32IsBgraFormatReturns true if the specified Image_Pixel_Format value represents a pixel format, such as IPF_8888_ARGB, that uses BGRA byte ordering.
int32IsBgraImageReturns true if the specified <Image> object represents any pixel format, such as IPF_8888_ARGB, that uses BGRA byte ordering.
int32IsFixedPointFormatReturns 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.
int32IsFixedPointImageReturns 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.
int32IsFixedPointSignedFormatReturns true if the format is any signed, fixed-point format. For example: returns true if IPF_I8 is submitted to this function.
int32IsFixedPointSignedImageReturns 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.
int32IsFixedPointUnsignedFormatReturns true if the format is any unsigned, fixed-point format. For example: returns true if IPF_UI8 is submitted to this function.
int32IsFixedPointUnsignedImageReturns 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.
int32IsFloat16FormatReturns true if the format is any 16-bit floating point format. For example: returns true if IPF_FP16 is submitted to this function.
int32IsFloat16ImageReturns 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.
int32IsFloat32FormatReturns true if the format is any 32-bit floating point format. For example: returns true if IPF_FP32 is submitted to this function.
int32IsFloat32ImageReturns 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.
int32IsFloat32VectorFormatReturns 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.
int32IsFloatFormatReturns true if the format is any floating point format. For example: returns true if IPF_FP16x2 or IPF_FP32 are submitted to this function.
int32IsFloatImageReturns 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.
int32IsInt16FormatReturns true if the format is any 16-bit integer format. For example: returns true if IPF_I16 is submitted to this function.
int32IsInt16ImageReturns 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.
int32IsInt32FormatReturns true if the format is any 32-bit integer format. For example: returns true if IPF_I32 is submitted to this function.
int32IsInt32ImageReturns 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.
int32IsInt32VectorFormatReturns 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.
int32IsInt8FormatReturns true if the format is any 8-bit integer format. For example: returns true if IPF_I8 is submitted to this function.
int32IsInt8ImageReturns 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.
int32IsNormalizedFormatReturns true if the format is any normalized format. For example: returns true if IPF_I8N or IPF_I16Nx2 are submitted to this function.
int32IsPackedFormatReturns 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.
int32IsPackedImageReturns 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.
int32IsRgbFormatReturns true if the format is 888_RGB. Otherwise returns false.
int32IsRgbImageReturns true if the format is 888_RGB. Otherwise returns false.
int32IsRgbaFormatReturns true if the specified Image_Pixel_Format value represents a pixel format, such as IPF_FP32x2, that uses RGBA byte ordering.
int32IsRgbaImageReturns true if the specified <Image> object has a pixel format, such as IPF_FP32x2, that uses RGBA byte ordering.
int32IsSignedFormatReturns true if the specified Image_Pixel_Format value represents a signed format such as IPF_I8, IPF_I16, or IPF_I32.
int32IsSignedImageReturns true if the specified <Image> object has a pixel format, such as IPF_I8, IPF_I16, or IPF_I32, that uses signed values.
int32IsUint16FormatReturns true if the format is any 16-bit unsigned integer format. For example: returns true if IPF_UI16 is submitted to this function.
int32IsUint16ImageReturns 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.
int32IsUint32FormatReturns true if the format is any 32-bit unsigned integer format. For example: returns true if IPF_UI32 is submitted to this function.
int32IsUint32ImageReturns 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.
uint32IsUint32VectorFormatReturns 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.
int32IsUint8FormatReturns true if the format is any 8-bit unsigned integer format. For example: returns true if IPF_UI8 is submitted to this function.
int32IsUint8ImageReturns 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.
int32IsUnsignedFormatReturns true if the specified Image_Pixel_Format value represents an unsigned format such as IPF_UI8, IPF_UI16, or IPF_UI32.
int32IsUnsignedImageReturns true if the specified <Image> object has a pixel format, such as IPF_UI8, IPF_UI16, or IPF_UI32, that uses unsigned values.
int32IsVideoFormatReturns true if the pixel format submitted is any of IPF_YUV420P, IPF_NV12, or IPF_YUYV.