PfncBuffer Class Reference

A Buffer that has GenICam layout information available. More...

Inherits Buffer, and IPfncBuffer.

Public Member Functions
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...
Public Member Functions inherited from Buffer
void	Dispose ()
	IDisposable implementation. More...
long	GetLength (int dimension)
	Gets the number of elements at the given dimension . More...
IntPtr	GetIncrement (int dimension)
	Get the offset to the next element in this buffer in bytes. More...

Static Public Member Functions
static new PfncBuffer	FromHandle (IntPtr handle, ShareObject doShare)
	Create a buffer object from a handle . More...
Static Public Member Functions inherited from Buffer
static Buffer	FromHandle (IntPtr handle, ShareObject doShare)
	Create a buffer object from a handle . More...

Protected Member Functions
	PfncBuffer (IntPtr handle)
	Create a buffer object from a handle . More...
Protected Member Functions inherited from Buffer
	Buffer (IntPtr handle)
	Create a buffer object from a handle . More...
virtual void	Dispose (bool disposing)
	IDispose helper function. More...

Properties
PfncFormat	PfncFormat [get]
	Get the PFNC format of the pixel data stored in this buffer.
int	Rank [get]
	Get the rank of the plane. More...
Properties inherited from Buffer
IntPtr	Handle [get]
	Native CVB buffer handle. More...
bool	IsDisposed [get]
	Tests if the native handle has already been disposed.
IntPtr	BasePtr [get]
	Get the base address of the buffer's memory.
long	Size [get]
	Get the valid size in bytes of the buffer's memory.
long	Capacity [get]
	Get the allocated size in bytes of the buffer's memory.
Properties inherited from IBuffer
IntPtr	BasePtr [get]
	Get the base address of the buffer's memory.
long	Size [get]
	Get the valid size in bytes of the buffer's memory.
long	Capacity [get]
	Get the allocated size in bytes of the buffer's memory.
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.
Properties inherited from IPfncBuffer
PfncFormat	PfncFormat [get]
	Get the PFNC format of the pixel data stored in this buffer.
int	Rank [get]
	Get the rank of the plane. More...

Additional Inherited Members
Events inherited from Buffer
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...

Detailed Description

A Buffer that has GenICam layout information available.

Constructor & Destructor Documentation

PfncBuffer()

PfncBuffer ( IntPtr  handle )

protected

Create a buffer object from a handle .

Parameters

handle

Native IPfncBuffer handle.

Member Function Documentation

FromHandle()

static new PfncBuffer FromHandle ( IntPtr  handle, ShareObject  doShare  )

static

Create a buffer object from a handle .

Parameters

handle	Native IPfncBuffer handle.
doShare	ShareObject.Yes if handle should be shared.

Returns

Newly created wrapper object.

GetIncrement()

IntPtr GetIncrement

(

int

dimension

)

Gets the number of elements at the given dimension .

Parameters

dimension

Dimension to get length for; e.g. 0 for x-values.

Returns

The number of elements in the given dimension .

Implements IPfncBuffer.

GetLength()

long GetLength

(

int

dimension

)

Gets the number of elements at the given dimension .

Parameters

dimension

Dimension to get length for; e.g. 0 for x-values.

Returns

The number of elements in the given dimension .

Implements IPfncBuffer.

Property Documentation

Rank

int Rank

get

Get the rank of the plane.

The rank is the number of dimensions in the plane. E.g. 2 for an image.

Implements IPfncBuffer.