PictureEffectsRaw Xojo Plugin

ShapeDistortEffectRaw Class (console safe)

A class to do distort the shape of a image in a 4 corner polygon.



MPImageFilterRaw
   ShapeDistortEffectRaw

class ShapeDistortEffectRaw implements

IRawBitmapProcessor

Properties

AddAlphaChannel (console safe) If this property is set to true then alpha channel is added even if there was none in the source bitmap.
AsyncCompleted (Inherited) (console safe) Returns true if asynchronous execution has completed, else false.
AsyncResult (Inherited) (console safe) Returns the result bitmap of asynchronous execution.
BackColor (console safe) Background color to fill to the sides of the distorted image.
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.
HighQuality (console safe) If set to true then high quality interpolation is used (slower). If set to false then faster method is used which is good for preview for example.
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.
PinnedSize (console safe) If set to true then the size of the destination image is same as size of the source image. corners stretched out of the image will get clipped off.
PolygonShape (console safe) A 4 point polygon that defines the pictures new shape. Note that if you got inward angles then you will sort of see under the image as if it was 3D object.
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

Apply (console safe) Applies the effect on a RawBitmap image with parameters that have been set on the class instance.
Apply (console safe) Applies the effect on a RawBitmap image with parameters that have been set on the class instance, taking also the polygon as parameter.
Cancel (Inherited) (console safe) Cancels processing and waits for threads to come to full stop when in asynchronous execution.
MapPoint (console safe) Maps a point from a destination image of given size to location in the source image.

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