IImageView Interface Reference

Inheritance diagram for IImageView:

Properties
IntPtr	Data [get]
	Returns the pointer to the beginning of the image buffer.
nuint	SizeInBytes [get]
	Returns the total size number of bytes occupied by the image in the buffer.
nuint	LineStartOffset [get]
	The byte offset to the first pixel of a line.
PixelFormat	PixelFormat [get]
	Returns the pixel format used by the image.
PixelFormatInfo	PixelFormatInfo [get]
	Returns a helper object describing the pixel format in detail. The PixelFormatInfo class provides methods to inspect the layout, size, channel count, channel order, and other attributes of the format returned by IImageView.PixelFormat.
Size	Size [get]
	Returns the overall size of the image (width × height).
uint	Width [get]
	Returns the width of the image in pixels.
uint	Height [get]
	Returns the height of the image in pixels.
uint	BitsPerPixel [get]
	Returns the number of bits that each pixel occupies.
nuint	BytesPerLine [get]
	Returns the number of bytes in a single image row.
Metadata	Metadata [get]
	Metadata associated with the image.

Detailed Description

Interface for viewing image pixel data from arbitrary sources.

This interface defines a standard way to access image properties and raw pixel data, enabling interoperability with different image processing libraries or backends. The interface does not own the image memory. Lifetime management must be handled externally.

Since

IDSImaging.Peak.Common 1.3

Definition at line 20 of file IImageView.cs.

Property Documentation

BitsPerPixel

uint BitsPerPixel

get

Returns the number of bits that each pixel occupies.

Note that this can also be queried with PixelFormatInfo but is provided for convenience here.

Implemented in ImageViewBase.

Definition at line 74 of file IImageView.cs.

BytesPerLine

nuint BytesPerLine

get

Returns the number of bytes in a single image row.

Implemented in ImageViewBase.

Definition at line 79 of file IImageView.cs.

Data

IntPtr Data

get

Returns the pointer to the beginning of the image buffer.

Implemented in ImageViewBase.

Definition at line 25 of file IImageView.cs.

Height

uint Height

get

Returns the height of the image in pixels.

This is a convenience property and effectively forwards to Size.Height.

Implemented in ImageViewBase.

Definition at line 66 of file IImageView.cs.

LineStartOffset

nuint LineStartOffset

get

The byte offset to the first pixel of a line.

Implemented in ImageViewBase.

Definition at line 35 of file IImageView.cs.

Metadata

Metadata Metadata

get

Metadata associated with the image.

Implemented in ImageViewBase.

Definition at line 84 of file IImageView.cs.

PixelFormat

PixelFormat PixelFormat

get

Returns the pixel format used by the image.

Implemented in ImageViewBase.

Definition at line 40 of file IImageView.cs.

PixelFormatInfo

PixelFormatInfo PixelFormatInfo

get

Returns a helper object describing the pixel format in detail. The PixelFormatInfo class provides methods to inspect the layout, size, channel count, channel order, and other attributes of the format returned by IImageView.PixelFormat.

Implemented in ImageViewBase.

Definition at line 48 of file IImageView.cs.

Size

Size Size

get

Returns the overall size of the image (width × height).

Implemented in ImageViewBase.

Definition at line 53 of file IImageView.cs.

SizeInBytes

nuint SizeInBytes

get

Returns the total size number of bytes occupied by the image in the buffer.

Implemented in ImageViewBase.

Definition at line 30 of file IImageView.cs.

Width

uint Width

get

Returns the width of the image in pixels.

This is a convenience property and effectively forwards to Size.Width.

Implemented in ImageViewBase.

Definition at line 60 of file IImageView.cs.