Unreal. Version

Transcription

1 Unreal Version

2 2 Introduction Unreal Copyrights and Trademarks 2017 Oculus VR, LLC. All Rights Reserved. OCULUS VR, OCULUS, and RIFT are trademarks of Oculus VR, LLC. (C) Oculus VR, LLC. All rights reserved. BLUETOOTH is a registered trademark of Bluetooth SIG, Inc. All other trademarks are the property of their respective owners. Certain materials included in this publication are reprinted with the permission of the copyright holder. 2

3 Unreal Contents 3 Contents Introduction and Version Compatibility...4 Visual Studio 2015 Quick Start... 6 Getting Started... 7 Unreal Mobile Development Unreal Input Gear VR Controller Haptics for Rift Controllers Guardian System Boundary Component...21 Unreal VR Audio Advanced Rendering Features Unreal Forward Shading Renderer (PC) VR Compositor Layers Multi-View (Mobile) Hybrid Monoscopic Rendering...27 Adaptive Pixel Density...32 Oculus Platform Features and Online Subsystems...35 Unreal Console Commands Blueprints...40 Unreal Samples Testing and Performance Analysis in Unreal Release Notes Oculus Oculus Oculus Oculus Oculus Oculus Oculus Oculus Oculus Oculus Oculus Unreal Unreal Unreal Unreal Unreal Unreal Unreal Unreal Unreal Unreal Unreal Engine Engine Engine Engine Engine Engine Engine Engine Engine Engine Engine Integration Integration Integration Integration Integration Integration Integration Integration Integration Integration Integration 1.13 Release Notes Release Notes Release Notes Release Notes Release Notes Release Notes Release Notes Release Notes Release Notes Release Notes Release Notes... 59

4 4 Introduction and Version Compatibility Unreal Introduction and Version Compatibility Unreal is distributed with Oculus plugins which make it easy to develop for the Oculus Rift and Gear VR. Applications targeting Oculus devices automatically apply stereoscopic rendering, orientation tracking (Rift and Gear VR), and positional tracking (Rift only). The OculusPlatform plugin provides an online subsystem which interfaces with Oculus Platform features. The OculusInput plugin provides support for Oculus Touch and Oculus Remote controllers. Unreal Engine Distributions Epic provides a binary distribution of UE4 through the Launcher, and a source distribution available from their GitHub repository. These distributions all contain Oculus support, but they may be a version or two behind the latest SDK. Oculus also distributes UE4 through our own GitHub repository. These distributions are always up to date with the latest Oculus SDKs. We support the current release of UE4, the previous release of UE4, and any preview of the next release of UE4. This development sequence is illustrated in the following chart: Note that our features ship first to the GitHub versions we maintain in our own repository. Which distribution should I use? For beginning developers, we recommend the binary distribution of the Unreal engine available through the Launcher. It is the most stable, and does not require pulling from GitHub or compiling the engine source code. It is typically a few months behind the latest Oculus SDK features. For most professional developers, we recommend the source distribution hosted on Epic s private GitHub repository here: It is available to developers who are subscribed to the private EpicGames/UnrealEngine repository. For more information on accessing this repository, see For professional developers who would like access to the latest SDK features, we recommend the source distributions hosted on Oculus s private GitHub repository here: UnrealEngine.git. To access this repository, you must hold a UE4 license and be subscribed to the private EpicGames/UnrealEngine repository (see for details).

5 Unreal Introduction and Version Compatibility 5 What does this guide cover? Unless otherwise noted, this documentation covers features included in Unreal versions available from Oculus s private GitHub repository. Note that API changes may occur when these branches are merged back into Epic s version of the engine. For Epic's documentation about Oculus development, go to Platforms/VR/. Unreal/Oculus SDK Version Compatibility The Oculus Unreal SDK requires Windows 7 or later. Table 1: Oculus GitHub Repository Branch Oculus PC SDK Oculus Mobile Tag SDK oculus release oculus release oculus release oculus release oculus release oculus release Table 2: Epic GitHub Repository Branch Oculus PC SDK Oculus Mobile Tag SDK release release release release release release

6 6 Visual Studio 2015 Quick Start Unreal Visual Studio 2015 Quick Start The following section describes how to download, compile, and launch UE4 from Oculus s GitHub repository. Professional developers who wish to take full advantage of the features available with our Unreal integration should download and build the source code. For more information and an overview of other options for working with Unreal, see Introduction and Version Compatibility on page 4. This guide assumes you have installed Visual Studio 2015 and are familiar with its use. Several of these steps may take some time to complete - some of them typically take over an hour, depending on your computer and the speed of your Internet connection. Note: Visual Studio 2013 is no longer supported. 1. Clone or download the UE4 source code from Oculus s GitHub repository here: To access this repository, you must hold a UE4 license and have access to the private Epic GitHub repository (see for details). 2. If you downloaded a zip archive of the code, extract the archive contents to a directory where you would like to build the engine, e.g., C:\Unreal\4.13-oculus. We recommend installing to a short path, or you may have errors in the next step with files that exceed the Windows length limit for file names. Alternately, you can map your install directory as a Windows drive to reduce the path length. 3. Run Setup.bat. 4. Run GenerateProjectFiles.bat. 5. Launch UE4.sln to open the project solution in Visual Studio In the menu bar, select Build > Configuration Manager. Verify that Active solution configuration is set to Development Editor, and that Active solution platform is set to Windows In the Solution Explorer, right-click UE4 under Engine and select Set as Startup Project. Then select Build in the same context menu. 8. To launch the engine: With command-line arguments: Right-click UE4 in the Solution Explorer and select Properties. In the UE Property Pages dialog, select Configuration Properties > Debugging on the left. Enter any desired configuration options in the Command Arguments field on the top. Without command-line arguments: In the Solution Explorer on the right, right-click UE4 under Engine and, in the context menu, select Debug > Start New Instance to launch the engine. 9. Select the project you would like to open, or specify a new project. If you are creating a new project, don t forget to specify a project name. 10.At this point, the engine will close and a new instance of Visual Studio will launch with your selected or new project. Repeat step 6 to launch the engine with the specified project. For Epic's instructions on building the Unreal Engine from source, see Building Unreal Engine from Source guide.

7 Unreal Getting Started 7 Getting Started Overview The easiest way to get started with Oculus development in Unreal is to experiment with the HMD support provided by default as a Player Start. If Unreal detects an Oculus Rift runtime (e.g., the Oculus app is installed), it will automatically provide orientation and positional tracking and stereoscopic rendering for any game. Standalone PC executables will automatically display in Oculus Rift when run in full-screen mode if a Rift is detected on your system. You may build a project normally and preview it in the Engine by selecting the VR Preview mode in the Play button pulldown options. Note: In order to play an in-development application, you will need to enable running applications from unknown sources in the Oculus app settings, available through the gear icon in the upper-right. Select Settings > General and toggle Unknown Sources on to allow. To preview a level in the Rift while editing with the engine, select the dropdown arrow near the Play button and select VR Preview. To play a scene in the Rift with a standalone PC game, simply maximize the game window and it will be mirrored to the Rift display. Note: While Unreal is running, you will not be able to access Oculus Home by putting on the headset. Adding a VR Camera Using the default camera set to VR Preview is a good way to get a quick sense of VR development with minimal overhead, but for actual development, we recommend adding a Camera actor to your map and enabling Oculus support by selecting the camera in Viewport and checking the Lock to Hmd checkbox in the Details tab (available in UE4 11).

