書式

XStoreColors(display, colormap, color, ncolors)

      Display *display;

      Colormap colormap;

      XColor color[];

      int ncolors;

XStoreColor(display, colormap, color)

      Display *display;

      Colormap colormap;

      XColor *color;

XStoreNamedColor(display, colormap, color, pixel, flags)

      Display *display;

      Colormap colormap;

      char *color;

      unsigned long pixel;

      int flags;

引き数

color

ピクセルと RGB 値か、色の名前を表す文字列(例えば red)を指定する。

color

格納される色定義のための構造体の配列を指定する。

colormap

カラーマップを指定する。

display

X サーバへの接続を指定する。

flags

RGB 成分のどれが設定されるかを指定する。

ncolors

色定義のための配列内の XColor 構造体の数を指定する。

pixel

カラーマップ内のエントリーを指定する。

説明

関数 XStoreColors は、 XColor 構造体の pixel メンバで指定されているピクセル値のカラーマップエントリー を変更する。 XColor 構造体の flag メンバに DoRed, DoGreen, DoBlue を設定することで、どの色成分を変更するか指定する。 カラーマップがスクリーンにインストールされていれば、変更は即座に表示に 反映される。 XStoreColors は、ピクセルが書き込み可能でカラーマップに割り当てられていれば、1つ 以上のピクセルでエラーになっても、指定したピクセルを変更する。 指定したピクセルがカラーマップの正しいインデックスでない場合には、 BadValue エラーとなる。 指定したピクセルが割り当てられていないか、読み取り専用で割り当てられて いる場合には、 BadAccess エラーとなる。 1つ以上のピクセルがエラーになった場合、エラーとして報告されるピクセル は任意である。

XStoreColors はエラー BadAccess, BadColor, BadValue を起こすことがある。

関数 XStoreColor は、 XColor 構造体の pixel メンバで指定されているピクセル値のカラーマップエントリ を変更する。 この値は XColor 構造体の pixel メンバに指定する。 このピクセル値は読み書き可能なセルで、カラーマップ内の正しいインデック スでなければならない。 指定したピクセルがカラーマップ内の正しいインデックスでなければ、 BadValue エラーとなる。 XStoreColor は色のRGB成分も変更する。 XColor 構造体の flags メンバに を指定することにより、どの色成分を変更するか指定する。 カラーマップがスクリーンにインストールされていれば、変更は即座に画面に 反映される。

XStoreColor はエラー BadAccess, BadColor, BadValue を起こすことがある。

関数 XStoreNamedColor はカラーマップに対応するスクリーンについて名前で指定された色を問い合わ せ、その結果を指定したカラーマップに格納する。 引き数 pixel はカラーマップ内のエントリーを決定する。 引き数 flags は、RGB成分のどれが設定されるかを決定する。 このメンバはビット DoRed, DoGreen, DoBlue について、ビット単位の論理和を取ることで設定できる。 色の名前のエンコーディングがホストポータブル文字エンコーディングでない 場合、実行結果は実装依存となる。 大文字を使用しても小文字を使用しても結果は同じである。 指定したピクセルがカラーマップの正しいインデックスでない場合はエラー BadValue となる。 指定したピクセルが割り当てられていないか、読み取り専用で割り当てられて いる場合には、 BadAccess エラーとなる。

XStoreNamedColor はエラー BadAccess, BadColor, BadName, BadValue を起こすことがある。

返り値

BadAccess

クライアントが、割り当てられていないカラーマップエントリーを解放しよ うとした。

BadAccess

読み取り専用のカラーマップエントリーにクライアントが格納しようとした。

BadColor

引き数 Colormap の値が、定義されている Colormap を指していない。

BadName

指定された名前のフォントや色が存在しない。

BadValue

指定された数値に、リクエストの許容範囲を越えているものがある。引き数に対 して特定の範囲が指定されていない限り、引き数の型で定義されている全ての範 囲が許される。選択肢として定義されている引き数はこのエラーを起こすことが ある。