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

SetBitmapBits

関数
ビットマップにビットパターンのデータを設定する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

INT SetBitmapBits(
    HBITMAP hbm,
    DWORD cb,
    const void* pvBits
);

パラメーター

名前方向説明
hbmHBITMAPin設定対象のビットマップへのハンドル。互換ビットマップ (DDB) である必要があります。
cbDWORDinlpBits パラメーターが指すバイト数。
pvBitsvoid*in指定したビットマップのカラーデータを格納したバイト配列へのポインター。

戻り値の型: INT

公式ドキュメント

SetBitmapBits 関数は、ビットマップのカラーデータのビットを指定した値に設定します。

戻り値

関数が成功した場合、戻り値はビットマップのビット設定に使用されたバイト数です。

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

解説(Remarks)

lpBits で指定される配列は、WORD 境界に整列されている必要があります。

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

各言語での呼び出し定義

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

INT SetBitmapBits(
    HBITMAP hbm,
    DWORD cb,
    const void* pvBits
);
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern int SetBitmapBits(
    IntPtr hbm,   // HBITMAP
    uint cb,   // DWORD
    IntPtr pvBits   // void*
);
<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function SetBitmapBits(
    hbm As IntPtr,   ' HBITMAP
    cb As UInteger,   ' DWORD
    pvBits As IntPtr   ' void*
) As Integer
End Function
' hbm : HBITMAP
' cb : DWORD
' pvBits : void*
Declare PtrSafe Function SetBitmapBits Lib "gdi32" ( _
    ByVal hbm As LongPtr, _
    ByVal cb As Long, _
    ByVal pvBits As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetBitmapBits = ctypes.windll.gdi32.SetBitmapBits
SetBitmapBits.restype = ctypes.c_int
SetBitmapBits.argtypes = [
    wintypes.HANDLE,  # hbm : HBITMAP
    wintypes.DWORD,  # cb : DWORD
    ctypes.POINTER(None),  # pvBits : void*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
SetBitmapBits = Fiddle::Function.new(
  lib['SetBitmapBits'],
  [
    Fiddle::TYPE_VOIDP,  # hbm : HBITMAP
    -Fiddle::TYPE_INT,  # cb : DWORD
    Fiddle::TYPE_VOIDP,  # pvBits : void*
  ],
  Fiddle::TYPE_INT)
#[link(name = "gdi32")]
extern "system" {
    fn SetBitmapBits(
        hbm: *mut core::ffi::c_void,  // HBITMAP
        cb: u32,  // DWORD
        pvBits: *const ()  // void*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("GDI32.dll")]
public static extern int SetBitmapBits(IntPtr hbm, uint cb, IntPtr pvBits);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_SetBitmapBits' -Namespace Win32 -PassThru
# $api::SetBitmapBits(hbm, cb, pvBits)
#uselib "GDI32.dll"
#func global SetBitmapBits "SetBitmapBits" sptr, sptr, sptr
; SetBitmapBits hbm, cb, pvBits   ; 戻り値は stat
; hbm : HBITMAP -> "sptr"
; cb : DWORD -> "sptr"
; pvBits : void* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "GDI32.dll"
#cfunc global SetBitmapBits "SetBitmapBits" sptr, int, sptr
; res = SetBitmapBits(hbm, cb, pvBits)
; hbm : HBITMAP -> "sptr"
; cb : DWORD -> "int"
; pvBits : void* -> "sptr"
; INT SetBitmapBits(HBITMAP hbm, DWORD cb, void* pvBits)
#uselib "GDI32.dll"
#cfunc global SetBitmapBits "SetBitmapBits" intptr, int, intptr
; res = SetBitmapBits(hbm, cb, pvBits)
; hbm : HBITMAP -> "intptr"
; cb : DWORD -> "int"
; pvBits : void* -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procSetBitmapBits = gdi32.NewProc("SetBitmapBits")
)

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

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

typedef SetBitmapBitsNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Void>);
typedef SetBitmapBitsDart = int Function(Pointer<Void>, int, Pointer<Void>);
final SetBitmapBits = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<SetBitmapBitsNative, SetBitmapBitsDart>('SetBitmapBits');
// hbm : HBITMAP -> Pointer<Void>
// cb : DWORD -> Uint32
// pvBits : void* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetBitmapBits(
  hbm: THandle;   // HBITMAP
  cb: DWORD;   // DWORD
  pvBits: Pointer   // void*
): Integer; stdcall;
  external 'GDI32.dll' name 'SetBitmapBits';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetBitmapBits"
  c_SetBitmapBits :: Ptr () -> Word32 -> Ptr () -> IO Int32
-- hbm : HBITMAP -> Ptr ()
-- cb : DWORD -> Word32
-- pvBits : void* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setbitmapbits =
  foreign "SetBitmapBits"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* hbm : HBITMAP -> (ptr void) *)
(* cb : DWORD -> uint32_t *)
(* pvBits : void* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library gdi32 (t "GDI32.dll"))
(cffi:use-foreign-library gdi32)

(cffi:defcfun ("SetBitmapBits" set-bitmap-bits :convention :stdcall) :int32
  (hbm :pointer)   ; HBITMAP
  (cb :uint32)   ; DWORD
  (pv-bits :pointer))   ; void*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetBitmapBits = Win32::API::More->new('GDI32',
    'int SetBitmapBits(HANDLE hbm, DWORD cb, LPVOID pvBits)');
# my $ret = $SetBitmapBits->Call($hbm, $cb, $pvBits);
# hbm : HBITMAP -> HANDLE
# cb : DWORD -> DWORD
# pvBits : void* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目