DescribePixelFormat 関数 (wingdi.h)

DescribePixelFormat 関数は、hdc に関連付けられているデバイスの iPixelFormat によって識別されるピクセル形式に関する情報を取得します。 この関数は、ppfd が指す PIXELFORMATDESCRIPTOR 構造体のメンバーを、そのピクセル形式データと共に設定します。

構文

int DescribePixelFormat(
  HDC                     hdc,
  int                     iPixelFormat,
  UINT                    nBytes,
  LPPIXELFORMATDESCRIPTOR ppfd
);

パラメーター

hdc

デバイス コンテキストを指定します。

iPixelFormat

ピクセル形式を指定するインデックス。 デバイス コンテキストでサポートされるピクセル形式は、正の 1 から始まる整数インデックスによって識別されます。

nBytes

ppfd が指す構造体のサイズ (バイト単位)。 DescribePixelFormat 関数は、その構造体に nBytes バイト以下のデータを格納します。 この値を sizeof(PIXELFORMATDESCRIPTOR) に設定します。

ppfd

ピクセル形式データを使用して関数が設定するメンバーを持つ PIXELFORMATDESCRIPTOR 構造体へのポインター。 関数は、構造体にコピーされたバイト数を構造体の nSize メンバーに格納します。 入力時に ppfd が NULL の場合、関数は構造体にデータを書き込まない。 これは、デバイス コンテキストの最大ピクセル形式インデックスのみを取得する場合に便利です。

戻り値

関数が成功した場合、戻り値はデバイス コンテキストの最大ピクセル形式インデックスです。 さらに、関数は、指定されたピクセル形式に従って ppfd によって指される PIXELFORMATDESCRIPTOR 構造体のメンバーを設定します。

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

要件

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	wingdi.h
Library	Gdi32.lib
[DLL]	Gdi32.dll

こちらもご覧ください

ChoosePixelFormat

GetPixelFormat

Windows 上の OpenGL

SetPixelFormat

Windows 関数