IImage Interface#

Provides access to image properties and image buffer.

Syntax#

C#

public interface IImage

VB

Public Interface IImage

The IImage type exposes the following members.

Properties#

	Name	Description
	Height	The height of the image in pixels, i.e. the number of image rows.
	IsValid	Indicates if the image is valid.
	Orientation	The vertical orientation of the pixel data stored in memory.
	PaddingX	The number of data bytes added to the end of each row.
	PixelData	The pixel data buffer. The type of the object containing the buffer depends on the class implementing this interface. The pixel data buffer is provided as a byte array if no custom buffer factory is used. With a custom buffer factory the provided type is dependent on its specific implementation.
	PixelDataPointer	The pointer to the pixel data buffer.
	PixelTypeValue	The pixel type.
	Width	The width of the image in pixels, i.e. the number of image columns.

Extension Methods#

	Name	Description
	ComputeStride	Computes the stride of the image in bytes. Returns null if the stride cannot be computed. (Defined by IImageExtensions.)
	Display	Uses the ImageWindow method DisplayImage(Int32, IImage) to display the image. (Defined by IImageExtensions.)

IImage.Height Property#

The height of the image in pixels, i.e. the number of image rows.

Syntax#

C#

int Height { get; }

VB

ReadOnly Property Height As Integer
    Get

Property Value#

Type: Int32

Remarks#

Error Safety: Does not throw exceptions.

IImage.IsValid Property#

Indicates if the image is valid.

Syntax#

C#

bool IsValid { get; }

VB

ReadOnly Property IsValid As Boolean
    Get

Return Value#

Type: Boolean
Returns true if the image is valid.

Remarks#

IImage.Orientation Property#

The vertical orientation of the pixel data stored in memory.

Syntax#

C#

ImageOrientation Orientation { get; }

VB

ReadOnly Property Orientation As ImageOrientation
    Get

Property Value#

Type: ImageOrientation

Remarks#

Error Safety: Does not throw exceptions.

IImage.PaddingX Property#

The number of data bytes added to the end of each row.

Syntax#

C#

int PaddingX { get; }

VB

ReadOnly Property PaddingX As Integer
    Get

Property Value#

Type: Int32

Remarks#

Error Safety: Does not throw exceptions.

IImage.PixelData Property#

The pixel data buffer. The type of the object containing the buffer depends on the class implementing this interface. The pixel data buffer is provided as a byte array if no custom buffer factory is used. With a custom buffer factory the provided type is dependent on its specific implementation.

Syntax#

C#

Object PixelData { get; }

VB

ReadOnly Property PixelData As Object
    Get

Property Value#

Type: Object

Remarks#

Error Safety: Does not throw exceptions.

IImage.PixelDataPointer Property#

The pointer to the pixel data buffer.

Syntax#

C#

IntPtr PixelDataPointer { get; }

VB

ReadOnly Property PixelDataPointer As IntPtr
    Get

Property Value#

Type: IntPtr

Remarks#

Error Safety: Does not throw exceptions.

IImage.PixelTypeValue Property#

The pixel type.

Syntax#

C#

PixelType PixelTypeValue { get; }

VB

ReadOnly Property PixelTypeValue As PixelType
    Get

Property Value#

Type: PixelType

Remarks#

Error Safety: Does not throw exceptions.

IImage.Width Property#

The width of the image in pixels, i.e. the number of image columns.

Syntax#

C#

int Width { get; }

VB

ReadOnly Property Width As Integer
    Get

Property Value#

Type: Int32

Remarks#

Error Safety: Does not throw exceptions.