Monkeybread Xojo plugin - LCMS2MBS methods

LCMS2MBS.OPTIMIZED_SH(n as UInt32) as UInt32

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	11.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Shifts the value so you can bitwise or it with other values to get a pixel format.

Optimized -- previous optimization already returns the final 8-bit value.

LCMS2MBS.PixelFormat(FloatingPoint as boolean, Optimized as boolean, ColorSpace as UInt32, MinIsWhite as boolean, Planar as boolean, EndianSwap as boolean, DoSwap as boolean, ExtraSamples as UInt32, Channels as UInt32, BytesPerSample as UInt32, SwapFirst as boolean) as UInt32

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	11.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Utility function to create a pixel format.

Format of pixel is defined by one UInt32, using bit fields as follows

A O TTTTT U Y F P X S EEE CCCC BBB

FloatingPoint: With this flag we can differentiate 16 bits as float and as int
Optimized: Previous optimization already returns the final 8-bit value
ColorSpace: Pixeltype
MinIsWhite: Flavor 0=MinIsBlack(Chocolate) 1=MinIsWhite(Vanilla)
Planar: Planar? 0=Chunky, 1=Planar
EndianSwap: swap 16 bps endianess?
DoSwap: Do swap? ie, BGR, KYMC
ExtraSamples: Extra samples
Channels: Channels (Samples per pixel)
BytesPerSample: bytes per sample
SwapFirst: Swap first - changes ABGR to BGRA and KCMY to CMYK

LCMS2MBS.PLANAR_SH(n as UInt32) as UInt32

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	11.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Shifts the value so you can bitwise or it with other values to get a pixel format.

Planar? 0=Chunky, 1=Planar

LCMS2MBS.PREMUL_SH(n as UInt32) as UInt32

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Shifts the value so you can bitwise or it with other values to get a pixel format.

Premultiplied? 0=No, 1=Yes

LCMS2MBS.SetAdaptationState(context as LCMS2ContextMBS, d as Double) as Double

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	14.1	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets adaptation state for absolute colorimetric intent, on all but CreateExtendedTransform.

Little CMS can handle incomplete adaptation states.

d: Degree on adaptation 0=Not adapted, 1=Complete adaptation, in-between=Partial adaptation. Use negative values to return the global state without changing it.

Returns previous global adaptation state.

See also:

SetAdaptationState(d as Double) as Double

LCMS2MBS.SetAdaptationState(d as Double) as Double

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	11.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets adaptation state for absolute colorimetric intent, on all but CreateExtendedTransform.

Little CMS can handle incomplete adaptation states.

d: Degree on adaptation 0=Not adapted, 1=Complete adaptation, in-between=Partial adaptation. Use negative values to return the global state without changing it.

Returns previous global adaptation state.

See also:

SetAdaptationState(context as LCMS2ContextMBS, d as Double) as Double

LCMS2MBS.SetAlarmCodes(context as LCMS2ContextMBS, values() as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	14.1	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the global codes used to mark out-out-gamut on Proofing transforms.

Values are meant to be encoded in 16 bits.
AlarmCodes: Array of 16 codes. All 16 values must be specified, set to zero for unused channels.

See also:

SetAlarmCodes(values() as Integer)

LCMS2MBS.SetAlarmCodes(values() as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	11.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the global codes used to mark out-out-gamut on Proofing transforms.

Values are meant to be encoded in 16 bits.
AlarmCodes: Array of 16 codes. All 16 values must be specified, set to zero for unused channels.

See also:

SetAlarmCodes(context as LCMS2ContextMBS, values() as Integer)

LCMS2MBS.SetLogErrorHandler(Context as LCMS2ContextMBS, handler as LCMS2ErrorHandlerMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	14.1	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Allows user to set any specific logger.

Each time this function is called, the previous logger is replaced. Calling this functin with NULL as parameter, does reset the logger to the default Little CMS logger. The default Little CMS logger does nothing.

LCMS2ErrorHandlerMBS is an Interface. You add it to the interface of your window/thread/class. Than you get a method "Error(context as LCMS2ContextMBS, ErrorCode as UInt32, Text as string)" which is called to log error messages. The context parameter is the object you pass for reference in the various context parameters to LCMS2 functions.

See also:

SetLogErrorHandler(handler as LCMS2ErrorHandlerMBS)

Some examples using this method:

LCMS2MBS.SetLogErrorHandler(handler as LCMS2ErrorHandlerMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Allows user to set any specific logger.

Each time this function is called, the previous logger is replaced. Calling this functin with NULL as parameter, does reset the logger to the default Little CMS logger. The default Little CMS logger does nothing.

LCMS2ErrorHandlerMBS is an Interface. You add it to the interface of your window/thread/class. Than you get a method "Error(context as LCMS2ContextMBS, ErrorCode as UInt32, Text as string)" which is called to log error messages. The context parameter is the object you pass for reference in the various context parameters to LCMS2 functions.

See also:

SetLogErrorHandler(Context as LCMS2ContextMBS, handler as LCMS2ErrorHandlerMBS)

LCMS2MBS.SWAPFIRST_SH(n as UInt32) as UInt32

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	11.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Shifts the value so you can bitwise or it with other values to get a pixel format.

Swap first - changes ABGR to BGRA and KCMY to CMYK

LCMS2MBS.TagInteger(tag as string) as UInt32

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	11.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Converts tag integer to string.

Example

MsgBox hex(LCMS2MBS.TagInteger("devs"))+" "+LCMS2MBS.TagString(&h64657673)

LCMS2MBS.TagString(tag as UInt32) as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	11.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Converts tag string to integer.

Example

MsgBox hex(LCMS2MBS.TagInteger("devs"))+" "+LCMS2MBS.TagString(&h64657673)

LCMS2MBS.TempFromWhitePoint(TempK as LCMS2CIExyYMBS) as Double

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	11.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Correlates a black body temperature in K from given chromaticity.

Example

Var c as new LCMS2CIExyYMBS

c.x = 0.32
c.y = 0.32
c.YY = 1.0

MsgBox str(LCMS2MBS.TempFromWhitePoint(c))

Returns temperature. Or zero on any error.

LCMS2MBS.T_BIT15(n as UInt32) as UInt32

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	20.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All