NDEVR
API Documentation
XRCameraView

A view that allows interfacing with OpenXR for Augmented and virtual reality. More...

Inheritance diagram for XRCameraView:
[legend]
Collaboration diagram for XRCameraView:
[legend]

Public Member Functions

virtual void * getSurface () override
 Returns a platform-specific pointer to the rendering surface.
Public Member Functions inherited from WindowInstance
 WindowInstance ()
 Default constructor.
 WindowInstance (const DynamicPointer< Camera > &camera, DesignObjectLookup *lookup)
 Constructs a WindowInstance with a given camera and design object lookup.
 ~WindowInstance ()
 Destructor.
void addKeyboardEvent (const std::function< void(KeyEvent)> &key_event)
 Registers a callback to be invoked when a keyboard event occurs.
void addMouseEvent (const std::function< void(MouseEvent)> &mouse_event)
 Registers a callback to be invoked when a mouse event occurs.
virtual const DynamicPointer< Camera > & camera ()
 Returns a reference to the dynamic camera pointer.
virtual ConstPointer< Cameracamera () const
 Returns a const pointer to the current camera.
void createEvent (const KeyEvent &event)
 Dispatches a keyboard event to all registered keyboard event callbacks.
void createEvent (const MouseEvent &event)
 Dispatches a mouse event to all registered mouse event callbacks.
fltp08 devicePixelRatio () const
 Returns the current device pixel ratio.
virtual void finishFrame (GraphicsUpdateArguments &args)
 Called at the end of a frame to perform any finalization work.
virtual uint04 getGrabImageSize ()
 Returns the size for image grabbing operations.
KeyControllergetKeyController ()
 Returns the keyboard controller associated with this window.
MouseControllergetMouseController ()
 Returns the mouse controller associated with this window.
Time getSurfaceUpdateTime () const
 Returns the timestamp of the last surface update.
const void * lockptr () const
 Returns a pointer that can be used as a lock identifier for this instance.
virtual Vector< 2, uint04logicalSize () const
 Returns the logical (device-independent) size of the window.
virtual Vector< 2, uint04pixelSize () const
 Returns the size of the window in physical pixels, accounting for the device pixel ratio.
virtual fltp08 referencePixelSize ()
 Returns the reference size in physical pixels, accounting for the device pixel ratio.
virtual fltp08 referenceSize ()
 Returns the reference size used for scaling calculations.
virtual void setCamera (const DynamicPointer< Camera > &camera)
 Sets the camera associated with this window.
void setDevicePixelRatio (const fltp08 ratio)
 Sets the device pixel ratio (physical pixels per logical pixel).
void setLookup (DesignObjectLookup *lookup)
 Sets the design object lookup used for scene queries.
virtual void setReferenceSize (fltp08 size)
 Sets the reference size used for scaling calculations.
virtual void setSize (const Vector< 2, uint04 > &size)
 Sets the logical size of the window.
virtual bool shouldExit () const
 Returns whether this window should exit or close.
virtual void updateInstance ()
 Called to update the window instance state.
virtual bool visible () const
 Returns whether this window is currently visible.

Additional Inherited Members

Protected Member Functions inherited from WindowInstance
void setExposed (bool exposed)
 Sets whether the window surface is currently exposed (visible and ready for rendering).
Protected Attributes inherited from WindowInstance
DynamicPointer< Cameram_camera
 The camera used for rendering in this window.
fltp08 m_device_pixel_ratio
 Ratio of physical pixels to logical pixels.
bool m_is_exposed = false
 Whether the window surface is currently exposed.
Buffer< std::function< void(KeyEvent)> > m_key_events
 Registered keyboard event callbacks.
DesignObjectLookupm_lookup
 Pointer to the design object lookup for scene queries.
Buffer< std::function< void(MouseEvent)> > m_mouse_events
 Registered mouse event callbacks.
fltp08 m_reference_size
 Reference size used for scaling calculations.
Vector< 2, uint04m_size
 Logical size of the window.
Time m_surface_update_time
 Timestamp of the last surface update.

Detailed Description

A view that allows interfacing with OpenXR for Augmented and virtual reality.


Definition at line 96 of file XRCameraView.h.

Member Function Documentation

◆ getSurface()

virtual void * XRCameraView::getSurface ( )
inlineoverridevirtual

Returns a platform-specific pointer to the rendering surface.

Returns
A void pointer to the underlying surface. Must be implemented by subclasses.

Implements WindowInstance.

Definition at line 113 of file XRCameraView.h.


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