Simplygon 9 Documentation

# 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

// Setter
void SetDDSCompressionType( Simplygon::EDDSCompressionType value );

// Getter
Simplygon::EDDSCompressionType GetDDSCompressionType();

# SetDDSCompressionType parameters

Type Name Min Max Description
EDDSCompressionType value The desired DDS compression type name.

# GetDDSCompressionType return value

Type: EDDSCompressionType

Default: NoCompression

Key Value Comment
NoCompression -1
BC1 0
BC2 1
BC3 2
BC4 3
BC5 4

# ExportFilePath

The main export file path. This must always be set.

# Syntax

// Setter
void SetExportFilePath( const char * value );

// Getter
spString GetExportFilePath();

# SetExportFilePath parameters

Type Name Min Max Description
const char * value The desired main export file path.

# GetExportFilePath return value

Type: spString

# ImageFileFormat

Output image file format to use.

# Syntax

// Setter
void SetImageFileFormat( Simplygon::EImageOutputFormat value );

// Getter
Simplygon::EImageOutputFormat GetImageFileFormat();

# SetImageFileFormat parameters

Type Name Min Max Description
EImageOutputFormat value The desired output image file format.

# GetImageFileFormat return value

Type: EImageOutputFormat

Default: PNG

Key Value Comment
BMP 0
DDS 1
JPEG 2
PNG 3
TGA 4
TIFF 5

# Methods details

# Clear

Close any open file or stream, release any allocated data.

# Syntax

void Clear();

# Parameters

Clear takes no parameters.

# GetClass

Get the name of the ImageDataExporter class.

# Syntax

spString GetClass();

# Parameters

GetClass takes no parameters.

# Return value

Type: spString

# IsA

Returns true if ImageDataExporter is a or is a descendant of the class named as the type parameter.

# Syntax

bool IsA( const char * type );

# 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

# IsNull

Returns true if the ImageDataExporter object is invalid.

# Syntax

bool IsNull();

# Parameters

IsNull takes no parameters.

# Return value

Type: bool

# RunExport

Runs the export. Note that all parameters must be setup before exporting.

# Syntax

bool RunExport();

# Parameters

RunExport takes no parameters.

# Return value

Type: bool

# SetImage

The image data to export.

# Syntax

void SetImage( spImageData value );

# Parameters

Type Name Min Max Description
ImageData value 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

static bool IsClassA( const char * type );

# 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

# 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

static spImageDataExporter SafeCast( spObject object );

# Parameters

Type Name Min Max Description
Object object Object to cast.

# Return value

Type: ImageDataExporter

← ImageDataImporter →