Time-of-Flight-SDK
frame_definitions.h
1 /*
2  * BSD 3-Clause License
3  *
4  * Copyright (c) 2019, Analog Devices, Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright notice, this
11  * list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright notice,
14  * this list of conditions and the following disclaimer in the documentation
15  * and/or other materials provided with the distribution.
16  *
17  * 3. Neither the name of the copyright holder nor the names of its
18  * contributors may be used to endorse or promote products derived from
19  * this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 #ifndef FRAME_DEFINITIONS_H
33 #define FRAME_DEFINITIONS_H
34 
35 #include <string>
36 
40 namespace aditof {
41 
46 enum class FrameDataType {
47  FULL_DATA,
48  DEPTH,
49  IR,
50  RGB
51 };
52 
57 struct FrameDetails {
61  unsigned int width;
62 
66  unsigned int height;
67 
71  unsigned int fullDataWidth;
72 
76  unsigned int fullDataHeight;
77 
81  unsigned int rgbWidth;
82 
86  unsigned int rgbHeight;
87 
92  std::string type;
93 };
94 
95 } // namespace aditof
96 
97 #endif // FRAME_DEFINITIONS_H
unsigned int fullDataHeight
The height of the actual full frame.
Namespace aditof.
Definition: frame.h:43
unsigned int rgbWidth
The width of the rgb frame.
unsigned int width
The width of the frame.
unsigned int rgbHeight
The height of the rgb frame.
std::string type
The type of the frame. Can be one of the types provided by the camera.
FrameDataType
Types of data that a frame can contain.
unsigned int fullDataWidth
The width of the actual full frame.
unsigned int height
The height of the frame.
Infrared information.
Describes the properties of a frame.