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. |
Methods
| Method | Description |
|---|
| Clear | Close any open file or stream, release any allocated data. |
| GetClass | Get the name of the ImageDataExporter class. |
| IsA | Returns true if ImageDataExporter is a or is a descendant of the class named as the type parameter. |
| IsNull | Returns true if the ImageDataExporter object is invalid. |
| 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. |
| 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. |
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: ``````
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 | |
Syntax
| Type | Name | Min | Max | Description |
|---|
| EImageOutputFormat | value | | | The desired output image file format. |
Type: ``````
Default: PNG
| Key | Value | Comment |
|---|
| BMP | 0 | |
| DDS | 1 | |
| JPEG | 2 | |
| PNG | 3 | |
| TGA | 4 | |
| TIFF | 5 | |
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 | |
Methods details
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.
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.
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.
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
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.
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.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Object | object | | | Object to cast. |
Return value
Type: ImageDataExporter
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Object | object | | | Object to cast. |
Return value
Type: ImageDataExporter
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to cast. |
Return value
Type: ImageDataExporter
