PictureEffectsRaw Xojo Plugin

ImageChannelMixerRaw Class (console safe)

A class to obtain image channels from RawBitmap object and mix them back together into new RawBitmap.

Supports:
  • 8 bit per channel bitmaps

  • 16 bit per channel bitmaps

  • RGB color spaces

  • CMYK color spaces

  • Gray color spaces


  • This class supports use of multiple CPU cores on all systems.

    MPImageFilterRaw
       ImageChannelMixerRaw

    class ImageChannelMixerRaw

    Properties

    AlphaChannel (console safe) This property will contain the alpha channel as RawBitmap if both alpha channel was requested in the ExtractChannels method and original bitmap contained alpha channel.
    AsyncCompleted (Inherited) (console safe) Returns true if asynchronous execution has completed, else false.
    AsyncResult (Inherited) (console safe) Returns the result bitmap of asynchronous execution.
    BlueChannel (console safe) This property will contain the alpha channel as RawBitmap if both blue channel was requested in the ExtractChannels method and original bitmap contained blue channel.
    CPUCoreCount (Inherited) (console safe) Returns number of detected CPU cores on the running machine.
    Canceled (Inherited) (console safe) If this one returns true then the effects execution was canceled by a Progress handler.
    CyanChannel (console safe) This property will contain the alpha channel as RawBitmap if both cyan channel was requested in the ExtractChannels method and original bitmap contained cyan channel.
    ErrorCode (Inherited) (console safe) Returns error code after applying the effect. This value is a Constant defined in the PictureEffectsRawError module.
    FillMissingChannelsWithMaxValues (console safe) If this property is set to true then missing channels when combining will be filled with max value instead of zero.
    ForceThreads (Inherited) (console safe) Forces use of thread when set to true even when using only one CPU core.
    GreenChannel (console safe) This property will contain the green channel as RawBitmap if both blue channel was requested in the ExtractChannels method and original bitmap contained green channel.
    KeyChannel (console safe) This property will contain the key channel as RawBitmap if both blue channel was requested in the ExtractChannels method and original bitmap contained key channel.
    MagentaChannel (console safe) This property will contain the magenta channel as RawBitmap if both blue channel was requested in the ExtractChannels method and original bitmap contained magenta channel.
    MaximumCPUCores (Inherited) (console safe) Read only property where each effect can report maximum CPU cores it supports.
    MultiprocessingHint (Inherited) (console safe) Use this property to fine tune CPU usage for this algorithm. By default this property is set to zero (Automatic). This property accepts all constants that are defined in this class.
    ProgressHandler (Inherited) (console safe) Use this property to use a progress class to get progress feedback from this function. This class must be a class that Implements the IProgressHandler Interface which is defined in this plugin.
    RedChannel (console safe) This property will contain the alpha channel as RawBitmap if both red channel was requested in the ExtractChannels method and original bitmap contained red channel.
    YellowChannel (console safe) This property will contain the alpha channel as RawBitmap if both yellow channel was requested in the ExtractChannels method and original bitmap contained yellow channel.

    Methods

    Cancel (Inherited) (console safe) Cancels processing and waits for threads to come to full stop when in asynchronous execution.
    CombineChannelsCMYK (console safe) Combines channels into RawBitmap with CMYK color space.
    CombineChannelsCMYKA (console safe) Combines channels into RawBitmap with CMYK color space and alpha channel.
    CombineChannelsGrayAlpha (console safe) Combines channels into RawBitmap with Gray color space and alpha channel.
    CombineChannelsRGB (console safe) Combines channels into RawBitmap with RGB color space.
    CombineChannelsRGBA (console safe) Combines channels into RawBitmap with RGB color space and alpha channel.
    ExtractChannels (console safe) Extracts channels from a RawBitmap by a given mask.

    Constants

    CHANNEL_RED = &h1
    CHANNEL_GREEN = &h2
    CHANNEL_BLUE = &h4
    CHANNEL_CYAN = &h8
    CHANNEL_MAGENTA = &h10
    CHANNEL_YELLOW = &h20
    CHANNEL_KEY = &h40
    CHANNEL_ALPHA = &h80
    CHANNEL_RGB = &h7
    CHANNEL_CMYK = &h78
    CHANNEL_ALL = &h7F
    CPU_USE_MACHINE_CORE_COUNT = -1 (Inherited)
    CPU_USE_AUTOMATIC = 0 (Inherited)
    CPU_USE_1_CORE = 1 (Inherited)
    CPU_USE_2_CORES = 2 (Inherited)
    CPU_USE_3_CORES = 3 (Inherited)
    CPU_USE_4_CORES = 4 (Inherited)
    CPU_USE_5_CORES = 5 (Inherited)
    CPU_USE_6_CORES = 6 (Inherited)
    CPU_USE_7_CORES = 7 (Inherited)
    CPU_USE_8_CORES = 8 (Inherited)

    Supported Platforms:

  • macOS Intel 64 bit
  • macOS Apple Silicon
  • Windows 32 bit
  • Windows 64 bit
  • Windows ARM 64 bit
  • Linux 32 bit
  • Linux 64 bit
  • Linux ARM 32 bit
  • Linux ARM 64 bit
  • iOS