8 8 Getting Started Unreal Placing a camera in the scene allows you to control the orientation of the camera view when the game loads, so that you can control the exact perspective that will be visible to the user. This is not possible with the Play Start described above. An additional benefit to using the Camera actor is that you can attach meshes and they will update their position following the HMD view with very little latency. This is generally the best way to add head-locked elements such as cockpit details. Note that we generally discourage head-locked UI elements, but it can be an attractive feature when used carefully. HMD Pose Tracking Origin The HMD pose is reported relative to a tracking origin, which may be set to two values in your HeadMountedDisplay settings: Eye Level The initial pose of the HMD when the camera activates. Floor Level The origin set by the user during Rift calibration, typically near the center of their playable area. Unlike eye-level, the floor-level origin's position is on the floor, at Y = 0. When you recenter the tracking origin, the behavior is different for eye and floor level. Eye level moves the origin's position (X, Y, and Z) and the yaw (Y rotation) to match the current head pose. Pitch and roll (X and Z rotation) are not modified because that would make the app's virtual horizon mismatch the real-world horizon, disorienting the user. Floor level moves the origin's X and Z position, but leaves the Y position alone to keep it consistent with the real-world floor. Rotation is handled the same way as eye level. For more information, see: Tracking in our Intro to VR IHeadMountedDisplay in the Unreal API Guide

9 Unreal Getting Started 9 VR Template Unreal Engine v4.13 and later include a Virtual Reality Blueprint project template which may be selected when creating a New Project. VR Template contains two maps, accessible through the Content Browser in Content > VirtualRealityBP > Maps. The HMD Locomotion Map is a simple level that demonstrates teleportation. Set your travel destination with the blue gaze-controlled circle. Once the teleport target is set, press the spacebar or gamepad button to teleport. You may optionally control the the orientation you will be facing on arrival with the gamepad primary joystick.

10 10 Getting Started Unreal The Motion Controller Map also demonstrates teleportation control, in this case using tracked Touch controllers. Point in the direction you d like to travel with the Touch controller and and control the destination orientation with your gaze. Then press the A-button to teleport.

11 Unreal Getting Started 11 Use the trigger buttons to pick up and manipulate the small blue blocks in the level.

12 12 Getting Started Unreal

13 Unreal Unreal Mobile Development 13 Unreal Mobile Development This guide covers environment setup, project configuration, and development for the Oculus Mobile platform using Unreal. Overview Unreal versions 4.10 and later provide built-in support for Oculus mobile development. Projects configured for VR automatically apply stereoscopic rendering and orientation tracking. Once your environment is set up with the appropriate tools and your project settings are configured properly, you may build virtual reality projects targeting Android, load APKs on your mobile device, and play them on the Oculus Mobile platform. Note: Mobile applications are subject to more computational limitations compared to Rift applications, and this should be taken into consideration beginning in the early design phase. Oculus Mobile SDK Oculus provides a mobile SDK with native C/C++ libraries for Android development in addition to supporting mobile development for game engines such as Unreal. It is not necessary for Unreal developers to download or install the Mobile SDK, but we recommend looking through our Mobile SDK Developer Guide for general information on Gear VR development such as application signature, basic mobile development tools such as adb and Oculus Remote Monitor, and performance guidelines. We recommend that Unreal mobile developers review the following sections: Mobile SDK Getting Started Guide Mobile Development Basics Mobile Best Practices Testing and Troubleshooting Developers interested in lower-level details about how the mobile VR rendering pipeline is handled by our native libraries may wish to download the mobile SDK and review the headers, particularly for the VrApi, which is responsible for returning headset orientation data and applying distortion, sensor fusion, and compositing. Mobile Environment Setup There are two ways to set up your environment for Gear VR development for Unreal: 1) using the Codeworks for Android installation package (recommended), or 2) using the standard Android SDK. Epic strongly recommends using the Codeworks for Android 1R4 installation package rather than the stock Android SDK. Using this package simplifies Unreal set up and may be necessary to successfully build Gear VR projects. However, it requires uninstalling any standard Android SDK installation and may interfere with development using other engines or IDEs that require the standard Android SDK. To install Codeworks for Android 1R4, follow the instructions in Epic s Required Android Setup guide. Note: You will find the required version of Codeworks here: Engine\Extras\AndroidWorks\Win64. To prepare for Gear VR development using the standard Android SDK, follow the instructions in our Mobile Android Development Software Setup for Windows guide to install the Java Development Kit (JDK), Native Development Kit, and Android SDK. Unreal developers do not need to install Android Studio. Our Unreal SDK does not currently support OS X or Linux.

14 14 Unreal Mobile Development Unreal Once you have installed the required Android tools, follow the setup instructions described in the Device Setup guide in our Mobile SDK documentation. In this process you will enable Developer Options on your mobile device and make a few device configuration settings. Application Signing Oculus mobile applications must be signed by two different signatures at different stages of development. An Oculus Signature File (osig) is required for your application to run on Gear VR, and an Android distribution keystore is required for submission to the Oculus Store. Once you add an osig to the appropriate Unreal directory, it will be added automatically to every APK that you build. You will need one osig for each mobile device. To add your osig to Unreal for development: 1. Follow the instructions in Application Signing to download your osig. 2. Navigate to the directory <Unreal-directory>\Engine\Build\Android\Java\. 3. Create a new directory inside \Engine\Build\Android\Java\ and name it assets. The name must not be capitalized. 4. Copy your osig to this directory. When you are ready to build an APK for submission to release, we recommend that you exclude the osig in your APK. To do so, select Edit > Project Settings > Android, scroll down to Advanced APKPackaging, and verify that Remove Oculus Signature Files from Distribution APK is checked. Before building your final release build, create a new Android keystore by following the Sign Your App Manually instructions in Android's Sign your Applications guide. Once you have generated your distribution

