SetDIBits

関数

DIBのビットでビットマップのピクセルを設定する。

DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

INT SetDIBits(
    HDC hdc,   // optional
    HBITMAP hbm,
    DWORD start,
    DWORD cLines,
    const void* lpBits,
    const BITMAPINFO* lpbmi,
    DIB_USAGE ColorUse
);

パラメーター

名前

型

方向

説明

hdc

HDC

inoptional

デバイスコンテキストへのハンドル。

hbm

HBITMAP

指定された DIB の色データを使用して変更される互換ビットマップ (DDB) へのハンドル。

start

DWORD

lpvBits パラメーターが指す配列内の、デバイス非依存の色データの開始走査線。

cLines

DWORD

デバイス非依存の色データを含む配列内の走査線の数。

lpBits

void*

バイトの配列として格納された DIB 色データへのポインター。ビットマップ値の形式は、lpbmi パラメーターが指す BITMAPINFO 構造体の biBitCount メンバーによって異なります。

lpbmi

BITMAPINFO*

DIB に関する情報を含む BITMAPINFO 構造体へのポインター。

ColorUse

DIB_USAGE

BITMAPINFO 構造体の bmiColors メンバーが提供されているかどうか、提供されている場合は bmiColors が明示的な赤、緑、青 (RGB) の値を含むか、それともパレットインデックスを含むかを示します。fuColorUse パラメーターは、次のいずれかの値である必要があります。

値	意味
DIB_PAL_COLORS	カラーテーブルは、hdc パラメーターで識別されるデバイスコンテキストの論理パレットへの 16 ビットインデックスの配列で構成されます。
DIB_RGB_COLORS	カラーテーブルが提供され、リテラルな RGB 値を含みます。

戻り値の型: INT

公式ドキュメント

SetDIBits 関数は、指定された DIB に含まれる色データを使用して、互換ビットマップ (DDB) 内のピクセルを設定します。

戻り値

関数が成功した場合、戻り値はコピーされた走査線の数です。

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

次の値が返される場合があります。

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

解説(Remarks)

ビットマップのビットがシステムパレットへのインデックスである場合に、最適なビットマップ描画速度が得られます。

アプリケーションは、GetSystemPaletteEntries 関数を呼び出すことで、システムパレットの色とインデックスを取得できます。色とインデックスを取得した後、アプリケーションは DIB を作成できます。詳細については、System Palette を参照してください。

hdc パラメーターで識別されるデバイスコンテキストは、fuColorUse パラメーターに DIB_PAL_COLORS 定数が設定されている場合にのみ使用され、それ以外の場合は無視されます。

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

走査線は、RLE 圧縮ビットマップを除き、DWORD 境界に揃えられている必要があります。

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

ICM: SetICMMode を iEnableICM パラメーターを ICM_ON に設定して呼び出すことでカラーマネジメントが有効にされている場合、カラーマネジメントが実行されます。lpbmi で指定されたビットマップが、gamma および endpoints メンバーを指定する BITMAPV4HEADER を持つ場合、または gamma および endpoints メンバーか profileData および profileSize メンバーのいずれかを指定する BITMAPV5HEADER を持つ場合、この呼び出しはビットマップのピクセルを、デバイスコンテキストのソースカラースペースではなく、それらのメンバーで記述されたカラースペースで表現されているものとして扱います。

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

各言語での呼び出し定義

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

INT SetDIBits(
    HDC hdc,   // optional
    HBITMAP hbm,
    DWORD start,
    DWORD cLines,
    const void* lpBits,
    const BITMAPINFO* lpbmi,
    DIB_USAGE ColorUse
);

