Platforms to show: All Mac Windows Linux Cross-Platform
Back to TiffPictureMBS class.
TiffPictureMBS.AddCustomTag(Tag as Integer, FieldReadCount as Integer, FieldWriteCount as Integer, FieldType as Integer, FieldBit as Integer, OkToChange as Integer, PassCount as Integer, FieldName as string) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | TIFF | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See tiff documentation for details.
Some examples using this method:
TiffPictureMBS.AddImage as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | TIFF | MBS Images Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns true on success and false on any error.
Calls TIFFWriteDirectory internally.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | TIFF | MBS Images Plugin | 3.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
In 5.1 and older the destructor.
In 5.2 and later only closes the tiff handle so you can still read the pictures, the output or input buffer.
TiffPictureMBS.CombinePictureWithMask as picture
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | TIFF | MBS Images Plugin | 6.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
TiffPictureMBS.Create(file as folderitem) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | TIFF | MBS Images Plugin | 4.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns true on success.
See also:
TiffPictureMBS.Create(file as folderitem, endian as Integer) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | TIFF | MBS Images Plugin | 4.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns true on success.
Endian settings:
0 | Default (System) |
1 | BigEndian (Mac) |
2 | LittleEndian (Win) |
See also:
TiffPictureMBS.Create(Path as String, endian as integer = 0) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | TIFF | MBS Images Plugin | 19.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns true on success.
Endian settings:
0 | Default (System) |
1 | BigEndian (Mac) |
2 | LittleEndian (Win) |
See also:
TiffPictureMBS.CreateString(Size as Integer) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | TIFF | MBS Images Plugin | 5.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Same as the Create() function, but memory based. You can now use functions like Scanline(), WriteSW() or WriteRGB() to put the picture data.
Returns true on success.
The Warning and Error events may show you reasons why it does not work.
The size parameter you pass in is a guess for the initial size of the memory block used. If more data is written, the memory block is resized, but it is quite slow to resize a memoryblock, so make a good guess!
You can and should use this function to write yourself a PictureToTiffString function. The plugin can not well make such a function as there are thousands of possible parameters combination you may want to use. (compared to the JPEG library where you only have the compression level parameter.)
See also:
Some examples using this method:
TiffPictureMBS.CreateString(Size as Integer, Mode as string) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | TIFF | MBS Images Plugin | 5.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Same as the other CreateString method, but you can pass a mode string to the library.
mode="wb" for big endian and mode="wl" for little endian.
See also:
TiffPictureMBS.Flush as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | TIFF | MBS Images Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
In normal operation this call is never needed - the library automatically does any flushing required.
TiffPictureMBS.FlushData as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | TIFF | MBS Images Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
In normal operation this call is never needed Å| the library automatically does any flushing required.
TiffPictureMBS.GetColorMap(byref red as memoryblock, byref green as memoryblock, byref blue as memoryblock) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | TIFF | MBS Images Plugin | 9.6 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
The memoryblock must be 2^bitspersample * 2 bytes big.
Returns true on success and false on failure.
TiffPictureMBS.GetColorProfile as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | TIFF | MBS Images Plugin | 7.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns "" on any error.
Some examples using this method:
TiffPictureMBS.GetData(Tag as Integer) as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | TIFF | MBS Images Plugin | 8.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
TiffPictureMBS.GetField(Tag as Integer, mem as memoryblock) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | TIFF | MBS Images Plugin | 7.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Please look for Tag values in the tiff specification.
Returns true on success.
Please make sure to use the correct setter depending on data type associated with the tag.
The memoryblock you pass in must be big enough to hold whatever data the library stores there.
TiffPictureMBS.GetFieldByte(Tag as Integer, byref value as Integer) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | TIFF | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Please look for Tag values in the tiff specification.
Returns true on success.
Please make sure to use the correct setter depending on data type associated with the tag.
TiffPictureMBS.GetFieldCount(Tag as Integer, byref count as Integer, mem as memoryblock) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | TIFF | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This is the special version using memoryblock so you can use it for reading values with a count value.
Please look for Tag values in the tiff specification.
Returns true on success.
Please make sure to use the correct setter depending on data type associated with the tag.
TiffPictureMBS.GetFieldDefaultedByte(Tag as Integer, byref value as Integer) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | TIFF | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Please look for Tag values in the tiff specification.
Returns true on success. May return a default value.
Please make sure to use the correct setter depending on data type associated with the tag.
GetFieldDefaulted* is identical to GetField*, except that if a tag is not defined in the current directory and it has a default value, then the default value is returned.
TiffPictureMBS.GetFieldDefaultedDouble(Tag as Integer, byref value as Double) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | TIFF | MBS Images Plugin | 7.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Please look for Tag values in the tiff specification.
Returns true on success. May return a default value.
Please make sure to use the correct setter depending on data type associated with the tag.
GetFieldDefaulted* is identical to GetField*, except that if a tag is not defined in the current directory and it has a default value, then the default value is returned.
TiffPictureMBS.GetFieldDefaultedInteger(Tag as Integer, byref value as Integer) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | TIFF | MBS Images Plugin | 7.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Please look for Tag values in the tiff specification.
Returns true on success. May return a default value.
Please make sure to use the correct setter depending on data type associated with the tag.
GetFieldDefaulted* is identical to GetField*, except that if a tag is not defined in the current directory and it has a default value, then the default value is returned.
TiffPictureMBS.GetFieldDefaultedShort(Tag as Integer, byref value as Integer) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | TIFF | MBS Images Plugin | 7.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Please look for Tag values in the tiff specification.
Returns true on success. May return a default value.
Please make sure to use the correct setter depending on data type associated with the tag.
GetFieldDefaulted* is identical to GetField*, except that if a tag is not defined in the current directory and it has a default value, then the default value is returned.
TiffPictureMBS.GetFieldDefaultedSingle(Tag as Integer, byref value as Single) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | TIFF | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Please look for Tag values in the tiff specification.
Returns true on success. May return a default value.
Please make sure to use the correct setter depending on data type associated with the tag.
GetFieldDefaulted* is identical to GetField*, except that if a tag is not defined in the current directory and it has a default value, then the default value is returned.
TiffPictureMBS.GetFieldDefaultedString(Tag as Integer, byref value as String) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | TIFF | MBS Images Plugin | 8.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Please look for Tag values in the tiff specification.
Returns true on success. May return a default value.
Please make sure to use the correct setter depending on data type associated with the tag.
The string is returned with ascii encoding. You may need to define a different encoding is this is not correct.
GetFieldDefaulted* is identical to GetField*, except that if a tag is not defined in the current directory and it has a default value, then the default value is returned.
TiffPictureMBS.GetFieldDouble(Tag as Integer, byref value as Double) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | TIFF | MBS Images Plugin | 7.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Please look for Tag values in the tiff specification.
Returns true on success.
Please make sure to use the correct setter depending on data type associated with the tag.
TiffPictureMBS.GetFieldInteger(Tag as Integer, byref value as Integer) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | TIFF | MBS Images Plugin | 7.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Please look for Tag values in the tiff specification.
Returns true on success.
Please make sure to use the correct setter depending on data type associated with the tag.
TiffPictureMBS.GetFieldMemory(Tag as Integer, byref ItemCount as Integer) as memoryblock
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | TIFF | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This is the special version using memoryblock so you can use it for reading values with a count value.
Please look for Tag values in the tiff specification.
Returns true on success.
Please make sure to use the correct setter depending on data type associated with the tag.
Some examples using this method:
TiffPictureMBS.GetFieldShort(Tag as Integer, byref value as Integer) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | TIFF | MBS Images Plugin | 7.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Please look for Tag values in the tiff specification.
Returns true on success.
Please make sure to use the correct setter depending on data type associated with the tag.
TiffPictureMBS.GetFieldSingle(Tag as Integer, byref value as Single) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | TIFF | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Please look for Tag values in the tiff specification.
Returns true on success.
Please make sure to use the correct setter depending on data type associated with the tag.
The items on this page are in the following plugins: MBS Images Plugin.