15 Unreal Unreal Mobile Development 15 keystore, go to Edit > Project Settings > Platforms > Android, scroll down to Distribution Signing, and entered the required information. See the Application Signing section of the Mobile SDK documentation for more information. Configure Unreal for Android SDK If you do not have a project prepared but would like to try out the process, you may use create a scene with starter content such as the C++ First Person project. Once you have installed the Android SDK and required tools, configure Unreal for Android development. 1. Select Edit > Project Settings. 2. In the Project Settings menu on the left, go to Platforms and select Android SDK (not Android - we will configure that later). 3. Configure all fields in SDKConfig with the appropriate paths to the necessary tools. Note: if you installed Codeworks for Android, these fields should be populated automatically. Project Configuration This section describes how to configure any C++ or Blueprints Unreal project targeting desktop or mobile for use with Oculus mobile devices. If you do not have a project prepared but would like to try out the process, you may use create a scene with starter content such as the C++ First Person project. 1. Select Edit > Plugins. 2. Select Virtual Reality. 3. Verify that the Enabled check box is checked for Gear VR. If you need to select it, click Restart Now in the lower-right afterward. Close Plugins configuration. 4. Select Edit > Project Settings. 5. Fill in any other desired information in Project > Description. 6. In the Project Settings menu on the left, go to Platforms and select Android. 7. Under APKPackaging, set the Minimum SDK Version to 19, and set the Target SDK Version to Scroll down to Advanced APKPackaging. Then: a. Check Configure the AndroidManifest for deployment to GearVR. b. Verify that Remove Oculus Signature Files from Distribution APK is unchecked, unless you are building a package to release. 9. In Engine > Rendering, uncheck Mobile HDR in the Mobile section. 10.Close the Project Settings configuration window. Building and Running Projects 1. Connect your Samsung phone to your PC via USB. 2. Open a shell terminal and verify that your device is communicating with your PC using adb devices. Note that depending on the device you are using, you may need to configure your connection for software installation. For more information, see Adb in our Mobile SDK Developer Guide. 3. We recommend using ASTC compression, though ETC2 will also work. Select File > Package Project > Android > Android (ASTC). 4. When prompted, browse to the destination folder where you would like your APK to be installed. 5. Once the build process is completed, navigate to the destination folder. Run the.bat file beginning with Install_ to install the application to your phone.

16 16 Unreal Mobile Development Unreal 6. Once the build process is complete, your application will be visible on your mobile devices under Apps. Note that it will not be visible in Oculus Home. 7. Click the application to launch. You will be prompted to insert it into your Gear VR headset. Note: You may also set your phone to Developer Mode, which allows you to run VR applications on your mobile device without inserting it into an HMD. Launching a Project Directly onto your Phone You may also directly build and launch an application to your phone without saving the APK locally. 1. Connect your phone to your PC by USB. 2. Select the Launch menu from the Unreal toolbar and select your phone under Devices. If you do not see your phone listed, verify your USB connection, and check if you need to set your connection to Connected as an Installer - some Samsung phones default to Charge Only connection. 3. Your application will build and install to your Android device. When the build is complete, you will be prompted to insert the phone into your headset to launch. Workflow We recommend setting your phone to Developer Mode, so you can run VR apps on your phone without inserting it into the Gear VR headset. This allows you to quickly review your progress on the device without much overhead. You may also launch the engine with a configuration option to use the GearVR plugin and Mobile renderer on the PC. This allows you to preview mobile development from the desktop using an Oculus Rift. To do so, disable OculusRift and SteamVR plugins for your project, and add -OpenGL -FeatureLevelES2 to your command line. To run your app during development, we generally recommend connecting your phone via USB, selecting the Launch pulldown menu, and then selecting your phone under the listed devices. Particularly if you are modifying maps and shaders but not changing the code, this is often much faster than building an APK. It is possible to preview a Gear VR application in the Oculus Rift during development. However, it is not generally useful to do so, because Rift applications are subject to substantially different performance requirements (see "Performance Targets" in Testing and Performance Analysis in Unreal on page 47). You may find it easiest to use the 2D preview in Unreal, and then either build an APK or use Launch on Device when you need to view the app in VR. Note: Mobile Content Scale Factor is not currently supported for Oculus development. Blueprints We provide Blueprints for common Gear VR operations such as querying battery level and headphone connection status. To access Blueprints for Gear VR, you must enable the Gear VR plugin in Edit > Plugins > Virtual Reality. For more information, see Blueprints on page 40. Multi-view Multi-view is an advanced rendering feature for Gear VR, available in experimental form in Unreal 4.14 and later. If your application is CPU-bound, we strongly recommend using multi-view to improve performance. For more information, see Multi-View (Mobile) on page 27 in Advanced Rendering.

17 Unreal Unreal Input 17 Unreal Input This section describes input handling for Oculus devices. Gear VR Controller The Gear VR Controller is an orientation-tracked input device available through Unreal as a Motion Controller. For instructions on how to add a Motion Controller component to your Pawn or Character, see Motion Controller Component Setup in Epic s Unreal documentation. Unreal has also provided a detailed training tutorial called Setting Up VR Motion Controllers. Gear VR positions the controller relative to the user by using a body model to estimate the controller s position. Whether the controller is visualized on the left or right side of the body is determined by left-handedness versus right-handedness, which is specified by users during controller pairing. Orientation tracking is handled automatically by the Motion Controller Component. If you need to query the controller orientation, you can query the Motion Controller rotation. Add the GearVRControllerComponent to create a MotionController with a Gear VR Controller mesh as a child (4.15 only). The Gear VR Controller mesh may be found in Plugins/GearVR/Content/. Motion Controller Components must be specified as either left or right controllers when they are added, and each Gear VR Controller button mapping has a left/right equivalent. However, any button click sends both left and right events, so the setting you choose when add the Motion Controller component has no effect. Gear VR Controller Sample We provide a sample called GearVRControllerSample in the directory <install>/samples/oculus. Please see the sample and its Level Blueprint for a full illustration of how to use the controller in your game. GearVRControllerSample includes two Blueprints: Enable Arm Model: enabled by default. Get Gear VR Controller Handedness: gets the handedness of the controller per the user configuration. Button Mapping The touchpad distinguishes between a touch, in which the user s finger is touching the pad without pushing it down, and a click. The touchpad may be queried using FaceButtons to check for clicks on the 12:00, 3:00, 6:00, and 9:00 positions, or with Thumbstick_X/Thumbstick_Y to check for the finger position anywhere on the pad using axis values from -1.0,-1.0 (lower-left corner) to 1.0,1.0 (upper-right corner). All left/right button events are equivalent. The volume and home buttons are reserved. Motioncontroller_Left_Thumbstick/Right_Thumbstick touchpad click anywhere MotionController_Left_FaceButton1/Right_FaceButton1 click at 12:00 MotionController_Left_FaceButton2/Right_FaceButton2 click at 3:00

18 18 Unreal Input Unreal MotionController_Left_FaceButton3/Right_FaceButton3 click at 6:00 MotionController_Left_FaceButton4/Right_FaceButton4 click at 9:00 MotionController_Left_FaceButton5/Right_FaceButton5 back button MotionController_Left_Thumbstick_X/Right_Thumbstick_X touchpad contact position from -1.0 (left) to 1.0 (right) MotionController_Left_Thumbstick_Y/Right_Thumbstick_Y touchpad contact position from -1.0 (bottom) to 1.0 (top) MotionController_Left_FaceButton6/Right_FaceButton6 touchpad touch Motioncontroller_Left_Trigger/Right_Trigger trigger Haptics for Rift Controllers You may use the standard Play Haptic Effect Blueprint to send a specified haptic curve to the Oculus Touch or Xbox controller. For more information, see Unreal s Play Haptic Effect guide. Haptics in Unreal Engine 4.13 PlayHapticEffects may be configured to play haptic waves based on three types of input. Right-click Content Browser to bring up the context menu, then select Miscellaneous. and select one of the following three options: Haptic Feedback Buffer: Plays a buffer of bytes 0-255, Haptic Feedback Curve: Draw the haptic linear curve you wish to play using the Haptic Curve Editor, or Haptic Feedback Soundwave: Select a mono audio file to be converted into a haptic effect of corresponding amplitude. The following Blueprint illustrates a simple haptics sequence on the Oculus Touch controller using Play Haptic Effect. This example sends vibrations using Play Haptic Effect when the left controller grip button is pressed. When the button is released, Stop Haptic Effect sends a stop command to the Touch controller. When the left controller X button is pressed, a constant vibration is sent by Set Haptics by Value until the button is released. Note that Set Haptics by Value calls are limited to 30 Hz; additional calls will be disregarded.