[DllImport("GDI32.dll", ExactSpelling = true)]
static extern int SetDIBits(
    IntPtr hdc,   // HDC optional
    IntPtr hbm,   // HBITMAP
    uint start,   // DWORD
    uint cLines,   // DWORD
    IntPtr lpBits,   // void*
    IntPtr lpbmi,   // BITMAPINFO*
    uint ColorUse   // DIB_USAGE
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function SetDIBits(
    hdc As IntPtr,   ' HDC optional
    hbm As IntPtr,   ' HBITMAP
    start As UInteger,   ' DWORD
    cLines As UInteger,   ' DWORD
    lpBits As IntPtr,   ' void*
    lpbmi As IntPtr,   ' BITMAPINFO*
    ColorUse As UInteger   ' DIB_USAGE
) As Integer
End Function

' hdc : HDC optional
' hbm : HBITMAP
' start : DWORD
' cLines : DWORD
' lpBits : void*
' lpbmi : BITMAPINFO*
' ColorUse : DIB_USAGE
Declare PtrSafe Function SetDIBits Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal hbm As LongPtr, _
    ByVal start As Long, _
    ByVal cLines As Long, _
    ByVal lpBits As LongPtr, _
    ByVal lpbmi As LongPtr, _
    ByVal ColorUse As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetDIBits = ctypes.windll.gdi32.SetDIBits
SetDIBits.restype = ctypes.c_int
SetDIBits.argtypes = [
    wintypes.HANDLE,  # hdc : HDC optional
    wintypes.HANDLE,  # hbm : HBITMAP
    wintypes.DWORD,  # start : DWORD
    wintypes.DWORD,  # cLines : DWORD
    ctypes.POINTER(None),  # lpBits : void*
    ctypes.c_void_p,  # lpbmi : BITMAPINFO*
    wintypes.DWORD,  # ColorUse : DIB_USAGE
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
SetDIBits = Fiddle::Function.new(
  lib['SetDIBits'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC optional
    Fiddle::TYPE_VOIDP,  # hbm : HBITMAP
    -Fiddle::TYPE_INT,  # start : DWORD
    -Fiddle::TYPE_INT,  # cLines : DWORD
    Fiddle::TYPE_VOIDP,  # lpBits : void*
    Fiddle::TYPE_VOIDP,  # lpbmi : BITMAPINFO*
    -Fiddle::TYPE_INT,  # ColorUse : DIB_USAGE
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn SetDIBits(
        hdc: *mut core::ffi::c_void,  // HDC optional
        hbm: *mut core::ffi::c_void,  // HBITMAP
        start: u32,  // DWORD
        cLines: u32,  // DWORD
        lpBits: *const (),  // void*
        lpbmi: *const BITMAPINFO,  // BITMAPINFO*
        ColorUse: u32  // DIB_USAGE
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("GDI32.dll")]
public static extern int SetDIBits(IntPtr hdc, IntPtr hbm, uint start, uint cLines, IntPtr lpBits, IntPtr lpbmi, uint ColorUse);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_SetDIBits' -Namespace Win32 -PassThru
# $api::SetDIBits(hdc, hbm, start, cLines, lpBits, lpbmi, ColorUse)

#uselib "GDI32.dll"
#func global SetDIBits "SetDIBits" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; SetDIBits hdc, hbm, start, cLines, lpBits, varptr(lpbmi), ColorUse   ; 戻り値は stat
; hdc : HDC optional -> "sptr"
; hbm : HBITMAP -> "sptr"
; start : DWORD -> "sptr"
; cLines : DWORD -> "sptr"
; lpBits : void* -> "sptr"
; lpbmi : BITMAPINFO* -> "sptr"
; ColorUse : DIB_USAGE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "GDI32.dll"
#cfunc global SetDIBits "SetDIBits" sptr, sptr, int, int, sptr, var, int
; res = SetDIBits(hdc, hbm, start, cLines, lpBits, lpbmi, ColorUse)
; hdc : HDC optional -> "sptr"
; hbm : HBITMAP -> "sptr"
; start : DWORD -> "int"
; cLines : DWORD -> "int"
; lpBits : void* -> "sptr"
; lpbmi : BITMAPINFO* -> "var"
; ColorUse : DIB_USAGE -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "GDI32.dll"
#cfunc global SetDIBits "SetDIBits" sptr, sptr, int, int, sptr, sptr, int
; res = SetDIBits(hdc, hbm, start, cLines, lpBits, varptr(lpbmi), ColorUse)
; hdc : HDC optional -> "sptr"
; hbm : HBITMAP -> "sptr"
; start : DWORD -> "int"
; cLines : DWORD -> "int"
; lpBits : void* -> "sptr"
; lpbmi : BITMAPINFO* -> "sptr"
; ColorUse : DIB_USAGE -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。