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

SetBkMode

関数
デバイスコンテキストの背景描画モード(透過または不透明)を設定する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

INT SetBkMode(
    HDC hdc,
    INT mode
);

パラメーター

名前方向説明
hdcHDCinデバイスコンテキストへのハンドル。
modeINTin

背景モード。このパラメーターには、次のいずれかの値を指定できます。

意味
OPAQUE テキスト、ハッチブラシ、またはペンが描画される前に、背景が現在の背景色で塗りつぶされます。
TRANSPARENT 背景は変更されません。

戻り値の型: INT

公式ドキュメント

SetBkMode 関数は、指定されたデバイスコンテキストの背景混合モードを設定します。背景混合モードは、テキスト、ハッチブラシ、および実線以外のペンスタイルで使用されます。

戻り値

関数が成功した場合、戻り値は以前の背景モードを示します。

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

解説(Remarks)

SetBkMode 関数は、CreatePen 関数で作成されたペンを使用して描画される線の線スタイルに影響します。SetBkMode は、ExtCreatePen 関数で作成されたペンを使用して描画される線には影響しません。

ハッチブラシの背景を透明または不透明にする方法については、CreateHatchBrush トピックに示されている例を参照してください。

次の例では、文字列を 36 回描画し、その都度反時計回りに 10 度ずつ回転させます。また、テキストを見えるようにするために背景モードを透明に設定しています。

#include "strsafe.h"
LRESULT CALLBACK WndProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam)
{
    int wmId, wmEvent;
    PAINTSTRUCT ps;
    HDC hdc;

    switch (message)
    {
    
    case WM_PAINT:
        {
        hdc = BeginPaint(hWnd, &ps);
        RECT rc; 
        int angle; 
        HGDIOBJ hfnt, hfntPrev; 
        WCHAR lpszRotate[22] = TEXT("String to be rotated.");
        HRESULT hr; 
        size_t pcch = 22;
 
// Allocate memory for a LOGFONT structure. 
 
PLOGFONT plf = (PLOGFONT) LocalAlloc(LPTR, sizeof(LOGFONT)); 
 
// Specify a font typeface name and weight. 
 
hr = StringCchCopy(plf->lfFaceName, 6, TEXT("Arial"));
if (FAILED(hr))
{
// TODO: write error handler
}

plf->lfWeight = FW_NORMAL; 
 
// Retrieve the client-rectangle dimensions. 
 
GetClientRect(hWnd, &rc); 
 
// Set the background mode to transparent for the 
// text-output operation. 
 
SetBkMode(hdc, TRANSPARENT); 
 
// Draw the string 36 times, rotating 10 degrees 
// counter-clockwise each time. 
 
for (angle = 0; angle < 3600; angle += 100) 
{ 
    plf->lfEscapement = angle; 
    hfnt = CreateFontIndirect(plf); 
    hfntPrev = SelectObject(hdc, hfnt);
    
    //
    // The StringCchLength call is fitted to the lpszRotate string
    //
    hr = StringCchLength(lpszRotate, 22, &pcch);
    if (FAILED(hr))
    {
    // TODO: write error handler
    } 
    TextOut(hdc, rc.right / 2, rc.bottom / 2, 
        lpszRotate, pcch); 
    SelectObject(hdc, hfntPrev); 
    DeleteObject(hfnt); 
} 
 
// Reset the background mode to its default. 
 
SetBkMode(hdc, OPAQUE); 
 
// Free the memory allocated for the LOGFONT structure. 
 
LocalFree((LOCALHANDLE) plf); 
        EndPaint(hWnd, &ps);
        break;
        }
    case WM_DESTROY:
        PostQuitMessage(0);
        break;
    default:
        return DefWindowProc(hWnd, message, wParam, lParam);
    }
    return 0;
}
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

SetBkMode = ctypes.windll.gdi32.SetBkMode
SetBkMode.restype = ctypes.c_int
SetBkMode.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    ctypes.c_int,  # mode : INT
]
require 'fiddle'
require 'fiddle/import'

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

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procSetBkMode = gdi32.NewProc("SetBkMode")
)

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

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

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

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

let setbkmode =
  foreign "SetBkMode"
    ((ptr void) @-> int32_t @-> returning int32_t)
(* hdc : HDC -> (ptr void) *)
(* mode : 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 ("SetBkMode" set-bk-mode :convention :stdcall) :int32
  (hdc :pointer)   ; HDC
  (mode :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetBkMode = Win32::API::More->new('GDI32',
    'int SetBkMode(HANDLE hdc, int mode)');
# my $ret = $SetBkMode->Call($hdc, $mode);
# hdc : HDC -> HANDLE
# mode : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目