19 Unreal Unreal Input 19 Haptics in Unreal Engine 4.12 In addition to Play Haptic Effects, Unreal 4.12 adds Play Haptic Soundwave. The following Blueprint illustrates a simple haptics sequence on the Oculus Touch controller using Play Haptic Effects and Play Haptic Soundwave. This example sends vibrations using Play Haptic Effect when the left controller grip button is pressed. When the button is released, Play Haptic Soundwave sends a second vibration to the controller.

20 20 Unreal Input Unreal When the left controller X button is pressed, a constant vibration is sent by Set Haptics by Value until the button is released. Note that Set Haptics by Value calls are limited to 30 Hz; additional calls will be disregarded. APlayerController::PlayHapticSoundWave takes a mono soundwave as an argument. It downsamples the wave into a series of bytes that serially describe the amplitude of the wave (uint8 values 0-255). Each byte is then multiplied by the factor specified in Scale (max = 255), and haptic vibrations are sent to the targeted Oculus Touch controller. Each controller must be targeted individually. Call Stop Haptic Effect to stop haptic playback. Haptics Sample The TouchSample, available from our Unreal GitHub repository, illustrates basic use of Oculus Touch, including haptics control using PlayHapticEffect() and PlayHapticSoundWave(). For more information, see Unreal Samples on page 43.

21 Unreal Unreal Input 21 Guardian System Boundary Component OculusRiftBoundaryComponent exposes an API for interacting with the Oculus Guardian System. Note: The Guardian System is not yet supported by public versions of the Oculus runtime. During Touch setup, users define an interaction area by drawing a perimeter called the Outer Boundary in space with the controller. An axis-aligned bounding box called the Play Area is calculated from this perimeter. When tracked devices approach the Outer Boundary, the Oculus runtime automatically provides visual cues to the user demarcating the Outer Boundary. This behavior may not be disabled or superseded by applications, though the Guardian System visualization may be disabled via user configuration in the Oculus App. Additional handling may be implemented by applications using the class UOculusRiftBoundaryComponent. Possible use cases include pausing the game if the user leaves the Play Area, placing geometry in the world based on boundary points to create a natural integrated barrier with in-scene objects, disabling UI when the boundary is being rendered to avoid visual discomfort, et cetera. All UOculusRiftBoundaryComponent public methods are available as Blueprints. Please see OculusRiftBoundaryComponent.h for additional details. Basic Use Boundary types are Boundary_Outer and Boundary_PlayArea. Device types are HMD, LTouch, RTouch, Touch (i.e., both controllers), and All.

22 22 Unreal Input Unreal Applications may query the interaction between devices and the Outer Boundary or Play Area by using UOculusRiftBoundaryComponent::GetTriggeredPlayAreaInfo() or UOculusRiftBoundaryComponent::GetTriggeredOuterBoundaryInfo(). Applications may also query arbitrary points relative to the Play Area or Outer Boundary using UOculusRiftBoundaryComponent::CheckIfPointWithinOuterBounds() or UOculusRiftBoundaryComponent::CheckIfPointWithinPlayArea(). This may be useful for determining the location of particular Actors in a scene relative to boundaries so, for example, they are spawned within reach, et cetera. Results are returned as a struct called FBoundaryTestResult, which includes the following members: Member Type Description IsTriggering bool Returns true if the device or point triggers the queried boundary type. DeviceType ETrackedDeviceTypeDevice type triggering boundary. ClosestDistance float Distance between the device or point and the closest point of the test area. ClosestPoint FVector Describes the location in tracking space of the closest boundary point to the queried device or point. ClosestPointNormal FVector Describes the normal of the closest boundary point to the queried device or point. All dimensions, points, and vectors are returned in Unreal world coordinate space. Applications may request that boundaries be displayed or hidden using RequestOuterBoundaryVisible(). Note that the Oculus runtime will override application requests under certain conditions. For example, setting Boundary Area visibility to false will fail if a tracked device is close enough to trigger the boundary s automatic display. Setting the visibility to true will fail if the user has disabled the visual display of the boundary system. Applications may query the current state of the boundary system using UOculusRiftBoundaryComponent::IsOuterBoundaryDisplayed() and UOculusRiftBoundaryComponent::IsOuterBoundaryTriggered(). You may bind delegates using the object OnOuterBoundaryTriggered. Additional Features You may set the boundary color of the automated Guardian System visualization (alpha is unaffected) using UOculusRiftBoundaryComponent::SetOuterBoundaryColor(). Use UOculusRiftBoundaryComponent::ResetOuterBoundaryColor()to reset to default settings. UOculusRiftBoundaryComponent::GetOuterBoundaryPoints() and UOculusRiftBoundaryComponent::GetPlayAreaPoints()return an array of up to 256 3D points that define the Boundary Area or Play Area in clockwise order at floor level. You may query the dimensions of a Boundary Area or Play Area using UOculusRiftBoundaryComponent::GetOuterBoundaryDimensions() or UOculusRiftBoundaryComponent::GetPlayAreaDimensions(), which return a vectors containing the width, height, and depth in tracking space units, with height always returning 0.

23 Unreal Unreal Input 23 Boundary Sample BoundarySample, available from our Unreal GitHub repository, illustrates the use of the Boundary Component API for interacting with our Guardian System. For more information, see Unreal Samples on page 43.

24 24 Unreal VR Audio Unreal Unreal VR Audio Audio is critical for creating a persuasive VR experience and can contribute strongly to the user's sense of immersion. Audio Basics When Unreal PC applications are launched, if the OculusRift plugin is enabled and the Oculus VR Runtime Service is installed, then the application will automatically override the default Windows graphics and audio devices and target the Rift. The Oculus VR Runtime Service is installed with the Oculus App. Unless your application is intended to run in VR, do not enable the OculusRift plugin. Otherwise, it is possible that audio and/or video will be incorrectly targeted to the Oculus Rift when the application is run. Alternatively, users can disable loading all HMD plugins by specifying "-nohmd" on the command line. Audio Spatialization The Oculus Audio SDK includes spatialization plugins (OSPs) that provide HRTF spatialization and reverb modeling for audio editing tools commonly used with Unreal, including Audiokinetic Wwise and FMOD Studio. FMOD supports both Rift and mobile development, and Wwise supports Rift development. For more details on integrating our spatialization plugins with FMOD and Wwise for use in Unreal, see the Rift Audio section of our Rift developer guide. We recommend using FMOD or Wwise with the appropriate OSP, which will provide access to our full spatialization feature set as well as the full functionality of the audio tools themselves. Epic also offers built-in audio spatialization for Rift with HRTF-spatialization only. Epic s 4.15-preview branch offers preview support for Gear VR which does not support some features such as ducking and filtering, and which may contain bugs. For an example of how to implement it, see AmbientSound Spatialize in the Unreal Audio Content Example. For more information on our plugins, and for general information about audio design for VR, please see our Audio SDK developer guide.

