書式

Status XcmsQueryColor(display, colormap, color_in_out, result_format)

      Display *display;

      Colormap colormap;

      XcmsColor *color_in_out;

      XcmsColorFormat result_format;

Status XcmsQueryColors(display, colormap, colors_in_out, ncolors, result_format)

      Display *display;

      Colormap colormap;

      XcmsColor colors_in_out[];

      unsigned int ncolors;

      XcmsColorFormat result_format;

Status XcmsLookupColor(display, colormap, color_string, color_exact_return, color_screen_return,
                        result_format)


      Display *display;

      Colormap colormap;

      char *color_string;

      XcmsColor *color_exact_return, *color_screen_return;

      XcmsColorFormat result_format;

引き数

display

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

colormap

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

color_exact_return

色文字列から展開された表色や、色名データベースで見つかった対応する文字 列から展開された表色が返される。

color_in_out

問い合わせるカラーセルを示す pixel メンバを指定する。 カラーセルに格納される表色は、この XcmsColor 構造体に返される。

color_screen_return

スクリーン上で複写することができる色が返される。

color_string

色文字列を指定する。

result_format

返される表色(引き数 color_screen_return と color_exact_return arguments) に対する色のフォーマットを指定する。 フォーマットが XcmsUndefinedFormat であり、色文字列が数値で表される表色の場合、表色はその数値形式の表色で 用いられるフォーマットで返される。 フォーマットが XcmsUndefinedFormat であり、色文字列が色の名前を含む場合、表色はデータベースに色を格納する ために用いられるフォーマットで返される。

ncolors

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

説明

関数 XcmsQueryColor は、指定した XcmsColor 構造体の pixel メンバのピクセル値に対する RGB 値を取得し、この値を result_format で指定された目的フォーマットに変換する。 ピクセル値が指定したカラーマップ内の有効なインデックスでない場合は、 エラー BadValue となる。 関数 XcmsQueryColors は、複数の XcmsColor 構造体の pixel メンバのピクセル値に対する RGB 値を取得し、この値を引き数 result_formt で指定された目的フォーマットに変更する。 ピクセル値が指定したカラーマップ内の有効なインデックスでない場合は、 エラー BadValue となる。 1つより多くのピクセルがエラーになった場合、通知されるエラーはどれかわ からない。

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

関数 XcmsLookupColor は、指定したカラーマップに関連するスクリーンについて、色名の文字列を 使った検索を行う。 この関数は正確な色の値と、指定したカラーマップのビジュアル型に関し てスクリーンが提供する最も近い値の両方を返す。 値は、引き数 result_format で指定したフォーマットで返される。 色の名前のエンコーディングがホストポータブル文字エンコーディングでない 場合、結果は実装依存である。 大文字でも小文字でも結果は同じである。 XcmsLookupColor は、名前を解決することができれば XcmsSuccess または XcmsSuccessWithCompression を返す。そうでない場合には XcmsFailure を返す。 XcmsSuccessWithCompression が返された場合、color_screen_return に返される表色はガモット圧縮した結 果である。

返り値

BadColor

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

BadValue

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