画像で使用する色を作成する

# imagecolorallocate

(PHP 4, PHP 5, PHP 7, PHP 8)

imagecolorallocate — 画像で使用する色を作成する

### 説明

function imagecolorallocate(
GdImage `$image`,
int `$red`,
int `$green`,
int `$blue`
): int|false

指定した RGB を配色とする色の ID を返します。

imagecolorallocate() は `image` で表される画像上で使用する各々の色を作成する際にコールする必要があります。

> 注意:

> imagecolorallocate() の最初のコールで パレットをもとにした画像 (imagecreate() を使用して作成した画像) で背景色がセットされます。

### パラメータ

`image`
  imagecreatetruecolor()のような画像作成関数が返す GdImage オブジェクト。
`red`

  赤コンポーネントの値。

`green`

  緑コンポーネントの値。

`blue`

  青コンポーネントの値。

これらの値は 0 から 255 までの整数か、あるいは 0x00 から 0XFF までの 16 進数です。

### 戻り値

色の ID、あるいは作成に失敗した場合に `false` を返します。

警告

この関数は論理値 `false` を返す可能性がありますが、`false` として評価される値を返す可能性もあります。 詳細については 論理値の セクションを参照してください。この関数の返り値を調べるには ===演算子 を 使用してください。

### 変更履歴

バージョン | 説明
--- | ---
8.0.0 | `image` は、 GdImage クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、有効な `gd` resource が期待されていました。

### 例

例1 imagecolorallocate() の例

    <?php

    $im = imagecreate(100, 100);

    // 背景色を赤にします
    $background = imagecolorallocate($im, 255, 0, 0);

    // その他の色を設定します
    $white = imagecolorallocate($im, 255, 255, 255);
    $black = imagecolorallocate($im, 0, 0, 0);

    // 十六進で指定します
    $white = imagecolorallocate($im, 0xFF, 0xFF, 0xFF);
    $black = imagecolorallocate($im, 0x00, 0x00, 0x00);

    ?>

### 参考

- imagecolorallocatealpha() - 画像で使用する色を透過度を指定して作成する
- imagecolordeallocate() - イメージの色リソースを開放する

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open