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

GetDIBits

関数
ビットマップのビットをDIB形式で取得する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

INT GetDIBits(
    HDC hdc,
    HBITMAP hbm,
    DWORD start,
    DWORD cLines,
    void* lpvBits,   // optional
    BITMAPINFO* lpbmi,
    DIB_USAGE usage
);

パラメーター

名前型方向説明
hdcHDCinデバイスコンテキストへのハンドル。
hbmHBITMAPinビットマップへのハンドル。これは互換ビットマップ (DDB) でなければなりません。
startDWORDin取得する最初の走査線。
cLinesDWORDin取得する走査線の数。
lpvBitsvoid*outoptionalビットマップデータを受け取るバッファへのポインター。このパラメーターが NULL の場合、関数はビットマップの寸法と形式を lpbmi パラメーターが指す BITMAPINFO 構造体に渡します。
lpbmiBITMAPINFO*inoutDIB データの目的の形式を指定する BITMAPINFO 構造体へのポインター。
usageDIB_USAGEin

BITMAPINFO 構造体の bmiColors メンバーの形式。次の値のいずれかでなければなりません。

値 意味
DIB_PAL_COLORS
 カラーテーブルは、現在の論理パレットへの 16 ビットインデックスの配列で構成される必要があります。
DIB_RGB_COLORS
 カラーテーブルは、赤、緑、青 (RGB) のリテラル値で構成される必要があります。

戻り値の型: INT

公式ドキュメント

GetDIBits 関数は、指定された互換ビットマップのビットを取得し、指定された形式の DIB としてバッファにコピーします。

戻り値

lpvBits パラメーターが NULL 以外で関数が成功した場合、戻り値はビットマップからコピーされた走査線の数です。

lpvBits パラメーターが NULL で、GetDIBits が BITMAPINFO 構造体への設定に成功した場合、戻り値は 0 以外になります。

関数が失敗した場合、戻り値は 0 です。

この関数は次の値を返す場合があります。

戻りコード 説明
ERROR_INVALID_PARAMETER
 入力パラメーターの 1 つ以上が無効です。

解説(Remarks)

DIB の要求された形式が内部形式と一致する場合、ビットマップの RGB 値がコピーされます。要求された形式が内部形式と一致しない場合は、カラーテーブルが合成されます。次の表は、各形式に対して合成されるカラーテーブルを示しています。

値 意味
1_BPP カラーテーブルは黒と白のエントリで構成されます。
4_BPP カラーテーブルは、標準 VGA パレットと同一の色の組み合わせで構成されます。
8_BPP カラーテーブルは、GDI によって定義された 256 色の一般的な組み合わせで構成されます。(これらの 256 色には、既定の論理パレットに含まれる 20 色が含まれます。)
24_BPP カラーテーブルは返されません。

lpvBits パラメーターが有効なポインターである場合、BITMAPINFOHEADER 構造体の最初の 6 つのメンバーは、DIB のサイズと形式を指定するために初期化されている必要があります。走査線は、RLE 圧縮ビットマップを除き、DWORD 境界に整列されている必要があります。

ボトムアップ DIB は高さを正の数に設定することで指定し、トップダウン DIB は高さを負の数に設定することで指定します。ビットマップのカラーテーブルは BITMAPINFO 構造体に追加されます。

lpvBits が NULL の場合、GetDIBits は lpbi が指す最初の構造体の最初のメンバーを調べます。このメンバーは、BITMAPCOREHEADER または BITMAPINFOHEADER 構造体のサイズ (バイト単位) を指定する必要があります。関数は、指定されたサイズを使用して、残りのメンバーをどのように初期化するかを決定します。

lpvBits が NULL で、BITMAPINFO のビットカウントメンバーが 0 に初期化されている場合、GetDIBits はカラーテーブルなしで BITMAPINFOHEADER 構造体または BITMAPCOREHEADER に値を設定します。この手法は、ビットマップ属性を照会するために使用できます。

hbmp パラメーターで識別されるビットマップは、アプリケーションがこの関数を呼び出すときに、デバイスコンテキストに選択されていてはなりません。

ボトムアップ DIB の原点はビットマップの左下隅であり、トップダウン DIB の原点は左上隅です。

例

