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

CreatePatternBrush

関数
指定ビットマップをパターンとするブラシを作成する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HBRUSH CreatePatternBrush(
    HBITMAP hbm
);

パラメーター

名前方向説明
hbmHBITMAPin論理ブラシの作成に使用するビットマップへのハンドル。

戻り値の型: HBRUSH

公式ドキュメント

CreatePatternBrush 関数は、指定したビットマップパターンを持つ論理ブラシを作成します。ビットマップには、CreateDIBSection 関数で作成された DIB セクションビットマップ、またはデバイス依存ビットマップを指定できます。

戻り値

関数が成功した場合、戻り値は論理ブラシを識別します。

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

解説(Remarks)

パターンブラシは、塗りつぶされる図形の内部を描画するためにシステムが使用するビットマップです。

アプリケーションが CreatePatternBrush を呼び出してブラシを作成した後は、SelectObject 関数を呼び出すことで、そのブラシを任意のデバイスコンテキストに選択できます。

DeleteObject 関数を使用すれば、関連付けられたビットマップに影響を与えることなくパターンブラシを削除できます。したがって、このビットマップを使用して任意の数のパターンブラシを作成できます。

モノクロ(1 ピクセルあたり 1 ビット)ビットマップを使用して作成されたブラシは、描画先となるデバイスコンテキストのテキストカラーと背景カラーを持ちます。0 ビットで表されるピクセルは現在のテキストカラーで描画され、1 ビットで表されるピクセルは現在の背景カラーで描画されます。

ICM: ブラシ作成時には色処理は行われません。ただし、ICM 対応のデバイスコンテキストにブラシが選択されると、カラーマネジメントが実行されます。

例については、ブラシの使用を参照してください。

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

各言語での呼び出し定義

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

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

CreatePatternBrush = ctypes.windll.gdi32.CreatePatternBrush
CreatePatternBrush.restype = ctypes.c_void_p
CreatePatternBrush.argtypes = [
    wintypes.HANDLE,  # hbm : HBITMAP
]
require 'fiddle'
require 'fiddle/import'

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

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procCreatePatternBrush = gdi32.NewProc("CreatePatternBrush")
)

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

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

typedef CreatePatternBrushNative = Pointer<Void> Function(Pointer<Void>);
typedef CreatePatternBrushDart = Pointer<Void> Function(Pointer<Void>);
final CreatePatternBrush = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<CreatePatternBrushNative, CreatePatternBrushDart>('CreatePatternBrush');
// hbm : HBITMAP -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CreatePatternBrush(
  hbm: THandle   // HBITMAP
): THandle; stdcall;
  external 'GDI32.dll' name 'CreatePatternBrush';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CreatePatternBrush"
  c_CreatePatternBrush :: Ptr () -> IO (Ptr ())
-- hbm : HBITMAP -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

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

関連項目

公式の関連項目