OSVR-Core
Imaging_decl.h
Go to the documentation of this file.
1 
11 // Copyright 2015 Sensics, Inc.
12 //
13 // Licensed under the Apache License, Version 2.0 (the "License");
14 // you may not use this file except in compliance with the License.
15 // You may obtain a copy of the License at
16 //
17 // http://www.apache.org/licenses/LICENSE-2.0
18 //
19 // Unless required by applicable law or agreed to in writing, software
20 // distributed under the License is distributed on an "AS IS" BASIS,
21 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 // See the License for the specific language governing permissions and
23 // limitations under the License.
24 
25 #ifndef INCLUDED_Imaging_decl_h_GUID_FB2A618F_DFF2_4CA1_B56E_C849105D480E
26 #define INCLUDED_Imaging_decl_h_GUID_FB2A618F_DFF2_4CA1_B56E_C849105D480E
27 
28 // Internal Includes
31 #include <osvr/Util/Deletable.h>
32 
33 // Library/third-party includes
34 #include <boost/shared_ptr.hpp>
35 
36 // Standard includes
37 // - none
38 
39 namespace osvr {
40 
41 namespace clientkit {
47  typedef boost::shared_ptr<OSVR_ImageBufferElement> ImageBufferPtr;
48 
52  struct ImagingReport {
55 
58 
61  ImageBufferPtr buffer;
62  };
63 
65  typedef void (*ImagingCallback)(
66  void *userdata, util::time::TimeValue const &timestamp,
67  ImagingReport report);
68 
70 } // end namespace clientkit
71 
72 } // end namespace osvr
73 
74 #endif // INCLUDED_Imaging_decl_h_GUID_FB2A618F_DFF2_4CA1_B56E_C849105D480E
Definition: ImagingReportTypesC.h:61
uint32_t OSVR_ChannelCount
The integer type specifying a number of channels/sensors or a channel/sensor index.
Definition: ChannelCountC.h:51
void(* ImagingCallback)(void *userdata, util::time::TimeValue const &timestamp, ImagingReport report)
The user-friendly imaging callback type.
Definition: Imaging_decl.h:65
The main namespace for all C++ elements of the framework, internal and external.
Definition: namespace_osvr.dox:3
OSVR_ChannelCount sensor
The device sensor number this frame came from.
Definition: Imaging_decl.h:54
The user-friendly imaging report.
Definition: Imaging_decl.h:52
ImageBufferPtr buffer
A shared pointer with custom deleter that owns the underlying image data buffer for the frame...
Definition: Imaging_decl.h:61
OSVR_ImagingMetadata metadata
Metadata containing the properties of this frame.
Definition: Imaging_decl.h:57
Header defining a base class for objects that just need to be generically deletable.
Standardized, portable parallel to struct timeval for representing both absolute times and time inter...
Definition: TimeValueC.h:81
Header forward-declaring TimeValue C++ API.