Purpose

The module MLImageFormatInfo requests descriptive information from an MLImageFormat file specified by a file name. It shows information such as the standard image tags and user tags.

See also general documentation about the MLImageFormat and MLDataCompressors.

Also, read the documentation of the modules MLImageFormatLoad, MLImageFormatSave, and MLImageFormatFileCache.

Windows

Default Panel

../../../Modules/ML/MLImageFormat/mhelp/Images/Screenshots/MLImageFormatInfo._default.png

Parameter Fields

Field Index

boolHintVal6: Bool dblHintVisible8: Bool isSaving: Bool
boolHintVal7: Bool dblHintVisible9: Bool progress: Float
boolHintVal8: Bool File Name: String regionOffset: IntVector6
boolHintVal9: Bool hintName0: String remove: Trigger
boolHintVisible0: Bool hintName1: String Reset Infos: Trigger
boolHintVisible1: Bool hintName2: String Status: String
boolHintVisible2: Bool hintName3: String stop: Trigger
boolHintVisible3: Bool hintName4: String strHintVal6: String
boolHintVisible4: Bool hintName5: String strHintVal7: String
boolHintVisible5: Bool hintName6: String strHintVal8: String
boolHintVisible6: Bool hintName7: String strHintVal9: String
boolHintVisible7: Bool hintName8: String strHintVisible0: Bool
boolHintVisible8: Bool hintName9: String strHintVisible1: Bool
boolHintVisible9: Bool intHintVal6: Integer strHintVisible2: Bool
Compression: Enum intHintVal7: Integer strHintVisible3: Bool
dblHintVal6: Double intHintVal8: Integer strHintVisible4: Bool
dblHintVal7: Double intHintVal9: Integer strHintVisible5: Bool
dblHintVal8: Double intHintVisible0: Bool strHintVisible6: Bool
dblHintVal9: Double intHintVisible1: Bool strHintVisible7: Bool
dblHintVisible0: Bool intHintVisible2: Bool strHintVisible8: Bool
dblHintVisible1: Bool intHintVisible3: Bool strHintVisible9: Bool
dblHintVisible2: Bool intHintVisible4: Bool suppressWorldPos: Bool
dblHintVisible3: Bool intHintVisible5: Bool Tag List: String
dblHintVisible4: Bool intHintVisible6: Bool True File Name: String
dblHintVisible5: Bool intHintVisible7: Bool Update: Trigger
dblHintVisible6: Bool intHintVisible8: Bool updateHintControls: Trigger
dblHintVisible7: Bool intHintVisible9: Bool  

Visible Fields

Compression

name: compression, type: Enum, persistent: no

Shows the compression algorithm.

Values:

Title Name
None None
MLCTComp2 MLCTComp2
BZip2 BZip2
Lzf LZF
Lzma LZMA
Zlib ZLIB
Lz4 LZ4

True File Name

name: trueFileName, type: String, persistent: no, deprecated name: autoFileName

Shows the true and absolute file name on the current system.

Status

name: status, type: String, persistent: no

Shows information about the module’s state.

Tag List

name: tagList, type: String, persistent: no

Shows a list of tags in the specified file.

Update

name: update, type: Trigger

When pressed, the file is opened, information updated, and the file closed again.

Reset Infos

name: resetInfos, type: Trigger

When pressed, all information fields are being reset to their default state.

File Name

name: fileName, type: String

Sets the file name of the file that should be loaded.

This file name can contain variables. Have a look at MLImageFormatSave for more information.

Hidden Fields

updateHintControls

name: updateHintControls, type: Trigger, persistent: no

hintName0

name: hintName0, type: String, persistent: no

dblHintVisible0

name: dblHintVisible0, type: Bool, persistent: no

intHintVisible0

name: intHintVisible0, type: Bool, persistent: no

strHintVisible0

name: strHintVisible0, type: Bool, persistent: no

boolHintVisible0

name: boolHintVisible0, type: Bool, persistent: no

hintName1

name: hintName1, type: String, persistent: no

dblHintVisible1

name: dblHintVisible1, type: Bool, persistent: no

intHintVisible1

name: intHintVisible1, type: Bool, persistent: no

strHintVisible1

name: strHintVisible1, type: Bool, persistent: no

boolHintVisible1

name: boolHintVisible1, type: Bool, persistent: no

hintName2

name: hintName2, type: String, persistent: no

