PictureEffectsRaw Xojo Plugin

ScaleEffectRaw Class (console safe)

A class to scale pictures that are contained in RawBitmap class.

This class has the following scaling algorithms:
  • BilinearScale
  • StretchHorizontal
  • StretchVertical

    Supports:
  • 8 bit per channel bitmaps

  • 16 bit per channel bitmaps

  • RGB color spaces

  • CMYK color spaces

  • Gray color spaces

  • Synchronous and asynchronous modes supported



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

    MPImageFilterRaw
       ScaleEffectRaw

    class ScaleEffectRaw

    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.
    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.

    Methods

    BilinearScale (console safe) To do high quality scaling on images use the BilinearScale function.
    BilinearScaleAsync (console safe) To do high quality scaling on images asynchronously use the BilinearScale function.
    Cancel (Inherited) (console safe) Cancels processing and waits for threads to come to full stop when in asynchronous execution.
    StretchHorizontal (console safe) Stretches a RawBitmap horizontally.
    StretchHorizontalAsync (console safe) Stretches a RawBitmap horizontally asynchronously.
    StretchVertical (console safe) Stretches a RawBitmap vertically.
    StretchVerticalAsync (console safe) Stretches a RawBitmap vertically asynchronously.

    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