Class IPvImage
Generic image interface.
Implements
Inherited Members
Namespace: eBUSDotNet
Assembly: eBUSDotNet.dll
Syntax
public class IPvImage : IDisposable
Fields
View SourceswigCMemOwn
Determines who is responsible for deleting the underlying C++ object.
Declaration
protected bool swigCMemOwn
Field Value
| Type | Description |
|---|---|
| bool |
Properties
View SourceBlockID
Block ID of IPvImage.
Declaration
public virtual ulong BlockID { get; }
Property Value
| Type | Description |
|---|---|
| ulong |
Height
Height of IPvImage.
Declaration
public virtual uint Height { get; }
Property Value
| Type | Description |
|---|---|
| uint |
ImageSize
Image size of IPvImage in bytes.
Declaration
public virtual uint ImageSize { get; }
Property Value
| Type | Description |
|---|---|
| uint |
PaddingX
Gets the horizontal image padding, in bytes.
Declaration
public virtual ushort PaddingX { get; }
Property Value
| Type | Description |
|---|---|
| ushort |
Remarks
The number of bytes at the end of an image's line that contain meaningless data. Images lines could be grabbed in increments of, let's say, 32 bytes. For an image 511 bytes across, the device adds a meaningless byte to make the line total 512 bytes (divisible by 32). In this case, the paddingX value would be 1 (byte).
Other GigE Vision devices may have different requirements on line length. Divisible by 4, 8, 16, etc. or no specific limitations or requirements.
PaddingY
Gets the vertical image padding, in bytes.
Declaration
public virtual ushort PaddingY { get; }
Property Value
| Type | Description |
|---|---|
| ushort |
Remarks
Additional bytes appended at the end of an image. See PaddingX for more information.
PixelType
Pixel type of IPvImage.
Declaration
public virtual PvPixelType PixelType { get; }
Property Value
| Type | Description |
|---|---|
| PvPixelType |
ReceptionTime
Reception time of IPvImage.
Declaration
public virtual ulong ReceptionTime { get; }
Property Value
| Type | Description |
|---|---|
| ulong |
Timestamp
Timestamp of IPvImage.
Declaration
public virtual ulong Timestamp { get; }
Property Value
| Type | Description |
|---|---|
| ulong |
Width
Width of IPvImage.
Declaration
public virtual uint Width { get; }
Property Value
| Type | Description |
|---|---|
| uint |
Methods
View SourceDispose()
Dispose.
Declaration
public void Dispose()
Dispose(bool)
Dispose
Declaration
protected virtual void Dispose(bool disposing)
Parameters
| Type | Name | Description |
|---|---|---|
| bool | disposing |
~IPvImage()
Destructor.
Declaration
protected ~IPvImage()
GetDataPointer()
Get the image's data pointer.
Declaration
public virtual byte* GetDataPointer()
Returns
| Type | Description |
|---|---|
| byte* | A pointer to the memory pointer. |
GetOffsetX()
Get the image's horizontal offset.
Declaration
public virtual uint GetOffsetX()
Returns
| Type | Description |
|---|---|
| uint | The image's horizontal offset, in pixels. |
GetOffsetY()
Get the image's vertical offset.
Declaration
public virtual uint GetOffsetY()
Returns
| Type | Description |
|---|---|
| uint | The image's vertical offset, in pixels. |