> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# LampPurposes 列挙型

> LampPurposes 列挙型

# LampPurposes 列挙型

単一の Lamp が使用されることを想定した用途のセットを表します。

## 構文

```cpp theme={null}
enum class LampPurposes : uint32_t
{
    Undefined       = 0x00,
    Control         = 0x01,
    Accent          = 0x02,
    Branding        = 0x04,
    Status          = 0x08,
    Illumination    = 0x10,
    Presentation    = 0x20
}; 

DEFINE_ENUM_FLAG_OPERATORS(LampPurposes);
```

## 定数

| 定数 | 説明 |
| - | - |
| Undefined | この Lamp には LampPurposes が指定されていません。 |
| Control | Lamp はデバイス上のコントロールに関連付けられています (例: ボタン、キー、スライダー)。 |
| Accent | Lamp は美観的なアクセントとして使用され、ユーザーとは対話しません (例: ケース ファンの LED、キーボードのイルミネーション付きサイド パネル)。 |
| Branding | Lamp はデバイスのブランディングに使用されます (例: メーカー ロゴ)。 |
| Status | Lamp はシステムの状態情報を示すために使用されます (例: 未読メール、CPU 温度)。 |
| Illumination | Lamp は LampArray の外部にあるオブジェクトを照らします (例: ステージのスポットライト、車のヘッドライト、カメラのフラッシュ)。 |
| Presentation | ユーザーが直接見ることを目的とした Lamp です (例: アート作品や衣装の中の照明)。 |

## 解説

このリストは将来拡張される可能性があるため、LampPurpose が現在の範囲内にあるかどうかを検証するエラー チェックは避けてください。推奨されるアプローチは、アプリケーションがサポートする LampPurposes のサブセットと比較することです。

## 要件

**ヘッダー:** LampArray.h で宣言されています。

## 関連項目

[Lighting API の概要](https://docs.xbox.com/ja-jp/build/core-features/common/lighting/gc-lighting-toc.md)\
[ILampArray::GetIndicesCountForPurposes](https://docs.xbox.com/ja-jp/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getindicescountforpurposes.md)\
[ILampArray::GetIndicesForPurposes](https://docs.xbox.com/ja-jp/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getindicesforpurposes.md)\
[ILampInfo::GetPurposes](https://docs.xbox.com/ja-jp/reference/lighting/lamparray/interfaces/ilampinfo/methods/ilampinfo_getpurposes.md)


## Related topics

- [LampArray API メンバー](https://docs.xbox.com/ja-jp/reference/lighting/lamparray/lamparray_members.md)
- [LampArrayKind 列挙型](https://docs.xbox.com/ja-jp/reference/lighting/lamparray/enums/lamparraykind.md)
- [LampArrayStatus 列挙型](https://docs.xbox.com/ja-jp/reference/lighting/lamparray/enums/lamparraystatus.md)
- [LampArrayEnumerationKind 列挙型](https://docs.xbox.com/ja-jp/reference/lighting/lamparray/enums/lamparrayenumerationkind.md)
- [GetIndicesForPurposes](https://docs.xbox.com/ja-jp/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getindicesforpurposes.md)