imagecolorallocate

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

imagecolorallocate — Alloziert eine Farbe für eine Grafik

Beschreibung

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

Gibt einen Farb-Kennzeichner zurück, der die aus den gegebenen RGB-Komponenten bestehende Farbe darstellt.

imagecolorallocate() muss aufgerufen werden, um jede Farbe zu erzeugen, die in dem durch image angegebenen Bild verwendet werden soll.

Hinweis:

Der erste Aufruf von imagecolorallocate() bestimmt die Hintergrundfarbe von palettenbasierten Bilder – also Bildern, die durch imagecreate() erzeugt wurden.

Parameter-Liste

image

Ein GdImage-Objekt, das von einer der Funktionen zur Bilderzeugung, z. B. imagecreatetruecolor(), zurückgegeben wurde.

red

Wert der Rotkomponente.

green

Wert der Grünkomponente.

blue

Wert der Blaukomponente.

Diese Parameter sind Ganzzahlen zwischen 0 und 255 oder Hexadezimalzahlen zwischen 0x00 und 0xFF.

Rückgabewerte

Ein Farb-Kennzeichner oder false, falls die Farbe nicht alloziert werden konnte.

Warnung

Diese Funktion kann sowohl das boolsche false zurückliefern, als auch einen nicht-boolschen Wert, welcher zu false ausgewertet wird. Weitere Informationen entnehmen Sie bitte dem Abschnitt über die boolschen Typen. Benutzen Sie deshalb den === Operator, um den Rückgabewert dieser Funktion zu überprüfen.

Changelog

Version Beschreibung
8.0.0 image erwartet nun eine GdImage-Instanz; vorher wurde eine gültige gd-Ressource erwartet.

Beispiele

Beispiel #1 imagecolorallocate()-Beispiel

<?php

$im = imagecreate(100, 100);

// färbt den Hintergrund rot
$background = imagecolorallocate($im, 255, 0, 0);

// alloziert weitere Farben
$white = imagecolorallocate($im, 255, 255, 255);
$black = imagecolorallocate($im, 0, 0, 0);

// hexadezimale Schreibweise
$white = imagecolorallocate($im, 0xFF, 0xFF, 0xFF);
$black = imagecolorallocate($im, 0x00, 0x00, 0x00);

?>

Siehe auch