25 Unreal Advanced Rendering Features 25 Advanced Rendering Features This section describes important rendering options and tools that can significantly improve your application. Unreal Forward Shading Renderer (PC) Unreal Engine 4.14 introduced an experimental forward shading renderer optimized for VR. We recommend that all future PC titles use the forward shading renderer. The primary advantage of the forward renderer is that it is substantially faster than the deferred renderer. It outputs lit pixels directly, whereas the deferred renderer outputs material properties to a set of buffers, and then reads them back to apply lighting in a separate pass. Because the forward renderer does not render to intermediate buffers, it can take advantage of MSAA. We recommend using MSAA for anti-aliasing, as it not only reduces motion blur, but often provides a significant savings in GPU utilization over TAA. Not all features from the deferred renderer are available in the forward renderer, but many of these features require tradeoffs that disproportionately impact VR development. For example, space screen effects may introduce stereo disparities that can be uncomfortable for users. Given the substantial advantages the forward shading renderer offers VR developers, we anticipate that the forward shading renderer will become the target for future VR optimizations. For more information on the forward shading renderer, see Epic s New: Forward Shading Renderer with MSAA. VR Compositor Layers In some versions of Unreal, you may add transparent or opaque quadrilateral, cubemap, or cylindrical overlays to your level as compositor layers. TimeWarp compositor layers are rendered at the same frame rate as the compositor, rather than rendering at the application frame rate. They are less prone to judder, and are raytraced through the lenses, which improves the clarity of textures displayed on them. We recommend using compositor layers for text and for headlocked elements. Text rendered on compositor layers is more legible, and headlocked layers remain headlocked when Asynchronous TimeWarp interpolates dropped frames. Gaze cursors and UIs are good candidates for rendering as quadrilateral compositor layers. Cylinders may be useful for smooth-curve UI interfaces. Cubemaps may be used for startup scenes or skyboxes. We recommend using a cubemap compositor layer for your loading scene, so it will always display at a steady minimum frame rate, even if the application performs no updates whatsoever. This can significantly improve application startup times. Quadrilateral, cylinder, and cubemap layers are supported in Unreal versions 4.13 and later. Cylinder and cubemap support currently support mobile development only. By default, VR compositor layers are always displayed on top of all other objects in the scene. You may set compositor layers to respect depth positioning by enabling Supports Depth. If you are using multiple layers, use the Priority setting to control the depth order in which the layers will be displayed, with lower values indicating greater priority (e.g., 0 is before 1).

26 26 Advanced Rendering Features Unreal Note that enabling Supports Depth may affect performance, so use it with caution and be sure to assess its impact. To create an overlay: 1. Create an Actor and add it to the level. If you don t want the Actor to be visible in the scene, use an Empty Actor. 2. Select the Actor, select Add Component, and choose Stereo Layer. 3. Under the Stereo Layer options, set Stereo Layer Type to Quad Layer or Cylinder Layer. 4. Set Stereo Layer Type to Face Locked, Torso Locked, or World Locked. 5. Set the overlay dimensions in world units in Quad Stereo Layer Properties or Cylinder Stereo Layer Properties. 6. Select Supports Depth in Stereo Layer to set your compositor layer to not always appear on top of other scene geometry. Note that this may affect performance. 7. Configure Texture and additional attributes as appropriate. The Actor you slave the component to will be fixed at the center of the quad or the cylinder. You may add up to three VR compositor layers to Gear VR applications, and up to fifteen to Rift applications. Layers Sample The LayerSample, available from our Unreal GitHub repository, illustrates the use of VR Compositor Layers to display a UMG UI. For more information, see Unreal Samples on page 43.

27 Unreal Advanced Rendering Features 27 Multi-View (Mobile) Multi-view is an advanced rendering feature for Gear VR, available in experimental form in Unreal 4.14 and later. If your application is CPU-bound, we strongly recommend using multi-view to improve performance. In typical OpenGL stereo rendering, each eye buffer must be rendered in sequence, doubling application and driver overhead. When multi-view is enabled, objects are rendered once to the left eye buffer, then duplicated to the right buffer automatically with appropriate modifications for vertex position and view-dependent variables such as reflection. Multi-view is currently supported by Note5, S6, S7, and S7 Edge phones using ARM Exynos processors and running Android M or N. It is also supported on S7 and S7 Edge phones using Qualcomm processors and running Android N. Multi-view requires OpenGL ES 2, and does not currently support OpenGL ES 3.1. Although multi-view can substantially reduce CPU overhead, keep in mind that applications submitted to the Oculus Store must maintain minimum frame rate per our requirements, even on devices that do not support multi-view. Enabling Multi-View Open Edit > Project Settings > Engine > Rendering. In the VR section, enable Mobile Multi-View. For Exynos devices, verify that Support OpenGL ES2 is checked in the Build section in Platforms > Android, and that Support OpenGL ES3 is not selected. Direct Multi-View Oculus versions 4.15 and higher using integration 1.12 or later support an enhanced version of multi-view that reduces the number of full-screen copies that must be rendered. In most cases, it provides a substantial reduction in GPU overhead. To enable Direct Multi-View, add the following to defaultengine.ini: [GearVR.Settings] benabledirectmultiview=true Hybrid Monoscopic Rendering Hybrid monoscopic rendering is an experimental feature introduced in Unreal 4.15 that renders objects close to the viewer in stereoscopic 3D, while rendering all objects that lie past a culling plane only once. Note: In Unreal 4.15, hybrid monoscopic rendering is available for mobile applications only. It may not currently be used with multi-view. Overview Enabling hybrid monoscopic rendering can produce performance improvements by drawing many objects only once instead of twice at a slight stereo disparity. In one test scenario, we measured a 25% decrease in rendering times on Epic s SunTemple sample. In most cases, the visual effect of rendering objects monoscopically with default settings is unnoticeable for typical users.

28 28 Advanced Rendering Features Unreal When hybrid monoscopic rendering feature is enabled, a third monoscopic camera is placed between the left and right cameras on the same plane. In mobile applications, the eye cameras have symmetric frusta, so the monoscopic camera shares the same projection matrix as the stereoscopic cameras. The UE4 mobile forward renderer then does the following: 1. Renders non-transparent content with the stereo cameras. 2. Shifts and combines the output to create a monoscopic occlusion mask, which pre-populates the monoscopic depth buffer. 3. Renders non-transparent content with the monoscopic camera. 4. Composites the monoscopic camera s result into the stereo buffers. 5. Render all transparent content and perform all post processing in stereo. To separate stereo and mono content, hybrid monoscopic rendering uses a depth buffer. All pixels beyond the culling plane are discarded in the stereo view by clearing the stereo depth buffer to that depth. The monoscopic projection near plane is also initialized at that depth to discard fragments that have already been rendered in stereo. For additional technical details, see Hybrid Mono Rendering in UE4 and Unity in our Developer Blog. Enabling Hybrid Monoscopic Rendering Open Edit > Project Settings > Engine > Rendering. In the VR section, enable Monoscopic Far Field (Experimental). Culling Plane When hybrid monoscopic rendering is enabled, a split plane parallel to the z-axis is added to the level, and objects falling on the far side of the plane are rendered using the monoscopic camera. Objects straddling the culling plane are rendered by both the monoscopic and stereoscopic cameras - see Best Practices below for more information. The distance of the culling plane may be configured in Settings > World Settings > VR > Mono Culling Distance (default setting is 750.0, or 7.5 meters). Console Commands When hybrid monoscopic rendering is enabled, you may set its mode with the following console command: vr.monoscopicfarfieldmode [0-4]

