dc2df8307f
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
112 lines
3.6 KiB
C
112 lines
3.6 KiB
C
/*
|
|
* 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) 2007 Blender Foundation.
|
|
* All rights reserved.
|
|
*/
|
|
|
|
/** \file
|
|
* \ingroup wm
|
|
*/
|
|
|
|
#ifndef __WM_H__
|
|
#define __WM_H__
|
|
|
|
struct ARegion;
|
|
struct ReportList;
|
|
struct wmWindow;
|
|
|
|
#include "gizmo/wm_gizmo_wmapi.h"
|
|
|
|
typedef struct wmPaintCursor {
|
|
struct wmPaintCursor *next, *prev;
|
|
|
|
void *customdata;
|
|
|
|
bool (*poll)(struct bContext *C);
|
|
void (*draw)(bContext *C, int, int, void *customdata);
|
|
|
|
short space_type;
|
|
short region_type;
|
|
} wmPaintCursor;
|
|
|
|
void wm_exit_schedule_delayed(const bContext *C);
|
|
|
|
extern void wm_close_and_free(bContext *C, wmWindowManager *);
|
|
extern void wm_close_and_free_all(bContext *C, ListBase *);
|
|
|
|
extern void wm_add_default(struct Main *bmain, bContext *C);
|
|
extern void wm_clear_default_size(bContext *C);
|
|
|
|
/* register to windowmanager for redo or macro */
|
|
void wm_operator_register(bContext *C, wmOperator *op);
|
|
|
|
/* wm_operator.c, for init/exit */
|
|
void wm_operatortype_free(void);
|
|
void wm_operatortype_init(void);
|
|
void wm_window_keymap(wmKeyConfig *keyconf);
|
|
void wm_operatortypes_register(void);
|
|
|
|
/* wm_gesture.c */
|
|
void wm_gesture_draw(struct wmWindow *win);
|
|
int wm_gesture_evaluate(wmGesture *gesture, const struct wmEvent *event);
|
|
void wm_gesture_tag_redraw(struct wmWindow *win);
|
|
|
|
/* wm_gesture_ops.c */
|
|
void wm_tweakevent_test(bContext *C, const wmEvent *event, int action);
|
|
|
|
/* wm_jobs.c */
|
|
void wm_jobs_timer(wmWindowManager *wm, wmTimer *wt);
|
|
void wm_jobs_timer_ended(wmWindowManager *wm, wmTimer *wt);
|
|
|
|
/* wm_files.c */
|
|
void wm_autosave_timer(struct Main *bmain, wmWindowManager *wm, wmTimer *wt);
|
|
void wm_autosave_timer_ended(wmWindowManager *wm);
|
|
void wm_autosave_delete(void);
|
|
void wm_autosave_read(bContext *C, struct ReportList *reports);
|
|
void wm_autosave_location(char *filepath);
|
|
|
|
/* wm_splash_screen.c */
|
|
void WM_OT_splash(wmOperatorType *ot);
|
|
|
|
/* wm_stereo.c */
|
|
void wm_stereo3d_draw_interlace(wmWindow *win, struct ARegion *region);
|
|
void wm_stereo3d_draw_anaglyph(wmWindow *win, struct ARegion *region);
|
|
void wm_stereo3d_draw_sidebyside(wmWindow *win, int view);
|
|
void wm_stereo3d_draw_topbottom(wmWindow *win, int view);
|
|
|
|
void wm_stereo3d_mouse_offset_apply(wmWindow *win, int *r_mouse_xy);
|
|
int wm_stereo3d_set_exec(bContext *C, wmOperator *op);
|
|
int wm_stereo3d_set_invoke(bContext *C, wmOperator *op, const wmEvent *event);
|
|
void wm_stereo3d_set_draw(bContext *C, wmOperator *op);
|
|
bool wm_stereo3d_set_check(bContext *C, wmOperator *op);
|
|
void wm_stereo3d_set_cancel(bContext *C, wmOperator *op);
|
|
|
|
/* init operator properties */
|
|
void wm_open_init_load_ui(wmOperator *op, bool use_prefs);
|
|
void wm_open_init_use_scripts(wmOperator *op, bool use_prefs);
|
|
|
|
#ifdef WITH_XR_OPENXR
|
|
typedef void (*wmXrSessionExitFn)(const wmXrData *xr_data);
|
|
|
|
/* wm_xr.c */
|
|
bool wm_xr_init(wmWindowManager *wm);
|
|
void wm_xr_exit(wmWindowManager *wm);
|
|
void wm_xr_session_toggle(wmWindowManager *wm, wmXrSessionExitFn session_exit_fn);
|
|
bool wm_xr_events_handle(wmWindowManager *wm);
|
|
#endif
|
|
|
|
#endif /* __WM_H__ */
|