dblHintVisible2

name: dblHintVisible2, type: Bool, persistent: no

intHintVisible2

name: intHintVisible2, type: Bool, persistent: no

strHintVisible2

name: strHintVisible2, type: Bool, persistent: no

boolHintVisible2

name: boolHintVisible2, type: Bool, persistent: no

hintName3

name: hintName3, type: String, persistent: no

dblHintVisible3

name: dblHintVisible3, type: Bool, persistent: no

intHintVisible3

name: intHintVisible3, type: Bool, persistent: no

strHintVisible3

name: strHintVisible3, type: Bool, persistent: no

boolHintVisible3

name: boolHintVisible3, type: Bool, persistent: no

hintName4

name: hintName4, type: String, persistent: no

dblHintVisible4

name: dblHintVisible4, type: Bool, persistent: no

intHintVisible4

name: intHintVisible4, type: Bool, persistent: no

strHintVisible4

name: strHintVisible4, type: Bool, persistent: no

boolHintVisible4

name: boolHintVisible4, type: Bool, persistent: no

hintName5

name: hintName5, type: String, persistent: no

dblHintVisible5

name: dblHintVisible5, type: Bool, persistent: no

intHintVisible5

name: intHintVisible5, type: Bool, persistent: no

strHintVisible5

name: strHintVisible5, type: Bool, persistent: no

boolHintVisible5

name: boolHintVisible5, type: Bool, persistent: no

hintName6

name: hintName6, type: String, persistent: no

dblHintVal6

name: dblHintVal6, type: Double, persistent: no

intHintVal6

name: intHintVal6, type: Integer, persistent: no

strHintVal6

name: strHintVal6, type: String, persistent: no

boolHintVal6

name: boolHintVal6, type: Bool, persistent: no

dblHintVisible6

name: dblHintVisible6, type: Bool, persistent: no

intHintVisible6

name: intHintVisible6, type: Bool, persistent: no

strHintVisible6

name: strHintVisible6, type: Bool, persistent: no

boolHintVisible6

name: boolHintVisible6, type: Bool, persistent: no

hintName7

name: hintName7, type: String, persistent: no

dblHintVal7

name: dblHintVal7, type: Double, persistent: no

intHintVal7

name: intHintVal7, type: Integer, persistent: no

strHintVal7

name: strHintVal7, type: String, persistent: no

boolHintVal7

name: boolHintVal7, type: Bool, persistent: no

dblHintVisible7

name: dblHintVisible7, type: Bool, persistent: no

intHintVisible7

name: intHintVisible7, type: Bool, persistent: no

strHintVisible7

name: strHintVisible7, type: Bool, persistent: no

boolHintVisible7

name: boolHintVisible7, type: Bool, persistent: no

hintName8

name: hintName8, type: String, persistent: no

dblHintVal8

name: dblHintVal8, type: Double, persistent: no

intHintVal8

name: intHintVal8, type: Integer, persistent: no

strHintVal8

name: strHintVal8, type: String, persistent: no

boolHintVal8

name: boolHintVal8, type: Bool, persistent: no

dblHintVisible8

name: dblHintVisible8, type: Bool, persistent: no

intHintVisible8

name: intHintVisible8, type: Bool, persistent: no

strHintVisible8

name: strHintVisible8, type: Bool, persistent: no

boolHintVisible8

name: boolHintVisible8, type: Bool, persistent: no

hintName9

name: hintName9, type: String, persistent: no

dblHintVal9

name: dblHintVal9, type: Double, persistent: no

intHintVal9

name: intHintVal9, type: Integer, persistent: no

strHintVal9

name: strHintVal9, type: String, persistent: no

boolHintVal9

name: boolHintVal9, type: Bool, persistent: no

dblHintVisible9

name: dblHintVisible9, type: Bool, persistent: no

intHintVisible9

name: intHintVisible9, type: Bool, persistent: no

strHintVisible9

name: strHintVisible9, type: Bool, persistent: no

boolHintVisible9

name: boolHintVisible9, type: Bool, persistent: no

progress

name: progress, type: Float, persistent: no

remove

name: remove, type: Trigger

stop

name: stop, type: Trigger

isSaving

name: isSaving, type: Bool, persistent: no

regionOffset

name: regionOffset, type: IntVector6, default: 0 0 0 0 0 0

suppressWorldPos

name: suppressWorldPos, type: Bool, default: FALSE