Promete Appの初期化

Promete製アプリの初期化には、まず PrometeApp.Create 静的メソッドを呼び出す必要があります。

using Promete;

var app = PrometeApp.Create()

PrometeApp.Create メソッドは、Prometeアプリケーションのインスタンスを生成するためのビルダーを返します。ビルダーには、メソッドチェーンでアプリケーションの初期化に必要なコンポーネントを追加することができます。

プラグインの追加

プラグインを追加する場合、ビルダーの Use メソッドを呼び出します。

using Promete;

var app = PrometeApp.Create()
  .Use<YourAwesomePlugin>()
  .Use<YourSweetPlugin>()

プラットフォームを指定してビルド

プラグイン追加後のメソッドチェーンで、ビルドメソッドを呼び出します。

BuildWithOpenGLDesktop メソッドは、PrometeをOpenGLを用いたデスクトップアプリとして初期化する拡張メソッドです。

内部的に必要なプラグインをすべて読み込んで初期化し、PrometeApp クラスのインスタンスを返します。

最終的には、以下のような初期化コードになるでしょう。

using Promete;

var app = PrometeApp.Create()
  .Use<YourAwesomePlugin>()
  .Use<YourSweetPlugin>()
  .BuildWithOpenGLDesktop();

実行

アプリケーションを実際に起動する場合、PrometeApp.Run() メソッドを呼び出します。なお、起動にはシーンが必須なので、空のシーンを作成します。

using Promete;

var app = PrometeApp.Create()
  .Use<YourAwesomePlugin>()
  .Use<YourSweetPlugin>()
  .BuildWithOpenGLDesktop();

return app.Run<MainScene>();

public class MainScene : Scene { }

これを実行すると、最小構成のPrometeアプリが起動します。具体的には、640x480の黒いウィンドウです。

Run() メソッドは、アプリケーションが終了するまでブロックします。停止すると、アプリケーションの終了コードが返されます。この例では、終了コードを return しています。

初期値の変更

app.Run() メソッドの引数として、WindowOptions オブジェクトを渡すことで、アプリケーションの初期値を変更することができます。

return app.Run(WindowOptions.Default with
{
  Title = "My App",
  Width = 800,
  Height = 600
});

プロパティ名	型	説明
Location	VectorInt	ウィンドウの表示位置
Size	VectorInt	ウィンドウのサイズ
Title	string	ウィンドウのタイトル
Scale	int	ウィンドウのスケール値。 1, 2, 4, 8を指定でき、その倍率に描画内容を拡大します。
IsFullScreen	bool	フルスクリーンモードで起動するかどうか
Mode	WindowMode	ウィンドウの表示モード。 Resizable, Fixed, NoFrameを指定できます。
TargetFps	int	ターゲットのFPS（描画フレームのレート）。デフォルトは60fpsです。
TargetUps	int	ターゲットのUPS（更新フレームのレート）。デフォルトは60upsです。
IsVsyncMode	bool	垂直同期を有効化するかどうか