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

Image Class

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

	Constructor	Description
	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 atl::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

	Name	Type	Description
	Area	System.Int32
	Data	System.IntPtr	Direct access to pixel data
	Depth	System.Int32	Number of channels (standard RGB images have 3).
	Empty	System.Boolean
	Flags	System.UInt32
	Format	Avl.PixelFormat
	Frame	Avl.Box
	Height	System.Int32
	IsDataOwn	System.Boolean
	IsDisposed	System.Boolean	Inherited from Avl.UnmanagedObject
	IsPreviewDepthValid	System.Boolean
	IsValid	System.Boolean
	IsView	System.Boolean	Inherited from Avl.UnmanagedObject
	Pitch	System.Int32
	PixelSize	System.Int32	Size of pixels in bytes.
	Size	Avl.Size
	Type	Avl.PlainType	Type of channels (standard RGB images have UINT8).
	Width	System.Int32

Methods

	Name	Description
	AddFlags(uint)	---------------------------------------------------------------------------------
	CopyTo(Avl.Image)
	Dispose()	Inherited from Avl.UnmanagedObject
	Equals(Avl.Image)
	Equals(object)	Inherited from System.Object
	GetHashCode()	Inherited from System.Object
	GetPixel(int, int)
	GetType()	Inherited from System.Object
	HasLocation(Avl.Location)
	HasLocation(int, int)	Helper method for range checking
	HasPoint(float, float)
	MakeDataOwn()
	MoveTo(Avl.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(Avl.Image, Optional<Avl.Region>)
	Reset(int, int, Avl.PlainType, int, int)
	Reset(int, int, Avl.PlainType, int, Optional<Avl.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, Avl.PlainType, int, byte[])	Resets the image and copies the given to the image buffer.
	Reset(int, int, Avl.PlainType, int, int, Optional<Avl.Region>)
	Reset(int, int, int, Avl.PlainType, int, System.IntPtr, Optional<Avl.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

• Class Reference