XLATEOBJ_cGetPalette

XLATEOBJ_cGetPalette 関数は、指定したパレットから RGB カラーまたはビットフィールド形式を取得する。

XLATEOBJ_cGetPalette pxlo, iPal, cPal, pPal

pxlo : [var] GDI が要求された情報を取得する XLATEOBJ 構造体へのポインタ。
iPal : [int] 
cPal : [int] pPal が指すバッファ内のエントリ数を指定する。これはパレットの総サイズより小さくてもよい。
pPal : [var] GDI が要求されたパレット情報を書き込むバッファへのポインタ。iPal が XO_SRCPALETTE または XO_DESTPALETTE で、それぞれのパレットタイプが PAL_INDEXED の場合、各エントリは 24 ビット RGB 値である。iPal が XO_SRCBITFIELDS または XO_DESTBITFIELDS で、それぞれのパレットタイプが PAL_BITFIELDS、PAL_RGB、または PAL_BGR の場合、pPal は赤、緑、青のカラーマスクを表す 3 つの ULONG マスクを指す。

(プラグイン / モジュール : gdi32.dll)

解説

XLATEOBJ_cGetPalette 関数は、指定したパレットから RGB カラーまたはビットフィールド形式を取得する。

[戻り値]
XLATEOBJ_cGetPalette は、pPal が NULL でない場合、書き込まれたエントリ数を返す。XLATEOBJ が
NULL またはそのパレットが無効な場合、値 0 が返される。pxlo が指すデータが iPal
の値と一致しない場合も、XLATEOBJ_cGetPalette は 0 を返す。たとえば、指されるデータがビットフィールドだが iPal
が XO_SRCPALETTE または XO_DESTPALETTE に設定されている場合、XLATEOBJ_cGetPalette は
0 を返す。同様に、pxlo が指すデータがパレットだが iPal が XO_SRCBITFIELDS または
XO_DESTBITFIELDS に設定されている場合も、XLATEOBJ_cGetPalette は 0 を返す。

[備考]
ドライバはカラーブレンディングの一部の方法を実行するためにパレットに関する情報を持たなければならない。

情報

プラグイン / モジュールgdi32.dll
バージョン1.0
作成日2026/04/16
著作者IronHSP / CsWin32 bridge
URLhttps://github.com/inovia/IronHSP
備考Win32 API の gdi32.dll 関数群。CsWin32 + win32metadata から自動生成。
hsp3net 専用 (intptr / NSTRUCT / wstr を使用)。
タイプ拡張命令
グループWin32API
対応環境
  • Windows 版 HSP
hs ファイルhsphelp\win32_gdi32_gen2.hs