GettingStarted

← Home

Getting Started

前提条件

• .NET 10 SDK
• SteamVR がインストール済みで、アプリ実行前に起動していること
• OpenVR ランタイム（SteamVR に同梱）

---

サンプルアプリを動かす（最速）

リポジトリをクローンしたらまずサンプルアプリを起動してフレームワークの動作を確認できます。

# SteamVR を起動してから実行する
dotnet run --project samples/FloatSoda.Samples.OverlayApp

起動すると SteamVR ダッシュボードに FloatSodaDashboard タブが追加され、中央に 100×100 のカラーボックスが表示されます(samples/FloatSoda.Samples.OverlayApp/Program.cs)。

SteamVR を終了するか VREvent_Quit を受信するとアプリも自動終了します。

サンプルには StatefulWidget を使った時計ウィジェット(WatchWidget.cs)も含まれていますが、StatefulElement が未実装のため現在はコメントアウトされています。

---

新しいアプリを作る

1. プロジェクトを作成する

dotnet new console -n MyOverlayApp
cd MyOverlayApp
dotnet add reference ../path/to/FloatSoda/src/FloatSoda/FloatSoda.csproj

2. 最小構成のコードを書く

Program.cs を以下のように書き換えます。Widget ベースの書き方が推奨です。

using FloatSoda;
using FloatSoda.Widgets;
using FloatSoda.Widgets.Layout;
using FloatSoda.Widgets.Paint;
using SkiaSharp;

var builder = FloatSodaAppBuilder.CreateDefault();
using var app = builder.Build();

Widget root = new Center
{
    Child = new ColoredBox
    {
        Color = SKColors.CornflowerBlue,
        Child = new SizedBox { Width = 400, Height = 200 }
    }
};

app.CreateDashboardOverlay("HelloWorld", root, 1000, 1000);

app.Run();

# SteamVR を起動してから実行
dotnet run

app.Run() は SteamVR が終了するまでブロックします。

Widget の実装状況: Center, Align, Column, Row, Flex, ColoredBox, SizedBox, ConstrainedBox, Clip*, RichText, Text などは使用可能です。Padding, Button, StatefulWidget 系は WIP（NotImplementedException）です。詳細は WidgetSystem.md を参照。

RenderObject レベルの直接操作（低レベル API）

using FloatSoda;
using FloatSoda.Geometrics;
using FloatSoda.RenderObjects.Layout;
using FloatSoda.RenderObjects.Painting;
using SkiaSharp;

var builder = FloatSodaAppBuilder.CreateDefault();
using var app = builder.Build();

var root = new RenderPositionedBox
{
    Child = new RenderConstrainedBox
    {
        AdditionalConstraints = BoxConstraints.Tight(400, 200),
        Child = new RenderColoredBox { Color = SKColors.CornflowerBlue }
    }
};

app.CreateDashboardOverlay("HelloWorld", root, 1000, 1000);
app.Run();

---

オーバーレイ種別の選び方

FloatSodaApp には 3 種類のオーバーレイ作成メソッドがあります。

メソッド	オーバーレイ種別	位置の管理
CreateDashboardOverlay(name, root, w, h)	DashboardOverlay	SteamVR ダッシュボードが管理（ユーザーが開くタブ）
CreateWorldSpaceOverlay(name, root, w, h, position)	WorldSpaceOverlay	ワールド座標で固定（Vector3 position）
CreateTrackingOverlay(name, root, w, h, device)	DeviceTrackedOverlay	トラッキングデバイスに追従（TrackedDevice 列挙体）

// ダッシュボード
app.CreateDashboardOverlay("MyDashboard", root, 1000, 1000);

// ワールド座標 (x=0, y=1, z=-1 メートル)
app.CreateWorldSpaceOverlay("MyWorld", root, 1000, 1000, new Vector3(0, 1, -1));

// 左コントローラーに追従
app.CreateTrackingOverlay("MyHand", root, 1000, 1000, TrackedDevice.LeftController);

---

フレームレート設定

FloatSodaAppBuilder でフレームレートを制御できます。

// 固定 FPS（デフォルトは IFrameLimiter 実装に依存）
var builder = FloatSodaAppBuilder.CreateDefault();
builder.WithTargetFrameRate(90);

// OpenVR Compositor のタイミングに同期（推奨: WaitGetPoses ベース）
builder.WithOpenVRFrameLimiter();

using var app = builder.Build();

VR アプリでは WithOpenVRFrameLimiter() を使うと Compositor のリフレッシュレートに同期できます。WithTargetFrameRate() を指定しない場合のデフォルトは 30fps です。

---

関連ページ

• WidgetSystem — 使えるウィジェットの一覧と実装状況
• OVRIntegration — オーバーレイ種別・プロパティ・イベント処理の詳細
• Architecture — フレームワーク内部の全体像