EOS Overlay

Using the EOS Overlay for in-app purchases.

Starting with version 1.2 of the Epic Online Services (EOS) SDK, an overlay was introduced to support in-app purchasing in games that use the SDK on the Epic Games Store.

Initialization

It is important to initialize the EOS SDK and call EOS_Platform_Create before initializing Direct3D. This gives the EOS Overlay a chance to install graphics API hooks necessary to render the overlay with each game frame presented to the user. In some cases, it may be desirable to disable the overlay functionality entirely. An example of this might be when a developer is running the game in an editor, and hooking the graphics API of the editor would cause problems. The EOS_Platform_Options passed to EOS_Platform_Create has been extended to take a Flags member, a bit-field with room for 64 flags. Currently there are two flags that will disable the overlay: 1. EOS_PF_LOADING_IN_EDITOR - This flag should be set whenever the EOS SDK is being used in a game editor such as UE4 Play-in-Editor (PIE) or Unity. 1. EOS_PF_DISABLE_OVERLAY - This flag should be set whenever you want to explicitly disable the overlay functionality. Purchase related functionality in the Ecom Interface will fail.

Installation

The EOS Overlay is installed by the Epic Games Launcher. In the future, the overlay will come as a redistributable installer package.

The EOS SDK looks up the location of the overlay from a registry key. This key needs to be set to the EOS Overlay binaries folder, and the Epic Games Launcher writes this key when the overlay is installed. As it may be helpful to know where this key is to troubleshoot issues, it can be found at HKEY_CURRENT_USER\Software\Epic Games\EOS\OverlayPath

Compatible Rendering APIs and Operating Systems

In addition to the common console commands, this sample supports the following additional console commands, which you can enter in-game:

Windows

Availability

API

Available Now

  • Direct3D 12

  • Direct3D 11

  • Vulkan

Coming Soon

  • Direct3D 10

  • Direct3D 9

  • OpenGL

macOS

Availability

API

Coming Soon

  • Metal

  • Vulkan

  • OpenGL

Linux

Availability

API

Coming Soon

  • Vulkan

  • OpenGL