Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

• interface ISpinDevice
• interface ISpinnakerInterface
• namespace Spinnaker
  • struct ActionCommandResult
  • struct BMPOption
  • class BasePtr The base class of the SystemPtr ,CameraPtr ,InterfacePtr ,ProducerPtr ,ImagePtr andLoggingEventDataPtr objects.
  • struct CCMSettings
  • class Camera The camera object class.
  • class CameraBase The base class for the camera object.
  • class CameraList Used to hold a list of camera objects.
  • class CameraPtr A reference tracked pointer to a camera object.
  • class ChunkData The chunk data which contains additional information about an image.
  • struct CoordinateDependentParams Container for 3D scan calibration parameters used in stereo processing.
  • class DeviceArrivalEventHandler An event handler for capturing the device arrival event.
  • struct DeviceEventExposureEndData
  • class DeviceEventHandler A handler to device events.
  • struct DeviceEventInferenceData
  • class DeviceEventUtility Static helper functions for the device event object class.
  • class DeviceRemovalEventHandler An event handler for capturing the device removal event.
  • class EventHandler The base class for all event handler types.
  • class Exception The Exception object represents an error that is returned from the library. Overloaded operators allow comparisons against otherException objects.
  • namespace GUI
    • class CameraSelectionDlg
    • class GUIFactory
    • class PropertyGridDlg
    • class ViewerDlg
  • namespace GUI_WPF
    • class CameraSelectionWindow
    • struct DeviceInformationStruct
    • class GUIFactory
    • class ImageDrawingWindow
    • class PropertyGridWindow
  • namespace GenApi
    • struct AttachStatistics_t Delivers information about the attached chunks and nodes.
    • class AutoLock
    • class AutoPollController Auto polling controller for NodeMap .
    • class BooleanNode Interface for string properties.
    • class CChunkAdapter Connects a chunked buffer to a node map.
    • class CChunkAdapterDcam Connects a chunked DCAM buffer to a node map.
    • class CChunkAdapterGEV Connects a chunked DCAM buffer to a node map.
    • class CChunkAdapterGeneric
    • class CChunkAdapterU3V Connects a chunked U3V buffer to a node map.
    • class CChunkPort Port attachable to a chunk in a buffer.
    • class CEnumerationTRef Interface for string properties.
    • class CEventAdapter Delivers Events to ports.
    • class CEventAdapter1394 Distribute the events to the node map.
    • class CEventAdapterGEV Connects a GigE Event to a node map.
    • class CEventAdapterGeneric Connects a generic event to a node map.
    • class CEventAdapterU3V Connects a U3V Event to a node map.
    • class CEventPort Port attachable to an event.
    • class CFeatureBag Bag holding streamable features of a nodetree.
    • class CFloatPtr
    • class CLock A lock class.
    • class CLockEx
    • class CNodeCallback callback body instance for INode pointers
    • class CNodeMapFactory The node map factory is used for creating node maps from camera description files. See the following for some examples. __
      • struct NodeStatistics_t
    • class CPointer Encapsulates a GenApi pointer dealing with the dynamic_cast automatically.
    • class CPortImpl Standard implementation for a port.
    • class CPortWriteList
    • class CRegisterPortImpl Standard implementation for a port using a register based transport layer.
    • class CSelectorSet
    • class CTestPortStruct
    • class CategoryNode Interface for string properties.
    • class CommandNode Interface for string properties.
    • class Counter Definition of a simple Counter class.
    • struct DCAM_CHECKSUM
    • struct DCAM_CHUNK_TRAILER
    • class EAccessModeClass Holds conversion methods for the access mode enumeration.
    • class ECachingModeClass Holds conversion methods for the caching mode enumeration.
    • class EDisplayNotationClass Holds conversion methods for the notation type of floats.
    • class EEndianessClass Holds conversion methods for the endianess enumeration.
    • class EGenApiSchemaVersionClass helper class converting EGenApiSchemaVersion from and to string
    • class EInputDirectionClass Holds conversion methods for the notation type of floats.
    • class ENameSpaceClass Holds conversion methods for the namespace enumeration.
    • class ERepresentationClass Holds conversion methods for the representation enumeration.
    • class ESignClass Holds conversion methods for the sign enumeration.
    • class ESlopeClass Holds conversion methods for the converter formulas.
    • class EStandardNameSpaceClass Holds conversion methods for the standard namespace enumeration.
    • class EVisibilityClass Holds conversion methods for the visibility enumeration.
    • class EYesNoClass Holds conversion methods for the standard namespace enumeration.
    • class EnumEntryNode Interface for string properties.
    • class EnumNode Interface for string properties.
    • class FileProtocolAdapter Adapter between the std::iostreambuf and the SFNC Features representing the device file system.
    • class FloatNode Interface for string properties.
    • class FloatRegNode Interface for string properties.
    • class Function_NodeCallback Container for a function pointer.
    • struct GVCP_CHUNK_TRAILER header of a GVCP request packet
    • struct GVCP_EVENTDATA_REQUEST Layout of a GVCP event data request packet (Extended ID flag not set)
    • struct GVCP_EVENTDATA_REQUEST_EXTENDED_ID Layout of a GVCP event data request packet (Extended ID flag set)
    • struct GVCP_EVENT_ITEM layout of a GVCP event item (Extended ID flag not set)
    • struct GVCP_EVENT_ITEM_BASIC layout of a GVCP event item (common to all types)
    • struct GVCP_EVENT_ITEM_EXTENDED_ID layout of a GVCP event item (Extended ID flag set)
    • struct GVCP_EVENT_REQUEST Layout of a GVCP event request packet (Extended ID flag not set)
    • struct GVCP_EVENT_REQUEST_EXTENDED_ID Layout of a GVCP event request packet (Extended ID flag set)
    • struct GVCP_REQUEST_HEADER header of a GVCP request packet
    • class IDevFileStreamBase
    • class IDevFileStreamBuf
    • class IntRegNode Interface for string properties.
    • class IntegerNode Interface for string properties.
    • class Member_NodeCallback Container for a member function pointer.
    • class Node class common to all nodes
    • class NodeMap Smart pointer template for NodeMaps with create function.
    • class ODevFileStreamBase
    • class ODevFileStreamBuf
    • class PortNode Interface for value properties.
    • class PortRecorder Interface for recording write commands on a port.
    • class PortReplay Interface for replaying write commands on a port.
    • class RegisterNode Interface for string properties.
    • struct SingleChunkDataStr_t
    • struct SingleChunkData_t
    • class SpinTestCamera
    • class StringNode Interface for string properties.
    • class StringRegNode Interface for string properties.
    • struct U3V_CHUNK_TRAILER header of a GVCP request packet
    • struct U3V_COMMAND_HEADER U3V/GenCP command header.
    • struct U3V_EVENT_DATA U3V/GenCP EVENT_CMD specific command data.
    • struct U3V_EVENT_MESSAGE Entire event data message (without the variable-sized data field)
    • class ValueNode Interface for value properties.
    • class double_autovector_t Vector of doubles with reference counting.
    • class int64_autovector_t Vector of integers with reference counting.
  • struct GenDCOption
  • namespace GenICam
    • class AutoLock
    • class CGlobalLock Named global lock which can be used over process boundaries.
    • class CGlobalLockUnlocker Unlocks the global lock object on destruction.
    • class CLock A lock class.
    • class CLockEx
    • class LockableObject Instance-Lock for an object.
      • class Lock
    • struct Version_t
    • class gcstring
  • class ICameraBase The interface file for base class for the camera object.
  • class ICameraList Used to hold a list of camera objects.
  • class IChunkData The Interface file forChunkData .
  • class IDataStream
  • class IDeviceArrivalEventHandler
  • class IDeviceEventHandler
  • class IDeviceRemovalEventHandler
  • class IImage The interface file for Image .
  • class IImageEventHandler
  • class IImageList The interface file for ImageList class.
  • class IImageListEventHandler
  • class IImageProcessor The interface file for ImageProcessor class.
  • class IImageStatistics The interface file for image statistics.
  • class IInterface The interface file for Interface .
  • class IInterfaceArrivalEventHandler
  • class IInterfaceEventHandler
  • class IInterfaceList The interface file for InterfaceList class.
  • class IInterfaceRemovalEventHandler
  • class ILoggingEventHandler
  • class IPointCloud The interface file for PointCloud class.
  • class IProducer The interface file for Producer .
  • class IProducerList The interface file for ProducerList class.
  • class IScan3DParameters The Interface file forScan3DParameters data.
  • class ISpinnakerGPU The interface file for SpinnakerGPU class.
  • class ISystem The interface file for System .
  • class ISystemEventHandler
  • class Image The image object class.
  • class ImageEventHandler A handler for capturing image arrival events.
  • class ImageList Used to hold a list of image objects.
  • class ImageListEventHandler A handler for capturing image list arrival events.
  • struct ImagePixel
  • class ImageProcessor Image post processing class for converting a source image to another pixel format.
  • class ImagePtr A reference tracked pointer to an image object. When the ImagePtr goes out of scope, it will trigger an auto release of the image from the stream.
  • class ImageStatistics Represents image statistics for an image.
  • class ImageUtility Static helper functions for the image object class.
  • class ImageUtilityCCM Static function to create color corrected images from an image object.
  • class ImageUtilityHeatmap Static functions to create heatmap images from image objects of pixel format Mono8 and Mono16.
  • class ImageUtilityPolarization Static functions to create polarization images from image objects of pixel format Polarized8 and BayerRGPolarized8.
  • class ImageUtilityStereo Static helper functions for stereo related computations.
  • struct InferenceBoundingBox
  • class InferenceBoundingBoxResult An inference bounding boxes object which holds information about the detected bounding boxes.
  • struct InferenceBoxCircle
  • struct InferenceBoxRect
  • struct InferenceBoxRotatedRect
  • class Interface An interface object which holds a list of cameras.
  • class InterfaceArrivalEventHandler An event handler for capturing the interface arrival event. Note that only GEV interface arrivals are currently handled.
  • class InterfaceEventHandler A handler to device arrival and removal events on all interfaces.
  • class InterfaceList A list of the available interfaces on the system.
  • class InterfacePtr A reference tracked pointer to the interface object.
  • class InterfaceRemovalEventHandler An event handler for capturing the interface removal event. Note that only GEV interface removals are currently handled.
  • struct JPEGOption
  • struct JPG2Option
  • struct LibraryVersion
  • class LoggingEventData The LoggingEventData object.
  • class LoggingEventDataPtr A reference tracked pointer to the LoggingEvent object.
  • class LoggingEventHandler An event handler for capturing the device logging event.
  • struct PGMOption
  • struct PNGOption
  • struct PPMOption
  • class PointCloud The PointCloud object class.
  • struct PointCloudParameters
  • class Producer The producer object is used to retrieve the list of interfaces and cameras available.
  • class ProducerList A list of the available producers on the system.
  • class ProducerPtr A reference tracked pointer to the producer object.
  • namespace Relay
    • struct ConnectParameters
    • class ISpinnakerRelay The interface file for SpinnakerRelay class.
    • struct RelayStatistics
    • class SpinnakerRelay Spinnaker __Relay class that enables forwarding ofSpinnaker images from source to destination PC.
  • struct SIOption
  • class Scan3DParameters
  • class SpinnakerGPU Provides the functionality for the user to post process images on an NVIDIA GPU device.
  • struct Stereo3DPoint
  • struct StereoCameraParameters
  • class System The system object is used to retrieve the list of interfaces and cameras available.
  • class SystemEventHandler A handler to interface arrival and removal events on the system. Note that only GEV interface arrivals and removals are currently handled.
  • class SystemPtr A reference tracked pointer to a system object.
  • struct TIFFOption
  • class TransportLayerDevice Part of the QuickSpin API to provide access to camera information without having to first initialize the camera.
  • class TransportLayerInterface Part of the QuickSpin API to provide access to camera information without having to first initialize the camera.
  • class TransportLayerStream Part of the QuickSpin API to provide access to camera information without having to first initialize the camera.
  • class TransportLayerSystem Part of the QuickSpin API to provide access to camera information without having to first initialize the camera.
  • namespace Video
    • struct AVIOption
    • struct H264Option
    • struct MJPGOption
    • class SpinVideo Provides the functionality for the user to record images to an AVI/MP4 file.
    • class VideoWriter
• namespace std