# GX_SetBankForClearImage

## 構文

  `#include <nitro/gx/gx_vramcnt.h>`
  `void GX_SetBankForClearImage(GXVRamClearImage clrImg);`

## 引数

clrImg | クリアイメージに割り当てるVRAMバンクを指定

## 返り値

なし。

## 説明

指定されたVRAMバンクをクリアイメージに割り当てます。ハードウェア的には、クリアイメージスロットの実体はテクスチャイメージスロット2,3と同じです。指定されたVRAMバンクがDisableになっているか、LCDCに割り当てられている場合に、そのVRAMバンクをクリアイメージに割り当てます。
クリアカラーイメージにVRAMを割り当てない場合にはすべてのピクセルが0でクリアされます。
この時、テクスチャイメージスロット２は使用できません。

`GX_VRAM_CLEARIMAGE_NONE` | クリアイメージにVRAMバンクを割り当てません。
`GX_VRAM_CLEARIMAGE_256_AB` | クリアイメージにVRAM-A,Bを割り当てます。
`GX_VRAM_CLEARIMAGE_256_CD` | クリアイメージにVRAM-C,Dを割り当てます。
`GX_VRAM_CLEARDEPTH_128_A` | クリアデプスイメージにVRAM-Aを割り当てます。 テクスチャイメージスロット2は使用不能になります。
`GX_VRAM_CLEARDEPTH_128_B` | クリアデプスイメージにVRAM-Bを割り当てます。 テクスチャイメージスロット2は使用不能になります。
`GX_VRAM_CLEARDEPTH_128_C` | クリアデプスイメージにVRAM-Cを割り当てます。 テクスチャイメージスロット2は使用不能になります。
`GX_VRAM_CLEARDEPTH_128_D` | クリアデプスイメージにVRAM-Dを割り当てます。 テクスチャイメージスロット2は使用不能になります。

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

    typedef enum
    {
        GX_VRAM_CLEARIMAGE_NONE = 0x0000,
        GX_VRAM_CLEARIMAGE_256_AB = GX_VRAM_A | GX_VRAM_B, // TextureImageSlot 23
        GX_VRAM_CLEARIMAGE_256_CD = GX_VRAM_C | GX_VRAM_D, // TextureImageSlot 23
        GX_VRAM_CLEARDEPTH_128_A  = GX_VRAM_A,
        GX_VRAM_CLEARDEPTH_128_B  = GX_VRAM_B,
        GX_VRAM_CLEARDEPTH_128_C  = GX_VRAM_C,
        GX_VRAM_CLEARDEPTH_128_D  = GX_VRAM_D
    }
    GXVRamClearImage;

## 参照

GX_GetBankForClearImage, GX_ResetBankForClearImage, GX_DisableBankForClearImage, GX_GetSizeOfClearImage

## 履歴

Ver. 2004/01/19