例については、Capturing an Image を参照してください。

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

各言語での呼び出し定義

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

INT GetDIBits(
    HDC hdc,
    HBITMAP hbm,
    DWORD start,
    DWORD cLines,
    void* lpvBits,   // optional
    BITMAPINFO* lpbmi,
    DIB_USAGE usage
);
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern int GetDIBits(
    IntPtr hdc,   // HDC
    IntPtr hbm,   // HBITMAP
    uint start,   // DWORD
    uint cLines,   // DWORD
    IntPtr lpvBits,   // void* optional, out
    IntPtr lpbmi,   // BITMAPINFO* in/out
    uint usage   // DIB_USAGE
);
<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function GetDIBits(
    hdc As IntPtr,   ' HDC
    hbm As IntPtr,   ' HBITMAP
    start As UInteger,   ' DWORD
    cLines As UInteger,   ' DWORD
    lpvBits As IntPtr,   ' void* optional, out
    lpbmi As IntPtr,   ' BITMAPINFO* in/out
    usage As UInteger   ' DIB_USAGE
) As Integer
End Function
' hdc : HDC
' hbm : HBITMAP
' start : DWORD
' cLines : DWORD
' lpvBits : void* optional, out
' lpbmi : BITMAPINFO* in/out
' usage : DIB_USAGE
Declare PtrSafe Function GetDIBits Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal hbm As LongPtr, _
    ByVal start As Long, _
    ByVal cLines As Long, _
    ByVal lpvBits As LongPtr, _
    ByVal lpbmi As LongPtr, _
    ByVal usage As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetDIBits = ctypes.windll.gdi32.GetDIBits
GetDIBits.restype = ctypes.c_int
GetDIBits.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    wintypes.HANDLE,  # hbm : HBITMAP
    wintypes.DWORD,  # start : DWORD
    wintypes.DWORD,  # cLines : DWORD
    ctypes.POINTER(None),  # lpvBits : void* optional, out
    ctypes.c_void_p,  # lpbmi : BITMAPINFO* in/out
    wintypes.DWORD,  # usage : DIB_USAGE
]
require 'fiddle'
require 'fiddle/import'

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

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procGetDIBits = gdi32.NewProc("GetDIBits")
)

