PictureEffectsRaw Xojo Plugin

RainbowEffectRaw Class (console safe)

A class to create rainbow effect on images.

The class can create horizontal rainbow effect, vertical rainbow effect or rainbow effect based on point of origin.

Supports:
  • 8 bit per channel bitmaps

  • 16 bit per channel bitmaps

  • RGB color spaces

  • Synchronous and asynchronous modes supported



  • This class supports use of multiple CPU cores.

    MPImageFilterRaw
       RainbowEffectRaw

    class RainbowEffectRaw implements

    IRawBitmapProcessor

    IRawBitmapProcessorAsync

    Properties

    AsyncCompleted (Inherited) (console safe) Returns true if asynchronous execution has completed, else false.
    AsyncResult (Inherited) (console safe) Returns the result bitmap of asynchronous execution.
    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.
    ErrorCode (Inherited) (console safe) Returns error code after applying the effect. This value is a Constant defined in the PictureEffectsRawError module.
    ForceThreads (Inherited) (console safe) Forces use of thread when set to true even when using only one CPU core.
    Mask (console safe) Sets mask for the operation if masking is wanted.
    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.
    Point2OfOrigin (console safe) Sets the 2nd point for the line if RainbowType is RainbowType is set to RainbowEffect.LINE_OF_ORIGIN.
    PointOfOrigin (console safe) Sets the point of origin for the rainbow effect if the RainbowType is set to RainbowEffect.POINT_OF_ORIGIN or RainbowType is set to RainbowEffect.LINE_OF_ORIGIN.
    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.
    RainbowType (console safe) Sets or gets the type of the rainbow effect to be used.
    Saturation (console safe) Sets the saturation of the rainbow.

    Methods

    Apply (console safe) Applies the effect on a RawBitmap image with parameters that have been set on the class instance.
    ApplyAsync (console safe) Applies the effect asynchronously on a RawBitmap image with parameters that have been set on the class instance.
    ApplyInPlace (console safe) Applies the effect on a RawBitmap image with parameters that have been set on the class instance, and the RawBitmap passed in will also get the result image.
    ApplyInPlaceAsync (console safe) Applies the effect asynchronously on a RawBitmap image with parameters that have been set on the class instance, and the RawBitmap passed in will also get the result image.
    Cancel (Inherited) (console safe) Cancels processing and waits for threads to come to full stop when in asynchronous execution.

    Enumerations

    RainbowTypeValuesEnum that contains values to define rainbow type

    Constants

    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