# GX_TrySetBankForBGExtPltt

## 構文

  `#include <nitro/gx/gx_vramcnt.h>`
  `BOOL GX_TrySetBankForBGExtPltt(GXVRamBGExtPltt bgExtPltt);`

## 引数

bgExtPltt | メイン2DエンジンのBG拡張パレットに割り当てるVRAMバンクを指定

## 返り値

正常にVRAMバンクが割り当てられた場合にTRUEを返します。
割り当てようとするVRAMバンクが別ライブラリによってロックされている場合にはFALSEを返します。

## 説明

メイン2DエンジンのＢＧ拡張パレットへ指定されたVRAMバンクの割り当てを試みます。指定されたVRAMバンクがDisableになっているか、LCDCに割り当てられている場合に、そのVRAMバンクをメイン2DエンジンのBG拡張パレットに割り当てます。
また、指定したVRAMバンクが他のライブラリによって排他ロックされている場合は割り当てに失敗します。
(注意) BG拡張パレットにVRAMバンクを割り当てると、テキストBGでカラーモードを256色を指定するか、256x16パレットBGを選択した場合、BG拡張パレットのパレット情報を参照します。その他の場合は標準パレットを参照することになります。

`GX_VRAM_BGEXTPLTT_NONE` | BG拡張パレットにVRAMバンクを割り当てません。
`GX_VRAM_BGEXTPLTT_01_F` | BG拡張パレットのスロット0,1を確保します。VRAM-Fを割り当てます。
`GX_VRAM_BGEXTPLTT_23_G` | BG拡張パレットのスロット2,3を確保します。VRAM-Gを割り当てます。
`GX_VRAM_BGEXTPLTT_0123_E` | BG拡張パレットのスロット0,1,2,3を確保します。VRAM-Eを割り当てます。
`GX_VRAM_BGEXTPLTT_0123_FG` | BG拡張パレットのスロット0,1,2,3を確保します。VRAM-F,Gを割り当てます。

以下に`GXVRamBGExtPltt`型の型定義を示しておきます。

    typedef enum
    {
        GX_VRAM_BGEXTPLTT_NONE    = 0x0000,
        GX_VRAM_BGEXTPLTT_01_F    = GX_VRAM_F,              // BGExtPltt 0-1 <--- Caution
        GX_VRAM_BGEXTPLTT_23_G    = GX_VRAM_G,              // BGExtPltt 2-3 <--- Caution // BGCNTで共有設定するときに使用できる
        GX_VRAM_BGEXTPLTT_0123_E  = GX_VRAM_E,              // BGExtPltt 0-3
        GX_VRAM_BGEXTPLTT_0123_FG = GX_VRAM_F | GX_VRAM_G   // BGExtPltt 0-1,2-3
    }
    GXVRamBGExtPltt;

## 参照

GX_SetBankForBGExtPltt, GX_GetBankForBGExtPltt, GX_ResetBankForBGExtPltt, GX_DisableBankForBGExtPltt, GX_GetSizeOfBGExtPltt

## 履歴

Ver. 2005/02/15 初版