// hdc (HDC), hbm (HBITMAP), start (DWORD), cLines (DWORD), lpvBits (void* optional, out), lpbmi (BITMAPINFO* in/out), usage (DIB_USAGE)
r1, _, err := procGetDIBits.Call(
	uintptr(hdc),
	uintptr(hbm),
	uintptr(start),
	uintptr(cLines),
	uintptr(lpvBits),
	uintptr(lpbmi),
	uintptr(usage),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function GetDIBits(
  hdc: THandle;   // HDC
  hbm: THandle;   // HBITMAP
  start: DWORD;   // DWORD
  cLines: DWORD;   // DWORD
  lpvBits: Pointer;   // void* optional, out
  lpbmi: Pointer;   // BITMAPINFO* in/out
  usage: DWORD   // DIB_USAGE
): Integer; stdcall;
  external 'GDI32.dll' name 'GetDIBits';
result := DllCall("GDI32\GetDIBits"
    , "Ptr", hdc   ; HDC
    , "Ptr", hbm   ; HBITMAP
    , "UInt", start   ; DWORD
    , "UInt", cLines   ; DWORD
    , "Ptr", lpvBits   ; void* optional, out
    , "Ptr", lpbmi   ; BITMAPINFO* in/out
    , "UInt", usage   ; DIB_USAGE
    , "Int")   ; return: INT
●GetDIBits(hdc, hbm, start, cLines, lpvBits, lpbmi, usage) = DLL("GDI32.dll", "int GetDIBits(void*, void*, dword, dword, void*, void*, dword)")
# 呼び出し: GetDIBits(hdc, hbm, start, cLines, lpvBits, lpbmi, usage)
# hdc : HDC -> "void*"
# hbm : HBITMAP -> "void*"
# start : DWORD -> "dword"
# cLines : DWORD -> "dword"
# lpvBits : void* optional, out -> "void*"
# lpbmi : BITMAPINFO* in/out -> "void*"
# usage : DIB_USAGE -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "gdi32" fn GetDIBits(
    hdc: ?*anyopaque, // HDC
    hbm: ?*anyopaque, // HBITMAP
    start: u32, // DWORD
    cLines: u32, // DWORD
    lpvBits: ?*anyopaque, // void* optional, out
    lpbmi: [*c]BITMAPINFO, // BITMAPINFO* in/out
    usage: u32 // DIB_USAGE
) callconv(std.os.windows.WINAPI) i32;
proc GetDIBits(
    hdc: pointer,  # HDC
    hbm: pointer,  # HBITMAP
    start: uint32,  # DWORD
    cLines: uint32,  # DWORD
    lpvBits: pointer,  # void* optional, out
    lpbmi: ptr BITMAPINFO,  # BITMAPINFO* in/out
    usage: uint32  # DIB_USAGE
): int32 {.importc: "GetDIBits", stdcall, dynlib: "GDI32.dll".}
pragma(lib, "gdi32");
extern(Windows)
int GetDIBits(
    void* hdc,   // HDC
    void* hbm,   // HBITMAP
    uint start,   // DWORD
    uint cLines,   // DWORD
    void* lpvBits,   // void* optional, out
    BITMAPINFO* lpbmi,   // BITMAPINFO* in/out
    uint usage   // DIB_USAGE
);
ccall((:GetDIBits, "GDI32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}, UInt32, UInt32, Ptr{Cvoid}, Ptr{BITMAPINFO}, UInt32),
      hdc, hbm, start, cLines, lpvBits, lpbmi, usage)
# hdc : HDC -> Ptr{Cvoid}
# hbm : HBITMAP -> Ptr{Cvoid}
# start : DWORD -> UInt32
# cLines : DWORD -> UInt32
# lpvBits : void* optional, out -> Ptr{Cvoid}
# lpbmi : BITMAPINFO* in/out -> Ptr{BITMAPINFO}
# usage : DIB_USAGE -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetDIBits(
    void* hdc,
    void* hbm,
    uint32_t start,
    uint32_t cLines,
    void* lpvBits,
    void* lpbmi,
    uint32_t usage);
]]
local gdi32 = ffi.load("gdi32")
-- gdi32.GetDIBits(hdc, hbm, start, cLines, lpvBits, lpbmi, usage)
-- hdc : HDC
-- hbm : HBITMAP
-- start : DWORD
-- cLines : DWORD
-- lpvBits : void* optional, out
-- lpbmi : BITMAPINFO* in/out
-- usage : DIB_USAGE
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('GDI32.dll');
const GetDIBits = lib.func('__stdcall', 'GetDIBits', 'int32_t', ['void *', 'void *', 'uint32_t', 'uint32_t', 'void *', 'void *', 'uint32_t']);
// GetDIBits(hdc, hbm, start, cLines, lpvBits, lpbmi, usage)
// hdc : HDC -> 'void *'
// hbm : HBITMAP -> 'void *'
// start : DWORD -> 'uint32_t'
// cLines : DWORD -> 'uint32_t'
// lpvBits : void* optional, out -> 'void *'
// lpbmi : BITMAPINFO* in/out -> 'void *'
// usage : DIB_USAGE -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("GDI32.dll", {
  GetDIBits: { parameters: ["pointer", "pointer", "u32", "u32", "pointer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.GetDIBits(hdc, hbm, start, cLines, lpvBits, lpbmi, usage)
// hdc : HDC -> "pointer"
// hbm : HBITMAP -> "pointer"
// start : DWORD -> "u32"
// cLines : DWORD -> "u32"
// lpvBits : void* optional, out -> "pointer"
// lpbmi : BITMAPINFO* in/out -> "pointer"
// usage : DIB_USAGE -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetDIBits(
    void* hdc,
    void* hbm,
    uint32_t start,
    uint32_t cLines,
    void* lpvBits,
    void* lpbmi,
    uint32_t usage);
C, "GDI32.dll");
// $ffi->GetDIBits(hdc, hbm, start, cLines, lpvBits, lpbmi, usage);
// hdc : HDC
// hbm : HBITMAP
// start : DWORD
// cLines : DWORD
// lpvBits : void* optional, out
// lpbmi : BITMAPINFO* in/out
// usage : DIB_USAGE
// 構造体/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 GetDIBits(
        Pointer hdc,   // HDC
        Pointer hbm,   // HBITMAP
        int start,   // DWORD
        int cLines,   // DWORD
        Pointer lpvBits,   // void* optional, out
        Pointer lpbmi,   // BITMAPINFO* in/out
        int usage   // DIB_USAGE
    );
}
@[Link("gdi32")]
lib LibGDI32
  fun GetDIBits = GetDIBits(
    hdc : Void*,   # HDC
    hbm : Void*,   # HBITMAP
    start : UInt32,   # DWORD
    cLines : UInt32,   # DWORD
    lpvBits : Void*,   # void* optional, out
    lpbmi : BITMAPINFO*,   # BITMAPINFO* in/out
    usage : UInt32   # DIB_USAGE
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetDIBitsNative = Int32 Function(Pointer<Void>, Pointer<Void>, Uint32, Uint32, Pointer<Void>, Pointer<Void>, Uint32);
typedef GetDIBitsDart = int Function(Pointer<Void>, Pointer<Void>, int, int, Pointer<Void>, Pointer<Void>, int);
final GetDIBits = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<GetDIBitsNative, GetDIBitsDart>('GetDIBits');
// hdc : HDC -> Pointer<Void>
// hbm : HBITMAP -> Pointer<Void>
// start : DWORD -> Uint32
// cLines : DWORD -> Uint32
// lpvBits : void* optional, out -> Pointer<Void>
// lpbmi : BITMAPINFO* in/out -> Pointer<Void>
// usage : DIB_USAGE -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetDIBits(
  hdc: THandle;   // HDC
  hbm: THandle;   // HBITMAP
  start: DWORD;   // DWORD
  cLines: DWORD;   // DWORD
  lpvBits: Pointer;   // void* optional, out
  lpbmi: Pointer;   // BITMAPINFO* in/out
  usage: DWORD   // DIB_USAGE
): Integer; stdcall;
  external 'GDI32.dll' name 'GetDIBits';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetDIBits"
  c_GetDIBits :: Ptr () -> Ptr () -> Word32 -> Word32 -> Ptr () -> Ptr () -> Word32 -> IO Int32
