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

SetStretchBltMode

関数
ビットマップ伸縮時のラスタ補間モードを設定する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

INT SetStretchBltMode(
    HDC hdc,
    STRETCH_BLT_MODE mode
);

パラメーター

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

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

意味
BLACKONWHITE
除去されるピクセルと既存のピクセルの色の値を用いて Boolean AND 演算を行います。ビットマップがモノクロビットマップの場合、このモードは白いピクセルを犠牲にして黒いピクセルを保持します。
COLORONCOLOR
ピクセルを削除します。このモードでは、除去されるすべてのピクセル行を、その情報を保持しようとせずに削除します。
HALFTONE
ソース矩形のピクセルを、コピー先矩形のピクセルブロックにマッピングします。コピー先のピクセルブロック全体の平均色が、ソースピクセルの色に近似します。

HALFTONE 伸縮モードを設定した後、アプリケーションは SetBrushOrgEx 関数を呼び出してブラシの原点を設定する必要があります。これを怠ると、ブラシの位置ずれが発生します。

STRETCH_ANDSCANS
BLACKONWHITE と同じです。
STRETCH_DELETESCANS
COLORONCOLOR と同じです。
STRETCH_HALFTONE
HALFTONE と同じです。
STRETCH_ORSCANS
WHITEONBLACK と同じです。
WHITEONBLACK
除去されるピクセルと既存のピクセルの色の値を用いて Boolean OR 演算を行います。ビットマップがモノクロビットマップの場合、このモードは黒いピクセルを犠牲にして白いピクセルを保持します。

戻り値の型: INT

公式ドキュメント

SetStretchBltMode 関数は、指定したデバイスコンテキストにおけるビットマップの伸縮モードを設定します。

戻り値

関数が成功した場合、戻り値は以前の伸縮モードです。

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

この関数は次の値を返すことがあります。

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

解説(Remarks)

伸縮モードは、アプリケーションが StretchBlt 関数を呼び出したときに、システムがビットマップの行または列をディスプレイデバイス上の既存のピクセルとどのように組み合わせるかを定義します。

BLACKONWHITE (STRETCH_ANDSCANS) および WHITEONBLACK (STRETCH_ORSCANS) モードは、通常、モノクロビットマップ内の前景ピクセルを保持するために使用されます。COLORONCOLOR (STRETCH_DELETESCANS) モードは、通常、カラービットマップの色を保持するために使用されます。

HALFTONE モードは、他の 3 つのモードよりも低速で、ソース画像の処理量が多くなりますが、より高品質な画像を生成します。また、ブラシの位置ずれを避けるため、HALFTONE モードを設定した後には SetBrushOrgEx を呼び出す必要があることに注意してください。

デバイスドライバーの機能によっては、追加の伸縮モードが利用できる場合もあります。

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

各言語での呼び出し定義

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

INT SetStretchBltMode(
    HDC hdc,
    STRETCH_BLT_MODE mode
);
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern int SetStretchBltMode(
    IntPtr hdc,   // HDC
    int mode   // STRETCH_BLT_MODE
);
<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function SetStretchBltMode(
    hdc As IntPtr,   ' HDC
    mode As Integer   ' STRETCH_BLT_MODE
) As Integer
End Function
' hdc : HDC
' mode : STRETCH_BLT_MODE
Declare PtrSafe Function SetStretchBltMode 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

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

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

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procSetStretchBltMode = gdi32.NewProc("SetStretchBltMode")
)

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

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

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

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

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

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

関連項目

公式の関連項目
使用する型