表示するサンプルコードの言語を指定できます。

レイヤー (Layer)

概要

レイヤーはパラメーター等を表示しているUI、キャラクターが居るフィールドといったゲームの画面内の大まかな描画先を継承により定義します。レイヤー自体には画像を表示する機能はなく、実際に画像を描画するためにはレイヤーにオブジェクトを登録する必要があります。オブジェクトを複数保持しオブジェクトを管理する機能を持っています。

レイヤー自体を直接使うことはなく基本的には、レイヤーを継承したレイヤー2Dやレイヤー3D(※)を使用します。レイヤー2Dは2D描画の描画先、レイヤー3Dの3D描画の描画先です。詳細はそれぞれの該当項目を参照してください。

本項目では、レイヤー2D及びレイヤー3Dに共通のメソッドとプロパティを解説します。

主なメソッド

名称 説明
AddPostEffect このレイヤーにポストエフェクトを追加します。このレイヤーの描画結果及びこのレイヤー以前に描画された結果に対してポストエフェクトを適用することができます。
ClearPostEffects このレイヤーから全てのポストエフェクトを取り除きます。

主なプロパティ

名称 説明
IsUpdated このレイヤーの毎フレーム実行される更新イベントを実行するか取得または設定します。
IsDrawn このレイヤーの描画処理を実行するか取得または設定します。
DrawingPriority このレイヤーの描画優先度を取得または設定します。値が大きいほど手前に描画されます。

主なイベント

名称 説明
OnAdded レイヤーがシーンに登録された時に実行されるイベント
OnRemoved レイヤーがシーンから登録解除された時に実行されるイベント
OnDispose レイヤーが破棄される時に実行されるイベント
OnUpdating ObjectのOnUpdateが実行される前に毎フレーム実行される更新イベント
OnUpdated ObjectのOnUpdateが実行された後に毎フレーム実行される更新イベント

使用方法

ほぼ全てのサンプルで使用されているので、そちらを参照してください。

※ 現在のバージョンではレイヤー3Dは開発中です。