This documentation is for the old version. Go to the latest Graphics Mill docs

Spray Members

The Spray type exposes the following members.

Constructors

Name Description
Public method Spray Overloaded.

Creates and initializes new Spray class instance.

Methods

Name Description
Public method {dtor}

Enables using delete operator in C++ applications. It is strongly not recommended to use it directly.

Public method Abort

Aborts current operation.

(Inherited from SyncHandler.)
Public method ApplyMaskTransform Overloaded.

Transforms given bitmap using specified mask.

Public method ApplyTransform Overloaded.

Transforms given bitmap.

Public method Continue

Resumes execution of the operation previously paused with Pause() method.

(Inherited from SyncHandler.)
Public method Dispose

Releases all resources used by this Spray.

(Overrides BitmapTransform.Dispose().)
Public method Equals (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method IsPixelFormatSupported

Verifies if bitmap with specified pixel format is supported by this transform.

(Inherited from BitmapTransform.)
Public method Lock

Locks the object.

(Inherited from SyncHandler.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Pause

Pauses execution of the current operation.

(Inherited from SyncHandler.)
Public method Randomize

Initializes Seed property with random value.

Public method ToString (Inherited from Object.)
Public method Unlock

Unlocks the object previously locked with method Lock().

(Inherited from SyncHandler.)
Public method WaitForCompletion

Suspends the calling thread until the operation currently run is completed.

(Inherited from SyncHandler.)

Properties

Name Description
Public property Amount

Gets/sets random number variance (used as offset of pixel when it is being spreading).

Public property BackgroundColor

Gets/sets background value used to replace pixels which should be taken outside of the image (actual on image edges when distance to the image edge is less than ).

Public property Completed

Returns value indicating if the operation is currently running.

(Inherited from SyncHandler.)
Public property ExceptionThrowEnabled

Gets/sets value that specifies if to throw exception in synchronous mode.

(Inherited from SyncHandler.)
Public property FadeType

Gets/sets fade type for the spray effect (how does it change from image edges to center).

Public property FillWithBackground

Gets/sets value that specifies how fill areas where no pixels felt: whether to use background color (see BackgroundColor property) or use original pixels of the bitmap.

Public property FrameWidth

Gets/sets a width of the frame for which the effect should be applied.

Public property Locked

Indicates if the object has been locked.

(Inherited from SyncHandler.)
Public property Priority

Gets/sets a priority for the auxilary thread.

(Inherited from SyncHandler.)
Public property Seed

Gets/sets seed value for random generator.

Public property SupportedPixelFormats

Returns an array of pixel formats that are supported by this transform.

(Inherited from BitmapTransform.)
Public property SynchronizationMode

Gets/sets synchronization mode for the object.

(Inherited from SyncHandler.)
Public property Timeout

Gets/sets value specifying maximum time for which object can be locked.

(Inherited from SyncHandler.)
Public property Unit

Gets/sets unit used to measure all the coordinates, sizes and other spatial values.

(Inherited from UnitConverterHandler.)

Events

Name Description
Public event Aborted

Fires when operation has been aborted.

(Inherited from SyncHandler.)
Public event Continued

Fires when operation has been resumed with Continue() method.

(Inherited from SyncHandler.)
Public event Paused

Fires when operation has been paused with Pause() method.

(Inherited from SyncHandler.)
Protected event Progress

Fires on the operation progress notifications.

(Inherited from SyncHandler.)
Public event Started

Fires after operation has been started.

(Inherited from SyncHandler.)
Public event Starting

Fires before operation is started.

(Inherited from SyncHandler.)
Public event Stopped

Fires after operation has been stopped.

(Inherited from SyncHandler.)
Public event Stopping

Fires before operation is stopped.

(Inherited from SyncHandler.)

See Also

Reference