2018-02-26 18:10:15 +00:00
|
|
|
/*
|
|
|
|
* This program is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU General Public License
|
|
|
|
* as published by the Free Software Foundation; either version 2
|
|
|
|
* of the License, or (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program; if not, write to the Free Software Foundation,
|
|
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
|
|
*
|
|
|
|
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
|
|
|
|
* All rights reserved.
|
|
|
|
*/
|
|
|
|
|
2019-02-17 21:08:12 +00:00
|
|
|
/** \file
|
|
|
|
* \ingroup GHOST
|
2018-02-26 18:10:15 +00:00
|
|
|
* Declaration of GHOST_IContext interface class.
|
|
|
|
*/
|
|
|
|
|
2020-08-07 08:18:01 +00:00
|
|
|
#pragma once
|
2018-02-26 18:10:15 +00:00
|
|
|
|
|
|
|
#include "GHOST_Types.h"
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Interface for GHOST context.
|
|
|
|
*
|
|
|
|
* You can create a offscreen context (windowless) with the system's
|
|
|
|
* GHOST_ISystem::createOffscreenContext method.
|
|
|
|
* \see GHOST_ISystem#createOffscreenContext
|
|
|
|
*/
|
2019-04-17 04:17:24 +00:00
|
|
|
class GHOST_IContext {
|
|
|
|
public:
|
|
|
|
/**
|
|
|
|
* Destructor.
|
|
|
|
*/
|
|
|
|
virtual ~GHOST_IContext()
|
|
|
|
{
|
|
|
|
}
|
2018-02-26 18:10:15 +00:00
|
|
|
|
2019-04-17 04:17:24 +00:00
|
|
|
/**
|
|
|
|
* Activates the drawing context.
|
|
|
|
* \return A boolean success indicator.
|
|
|
|
*/
|
|
|
|
virtual GHOST_TSuccess activateDrawingContext() = 0;
|
2018-02-26 18:10:15 +00:00
|
|
|
|
2019-04-17 04:17:24 +00:00
|
|
|
/**
|
|
|
|
* Release the drawing context of the calling thread.
|
|
|
|
* \return A boolean success indicator.
|
|
|
|
*/
|
|
|
|
virtual GHOST_TSuccess releaseDrawingContext() = 0;
|
2018-02-26 18:10:15 +00:00
|
|
|
|
VR: Initial Virtual Reality support - Milestone 1, Scene Inspection
NOTE: While most of the milestone 1 goals are there, a few smaller features and
improvements are still to be done.
Big picture of this milestone: Initial, OpenXR-based virtual reality support
for users and foundation for advanced use cases.
Maniphest Task: https://developer.blender.org/T71347
The tasks contains more information about this milestone.
To be clear: This is not a feature rich VR implementation, it's focused on the
initial scene inspection use case. We intentionally focused on that, further
features like controller support are part of the next milestone.
- How to use?
Instructions on how to use this are here:
https://wiki.blender.org/wiki/User:Severin/GSoC-2019/How_to_Test
These will be updated and moved to a more official place (likely the manual) soon.
Currently Windows Mixed Reality and Oculus devices are usable. Valve/HTC
headsets don't support the OpenXR standard yet and hence, do not work with this
implementation.
---------------
This is the C-side implementation of the features added for initial VR
support as per milestone 1. A "VR Scene Inspection" Add-on will be
committed separately, to expose the VR functionality in the UI. It also
adds some further features for milestone 1, namely a landmarking system
(stored view locations in the VR space)
Main additions/features:
* Support for rendering viewports to an HMD, with good performance.
* Option to sync the VR view perspective with a fully interactive,
regular 3D View (VR-Mirror).
* Option to disable positional tracking. Keeps the current position (calculated
based on the VR eye center pose) when enabled while a VR session is running.
* Some regular viewport settings for the VR view
* RNA/Python-API to query and set VR session state information.
* WM-XR: Layer tying Ghost-XR to the Blender specific APIs/data
* wmSurface API: drawable, non-window container (manages Ghost-OpenGL and GPU
context)
* DNA/RNA for management of VR session settings
* `--debug-xr` and `--debug-xr-time` commandline options
* Utility batch & config file for using the Oculus runtime on Windows.
* Most VR data is runtime only. The exception is user settings which are saved
to files (`XrSessionSettings`).
* VR support can be disabled through the `WITH_XR_OPENXR` compiler flag.
For architecture and code documentation, see
https://wiki.blender.org/wiki/Source/Interface/XR.
---------------
A few thank you's:
* A huge shoutout to Ray Molenkamp for his help during the project - it would
have not been that successful without him!
* Sebastian Koenig and Simeon Conzendorf for testing and feedback!
* The reviewers, especially Brecht Van Lommel!
* Dalai Felinto for pushing and managing me to get this done ;)
* The OpenXR working group for providing an open standard. I think we're the
first bigger application to adopt OpenXR. Congratulations to them and
ourselves :)
This project started as a Google Summer of Code 2019 project - "Core Support of
Virtual Reality Headsets through OpenXR" (see
https://wiki.blender.org/wiki/User:Severin/GSoC-2019/).
Some further information, including ideas for further improvements can be found
in the final GSoC report:
https://wiki.blender.org/wiki/User:Severin/GSoC-2019/Final_Report
Differential Revisions: D6193, D7098
Reviewed by: Brecht Van Lommel, Jeroen Bakker
2020-03-17 19:20:55 +00:00
|
|
|
virtual unsigned int getDefaultFramebuffer() = 0;
|
|
|
|
|
|
|
|
virtual GHOST_TSuccess swapBuffers() = 0;
|
|
|
|
|
2018-02-26 18:10:15 +00:00
|
|
|
#ifdef WITH_CXX_GUARDEDALLOC
|
2019-04-17 04:17:24 +00:00
|
|
|
MEM_CXX_CLASS_ALLOC_FUNCS("GHOST:GHOST_IContext")
|
2018-02-26 18:10:15 +00:00
|
|
|
#endif
|
|
|
|
};
|