29 Unreal Advanced Rendering Features 29 Mode Description 0 Off 1 On (default) 2 Stereo only 3 Stereo only with no culling plane 4 Mono only Best Practices This section describes how to implement and tune hybrid monoscopic rendering. We recommend reading it carefully - the substantial performance improvements this feature provides when properly implemented make it worth spending some time to get it working properly. However, if it is improperly used, it may actually decrease performance. Due to limitations of the frustum culling algorithm we use to cull meshes, large objects around the scene such as environment cubemaps or skyboxes are still drawn to the stereoscopic cameras that have a close culling plane, even if no pixel of those objects makes it past the far plane. Those draw calls are unnecessary and create bandwidth and vertex costs to the GPU and CPU. To prevent unnecessary draw calls in the stereo buffer, we strongly recommend that you identify objects that are further than the culling plane and still render, and force them to render in the monoscopic buffer only. To identify all objects rendered to the stereoscopic cameras, set your level to display objects drawn to the

30 30 Advanced Rendering Features Unreal stereoscopic buffer only with the console command vr.monoscopicfarfieldmode 2. You will only see objects that lie on the near side of the culling plane, like this: Figure 1: Stereo Only

31 Unreal Advanced Rendering Features 31 Next, set your level to display all draw calls to the stereoscopic buffer with the console command vr.monoscopicfarfieldmode 3. This will display the stereo buffer without culling: Figure 2: Stereo Only with No Culling Any mesh that appears when vr.monoscopicfarfieldmode is set to 3 but not when it is set to 2 is redundantly rendered and should be set to render in the monoscopic buffer only. In the pictures above, that includes anything visible in the second image that does not appear in the first image. Notice in this example the mountains in the scene are drawn to the stereoscopic buffer - this is a typical case. Any very large object that the user is inside of will typically be a candidate for forcing to mono only. To force any mesh to render in the monoscopic buffer only, select the mesh and check the Render in Mono option under Rendering.

32 32 Advanced Rendering Features Unreal Hybrid monoscopic rendering is usually a better fit for levels that contain a lot of distant content, such as outdoor scenes. In a small room where nearly everything lies before or straddles the culling plane, it will probably not improve performance. Note that you may enable or disable hybrid monoscopic rendering dynamically in an application, enabling it in levels where it provides a performance improvement, and disabling it when it does not. One way to quickly assess the performance impact is to use the console command stat RHI to configure your application to display the number of triangles being drawn in your level in real time. Then run the level with hybrid monoscopic rendering disabled and compare it to running the same level with the feature enabled, with different values for the culling plane, with different meshes tagged with Render in Mono, and so forth. Adaptive Pixel Density Adaptive Pixel Density allows applications to scale down the application viewport as GPU resources exceed 85% utilization, and to scale up as they become more available. For CPU-bound applications, this feature has the potential to improve visual quality. The following charts illustrate pixel density (gold) and frames per second (blue) on a demo application with Adaptive Pixel Density off and on, respectively.

33 Unreal Advanced Rendering Features 33

34 34 Advanced Rendering Features Unreal To enable Adaptive Pixel Density, use the console command hmd pdadaptive on. You may specify a minimum and maximum scaling factor (default 1 = normal density). See Unreal Console Commands on page 38 for more information. To enable Adaptive Pixel Density on startup, specify the appropriate settings in Engine/Config/BaseEngine.ini. For example: [Oculus.Settings] PixelDensityMin=0.5 PixelDensityMax=1.0 PixelDensityAdaptive=true See Loading Console Variables in Epic s Console Manager: Console Variables in C++ for more information. If you do not want some Actors within your level (e.g., text displays) to be scaled, they should be drawn using separate VR Compositor Layers which are not scaled by pixel density. For more information, see VR Compositor Layers on page 25. Note: To minimize the perceived artifacts from changing resolution, there is a two-second minimum delay between every resolution change.

35 Unreal Oculus Platform Features and Online Subsystems 35 Oculus Platform Features and Online Subsystems The Oculus Platform supports several features related to security, community, revenue, and engagement, including matchmaking, in-app purchase, entitlement checking, VoIP, cloudsaves, and more. Unreal developers may access Oculus Platform features in two ways: 1. A subset of Platform functionality is built into the engine and is available through the Unreal Online Subsystem interface, and 2. The Platform SDK includes an Unreal plugin providing full access to all Oculus Platform features Some Platform features support Blueprints, such as Entitlement Checking. For more information and instructions, see the Platform section of Blueprints on page 40 For instructions on using the Oculus Platform Plugin for Unreal, please see our Platform SDK documentation and the readme included in the Unreal folder of the Platform SDK archive (available from our Downloads page). Unreal Online Subsystems Several Oculus Platform features may be accessed through Unreal s Online Subsystems (OSS) interface in Unreal Engine 4.12 and For more information on available UE4 versions and compatibility, see our Introduction and Version Compatibility on page 4. For each supported feature, only a subset of functionality is exposed by the Online Subsystems interface. Developers who wish to use Platform features not available through Online Subsystems should code against the native C headers located in Engine\Source\ThirdParty\Oculus\LibOVRPlatform and include them in their build. The following features are available through the Online Subsystems. Feature Online Subsystem Interface Achievements Achievements Top Players Leaderboards Friends Leaderboards Rooms Sessions Matchmaking Sessions Cloudsaves Cloudsaves Identity Identity Entitlements Identity VoIP Voice

36 36 Oculus Platform Features and Online Subsystems Unreal Feature Online Subsystem Interface P2P Networking Netdriver To enable the OSS plugin, select Edit > Plugin Settings > Built-In > Online Platform > Online Subsystem Oculus, and check Enabled. To access Oculus Platform features through Online Subsystems, you must adjust your defaultengine.ini file to use Oculus: [OnlineSubsystem] DefaultPlatformService=Oculus [OnlineSubsystemOculus] benabled=true OculusAppId=<app_id_here> For more information on Unreal Subsystems, see Epic s Online Subsystems Overview. Entitlement Checking Entitlement checking may be used to protect apps from unauthorized distribution. Unreal developers using Blueprints can use the Verify Entitlements Blueprint under Oculus > Entitlement. For more information and instructions, see the Platform section of Blueprints on page 40 and Entitlements: App Authorizations in our Platform guide. Applications should always have entitlement checks enabled for submissions to the Oculus store. VoIP Our Online Subsystems implementation of VoIP extends the Unreal class IOnlineVoice. See Unreal s IOnlineVoice reference for more information. To enable VoIP in DefaultEngine.ini: [OnlineSubsystem] DefaultPlatformService=Oculus bhasvoiceenabled=true [Voice] benabled=true To connect to someone else: Online::GetVoiceInterface()->RegisterRemoteTalker(<FUniqueNetIdOculus>); To disconnect from someone: Online::GetVoiceInterface()->UnregisterRemoteTalker(<FUniqueNetIdOculus>); To see if a remote user is talking: Online::GetVoiceInterface()->IsRemotePlayerTalking(<FUniqueNetIdOculus>); To unmute yourself: Online::GetVoiceInterface()->StartNetworkedVoice(0);

