ImageViewBase Class Reference

Inheritance diagram for ImageViewBase:

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.
virtual 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).
virtual uint	Width [get]
	Returns the width of the image in pixels.This is a convenience property and effectively forwards to Size.Width.
virtual uint	Height [get]
	Returns the height of the image in pixels.This is a convenience property and effectively forwards to Size.Height.
virtual 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.
nuint	BytesPerLine [get]
	Returns the number of bytes in a single image row.
Metadata	Metadata [get]
	Metadata associated with the image.

Detailed Description

Abstract base class for IImageView implementations, providing common shared logic.

This base class simplifies the creation of image views by providing automatic implementations for derived properties such as Width, Height, and BitsPerPixel.

Since

IDSImaging.Peak.Common 1.3

Property Documentation

BitsPerPixel

virtual 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.

Implements IImageView.

BytesPerLine

nuint BytesPerLine

getabstract

Returns the number of bytes in a single image row.

Implements IImageView.

Data

IntPtr Data

getabstract

Returns the pointer to the beginning of the image buffer.

Implements IImageView.

Height

virtual uint Height

get

Returns the height of the image in pixels.This is a convenience property and effectively forwards to Size.Height.

Implements IImageView.

LineStartOffset

nuint LineStartOffset

getabstract

The byte offset to the first pixel of a line.

Implements IImageView.

Metadata

Metadata Metadata

getabstract

Metadata associated with the image.

Implements IImageView.

PixelFormat

virtual PixelFormat PixelFormat

get

Returns the pixel format used by the image.

Implements IImageView.

PixelFormatInfo

PixelFormatInfo PixelFormatInfo

getabstract

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.

Implements IImageView.

Size

Size Size

getabstract

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

Implements IImageView.

SizeInBytes

nuint SizeInBytes

getabstract

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

Implements IImageView.

Width

virtual uint Width

get

Returns the width of the image in pixels.This is a convenience property and effectively forwards to Size.Width.

Implements IImageView.