PictureEffectsRaw Xojo Plugin

GainEffectRaw Class (console safe)

A class to do Gain and Bias effect on pictures contained in RawBitmap objects.

This class supports use of multiple CPU cores.

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.

    MapEffectRaw
       GainEffectRaw

    class GainEffectRaw implements

    IRawBitmapProcessor

    Constructors

    GainEffectRawConstructor with no parameters
    GainEffectRawConstructor that takes gain and bias as parameters.

    Properties

    AsyncCompleted (Inherited) Returns true if asynchronous execution has completed, else false.
    AsyncResult (Inherited) Returns the result bitmap of asynchronous execution.
    BiasThe bias
    CPUCoreCount (Inherited) Returns number of detected CPU cores on the running machine.
    Canceled (Inherited) If this one returns true then the effects execution was canceled by a Progress handler.
    ErrorCode (Inherited) Returns error code after applying the effect. This value is a Constant defined in the PictureEffectsRawError module.
    ForceThreads (Inherited) Forces use of thread when set to true even when using only one CPU core.
    GainThe gain
    MaskSets mask for the operation if masking is wanted.
    Mask (Inherited) Sets mask for the operation if masking is wanted.
    MaximumCPUCores (Inherited) Read only property where each effect can report maximum CPU cores it supports.
    MultiprocessingHint (Inherited) 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) 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.

    Methods

    ApplyApplies the effect on a RawBitmap image with parameters that have been set on the class instance.
    Apply (Inherited) Applies the effect on a RawBitmap image with parameters that have been set on the class instance, taking additionally the mapping channels as parameters.
    ApplyAsyncApplies the effect asynchronously on a RawBitmap image with parameters that have been set on the class instance.
    ApplyInPlaceApplies 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.
    ApplyInPlace (Inherited) 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.
    ApplyInPlaceAsyncApplies 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) Cancels processing and waits for threads to come to full stop when in asynchronous execution.
    SetMaps (Inherited) Sets the mapping parameters

    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