Skip to main content

Overview

This documentation provides an overview of the functions available in the Interhaptics Engine API. The API allows developers to interact with the Interhaptics Engine and control haptic effects, manage body parts, and control haptic events.

This SDK provides a comprehensive set of tools and resources for integrating the Interhaptics Engine into a game application on the various supported platforms. The next pages outline the necessary components and recommended steps for integration within the game engine.

Get Interhaptics for Game Engine SDK​

Please enter the required information below to access the SDK​

Access GitHub - Download Interhaptics Engine

Articles​

Components​

The Interhaptics Engine includes the following components required to do in-engine integration. Its two main components are the Haptic Engine and the Device Providers.

  1. Haptic Engine Libraries: These libraries, tailored for each supported architecture, provide the necessary functionality for haptic feedback.

  2. Haptic Engine C++ APIs: A set of C++ APIs that allow developers to interact with the Haptic Engine and control haptic effects within the game application.

  3. Device Provider Libraries: Libraries specific to each supported platform, enabling communication with haptic devices and providing necessary device-related functionality.

  4. Documentation: Detailed documentation explaining the integration process, API references, and usage guidelines.

Integration Process​

To successfully integrate the Interhaptics Engine into a game application, the following steps are recommended:

  1. Interhaptics Engine Library Integration: This step involves integrating the Interhaptics Engine library into the game application. It includes packaging, loading, and initializing the library according to the targeted platform.

  2. Support for .haps File Assets: Enable support for Interhaptics' proprietary haptic effects (.haps) as game assets, allowing the engine to load and unload these effects during gameplay.

  3. Device Providers Libraries Integration: Integrate the Device Provider libraries into the game application. This step includes packaging, loading, and initializing the libraries for the targeted platform, enabling communication with haptic devices.

  4. Rendering Loop and Provider Loop Integration: Integrate the rendering loop of the game engine with the Provider loop of the Interhaptics Engine. This synchronization ensures proper haptic feedback and maintains compatibility across the supported platforms.

By following these recommended steps, the game engine will gain the following capabilities:

  • Load and unload Interhaptics proprietary effects (.haps) during gameplay.
  • Control haptic sources based on game events.
  • Map the haptic experience across different supported platforms to ensure cross-platform compatibility.

For detailed instructions and guidelines on each integration step, please refer to the accompanying documentation provided with the Interhaptics Engine SDK.

Please note that the Interhaptics Engine SDK supports all platforms officially supported by Interhaptics as shown in the image below. Ensure compatibility with the target platform and refer to the platform-specific documentation for any additional integration requirements or considerations.

Interhaptics Engine Schema
Interhaptics Engine Schema

Interhaptics Engine Libraries​

The Interhaptics Engine Library is a precompiled C++ library that provides essential functionality for integrating haptic feedback into game applications. It is available for the following platforms:

  • Windows x64
  • PlayStation Prospero (on demand)
  • Xbox UWP (on demand)
  • Switch ARM (on demand)
  • iOS arm64 (on demand)
  • Android arm7 / arm64 (on demand)

Loading and Initialization​

Before utilizing the Interhaptics Engine Library, it must be properly loaded and initialized in the game application. The initialization process ensures the library is ready for use and enables access to the available APIs.

Functionality​

The Interhaptics Engine Library handles various aspects of haptic feedback, including:

  • Loading and unloading haptic effects: The library manages the loading and unloading of haptic effects, allowing game developers to dynamically control the haptic experience.
  • Control of haptic sources: Developers can utilize the library's APIs to control haptic sources in response to game events, enhancing the immersive experience.
  • Haptic mixing: The library incorporates haptic mixing capabilities to combine multiple haptic effects and create complex feedback patterns.
  • Haptic rendering: The Interhaptics Engine Library facilitates the rendering of haptic effects, ensuring their accurate representation to provide realistic haptic feedback.

Device Providers​

Device Providers are a collection of precompiled libraries responsible for establishing communication between the Interhaptics Engine and haptic APIs of various devices. These libraries facilitate the integration and interoperability between the Interhaptics Engine and supported devices.

Functionality​

The device providers handle the following tasks:

  • Device Initialization: If required, the device providers initialize the connected haptic devices, preparing them for interaction with the Interhaptics Engine.
  • Subscription to Rendering Output: The providers subscribe to the Interhaptics Engine's rendering output, ensuring that haptic feedback is appropriately delivered to the connected devices.
  • Transcoding: The device providers handle the necessary transcoding of haptic data between the Interhaptics Engine and the targeted haptic APIs, ensuring compatibility and seamless communication.

Refer to the Key Concepts section of this documentation for more detailed information on loading, unloading, and rendering processes related to the Interhaptics Engine and device providers, respectively.

Please consult the accompanying documentation for comprehensive instructions and usage guidelines on integrating the Interhaptics Engine Library and supported device providers into your game application.

.haps Files​

.haps files are standard text files that store haptic parameters for designed haptic effects. These files utilize the JSON (JavaScript Object Notation) format to represent the haptic effect's configuration and properties. The Interhaptics Engine relies on .haps files to load and apply specific haptic effects during gameplay.

File Structure and Format​

The structure and format of .haps files follows the guidelines specified in the Haptic Composer documentation. You can find comprehensive information about the structure and contents of .haps files by referring to the Interhaptics online documentation at the following link.

Please consult the online documentation to thoroughly understand the .haps file format and how to design haptic effects using the Haptic Composer tool.

Ensure that the .haps files in your game application adhere to the specified structure and format to guarantee proper loading and application of haptic effects by the Interhaptics Engine.