Frame2D Class |
A 2D frame captured by a Zivid camera
Inheritance HierarchySystemObject
Zivid.NETFrame2D
Zivid.NETFrame2D
Namespace: Zivid.NET
Assembly: ZividCoreNET (in ZividCoreNET.dll) Version: 2.16.0.0
SyntaxThe Frame2D type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | CameraInfo | Get information about the camera used to capture the frame |
| Info | Get information collected at the time of the capture |
| IsDisposed | Check if the frame is disposed |
| Settings | Get the settings used to capture this frame |
| State | Get the camera state data at the time of the capture |
Methods| Name | Description | |
|---|---|---|
 | Clone |
Returns a clone of the frame. The clone will include a copy of all of the frame data.
|
| Dispose | Releases all resources used by the Frame2D |
| ImageBGRA | Get the associated 2D color image in 8-bit BGRA format |
| ImageBGRA_SRGB | Get the associated 2D color image in the sRGB color space in 8-bit BGRA format |
| ImageRGBA | Get the associated 2D color image in 8-bit RGBA format |
| ImageRGBA_SRGB | Get the associated 2D color image in the sRGB color space in 8-bit RGBA format |
| ImageSRGB | Get the associated 2D color image in the sRGB color space in 8-bit RGBA format |
| ShallowCopy |
Returns a shallow copy of the frame. The copy will share the image data with the original frame.
|
| ToString | Get string representation of the frame (Overrides ObjectToString.) |
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