メインメニューを開く

MonoGame/クラスライブラリ/RenderTargetUsage列挙体

< MonoGame‎ | クラスライブラリ

RenderTargetUsage列挙体は、グラフィックデバイス(GraphicsDeviceクラス)に新たなレンダリングターゲット(RenderTarget2Dクラス)を設定したとき、そのレンダリングターゲットのデータをどのように処理するかを指定するのに使用する列挙体である。

目次

名前空間編集

構文編集

public enum RenderTargetUsage

フィールド編集

概要
DiscardContents 常にレンダリングターゲットのデータを削除する。
PlatformContents プラットフォームに応じて扱いを変える。使うな危険。
PreserveContents 常にレンダリングターゲットのデータを保持する。

備考編集

PreserveContentsは遅い編集

PreserveContentsはVRAM容量が少ない環境ではメインメモリへの保存と復元が発生するため絶望的なほど遅くなる。 PCではまず問題になることはないようだが、一部のスマホでは絶望的な速度になるようだ。 なるべくDiscardContentsを使ったほうが良さそうだ。

DiscardContentsの注意点編集

DiscardContents設定になっていると「GraphicsDevice.SetRenderTargetするたびに破棄(初期化)される」という特徴がある。この特性があるためレンダリング系APIの呼出順序を間違えると残念なことになる。

GraphicsDevice.SetRenderTarget(このRenderTargetは初期化される);

ちなみにGraphicsDeviceが最初から持っているレンダリングターゲット(DirectXでいうプライマリサーフェイス、SetRenterTarget(null))に相当するものは問答無用でDiscardContentsに設定されている。

このため、たとば以下のコードは正常に動作しない。

protected override void Draw(GameTime gameTime)
{
    var gd = _graphics.GraphicsDevice;

    // (1)プライマリサーフェイスを塗りつぶす
    gd.Clear(Color.CornflowerBlue);

    // (2)レンダリングターゲットを切り替える
    gd.SetRenderTarget(new RenderTarget2D(GraphicsDevice, 128, 128));

    // (3)レンダリングターゲットをプライマリサーフェイスに戻す
    // プライマリサーフェイスは問答無用でDiscardContents設定なので
    // 内容はクリアされ(1)の塗りつぶしは無かったことにされる。
    // なお、(2)のレンダーターゲットは影響を受けない。
    gd.SetRenderTarget(null);

    base.Draw(gameTime);
}

DiscardContentsの場合は以下のような呼出順序で書かなければならない。

protected override void Draw(GameTime gameTime)
{
    var gd = _graphics.GraphicsDevice;

    // (1)レンダリングターゲットを切り替える
    gd.SetRenderTarget(new RenderTarget2D(GraphicsDevice, 128, 128));

    // (2)レンダリングターゲットをプライマリサーフェイスに戻す(と同時にまっさらになる)
    // (1)のレンダーターゲットは影響を受けない。
    gd.SetRenderTarget(null);

    // (3)プライマリサーフェイスを塗りつぶす
    gd.Clear(Color.CornflowerBlue);

    base.Draw(gameTime);
}

関連項目編集