A single linear plane of component data. More...
Inherits INativeHandle.
Public Member Functions | |
void | Dispose () |
IDisposable implementation. More... | |
IntPtr | GetIncrement (int dimension) |
Gets the number of elements at the given dimension . More... | |
long | GetLength (int dimension) |
Gets the number of elements at the given dimension . More... | |
Static Public Member Functions | |
static Plane | FromHandle (IntPtr handle, ShareObject doShare) |
Create a plane object from a handle . More... | |
static Plane | FromImagePlane (ImagePlane imagePlane, PlaneRole role) |
Creates a plane from an image plane. More... | |
Protected Member Functions | |
Plane (IntPtr handle) | |
Create a plane object from a handle . More... | |
Plane (IntPtr handle, IntPtr sharedImagePlaneHandle) | |
Constructor. More... | |
virtual void | Dispose (bool disposing) |
IDispose helper function. More... | |
Properties | |
IntPtr | Handle [get] |
Native CVB buffer handle. More... | |
bool | IsDisposed [get] |
Tests if the native handle has already been disposed. | |
PlaneRole | Role [get] |
Gets the PlaneRole of this plane. | |
DataType | DataType [get] |
Gets the CVB DataType for this plane. | |
IntPtr | BasePtr [get] |
Get the base address of the plane's memory. | |
int | Rank [get] |
Get the rank of the plane. More... | |
Properties inherited from INativeHandle | |
IntPtr | Handle [get] |
The native handle of the object. | |
bool | IsDisposed [get] |
Possibility to check whether the object has already been disposed of. | |
Events | |
NativeHandleEventDelegate | ObjectDisposing |
Raised when this object is about to be disposed via the IDisposable.Dispose method. More... | |
Events inherited from INativeHandle | |
NativeHandleEventDelegate | ObjectDisposing |
Raised when this object is about to be disposed via the IDisposable.Dispose method. More... | |
A single linear plane of component data.
|
protected |
Create a plane object from a handle .
handle | Native IBuffer handle. |
|
protected |
Constructor.
handle | Native IBuffer handle. |
sharedImagePlaneHandle | Native handle of the ImagePlane the handle was created with. |
void Dispose | ( | ) |
IDisposable implementation.
Call this method to release the resources allocated by this buffer immediately. Remember that after calling Dispose, any subsequent access to references to this buffer will result in an ObjectDisposedException.
|
protectedvirtual |
IDispose helper function.
disposing | true when called via IDisposable.Dispose, false when called by the finalizer. |
|
static |
Create a plane object from a handle .
handle | Native IBuffer handle. |
doShare | ShareObject.Yes if handle should be shared. |
|
static |
Creates a plane from an image plane.
imagePlane | The image plane. |
role | The role of this plane. |
ArgumentException | When imagePlane does not support linear access. |
CvbException | When an error during plane creation occurs. |
IntPtr GetIncrement | ( | int | dimension | ) |
Gets the number of elements at the given dimension .
dimension | Dimension to get length for; e.g. 0 for x-values. |
long GetLength | ( | int | dimension | ) |
Gets the number of elements at the given dimension .
dimension | Dimension to get length for; e.g. 0 for x-values. |
|
get |
Native CVB buffer handle.
It is normally not necessary to work with this handle in CVB.Net. Note that using this handle in connection with the legacy CVB managed wrappers may actually be disruptive to your application.
Implements INativeHandle.
|
get |
Get the rank of the plane.
The rank is the number of dimensions in the plane. E.g. 2 for an image.
NativeHandleEventDelegate ObjectDisposing |
Raised when this object is about to be disposed via the IDisposable.Dispose method.
This event is raised right before this object is disposed. The dispose itself cannot be canceled.