A 2D frame captured by a Zivid camera
Inheritance HierarchySystemObject
Zivid.NETFrame2D
Namespace:
Zivid.NET
Assembly:
ZividCoreNET (in ZividCoreNET.dll) Version: 0.0.0.0
Syntaxpublic class Frame2D : IDisposable
Public Class Frame2D
Implements IDisposable
public ref class Frame2D : IDisposable
The Frame2D type exposes the following members.
Constructors
| Name | Description |
---|
 | Frame2D | Initializes a new instance of the Frame2D class |
Top
Properties
| Name | Description |
---|
 | CameraInfo | Get information about the camera used to capture the frame |
 | Info | Get information collected at the time of the capture |
 | Settings | Get the settings used to capture this frame |
 | State | Get the camera state data at the time of the capture |
Top
Methods
| Name | Description |
---|
 | Dispose | Releases all resources used by the Frame2D |
 | ImageBGRA | Get the associated 2D color image in 8-bit BGRA format |
 | ImageRGBA | Get the associated 2D color image in 8-bit RGBA format |
 | ImageSRGB | Get the associated 2D color image in the sRGB color space in 8-bit RGBA format |
Top
Remarks
Contains a 2D image as well as metadata, settings and state of the
API at the time of capture.
Note that if this Frame2D object was returned from a call to `Camera::Capture(Settings^)` or
`Camera::Capture(Settings2D^)`, then there may still be remaining data transfer and processing going on
in the background. When you call a method on Frame2D that requires the capture to be finished,
for example
ImageRGBA, the method will block until the image is available.
See Also