概要
このドキュメントでは、Interhaptics Engine API で利用可能な関数の概要を説明します。この API を使用することで、開発者は Interhaptics Engine と対話し、ハプティック効果を制御したり、ボディパーツを管理したり、ハプティックイベントを制御したりできます。
この SDK は、サポートされるさまざまなプラットフォーム上でゲームアプリケーションに Interhaptics Engine を統合するための包括的なツールとリソースを提供します。次のページでは、ゲームエンジン内での統合に必要なコンポーネントと推奨される手順について説明します。
Interhaptics for Game Engine SDK の入手
SDK にアクセスするために、以下の必要事項を入力してください
GitHub にアクセス - Interhaptics Engine をダウンロード
記事
コンポーネント
Interhaptics Engine には、エンジン内統合を行うために必要な以下のコンポーネントが含まれています。主要な 2 つのコンポーネントは、Haptic Engine とデバイスプロバイダーです。
-
Haptic Engine ライブラリ: 各サポートされるアーキテクチャ向けに調整されたこれらのライブラリは、ハプティックフィードバックに必要な機能を提供します。
-
Haptic Engine C++ API: 開発者が Haptic Engine と対話し、ゲームアプリケーション内のハプティック効果を制御できる一連の C++ API です。
-
デバイスプロバイダーライブラリ: サポートされる各プラットフォーム固有のライブラリで、ハプティックデバイスとの通信を可能にし、必要なデバイス関連機能を提供します。
-
ドキュメント: 統合プロセス、API リファレンス、使用ガイドラインを説明する詳細なドキュメントです。
統合プロセス
Interhaptics Engine をゲームアプリケーションに正常に統合するために、以下の手順が推奨されます。
-
Interhaptics Engine ライブラリの統合: このステップでは、Interhaptics Engine ライブラリをゲームアプリケーションに統合します。対象プラットフォームに応じて、ライブラリのパッケージ化、ロード、初期化を含みます。
-
.haps ファイルアセットのサポート: Interhaptics 独自のハプティック効果 (.haps) をゲームアセットとしてサポートし、ゲームプレイ中にこれらの効果をエンジンがロードおよびアンロードできるようにします。
-
デバイスプロバイダーライブラリの統合: デバイスプロバイダーライブラリをゲームアプリケーションに統合します。このステップには、対象プラットフォーム向けにライブラリをパッケージ化、ロード、初期化することが含まれ、ハプティックデバイスとの通信を可能にします。
-
レンダリングループとプロバイダーループの統合: ゲームエンジンのレンダリングループを Interhaptics Engine のプロバイダーループと統合します。この同期により、適切なハプティックフィードバックを保証し、サポートされるプラットフォーム間の互換性を維持します。
これらの推奨手順に従うことで、ゲームエンジンは以下の機能を獲得します。
- ゲームプレイ中に Interhaptics 独自の効果 (.haps) をロードおよびアンロードする。
- ゲームイベントに基づいてハプティックソースを制御する。
- クロスプラットフォーム互換性を保証するために、サポートされる異なるプラットフォーム間でハプティック体験をマッピングする。
各統合ステップに関する詳細な手順とガイドラインについては、Interhaptics Engine SDK に付属のドキュメントを参照してください。
なお、Interhaptics Engine SDK は、以下の画像に示すように、Interhaptics が公式にサポートするすべてのプラットフォームに対応しています。対象プラットフォームとの互換性を確認し、追加の統合要件や考慮事項についてはプラットフォーム固有のドキュメントを参照してください。
Interhaptics Engine ライブラリ
Interhaptics Engine ライブラリは、ハプティックフィードバックをゲームアプリケーションに統合するための必須機能を提供する、プリコンパイル済みの C++ ライブラリです。以下のプラットフォームで利用可能です。
- Windows x64
- PlayStation Prospero（オンデマンド）
- Xbox UWP（オンデマンド）
- Switch ARM（オンデマンド）
- iOS arm64（オンデマンド）
- Android arm7 / arm64（オンデマンド）
ロードと初期化
Interhaptics Engine ライブラリを利用する前に、ゲームアプリケーション内で適切にロードして初期化する必要があります。初期化プロセスにより、ライブラリが使用可能な状態となり、利用可能な API へのアクセスが可能になります。
機能
Interhaptics Engine ライブラリは、以下を含むハプティックフィードバックのさまざまな側面を処理します。
- ハプティック効果のロードとアンロード: ライブラリはハプティック効果のロードとアンロードを管理し、ゲーム開発者がハプティック体験を動的に制御できるようにします。
- ハプティックソースの制御: 開発者はライブラリの API を利用して、ゲームイベントに応じてハプティックソースを制御し、没入感のある体験を強化できます。
- ハプティックミキシング: ライブラリはハプティックミキシング機能を組み込み、複数のハプティック効果を組み合わせて複雑なフィードバックパターンを作成します。
- ハプティックレンダリング: Interhaptics Engine ライブラリは、ハプティック効果のレンダリングを促進し、現実的なハプティックフィードバックを提供するために正確な表現を保証します。
デバイスプロバイダー
デバイスプロバイダーは、Interhaptics Engine とさまざまなデバイスのハプティック API 間の通信を確立するためのプリコンパイル済みライブラリの集合です。これらのライブラリは、Interhaptics Engine とサポートされるデバイス間の統合と相互運用性を促進します。
機能
デバイスプロバイダーは、以下のタスクを処理します。
- デバイスの初期化: 必要に応じて、デバイスプロバイダーは接続されたハプティックデバイスを初期化し、Interhaptics Engine との対話のための準備を行います。
- レンダリング出力へのサブスクリプション: プロバイダーは Interhaptics Engine のレンダリング出力にサブスクライブし、ハプティックフィードバックが接続されたデバイスに適切に配信されることを保証します。
- トランスコーディング: デバイスプロバイダーは、Interhaptics Engine と対象のハプティック API 間で必要なハプティックデータのトランスコーディングを処理し、互換性とシームレスな通信を保証します。
Interhaptics Engine とデバイスプロバイダーに関連するロード、アンロード、レンダリングプロセスの詳細については、本ドキュメントの主要概念セクションを参照してください。
ゲームアプリケーションへの Interhaptics Engine ライブラリおよびサポートされるデバイスプロバイダーの統合に関する包括的な手順と使用ガイドラインについては、付属のドキュメントを参照してください。
.haps ファイル
.haps ファイルは、設計されたハプティック効果のハプティックパラメータを格納する標準テキストファイルです。これらのファイルは、ハプティック効果の構成とプロパティを表現するために JSON (JavaScript Object Notation) 形式を利用します。Interhaptics Engine は、ゲームプレイ中に特定のハプティック効果をロードして適用するために .haps ファイルに依存しています。
ファイル構造と形式
.haps ファイルの構造と形式は、Haptic Composer ドキュメントで指定されたガイドラインに従います。.haps ファイルの構造と内容に関する包括的な情報については、以下のリンクから Interhaptics オンラインドキュメントを参照してください。
.haps ファイル形式と Haptic Composer ツールを使用したハプティック効果の設計方法を十分に理解するため、オンラインドキュメントを参照してください。
ゲームアプリケーション内の .haps ファイルが指定された構造と形式に準拠していることを確認し、Interhaptics Engine によるハプティック効果の適切なロードと適用を保証してください。