Provides script language access to C++ objects of this type.
| Class Hierarchy | Type » SurfaceInfo |
Function members are as follows:
| Return Type | Function Name | Documentation |
|---|---|---|
| int32 | Clear | Returns the <SurfaceInfo> object to its constructor defaults. |
| <Float16Vector> | GetFloat16Vector | Returns a pointer to this object's underlying <Float16Vector>. |
| <Float32Vector> | GetFloat32Vector | Returns a pointer to this object's underlying <Float32Vector>. |
| <Int16Vector> | GetInt16Vector | Returns a pointer to this object's underlying <Int16Vector>. |
| <Int32Vector> | GetInt32Vector | Returns a pointer to this object's underlying <Int32Vector>. |
| <Int8Vector> | GetInt8Vector | Returns a pointer to this object's underlying <Int8Vector>. |
| <Uint16Vector> | GetUint16Vector | Returns a pointer to this object's underlying <Uint16Vector>. |
| <Uint32Vector> | GetUint32Vector | Returns a pointer to this object's underlying <Uint32Vector>. |
| <Uint8Vector> | GetUint8Vector | Returns a pointer to this object's underlying <Uint8Vector>. |
| int32 | HasInvalidCoordinates | Returns true if a range of image coordinates are invalid. |
| int32 | HasValidCoordinates | Returns true if a range of image coordinates are valid. For example: a 512x512 texture can have starting x and y coordinates of zero, but the end x and y coordinates must be greater than zero. Similarly, for a 512x512 texture, you cannot have starting x and y coordinates that are less than zero. Please note that this test does not determine if the coordinates are valid for a particular texture, just whether or not they are generally valid. |
| int32 | MakeTopology1D | Sets this object's topology flag to ImageTopology_1D. This refers to the ImageTopology enumeration. Please see TYPE_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. |
| int32 | MakeTopology1DArray | Sets this object's topology flag to ImageTopology_1DArray. This refers to the ImageTopology enumeration. Please see TYPE_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. |
| int32 | MakeTopology2D | Sets this object's topology flag to ImageTopology_2D. This refers to the ImageTopology enumeration. Please see TYPE_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. |
| int32 | MakeTopology2DArray | Sets this object's topology flag to ImageTopology_2DArray. This refers to the ImageTopology enumeration. Please see TYPE_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. |
| int32 | MakeTopology3D | Sets this object's topology flag to ImageTopology_3D. This refers to the ImageTopology enumeration. Please see TYPE_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. |
| int32 | MakeTopologyCubemap | Sets this object's topology flag to ImageTopology_Cubemap. This refers to the ImageTopology enumeration. Please see TYPE_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. |
| int32 | MakeTopologyCubemapArray | Sets this object's topology flag to ImageTopology_CubemapArray. This refers to the ImageTopology enumeration. Please see TYPE_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. |
Object members are as follows:
| Type Name | Accessor Name | Documentation |
|---|---|---|
| int32 | ArrayCount | Gets or sets the array count. |
| int32 | BitsPerPixel | Gets or sets the bits per pixel value stored by this object. |
| int32 | BytesPerPixel | Gets or sets the bytes per pixel value stored by this object. |
| double | DstFormatMax | Gets or sets the destination format max value. |
| double | DstFormatMin | Gets or sets the destination format min value. |
| string | FilePath | Gets or sets the file path. |
| int32 | Height | Gets or sets the height value. |
| int32 | LinearSourceData | Gets or sets this object's linear source data flag. |
| int32 | PixelFormat | Gets or sets the pixel format flag. This refers to the Image_Pixel_Format enumeration. Please see TYPE_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. |
| int32 | RenderDepth | Gets or sets the render depth, which is an <int32> that determines how many slices there are in a 3D texture. |
| int32 | RenderHeight | Gets or sets the height in pixels of the texture used by the rendering device. Please note, this is offset from Source Y. |
| int32 | RenderWidth | Gets or sets the width in pixels of the texture used by the rendering device. Please note, this is offset from Source X. |
| int32 | Slices | Gets or sets the number of arrays if this object refers to an array texture (layered texture). |
| int32 | SourceX | Gets or sets the starting width pixel of the texture used by the rendering device. This can be 0, which is the first width pixel, or it can be an offset from 0. |
| int32 | SourceY | Gets or sets the starting height pixel of the texture used by the rendering device. This can be 0, which is the first height pixel, or it can be an offset from 0. |
| double | SrcFormatMax | Gets or sets the source format max value. |
| double | SrcFormatMin | Gets or sets the source format min value. |
| string | SurfaceName | Gets or sets a string containing the name of the surface. |
| int32 | TextureType | Gets or sets the texture type. This refers to the Texture_Type enumeration. Please see TYPE_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. |
| int32 | TileR | Gets or sets an <int32> where 0 means 'do not tile along the R axis' and 1 means 'tile along the R axis'. |
| int32 | TileS | Gets or sets an <int32> where 0 means 'do not tile along the S axis' and 1 means 'tile along the S axis'. |
| int32 | TileT | Gets or sets an <int32> where 0 means 'do not tile along the T axis' and 1 means 'tile along the T axis'. |
| int32 | Topology | Gets or sets this object's topology flag. This refers to the ImageTopology enumeration. Please see TYPE_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. |
| int32 | Width | Gets or sets the width value. |