You are here: Start » FIL.NET » Image Class

Image Class

Namespace:Fil
Assembly:FilNet.Types.dll

Universal (portable) image type with explicit run-time information about its format. Designed for optimum balance between simplicity and genericity. Supports monochromatic and multichannel images based on one of the 6 plain data types (UINT8, SINT8, UINT16, SINT16, SINT32, REAL). Image performs automatic memory management.

Constructors

 ConstructorDescription
Image(Int32, Int32, Int32, PlainType, Int32, IntPtr, Optional<Region>) Constructor used for creating wrappers on existing data.
Image() Constructor used for images, which will be created later, e.g. by 'LoadImage' function
Image(Image) Copying constructor. Performs deep data copy.
Image(Int32, Int32, PlainType, Int32, Optional<Region>) Constructor used for creating new images. Parameter inRoi defines which pixels should not be set with zero values. If value ftl::NIL is provided all image pixels will not set.
Image(String, Boolean)
Image(Int32, Int32, PlainType, Int32) Creates a new image with given dimensions and sets all the pixels to .

Properties

 NameTypeDescription
AreaSystem.Int32
DataSystem.IntPtr Direct access to pixel data
DepthSystem.Int32 Number of channels (standard RGB images have 3).
EmptySystem.Boolean
FlagsSystem.UInt32
FormatFil.PixelFormat
FrameFil.Box
HeightSystem.Int32
IsDataOwnSystem.Boolean
IsDisposedSystem.BooleanInherited from Fil.UnmanagedObject
IsPreviewDepthValidSystem.Boolean
IsValidSystem.Boolean
IsViewSystem.BooleanInherited from Fil.UnmanagedObject
PitchSystem.Int32
PixelSizeSystem.Int32 Size of pixels in bytes.
SizeFil.Size
TypeFil.PlainType Type of channels (standard RGB images have UINT8).
WidthSystem.Int32

Methods

 NameDescription
AddFlags(uint) ---------------------------------------------------------------------------------
CopyTo(Fil.Image)
Dispose()Inherited from Fil.UnmanagedObject
Equals(Fil.Image)
Equals(object)Inherited from System.Object
GetHashCode()Inherited from System.Object
GetPixel(int, int)
GetType()Inherited from System.Object
HasLocation(Fil.Location)
HasLocation(int, int) Helper method for range checking
HasPoint(float, float)
MakeDataOwn()
MoveTo(Fil.Image)
PtrToX(System.IntPtr)
PtrToY(System.IntPtr)
Release() Returns pointer to pixels memory which since that point will be owned externally (this image will not delete it in the destructor).
Reset()
Reset(Fil.Image, Optional<Fil.Region>)
Reset(int, int, Fil.PlainType, int, int)
Reset(int, int, Fil.PlainType, int, Optional<Fil.Region>) If the format is different then recreates the image (pixel data will be own). Typically used for (re-)creating output images in image processing functions.
Reset(int, int, int, Fil.PlainType, int, byte[]) Resets the image and copies the given to the image buffer.
Reset(int, int, Fil.PlainType, int, int, Optional<Fil.Region>)
Reset(int, int, int, Fil.PlainType, int, System.IntPtr, Optional<Fil.Region>, bool) Turns the image into a wrapper of external data (pixel data will be NOT own).
ToString()Inherited from System.Object

Remarks

See also