class ImageDataExporter
Class for saving image data to different file formats.
Properties
| Property | Description |
|---|
| DDSCompressionType | The DDS block compression type to use. The block compression type will alter the number of output channels. BC1-3 - 3 channels. BC4 - 1 channel. BC5 - 3 channels. |
| ExportFilePath | The main export file path. This must always be set. |
| ImageFileFormat | Output image file format to use. |
| Name | The name of the ImageDataExporter object. (Inherited from Object) |
Methods
| Method | Description |
|---|
| AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
| Clear | Close any open file or stream, release any allocated data. |
| GetClass | Get the name of the ImageDataExporter class. (Inherited from Object) |
| IsA | Returns true if ImageDataExporter is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the ImageDataExporter object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the ImageDataExporter object is valid. (Inherited from Object) |
| NonNull | Returns true if the ImageDataExporter object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the ImageDataExporter object to the log. (Inherited from Object) |
| RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
| RunExport | Runs the export. Note that all parameters must be setup before exporting. |
| SetImage | The image data to export. |
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 spImageDataExporter, and if this is the case, returns the object cast into spImageDataExporter. (Inherited from Object) |
Properties details
DDSCompressionType
The DDS block compression type to use. The block compression type will alter the number of output channels. BC1-3 - 3 channels. BC4 - 1 channel. BC5 - 3 channels.
Syntax
SetDDSCompressionType parameters
GetDDSCompressionType return value
Type: EDDSCompressionType
Default: NoCompression
| Key | Value | Comment |
|---|
| NoCompression | -1 | |
| BC1 | 0 | |
| BC2 | 1 | |
| BC3 | 2 | |
| BC4 | 3 | |
| BC5 | 4 | |
Syntax
SetDDSCompressionType parameters
GetDDSCompressionType return value
Type: EDDSCompressionType
Default: NoCompression
| Key | Value | Comment |
|---|
| NoCompression | -1 | |
| BC1 | 0 | |
| BC2 | 1 | |
| BC3 | 2 | |
| BC4 | 3 | |
| BC5 | 4 | |
Syntax
SetDDSCompressionType parameters
GetDDSCompressionType return value
Type: EDDSCompressionType
Default: NoCompression
| Key | Value | Comment |
|---|
| EDDSCompressionType_NoCompression | -1 | |
| EDDSCompressionType_BC1 | 0 | |
| EDDSCompressionType_BC2 | 1 | |
| EDDSCompressionType_BC3 | 2 | |
| EDDSCompressionType_BC4 | 3 | |
| EDDSCompressionType_BC5 | 4 | |
ExportFilePath
The main export file path. This must always be set.
Syntax
SetExportFilePath parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | The desired main export file path. |
GetExportFilePath return value
Type: spString
Syntax
SetExportFilePath parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | The desired main export file path. |
GetExportFilePath return value
Type: string
Syntax
SetExportFilePath parameters
| Name | Type | Min | Max | Description |
|---|
| value | str | | | The desired main export file path. |
GetExportFilePath return value
Type: str
Output image file format to use.
Syntax
| Type | Name | Min | Max | Description |
|---|
| EImageOutputFormat | value | | | The desired output image file format. |
Type: EImageOutputFormat
Default: PNG
| Key | Value | Comment |
|---|
| BMP | 0 | |
| DDS | 1 | |
| JPEG | 2 | |
| PNG | 3 | |
| TGA | 4 | |
| TIFF | 5 | |
| EXR | 8 | |
Syntax
| Type | Name | Min | Max | Description |
|---|
| EImageOutputFormat | value | | | The desired output image file format. |
Type: EImageOutputFormat
Default: PNG
| Key | Value | Comment |
|---|
| BMP | 0 | |
| DDS | 1 | |
| JPEG | 2 | |
| PNG | 3 | |
| TGA | 4 | |
| TIFF | 5 | |
| EXR | 8 | |
Syntax
| Name | Type | Min | Max | Description |
|---|
| value | EImageOutputFormat | | | The desired output image file format. |
Type: EImageOutputFormat
Default: PNG
| Key | Value | Comment |
|---|
| EImageOutputFormat_BMP | 0 | |
| EImageOutputFormat_DDS | 1 | |
| EImageOutputFormat_JPEG | 2 | |
| EImageOutputFormat_PNG | 3 | |
| EImageOutputFormat_TGA | 4 | |
| EImageOutputFormat_TIFF | 5 | |
| EImageOutputFormat_EXR | 8 | |
Name
The name of the ImageDataExporter object. (Inherited from Object)
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | New name of the object. |
GetName return value
Type: spString
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | New name of the object. |
GetName return value
Type: string
Syntax
SetName parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | New name of the object. |
GetName return value
Type: str
Methods details
AddObserver
Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: rid
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: int
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observer | Observer | | | Observer is the object that will receive events. |
Return value
Type: int
Clear
Close any open file or stream, release any allocated data.
Syntax
Parameters
Clear takes no parameters.
Syntax
Parameters
Clear takes no parameters.
Syntax
Parameters
Clear takes no parameters.
GetClass
Get the name of the ImageDataExporter class. (Inherited from Object)
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: spString
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: string
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: str
IsA
Returns true if ImageDataExporter is a or is a descendant of the class named as the type parameter. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if ImageDataExporter is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if ImageDataExporter is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if ImageDataExporter is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the ImageDataExporter object is invalid. (Inherited from Object)
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
IsSameObjectAs
Returns true if the ImageDataExporter object is valid. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to compare with. |
Return value
Type: bool
NonNull
Returns true if the ImageDataExporter object is valid. (Inherited from Object)
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
PrintInfo
Prints the content/info of the ImageDataExporter object to the log. (Inherited from Object)
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
RemoveObserver
Removes a previously added observer object. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observerId | int | | | ObserverId is the id returned by AddObserver when the observer was added. |
RunExport
Runs the export. Note that all parameters must be setup before exporting.
Syntax
Parameters
RunExport takes no parameters.
Return value
Type: bool
Syntax
Parameters
RunExport takes no parameters.
Return value
Type: bool
Syntax
Parameters
RunExport takes no parameters.
Return value
Type: bool
SetImage
The image data to export.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| ImageData | value | | | The image data object to export. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| ImageData | value | | | The image data object to export. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| value | ImageData | | | The image data object to export. |
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)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
SafeCast
SafeCast makes sure the input object is of a class that can be cast into spImageDataExporter, and if this is the case, returns the object cast into spImageDataExporter. (Inherited from Object)