37 Unreal Oculus Platform Features and Online Subsystems 37 To mute yourself: Online::GetVoiceInterface()->StopNetworkedVoice(0); P2P Our Online Subsystem implementation of P2P extends the Unreal class UNetDriver. See Unreal's UNetDriver reference for more information. To enable P2P in DefaultEngine.ini: [/Script/Engine.GameEngine] +NetDriverDefinitions=(DefName="GameNetDriver",DriverClassName="OnlineSubsystemOculus.OculusNetDriver",DriverClass [/Script/OnlineSubsystemOculus.OculusNetDriver] NetConnectionClassName="OnlineSubsystemOculus.OculusNetConnection" To act as the host of a game, open the map as a listen server. To act as the client of the game, open a connection to <oculus_id_of_host>.oculus.

38 38 Unreal Console Commands Unreal Unreal Console Commands This document reviews useful console commands available for Unreal development. Rift: Press the tab keys while your game is running to bring up the console. Gear VR: To bring up the console on a mobile device, set it to developer mode (instructions developer.oculus.com/documentation/mobilesdk/latest/concepts/mobile-troublesh-device-run-app-outside/), launch the application, and tap the screen with four fingers. To specify console commands to be loaded on startup, in most cases you should add them to Engine/Config/ ConsoleVariables.ini. See Loading Console Variables in Epic s Console Manager: Console Variables in C++ for more information. For more information, see "Useful VR Console Commands" in Unreal's VR Cheat Sheet. Table 3: Configuration Commands Command Description stereo on off Enables/Disables stereo mode. stereo e=0.064 Eye distance (m). stereo w2m=100 Overrides default world-units-to-meters scale. stereo ncp=10 fcp=10000 Overrides near clipping and/or far clipping planes for stereo rendering (in cm). stereo cs=1 ps=1 Overrides camera and position scale. stereo show Shows current ipd and head model offset. stereo reset Resets stereo settings. hmd enable disable Enables/Disables HMD. hmd pd [0..3.0] Sets pixel density in the center (default is 1.0). hmd pdadaptive on off Enables/Disables adaptive pixel density (see Adaptive Pixel Density on page 32 for more d hmd pdmax [ ] Sets maximum adaptive pixel density (ignored if hmd pdadaptive is off). hmd pdmin [ ] Sets minimum adaptive pixel density (ignored if hmd pdadaptive is off). hmd sp [ ] Overrides screenpercentage for stereo mode. (Deprecated, use 'hmd pd xxx' instead). hmd hqdistortion on off Enables/Disables high-quality distortion. hmd mirror on off Enables/Disables mirroring to the desktop window.

39 Unreal Unreal Console Commands 39 Command Description hmd mirror mode [0..4] Sets mirror mode: 0=Distorted, 1=Undistorted, 2=SingleEye, 3=SingleEye Letterboxed, 4=SingleEye Cropped hmdpos on off toggle Enables/Disables/Toggles positional tracking. hmdpos enforce on off Enables/Disables head tracking even if not in stereo (for testing purposes). hmdpos reset {yaw} Resets position and rotation, applies yaw (in degrees) if provided. hmdpos resetrot {yaw} Resets rotation only, applies yaw (in degrees) if provided. hmdpos resetpos Resets position only. hmdpos show Outputs status of positional tracking to log. hmdpos floor eye Selects tracking origin. Table 4: Misc Commands Command Description hmd stats Shows HMD-related stats. hmd grid Toggles lens-centered grid. hmd updateongt on off Enables/Disables updating HMD pose on game thread. On by default. hmd updateonrt on off Enables/Disables updating HMD pose on render thread, for lower latency. On by default. hmd cubemap [gearvr] [xoff=n] Generates a cube map image of your application. May be used for VR app previews in the [yoff=n] [zoff=n] [yaw=n] Store. Cube map PNGs will be saved in the directory GameDir/Saved/Cubemaps. gearvr: If specified, cube map size will be 6x1024x1024, otherwise it will be 6*2048x2048. xoff, yoff, zoff: Offset from the current player's location. yaw: override yaw rotation (degrees). hmd setint PerfHUDMode [0..4] Selects performance HUD mode, set to 0 to disable. hmd setint DebugHudStereoMode [0..3] Selects debug HUD stereo mode, set to 0 to disable. hmdversion Prints Oculus SDK version used and Oculus Plugin info.

40 40 Blueprints Unreal Blueprints Oculus Blueprints are available for developer use. Gear VR To access Blueprints for Gear VR, you must enable the Gear VR plugin in Edit > Plugins > Virtual Reality. The following Blueprints under the Gear VR class are provided to assist with mobile development: Are Head Phones Plugged In - returns bool Get Battery Level - returns float Get Temperature in Celsius - returns float Is Power Level State Minimum - returns bool Is Power Level State Throttled - returns bool Set CPU And GPU Levels - passes floats to Gear VR Function Library Oculus Rift To access these Blueprints, you must enable the Online Subsystem Oculus in Edit > Plugin > Online Platform. The following Blueprints are available for Rift development: Add Oculus Rift Boundary Component - Creates a new Guardian System boundary component and assigns ownership of it to an actor. Cast to Oculus Rift Boundary Component Cast to Oculus Rift Boundary Component Class Oculus Rift Input To access these Blueprints, you must enable the Online Subsystem Oculus in Edit > Plugin > Online Platform. Gamepad events return Oculus Remote button events (bool) return Oculus Touch button events (bool) Gamepad Values - return Oculus Touch values (floats)

41 Unreal Blueprints 41 Oculus Library - provides a number of Blueprints for querying and controlling splash screen, HMD pose, loading icon, user profile, raw sensor data, position scale, and more. Oculus Touch The following Blueprints are not Oculus-specific, but may be used to control haptics for the Xbox or Oculus Touch controllers. For detailed information, see Haptics for Rift Controllers on page 18 Play Haptic Effect Stop Haptic Effect Set Haptics by Value Play Haptic Soundwave Platform To access these Blueprints, you must enable the Online Subsystem Oculus in Edit > Plugin > Online Platform. Verify Entitlements - verifies the user is authorized to run the application. Get Oculus Identity - returns Oculus ID and Oculus username as strings; provides flow control for On Success/On Failure In this simple example of the Verify Entitlement Blueprint, the application will verify that the user has an entitlement when the application launches, and quit if the check fails. In reality, we recommend providing an appropriate error message before shutting down. This example of the Get Oculus Identity Blueprint illustrates how to print the user s Oculus ID to the log or screen.

