class
ImageData
ImageData holds unpacked image data. The data is stored in an FieldData object as value fields. For simplicity all images are implemented as 3D images, but has an extent of 1 in Z for 2D images, and an extent of 1 in both Y and Z for 1D images. Cube maps are stored as a 3D image with Z-depth of 6 (one for each side)
Properties
Property | Description |
---|---|
ColorSpace | Used to set the color space of the image data. Note that this applies only to integer based data types. Floating point data is always considered linear. |
Name | The name of the ImageData object. (Inherited from Object) |
Methods
Method | Description |
---|---|
AddColors | Adds the Colors field. |
AddField | Adds a field. The field must have a name that does not conflict with any of the existing field names. The field is referenced by the image after the call to AddField() |
AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
DeepCopy | Copies the field setup and data from another object. To only copy the setup, set copy_data to false. |
Equals | Check for equality against another image data. |
GetClass | Get the name of the ImageData class. (Inherited from Object) |
GetColors | The Colors field. |
GetColorsFormat | The color field format specification. |
GetColorsValueType | The base type used by the colors field. |
GetDDSCompressionType | The DDS compression type for the image data. |
GetField | Gets a field. |
GetFieldValueType | Gets the value type of a field. |
GetImageFields | The ImageFields field data object, that holds all fields within the image. |
GetInputFormat | The format of the image data. |
GetType | The type of this image data. |
GetXSize | The X dimension size of this image data. |
GetYSize | The Y dimension size of this image data. |
GetZSize | The Z dimension size of this image data. |
HasColors | Checks if the image has a color field. |
HasField | Check if a field exists in the IImageData object. |
IsA | Returns true if ImageData is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
IsNull | Returns true if the ImageData object is invalid. (Inherited from Object) |
IsSameObjectAs | Returns true if the ImageData object is valid. (Inherited from Object) |
NewCopy | Creates another image data object with the same field setup. To also copy the data to the new object, set copy_data to true. |
NonNull | Returns true if the ImageData object is valid. (Inherited from Object) |
PrintInfo | Prints the content/info of the ImageData object to the log. (Inherited from Object) |
RemoveColors | Removes the Colors field. |
RemoveField | Removes a field. |
RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
Reset | Clears all data from the image, and removes all data fields. The type is reset to 2D. |
Set1DSize | The X dimension size of this image data. |
Set2DSize | The X and Y dimension size of this image data. |
Set3DSize | The X, Y and Z dimension size of this image data. |
SetCubeSize | The 6 uniform cube side dimensions of this image data. |
Static methods
Method | Description |
---|---|
IsClassA | Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
SafeCast | SafeCast makes sure the input object is of a class that can be cast into spImageData, and if this is the case, returns the object cast into spImageData. (Inherited from Object) |
Properties details
ColorSpace
Used to set the color space of the image data. Note that this applies only to integer based data types. Floating point data is always considered linear.
Name
The name of the ImageData object. (Inherited from Object)
Methods details
AddColors
Adds the Colors field.
AddField
Adds a field. The field must have a name that does not conflict with any of the existing field names. The field is referenced by the image after the call to AddField()
AddObserver
Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
DeepCopy
Copies the field setup and data from another object. To only copy the setup, set copy_data to false.
Equals
Check for equality against another image data.
GetClass
Get the name of the ImageData class. (Inherited from Object)
GetColors
The Colors field.
GetColorsFormat
The color field format specification.
GetColorsValueType
The base type used by the colors field.
GetDDSCompressionType
The DDS compression type for the image data.
GetField
Gets a field.
GetFieldValueType
Gets the value type of a field.
GetImageFields
The ImageFields field data object, that holds all fields within the image.
GetInputFormat
The format of the image data.
GetType
The type of this image data.
GetXSize
The X dimension size of this image data.
GetYSize
The Y dimension size of this image data.
GetZSize
The Z dimension size of this image data.
HasColors
Checks if the image has a color field.
HasField
Check if a field exists in the IImageData object.
IsA
Returns true if ImageData is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull
Returns true if the ImageData object is invalid. (Inherited from Object)
IsSameObjectAs
Returns true if the ImageData object is valid. (Inherited from Object)
NewCopy
Creates another image data object with the same field setup. To also copy the data to the new object, set copy_data to true.
NonNull
Returns true if the ImageData object is valid. (Inherited from Object)
PrintInfo
Prints the content/info of the ImageData object to the log. (Inherited from Object)
RemoveColors
Removes the Colors field.
RemoveField
Removes a field.
RemoveObserver
Removes a previously added observer object. (Inherited from Object)
Reset
Clears all data from the image, and removes all data fields. The type is reset to 2D.
Set1DSize
The X dimension size of this image data.
Set2DSize
The X and Y dimension size of this image data.
Set3DSize
The X, Y and Z dimension size of this image data.
SetCubeSize
The 6 uniform cube side dimensions of this image data.
Static methods details
IsClassA
Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCast
SafeCast makes sure the input object is of a class that can be cast into spImageData, and if this is the case, returns the object cast into spImageData. (Inherited from Object)