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

CreateCompatibleBitmap

関数
指定デバイスコンテキストと互換のビットマップを作成する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HBITMAP CreateCompatibleBitmap(
    HDC hdc,
    INT cx,
    INT cy
);

パラメーター

名前方向説明
hdcHDCinデバイスコンテキストへのハンドル。
cxINTinビットマップの幅(ピクセル単位)。
cyINTinビットマップの高さ(ピクセル単位)。

戻り値の型: HBITMAP

公式ドキュメント

CreateCompatibleBitmap 関数は、指定したデバイスコンテキストに関連付けられたデバイスと互換性のあるビットマップを作成します。

戻り値

関数が成功した場合、戻り値は互換ビットマップ(DDB)へのハンドルです。

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

解説(Remarks)

CreateCompatibleBitmap 関数によって作成されるビットマップのカラー形式は、hdc パラメーターで指定されたデバイスのカラー形式と一致します。このビットマップは、元のデバイスと互換性のある任意のメモリデバイスコンテキストに選択できます。

メモリデバイスコンテキストはカラービットマップとモノクロビットマップの両方を許可するため、指定したデバイスコンテキストがメモリデバイスコンテキストの場合、CreateCompatibleBitmap 関数が返すビットマップの形式は異なります。ただし、メモリ以外のデバイスコンテキスト用に作成された互換ビットマップは、常に指定したデバイスコンテキストと同じカラー形式を持ち、同じカラーパレットを使用します。

注: メモリデバイスコンテキストが作成されると、最初は 1×1 のモノクロビットマップが選択された状態になります。このメモリデバイスコンテキストを CreateCompatibleBitmap で使用すると、作成されるビットマップはモノクロビットマップになります。カラービットマップを作成するには、次のコードに示すように、メモリデバイスコンテキストの作成に使用した HDC を使用してください。


    HDC memDC = CreateCompatibleDC ( hDC );
    HBITMAP memBM = CreateCompatibleBitmap ( hDC, nWidth, nHeight );
    SelectObject ( memDC, memBM );

アプリケーションが nWidth または nHeight パラメーターを 0 に設定した場合、CreateCompatibleBitmap は 1×1 ピクセルのモノクロビットマップへのハンドルを返します。

CreateDIBSection 関数によって作成されるビットマップである DIB セクションが、hdc パラメーターで指定されたデバイスコンテキストに選択されている場合、CreateCompatibleBitmap は DIB セクションを作成します。

ビットマップが不要になったら、DeleteObject 関数を呼び出して削除してください。

例については、Scaling 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>

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

CreateCompatibleBitmap = ctypes.windll.gdi32.CreateCompatibleBitmap
CreateCompatibleBitmap.restype = ctypes.c_void_p
CreateCompatibleBitmap.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    ctypes.c_int,  # cx : INT
    ctypes.c_int,  # cy : INT
]
require 'fiddle'
require 'fiddle/import'

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

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procCreateCompatibleBitmap = gdi32.NewProc("CreateCompatibleBitmap")
)

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

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

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

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

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

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

関連項目

公式の関連項目