dvcBufStruct Struct Reference

#include "dvcdefs.h"

List of all members.

Public Attributes
int	nBuffers
int	nHeight
int	nWidth
int	nXOffset
int	nYOffset
PUSHORT *	pBuffers
PBYTE	pBufferStatus
ImageMetaDataP	pMeta

---

Detailed Description

structure for fast streaming with user-defined ring buffers. The dvcBufStruct encapsulates an array of buffers with corresponding meta structures and state flags. This image array can be filled once or continuously as a ring buffer.

See also:

dvcAllocateUserBuffers(), dvcSetUserBuffers(), dvcReleaseUserBuffers().

pBufferStatus states

• DVC_BUFFER_IDLE buffer idle
  
• DVC_BUFFER_BUSY buffer currently being filled
  
• DVC_BUFFER_FULL buffer filled
  
• DVC_BUFFER_OVERFLOW buffer not filled while waiting on the application
  
• DVC_BUFFER_ERROR error reading or writing the buffer
  

---

Member Data Documentation

int dvcBufStruct::nBuffers

number of buffers to be allocated

int dvcBufStruct::nHeight

number of rows to transfer if less than each buffer's height. All buffers must be the same size.

int dvcBufStruct::nWidth

number of pixels/row to transfer if less than each buffer's width. All buffers must be the same size.

int dvcBufStruct::nXOffset

Offset in pixels to the first pixel per row.

int dvcBufStruct::nYOffset

Offset in rows to the row to transfer.

PUSHORT* dvcBufStruct::pBuffers

Array of pointers to writable image buffers

PBYTE dvcBufStruct::pBufferStatus

Array of pointers to each buffer's status

ImageMetaDataP dvcBufStruct::pMeta

Array of pointers to meta data structures, one per buffer

---

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

• dvcdefs.h

---