42 42 Blueprints Unreal

43 Unreal Unreal Samples 43 Unreal Samples Oculus provides samples which illustrate basic VR concepts in Unreal such as Touch, haptics, and the Boundary Component API for interacting with the Guardian System. Samples are available from the Oculus Unreal GitHub repository. To access this repository, you must hold a UE4 license and be subscribed to the private EpicGames/UnrealEngine repository (see for details). All samples require a compatible version of the Unreal Engine which supports the illustrated features. To explore samples, we generally recommend using Unreal versions that we ship from our GitHub repository, which always include the latest features. For a review of which Unreal versions support which features, see Introduction and Version Compatibility on page 4. Boundary Sample BoundarySample is a Blueprint sample that illustrates the use of the Boundary Component API for interacting with our Guardian System. This API allows developers to query the Guardian System trigger state, return the closest boundary point to a queried device or point, and more. In this sample, the Guardian System Boundary Area is visualized on the ground in orange-yellow, and the Play Area is visualized on the ground in purple. Two spheres track the Touch controllers. When they approach the Boundary Area, they project a colored arrow toward the nearest sample point in the Guardian Area. NewGameMode and VRCharacter are used to initialize the scene and make the scene display at the appropriate height, et cetera. Controls and Behavior

44 44 Unreal Samples Unreal These behaviors are controlled by the BoundarySampleMap, which you can use as a reference for implementing related functionality. Test Control or Behavior RequestOuterBoundaryVisible() Press 'V' on keyboard/right Touch button A to request boundary on. Press 'X'/right Touch button B to cancel. SetOuterBoundaryColor() Press 'G' on keyboard/left Touch button X to set boundary to green. Press 'P'/left Touch button Y to make purple. IsOuterBoundaryDisplayed() If so, cylinder is not visible. IsOuterBoundaryTriggered() If so, cone is not visible (cone should remain if boundaries are requested on by application). GetTriggeredOuterBoundaryInfo() Visualize normals. GetTriggeredPlayAreaInfo() Visualize normals. OnOuterBoundaryTriggered Cube made visible. Event OnOuterBoundaryReturned Cube made invisible. Event Layer Sample LayerSample is a Blueprint sample that illustrates the use of VR Compositor Layers to display a UMG UI. This sample includes two spheres that track with the Touch controllers and two UMG widgets rendered as VR Compositor layers. One is rendered as a quad layer and the other as a cylinder layer. Because cylinder layers are not currently supported on the Rift, note that the cylinder layer only appears cylindrical when viewed on Gear VR. When the scene is viewed on the Rift, you will only see a quad.

45 Unreal Unreal Samples 45 Actor_Blueprint illustrates rendering a UMG widget into a stereo layer. The widget is first rendered into a Material, then the SlateUI texture is pulled from the Material into the stereo layer. This is the UMG widget that is rendered to the quad and cylindrical layers in the sample. Open MenuBlueprint to open the UMG widget in the UMG Editor. NewGameMode and VRCharacter are used to initialize the scene and make the scene display at the appropriate height, et cetera. Touch Sample TouchSample illustrates basic use of Oculus Touch including controller tracking and thumbstick control. It also illustrates haptics control using PlayHapticEffect() and PlayHapticSoundWave(). Two spheres track with the Touch controllers. The right controller thumbstick may be used to control the position of the light gray box. Touch capacitance sensors detect whether the right thumb is in a touch or near-touch position, which controls the height of the box. Press and hold the left Touch grip button to play a haptics clip. Press and hold the left Touch X button to create a haptics effect by setting the haptics value directly.

46 46 Unreal Samples Unreal You will find the Haptics control Blueprint and the Thumbstick control Blueprint in the sample Level Blueprint. NewGameMode and VRCharacter are used to initialize the scene and make the scene display at the appropriate height, et cetera.

47 Unreal Testing and Performance Analysis in Unreal 47 Testing and Performance Analysis in Unreal VR application debugging is a matter of getting insight into how the application is structured and executed, gathering data to evaluate actual performance, evaluating it against expectation, then methodically isolating and eliminating problems. When analyzing or debugging, it is crucial to proceed in a controlled way so that you know specifically what change results in a different outcome. Focus on bottlenecks first. Only compare apples to apples, and change one thing at a time (e.g., resolution, hardware, quality, configuration). Always be sure to profile, as systems are full of surprises. We recommend starting with simple code, and optimizing as you go - don t try to optimize too early. Performance Targets Before debugging performance problems, establish clear targets to use as a baseline for calibrating your performance. These targets can give you a sense of where to aim, and what to look at if you re not making frame rate or are having performance problems. Below you will find some general guidelines for establishing your baselines, given as approximate ranges unless otherwise noted. Mobile 60 FPS (required by Oculus Store) draw calls per frame 50, ,000 triangles or vertices per frame PC 90 FPS (required by Oculus Store) 500-1,000 draw calls per frame 1-2 million triangles or vertices per frame For more information, see: PC SDK Developer Guide Mobile VR Application Development Oculus Store Submission Requirements Oculus Rift App Requirements Gear VR App Requirements Rift Performance HUD The Oculus Performance Heads-Up Display (HUD) is an important, easy-to-use tool for viewing timings for render, latency, and performance headroom in real-time as you run an application in the Oculus Rift. The HUD is easily accessible through the Oculus Debug Tool provided with the PC SDK. You may activate it in the Viewport by pressing the ~ key. For more details, see the Performance Heads-Up Display and Oculus Debug Tool sections of the Oculus Rift Developers Guide.

48 48 Testing and Performance Analysis in Unreal Unreal Rift Compositor Mirror The compositor mirror is an experimental tool for viewing exactly what appears in the headset, with Asynchronous TimeWarp and distortion applied. The compositor mirror is useful for development and troubleshooting without having to wear the headset. Everything that appears in the headset will appear, including Oculus Home, Guardian boundaries, ingame notifications, and transition fades. The compositor mirror is compatible with any game or experience, regardless of whether it was developed using the native PC SDK or a game engine. For more details, see the Compositor Mirror section of the PC SDK Guide. Debug Console (Mobile) If your phone is set to Developer Mode, you may bring up a debug console for VR apps by pressing the screen with four fingers simultaneously while the application is running. Enter stat unit in the console for information about your application frame rate and CPU performance. Oculus Remote Monitor (Mobile) The Oculus Remote Monitor client connects to VR applications running on remote mobile devices to capture, store, and display the streamed-in data. The VrCapture library is automatically included in Unreal projects, so setup and use of the Oculus Remote Monitor is easy. Oculus Remote Monitor is available from our Downloads page. For more information about setup, features, and use, see Oculus Remote Monitor in our Mobile SDK guide. The Frame Buffer Viewer provides a mechanism for inspecting the frame buffer as the data is received in real-time, which is particularly useful for monitoring play test sessions. When enabled, the Capture library will stream a downscaled pre-distortion eye buffer across the network.