書式

Status XcmsStoreColor(display, colormap, color)

      Display *display;

      Colormap colormap;

      XcmsColor *color;

Status XcmsStoreColors(display, colormap, colors, ncolors, compression_flags_return)

      Display *display;

      Colormap colormap;

      XcmsColor colors[];

      int ncolors;

      Bool compression_flags_return[];

引き数

display

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

color

格納するカラーセルと色を指定する。 この XcmsColor 構造体で指定される値は、返される時にも変更されていない。

colors

表色である XcmsColor 構造体の配列を指定。配列のそれぞれの要素は、カラーセルとそのセルに格納 される色を指定する。 配列で指定した値は、返される時にも変更されない。

colormap

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

compression_flags_return

圧縮の状態を示す Boolean 値の配列が返される。 NULL でない値が与えられた場合、対応する色が圧縮されていれば配列の各要 素には True が設定され、そうでなければ False が設定される。 圧縮の状態が不要であれば、NULL を指定すること。

ncolors

表色の配列内の XcmsColor 構造体の数を指定する。

説明

関数 XcmsStoreColor は、 XcmsColor 構造体で指定された色を RGB 値に変換する。 その後、この関数は3つのフラグ (DoRed, DoGreen, DoBlue) が設定されている XColor 構造体の RGB 表色を用いて XStoreColor を呼び出し、 XcmsColor 構造体の pixel メンバで指定されたカラーセルを変更する。 このピクセル値は指定したカラーマップに対する有効なインデックスでなけれ ばならない。また、ピクセル値によって指定されるカラーセルは読み書き可能 なセルでなければならない。 ピクセル値が有効なインデックスでない場合は、エラー BadValue となる。 カラーセルが割り当てられていないか、読み取り専用で割り当てられて いる場合は、エラー BadAccess となる。 カラーマップがそのスクリーンにインストールされていれば、変更は即座に画 面表示に反映される。

XStoreColor は返り値を持たないことに注意せよ。したがって、この関数が返す XcmsSuccess は、RGB 値への変換が成功し、 XStoreColor の呼び出した行われたことだけを示す。 実際に格納された色を取得するには、 XcmsQueryColor を使用すること。 スクリーンのハードウェアの制限やガモット圧縮のため、カラーマップに格納 された色は指定した色と異なることがある。

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

関数 XcmsStoreColors は、 XcmsColor 構造体の配列で指定された色を RGB 値に変換する。 その後、この関数は3つのフラグ (DoRed, DoGreen, DoBlue) が設定されている XColor 構造体の RGB 表色を用いて XStoreColors を呼び出し、対応する XcmsColor 構造体の pixel メンバで指定されたカラーセルを変更する。 このピクセル値は指定したカラーマップに対する有効なインデックスでなけれ ばならない。また、ピクセル値によって指定されるカラーセルは読み書き可能 なセルでなければならない。 ピクセル値が有効なインデックスでない場合は、エラー BadValue となる。 カラーセルが割り当てられていないか、読み取り専用で割り当てられている 場合は、エラー BadAccess となる。 1つ以上のピクセルでエラーになった場合1つのピクセルに対してエラーが通知 されるが、どのピクセルになるかはわからない。 カラーマップがそのスクリーンにインストールされていれば、変更は即座に画 面表示に反映される。

XStoreColors は返り値を持たないことに注意せよ。したがって、この関数が返す XcmsSuccess は、RGB 値への変換が成功し、 XStoreColors の呼び出した行われたことだけを示す。 実際に格納された色を取得するには、 XcmsQueryColors を使用すること。 スクリーンのハードウェアの制限やガモット圧縮のため、カラーマップに格納 された色は指定した色と異なることがある。

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

返り値

BadAccess

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

BadAccess

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

BadColor

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

BadValue

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