-- hdc : HDC -> Ptr ()
-- hbm : HBITMAP -> Ptr ()
-- start : DWORD -> Word32
-- cLines : DWORD -> Word32
-- lpvBits : void* optional, out -> Ptr ()
-- lpbmi : BITMAPINFO* in/out -> Ptr ()
-- usage : DIB_USAGE -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getdibits =
  foreign "GetDIBits"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> uint32_t @-> (ptr void) @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* hdc : HDC -> (ptr void) *)
(* hbm : HBITMAP -> (ptr void) *)
(* start : DWORD -> uint32_t *)
(* cLines : DWORD -> uint32_t *)
(* lpvBits : void* optional, out -> (ptr void) *)
(* lpbmi : BITMAPINFO* in/out -> (ptr void) *)
(* usage : DIB_USAGE -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library gdi32 (t "GDI32.dll"))
(cffi:use-foreign-library gdi32)

(cffi:defcfun ("GetDIBits" get-dibits :convention :stdcall) :int32
  (hdc :pointer)   ; HDC
  (hbm :pointer)   ; HBITMAP
  (start :uint32)   ; DWORD
  (c-lines :uint32)   ; DWORD
  (lpv-bits :pointer)   ; void* optional, out
  (lpbmi :pointer)   ; BITMAPINFO* in/out
  (usage :uint32))   ; DIB_USAGE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetDIBits = Win32::API::More->new('GDI32',
    'int GetDIBits(HANDLE hdc, HANDLE hbm, DWORD start, DWORD cLines, LPVOID lpvBits, LPVOID lpbmi, DWORD usage)');
# my $ret = $GetDIBits->Call($hdc, $hbm, $start, $cLines, $lpvBits, $lpbmi, $usage);
# hdc : HDC -> HANDLE
# hbm : HBITMAP -> HANDLE
# start : DWORD -> DWORD
# cLines : DWORD -> DWORD
# lpvBits : void* optional, out -> LPVOID
# lpbmi : BITMAPINFO* in/out -> LPVOID
# usage : DIB_USAGE -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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