OSVR-Core
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
osvr::common::ImagingComponent Class Reference

BaseDevice component. More...

#include <ImagingComponent.h>

Inheritance diagram for osvr::common::ImagingComponent:
osvr::common::DeviceComponent

Public Types

typedef std::function< void(ImageData const &, util::time::TimeValue const &)> ImageHandler
 
- Public Types inherited from osvr::common::DeviceComponent
typedef BaseDevice Parent
 

Public Member Functions

OSVR_COMMON_EXPORT void sendImageData (OSVR_ImagingMetadata metadata, OSVR_ImageBufferElement *imageData, OSVR_ChannelCount sensor, OSVR_TimeValue const &timestamp)
 
OSVR_COMMON_EXPORT void registerImageHandler (ImageHandler cb)
 
- Public Member Functions inherited from osvr::common::DeviceComponent
void recordParent (Parent &dev)
 Called (only) by BaseDevice when being added: effectively records a "parent pointer" that does not convey ownership. More...
 
void update ()
 Called during mainloop.
 

Static Public Member Functions

static OSVR_COMMON_EXPORT shared_ptr< ImagingComponentcreate (OSVR_ChannelCount numSensor=0)
 Factory method. More...
 

Public Attributes

messages::ImageRegion imageRegion
 Message from server to client, containing some image data.
 
messages::ImagePlacedInSharedMemory imagePlacedInSharedMemory
 Message from server to client, notifying of image data in the shared memory ring buffer. More...
 

Additional Inherited Members

- Protected Member Functions inherited from osvr::common::DeviceComponent
 DeviceComponent ()
 Protected constructor, to require subclassing.
 
bool m_hasParent () const
 Returns true if we have a parent registered.
 
Parentm_getParent ()
 Gets the parent - only call if m_hasParent() is true.
 
void m_registerHandler (vrpn_MESSAGEHANDLER handler, void *userdata, RawMessageType const &msgType)
 Registers a handler whose lifetime is tied to the lifetime of the component. More...
 
virtual void m_update ()
 Implementation-specific (optional) stuff to do during mainloop.
 

Detailed Description

BaseDevice component.

Member Function Documentation

§ create()

shared_ptr< ImagingComponent > osvr::common::ImagingComponent::create ( OSVR_ChannelCount  numSensor = 0)
static

Factory method.

Required to ensure that allocation and deallocation stay on the same side of a DLL line.

Member Data Documentation

§ imagePlacedInSharedMemory

messages::ImagePlacedInSharedMemory osvr::common::ImagingComponent::imagePlacedInSharedMemory

Message from server to client, notifying of image data in the shared memory ring buffer.


The documentation for this class was generated from the following files: