BitFlow.NET
Source code documentation of the BitFlow .NET interface.
BufferAcquisition.BufferInfo Class Reference

Used to bridge the gap between managed C++ and C# for returning the buffer info for the WaitForFrameDone methods. More...

Public Member Functions

override bool Equals (Object o)
 
override int GetHashCode ()
 
 BufferInfo ()
 

Static Public Member Functions

static operator BufferInfo (ManBufferInfo info)
 
static bool operator== (BufferInfo l, BufferInfo r)
 
static bool operator!= (BufferInfo l, BufferInfo r)
 

Properties

IntPtr BufData [get]
 The raw buffer data. During a circular acquisition, the buffer data may be overwritten. More...
 
uint FrameCount [get]
 The frame count of this buffer within the overall acquisition. More...
 
BFTime TimeStamp [get]
 The system or board time at the instant of frame capture. More...
 
uint BufferNumber [get]
 The index of this buffer in the buffer array. More...
 
uint NumLinesAcquired [get]
 The number of lines acquired. Usually equals the buffer y-size/height. More...
 
uint NumItemsOnQueue [get]
 The number of buffers still waiting on the queue. More...
 
uint CXPSrcTag [get]
 The CXP frame buffer soruce tag. More...
 
uint CXPXOffset [get]
 The CXP frame x-offset. More...
 
uint CXPYOffset [get]
 The CXP frame y-offset. More...
 
IntPtr m_BufData [get]
 Retained for legacy purposes. Please use BufData instead. More...
 
uint m_FrameCount [get]
 Retained for legacy purposes. Please use FrameCount instead. More...
 
BFTimeManaged m_TimeStamp [get]
 Retained for legacy purposes. Please use TimeStamp instead. More...
 
uint m_BufferNumber [get]
 Retained for legacy purposes. Please use BufferNumber instead. More...
 
uint m_NumLinesAcquired [get]
 Retained for legacy purposes. Please use NumLinesAcquired instead. More...
 
uint m_NumItemsOnQueue [get]
 Retained for legacy purposes. Please use NumItemsOnQueue instead. More...
 

Detailed Description

Used to bridge the gap between managed C++ and C# for returning the buffer info for the WaitForFrameDone methods.

Constructor & Destructor Documentation

◆ BufferInfo()

BufferAcquisition.BufferInfo.BufferInfo ( )

Member Function Documentation

◆ Equals()

override bool BufferAcquisition.BufferInfo.Equals ( Object  o)

◆ GetHashCode()

override int BufferAcquisition.BufferInfo.GetHashCode ( )

◆ operator BufferInfo()

static BufferAcquisition.BufferInfo.operator BufferInfo ( ManBufferInfo  info)
explicitstatic

◆ operator!=()

static bool BufferAcquisition.BufferInfo.operator!= ( BufferInfo  l,
BufferInfo  r 
)
static

◆ operator==()

static bool BufferAcquisition.BufferInfo.operator== ( BufferInfo  l,
BufferInfo  r 
)
static

Property Documentation

◆ BufData

IntPtr BufferAcquisition.BufferInfo.BufData
get

The raw buffer data. During a circular acquisition, the buffer data may be overwritten.

◆ BufferNumber

uint BufferAcquisition.BufferInfo.BufferNumber
get

The index of this buffer in the buffer array.

◆ CXPSrcTag

uint BufferAcquisition.BufferInfo.CXPSrcTag
get

The CXP frame buffer soruce tag.

◆ CXPXOffset

uint BufferAcquisition.BufferInfo.CXPXOffset
get

The CXP frame x-offset.

◆ CXPYOffset

uint BufferAcquisition.BufferInfo.CXPYOffset
get

The CXP frame y-offset.

◆ FrameCount

uint BufferAcquisition.BufferInfo.FrameCount
get

The frame count of this buffer within the overall acquisition.

◆ m_BufData

IntPtr BufferAcquisition.BufferInfo.m_BufData
get

Retained for legacy purposes. Please use BufData instead.

◆ m_BufferNumber

uint BufferAcquisition.BufferInfo.m_BufferNumber
get

Retained for legacy purposes. Please use BufferNumber instead.

◆ m_FrameCount

uint BufferAcquisition.BufferInfo.m_FrameCount
get

Retained for legacy purposes. Please use FrameCount instead.

◆ m_NumItemsOnQueue

uint BufferAcquisition.BufferInfo.m_NumItemsOnQueue
get

Retained for legacy purposes. Please use NumItemsOnQueue instead.

◆ m_NumLinesAcquired

uint BufferAcquisition.BufferInfo.m_NumLinesAcquired
get

Retained for legacy purposes. Please use NumLinesAcquired instead.

◆ m_TimeStamp

BFTimeManaged BufferAcquisition.BufferInfo.m_TimeStamp
get

Retained for legacy purposes. Please use TimeStamp instead.

◆ NumItemsOnQueue

uint BufferAcquisition.BufferInfo.NumItemsOnQueue
get

The number of buffers still waiting on the queue.

◆ NumLinesAcquired

uint BufferAcquisition.BufferInfo.NumLinesAcquired
get

The number of lines acquired. Usually equals the buffer y-size/height.

◆ TimeStamp

BFTime BufferAcquisition.BufferInfo.TimeStamp
get

The system or board time at the instant of frame capture.


The documentation for this class was generated from the following file: