Win32 API 日本語リファレンス
ホームGraphics.OpenGL › ChoosePixelFormat

ChoosePixelFormat

関数
条件に最も適合するピクセル形式を選択する。
DLLGDI32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// GDI32.dll
#include <windows.h>

INT ChoosePixelFormat(
    HDC hdc,
    const PIXELFORMATDESCRIPTOR* ppfd
);

パラメーター

名前方向説明
hdcHDCinppfd が指すピクセルフォーマット記述子に最も適合するものを判定するために、関数が調べるデバイスコンテキストを指定します。
ppfdPIXELFORMATDESCRIPTOR*in

要求するピクセルフォーマットを指定する PIXELFORMATDESCRIPTOR 構造体へのポインターです。ここでは、ppfd が指す PIXELFORMATDESCRIPTOR 構造体の各メンバーは次のように使用されます:

nSize PIXELFORMATDESCRIPTOR データ構造体のサイズを指定します。このメンバーには sizeof(PIXELFORMATDESCRIPTOR) を設定します。
nVersion PIXELFORMATDESCRIPTOR データ構造体のバージョン番号を指定します。このメンバーには 1 を設定します。
dwFlags ピクセルバッファーのプロパティを指定するビットフラグの集合です。次のビットフラグ定数は、ビットごとの OR で組み合わせることができます。次のフラグのいずれかが設定されている場合、ChoosePixelFormat 関数は、そのフラグも設定されているピクセルフォーマットに一致させようとします。設定されていない場合、ChoosePixelFormat はピクセルフォーマット中のそのフラグを無視します: PFD_DRAW_TO_WINDOWPFD_DRAW_TO_BITMAPPFD_SUPPORT_GDIPFD_SUPPORT_OPENGL 次のフラグのいずれかが設定されている場合、ChoosePixelFormat は、そのフラグも設定されているピクセルフォーマットに一致させようとします。設定されていない場合は、そのフラグが設定されていないピクセルフォーマットに一致させようとします: PFD_DOUBLEBUFFER PFD_STEREO 次のフラグが設定されている場合、関数はピクセルフォーマット中の PFD_DOUBLEBUFFER フラグを無視します: PFD_DOUBLEBUFFER_DONTCARE 次のフラグが設定されている場合、関数はピクセルフォーマット中の PFD_STEREO フラグを無視します: PFD_STEREO_DONTCARE
iPixelType 関数が対象とするピクセルフォーマットの種類を指定します: PFD_TYPE_RGBAPFD_TYPE_COLORINDEX
cColorBits 0 以上の値。
cRedBits 使用されません。
cRedShift 使用されません。
cGreenBits 使用されません。
cGreenShift 使用されません。
cBlueBits 使用されません。
cBlueShift 使用されません。
cAlphaBits 0 以上の値。
cAlphaShift 使用されません。
cAccumBits 0 以上の値。
cAccumRedBits 使用されません。
cAccumGreenBits 使用されません。
cAccumBlueBits 使用されません。
cAccumAlphaBits 使用されません。
cDepthBits 0 以上の値。
cStencilBits 0 以上の値。
cAuxBuffers 0 以上の値。
iLayerType 次のいずれかのレイヤー種別の値を指定します: PFD_MAIN_PLANEPFD_OVERLAY_PLANEPFD_UNDERLAY_PLANE
bReserved 使用されません。
dwLayerMask 使用されません。
dwVisibleMask 使用されません。
dwDamageMask 使用されません。

戻り値の型: INT

公式ドキュメント

ChoosePixelFormat 関数は、デバイスコンテキストがサポートするピクセルフォーマットの中から、指定されたピクセルフォーマット仕様に最も適合するものを選択しようとします。

戻り値

関数が成功した場合、戻り値は、指定されたピクセルフォーマット記述子に最も近いピクセルフォーマットのインデックス(1 から始まる)です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

ChoosePixelFormat 関数が選択したピクセルフォーマットが要件を満たしているかどうかは、呼び出し側で確認する必要があります。たとえば、24 ビットの RGB カラーバッファーを持つピクセルフォーマットを要求しても、デバイスコンテキストが 8 ビットの RGB カラーバッファーしか提供していない場合、関数は 8 ビットの RGB カラーバッファーを持つピクセルフォーマットを返します。

次のコードサンプルは、指定したピクセルフォーマットに一致させるために ChoosePixelFormat を使用する方法を示します。

PIXELFORMATDESCRIPTOR pfd = {
    sizeof(PIXELFORMATDESCRIPTOR),  //  この pfd のサイズ
    1,                     // バージョン番号
    PFD_DRAW_TO_WINDOW |   // ウィンドウをサポート
    PFD_SUPPORT_OPENGL |   // OpenGL をサポート
    PFD_DOUBLEBUFFER,      // ダブルバッファー
    PFD_TYPE_RGBA,         // RGBA 型
    24,                    // 24 ビットの色深度
    0, 0, 0, 0, 0, 0,      // カラービットは無視される
    0,                     // アルファバッファーなし
    0,                     // シフトビットは無視される
    0,                     // アキュムレーションバッファーなし
    0, 0, 0, 0,            // アキュムレーションのビットは無視される
    32,                    // 32 ビットの z バッファー
    0,                     // ステンシルバッファーなし
    0,                     // 補助バッファーなし
    PFD_MAIN_PLANE,        // メインレイヤー
    0,                     // 予約済み
    0, 0, 0                // レイヤーマスクは無視される
    };
    HDC  hdc;
    int  iPixelFormat;

iPixelFormat = ChoosePixelFormat(hdc, &pfd);
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// GDI32.dll
#include <windows.h>

INT ChoosePixelFormat(
    HDC hdc,
    const PIXELFORMATDESCRIPTOR* ppfd
);
[DllImport("GDI32.dll", SetLastError = true, ExactSpelling = true)]
static extern int ChoosePixelFormat(
    IntPtr hdc,   // HDC
    IntPtr ppfd   // PIXELFORMATDESCRIPTOR*
);
<DllImport("GDI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ChoosePixelFormat(
    hdc As IntPtr,   ' HDC
    ppfd As IntPtr   ' PIXELFORMATDESCRIPTOR*
) As Integer
End Function
' hdc : HDC
' ppfd : PIXELFORMATDESCRIPTOR*
Declare PtrSafe Function ChoosePixelFormat Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal ppfd As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ChoosePixelFormat = ctypes.windll.gdi32.ChoosePixelFormat
ChoosePixelFormat.restype = ctypes.c_int
ChoosePixelFormat.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    ctypes.c_void_p,  # ppfd : PIXELFORMATDESCRIPTOR*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
ChoosePixelFormat = Fiddle::Function.new(
  lib['ChoosePixelFormat'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_VOIDP,  # ppfd : PIXELFORMATDESCRIPTOR*
  ],
  Fiddle::TYPE_INT)
#[link(name = "gdi32")]
extern "system" {
    fn ChoosePixelFormat(
        hdc: *mut core::ffi::c_void,  // HDC
        ppfd: *const PIXELFORMATDESCRIPTOR  // PIXELFORMATDESCRIPTOR*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("GDI32.dll", SetLastError = true)]
public static extern int ChoosePixelFormat(IntPtr hdc, IntPtr ppfd);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_ChoosePixelFormat' -Namespace Win32 -PassThru
# $api::ChoosePixelFormat(hdc, ppfd)
#uselib "GDI32.dll"
#func global ChoosePixelFormat "ChoosePixelFormat" sptr, sptr
; ChoosePixelFormat hdc, varptr(ppfd)   ; 戻り値は stat
; hdc : HDC -> "sptr"
; ppfd : PIXELFORMATDESCRIPTOR* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "GDI32.dll"
#cfunc global ChoosePixelFormat "ChoosePixelFormat" sptr, var
; res = ChoosePixelFormat(hdc, ppfd)
; hdc : HDC -> "sptr"
; ppfd : PIXELFORMATDESCRIPTOR* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT ChoosePixelFormat(HDC hdc, PIXELFORMATDESCRIPTOR* ppfd)
#uselib "GDI32.dll"
#cfunc global ChoosePixelFormat "ChoosePixelFormat" intptr, var
; res = ChoosePixelFormat(hdc, ppfd)
; hdc : HDC -> "intptr"
; ppfd : PIXELFORMATDESCRIPTOR* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procChoosePixelFormat = gdi32.NewProc("ChoosePixelFormat")
)

// hdc (HDC), ppfd (PIXELFORMATDESCRIPTOR*)
r1, _, err := procChoosePixelFormat.Call(
	uintptr(hdc),
	uintptr(ppfd),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function ChoosePixelFormat(
  hdc: THandle;   // HDC
  ppfd: Pointer   // PIXELFORMATDESCRIPTOR*
): Integer; stdcall;
  external 'GDI32.dll' name 'ChoosePixelFormat';
result := DllCall("GDI32\ChoosePixelFormat"
    , "Ptr", hdc   ; HDC
    , "Ptr", ppfd   ; PIXELFORMATDESCRIPTOR*
    , "Int")   ; return: INT
●ChoosePixelFormat(hdc, ppfd) = DLL("GDI32.dll", "int ChoosePixelFormat(void*, void*)")
# 呼び出し: ChoosePixelFormat(hdc, ppfd)
# hdc : HDC -> "void*"
# ppfd : PIXELFORMATDESCRIPTOR* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "gdi32" fn ChoosePixelFormat(
    hdc: ?*anyopaque, // HDC
    ppfd: [*c]PIXELFORMATDESCRIPTOR // PIXELFORMATDESCRIPTOR*
) callconv(std.os.windows.WINAPI) i32;
proc ChoosePixelFormat(
    hdc: pointer,  # HDC
    ppfd: ptr PIXELFORMATDESCRIPTOR  # PIXELFORMATDESCRIPTOR*
): int32 {.importc: "ChoosePixelFormat", stdcall, dynlib: "GDI32.dll".}
pragma(lib, "gdi32");
extern(Windows)
int ChoosePixelFormat(
    void* hdc,   // HDC
    PIXELFORMATDESCRIPTOR* ppfd   // PIXELFORMATDESCRIPTOR*
);
ccall((:ChoosePixelFormat, "GDI32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{PIXELFORMATDESCRIPTOR}),
      hdc, ppfd)
# hdc : HDC -> Ptr{Cvoid}
# ppfd : PIXELFORMATDESCRIPTOR* -> Ptr{PIXELFORMATDESCRIPTOR}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t ChoosePixelFormat(
    void* hdc,
    void* ppfd);
]]
local gdi32 = ffi.load("gdi32")
-- gdi32.ChoosePixelFormat(hdc, ppfd)
-- hdc : HDC
-- ppfd : PIXELFORMATDESCRIPTOR*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('GDI32.dll');
const ChoosePixelFormat = lib.func('__stdcall', 'ChoosePixelFormat', 'int32_t', ['void *', 'void *']);
// ChoosePixelFormat(hdc, ppfd)
// hdc : HDC -> 'void *'
// ppfd : PIXELFORMATDESCRIPTOR* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("GDI32.dll", {
  ChoosePixelFormat: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.ChoosePixelFormat(hdc, ppfd)
// hdc : HDC -> "pointer"
// ppfd : PIXELFORMATDESCRIPTOR* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t ChoosePixelFormat(
    void* hdc,
    void* ppfd);
C, "GDI32.dll");
// $ffi->ChoosePixelFormat(hdc, ppfd);
// hdc : HDC
// ppfd : PIXELFORMATDESCRIPTOR*
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Gdi32 extends StdCallLibrary {
    Gdi32 INSTANCE = Native.load("gdi32", Gdi32.class);
    int ChoosePixelFormat(
        Pointer hdc,   // HDC
        Pointer ppfd   // PIXELFORMATDESCRIPTOR*
    );
}
@[Link("gdi32")]
lib LibGDI32
  fun ChoosePixelFormat = ChoosePixelFormat(
    hdc : Void*,   # HDC
    ppfd : PIXELFORMATDESCRIPTOR*   # PIXELFORMATDESCRIPTOR*
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ChoosePixelFormatNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef ChoosePixelFormatDart = int Function(Pointer<Void>, Pointer<Void>);
final ChoosePixelFormat = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<ChoosePixelFormatNative, ChoosePixelFormatDart>('ChoosePixelFormat');
// hdc : HDC -> Pointer<Void>
// ppfd : PIXELFORMATDESCRIPTOR* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ChoosePixelFormat(
  hdc: THandle;   // HDC
  ppfd: Pointer   // PIXELFORMATDESCRIPTOR*
): Integer; stdcall;
  external 'GDI32.dll' name 'ChoosePixelFormat';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ChoosePixelFormat"
  c_ChoosePixelFormat :: Ptr () -> Ptr () -> IO Int32
-- hdc : HDC -> Ptr ()
-- ppfd : PIXELFORMATDESCRIPTOR* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let choosepixelformat =
  foreign "ChoosePixelFormat"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* hdc : HDC -> (ptr void) *)
(* ppfd : PIXELFORMATDESCRIPTOR* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library gdi32 (t "GDI32.dll"))
(cffi:use-foreign-library gdi32)

(cffi:defcfun ("ChoosePixelFormat" choose-pixel-format :convention :stdcall) :int32
  (hdc :pointer)   ; HDC
  (ppfd :pointer))   ; PIXELFORMATDESCRIPTOR*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ChoosePixelFormat = Win32::API::More->new('GDI32',
    'int ChoosePixelFormat(HANDLE hdc, LPVOID ppfd)');
# my $ret = $ChoosePixelFormat->Call($hdc, $ppfd);
# hdc : HDC -> HANDLE
# ppfd : PIXELFORMATDESCRIPTOR* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型