DescribePixelFormat

DescribePixelFormat 関数は、hdc に関連付けられたデバイスの iPixelFormat で識別されるピクセルフォーマットに関する情報を取得する。関数は ppfd が指す PIXELFORMATDESCRIPTOR 構造体のメンバをそのピクセルフォーマットデータで設定する。

DescribePixelFormat hdc, iPixelFormat, nBytes, ppfd

hdc : [intptr] デバイスコンテキストを指定する。
iPixelFormat : [int] ピクセルフォーマットを指定するインデックス。デバイスコンテキストがサポートするピクセルフォーマットは正の 1 始まり整数インデックスで識別される。
nBytes : [int] ppfd が指す構造体のサイズ(バイト単位)。DescribePixelFormat はその構造体に nBytes バイトを超えるデータを格納しない。この値には sizeof(PIXELFORMATDESCRIPTOR) を設定する。
ppfd : [var] 関数がピクセルフォーマットデータでメンバを設定する PIXELFORMATDESCRIPTOR 構造体へのポインタ。関数は構造体にコピーしたバイト数を構造体の nSize メンバに格納する。呼び出し時に ppfd が NULL の場合、関数は構造体にデータを書き込まない。これはデバイスコンテキストの最大ピクセルフォーマットインデックスのみを取得したい場合に便利である。

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

解説

DescribePixelFormat 関数は、hdc に関連付けられたデバイスの iPixelFormat
で識別されるピクセルフォーマットに関する情報を取得する。関数は ppfd が指す PIXELFORMATDESCRIPTOR
構造体のメンバをそのピクセルフォーマットデータで設定する。

[戻り値]
関数が成功した場合、戻り値はデバイスコンテキストの最大ピクセルフォーマットインデックスとなる。さらに、関数は ppfd が指す
PIXELFORMATDESCRIPTOR
構造体のメンバを指定したピクセルフォーマットに従って設定する。関数が失敗した場合、戻り値はゼロとなる。拡張エラー情報を取得するには
GetLastError を呼ぶ。

情報

プラグイン / モジュール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