org.bytedeco.flycapture.FlyCapture2

Class FC2Config

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.flycapture.FlyCapture2.FC2Config

All Implemented Interfaces:

AutoCloseable

@Namespace(value="FlyCapture2")
 @NoOffset
 @Properties(inherit=FlyCapture2.class)
public class FC2Config
extends Pointer

Configuration for a camera. These options are options that are generally should be set before starting isochronous transfer.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
FC2Config()
FC2Config(long size) Native array allocator.
FC2Config(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
int	asyncBusSpeed() Asynchronous bus speed.
FC2Config	asyncBusSpeed(int setter)
int	bandwidthAllocation() Bandwidth allocation flag that tells the camera the bandwidth allocation strategy to employ.
FC2Config	bandwidthAllocation(int setter)
int	grabMode() Grab mode for the camera.
FC2Config	grabMode(int setter)
int	grabTimeout() Time in milliseconds that RetrieveBuffer() and WaitForBufferEvent() will wait for an image before timing out and returning.
FC2Config	grabTimeout(int setter)
boolean	highPerformanceRetrieveBuffer() This parameter enables RetrieveBuffer to run in high performance mode.
FC2Config	highPerformanceRetrieveBuffer(boolean setter)
int	isochBusSpeed() Isochronous bus speed.
FC2Config	isochBusSpeed(int setter)
int	minNumImageNotifications() Minimum number of notifications needed for the current image settings on the camera.
FC2Config	minNumImageNotifications(int setter)
int	numBuffers() Number of buffers used by the FlyCapture2 library to grab images.
FC2Config	numBuffers(int setter)
int	numImageNotifications() Number of notifications per image.
FC2Config	numImageNotifications(int setter)
FC2Config	position(long position)
int	registerTimeout() Register read/write timeout value, in microseconds.
FC2Config	registerTimeout(int setter)
int	registerTimeoutRetries() Number of retries to perform when a register read/write timeout is received by the library.
FC2Config	registerTimeoutRetries(int setter)
IntPointer	reserved()
int	reserved(int i) Reserved for future use
FC2Config	reserved(int i, int setter)

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, hashCode, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, toString, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FC2Config

public FC2Config(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

FC2Config

public FC2Config(long size)

Native array allocator. Access with Pointer.position(long).

FC2Config

public FC2Config()

Method Detail

position

public FC2Config position(long position)

Overrides:

position in class Pointer

numBuffers

@Cast(value="unsigned int")
public int numBuffers()

Number of buffers used by the FlyCapture2 library to grab images.

numBuffers

public FC2Config numBuffers(int setter)

numImageNotifications

@Cast(value="unsigned int")
public int numImageNotifications()

Number of notifications per image. This value should only be set after the image settings to be used is set to the camera. The default number of notifications is 1. There are 4 general scenarios: - 1 notification - End of image - 2 notifications - After first packet and end of image - 3 notifications - After first packet, middle of image, end of image - x notifications - After first packet, (x -2) spread evenly, end of image Specifying zero for the number of notifications will be ignored (the current value will not be modified). Note that the event numbers start at 0. Ex. when 3 notifications are used, the three events will be 0, 1 and 2.

numImageNotifications

public FC2Config numImageNotifications(int setter)

minNumImageNotifications

@Cast(value="unsigned int")
public int minNumImageNotifications()

Minimum number of notifications needed for the current image settings on the camera. Read-only value.

minNumImageNotifications

public FC2Config minNumImageNotifications(int setter)

grabTimeout

public int grabTimeout()

Time in milliseconds that RetrieveBuffer() and WaitForBufferEvent() will wait for an image before timing out and returning.

grabTimeout

public FC2Config grabTimeout(int setter)

grabMode

@Cast(value="FlyCapture2::GrabMode")
public int grabMode()

Grab mode for the camera. The default is DROP_FRAMES.

grabMode

public FC2Config grabMode(int setter)

highPerformanceRetrieveBuffer

@Cast(value="bool")
public boolean highPerformanceRetrieveBuffer()

This parameter enables RetrieveBuffer to run in high performance mode. This means that any interaction with the camera, other then grabbing the image is disabled. Currently Retrieve buffer reads registers on the camera to determine which embedded image information settings have been enabled, and it reads what the bayer tile is currently set to. When High Performance mode is on, these reads are disabled. This means that any changes to the Bayer Tile or to the Embedded image info after StartCapture() will not be tracked when made using direct register writes. If the corresponding SetEmbededImageInfo() and GetEmbededImageInfo() calls are used then the changes will be appropriately reflected. This also means that changes to embedded image info from other processes will not be updated either.

highPerformanceRetrieveBuffer

public FC2Config highPerformanceRetrieveBuffer(boolean setter)

isochBusSpeed

@Cast(value="FlyCapture2::BusSpeed")
public int isochBusSpeed()

Isochronous bus speed.

isochBusSpeed

public FC2Config isochBusSpeed(int setter)

asyncBusSpeed

@Cast(value="FlyCapture2::BusSpeed")
public int asyncBusSpeed()

Asynchronous bus speed.

asyncBusSpeed

public FC2Config asyncBusSpeed(int setter)

bandwidthAllocation

@Cast(value="FlyCapture2::BandwidthAllocation")
public int bandwidthAllocation()

Bandwidth allocation flag that tells the camera the bandwidth allocation strategy to employ.

bandwidthAllocation

public FC2Config bandwidthAllocation(int setter)

registerTimeoutRetries

@Cast(value="unsigned int")
public int registerTimeoutRetries()

Number of retries to perform when a register read/write timeout is received by the library. The default value is 0.

registerTimeoutRetries

public FC2Config registerTimeoutRetries(int setter)

registerTimeout

@Cast(value="unsigned int")
public int registerTimeout()

Register read/write timeout value, in microseconds. The default value is dependent on the interface type.

registerTimeout

public FC2Config registerTimeout(int setter)

reserved

@Cast(value="unsigned int")
public int reserved(int i)

Reserved for future use

reserved

public FC2Config reserved(int i,
                          int setter)

reserved

@MemberGetter
 @Cast(value="unsigned int*")
public IntPointer reserved()