StretchDIBits

関数

DIBのピクセルを伸縮して転送先矩形へ転送する。

DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

INT StretchDIBits(
    HDC hdc,
    INT xDest,
    INT yDest,
    INT DestWidth,
    INT DestHeight,
    INT xSrc,
    INT ySrc,
    INT SrcWidth,
    INT SrcHeight,
    const void* lpBits,   // optional
    const BITMAPINFO* lpbmi,
    DIB_USAGE iUsage,
    ROP_CODE rop
);

パラメーター

名前

型

方向

説明

hdc

HDC

変換先デバイスコンテキストのハンドル。

xDest

INT

変換先矩形の左上隅の x 座標(論理単位)。

yDest

INT

変換先矩形の左上隅の y 座標(論理単位)。

DestWidth

INT

変換先矩形の幅(論理単位)。

DestHeight

INT

変換先矩形の高さ(論理単位)。

xSrc

INT

イメージ内の変換元矩形の x 座標(ピクセル単位)。

ySrc

INT

イメージ内の変換元矩形の y 座標(ピクセル単位)。

SrcWidth

INT

イメージ内の変換元矩形の幅(ピクセル単位)。

SrcHeight

INT

イメージ内の変換元矩形の高さ(ピクセル単位)。

lpBits

void*

inoptional

バイト配列として格納されたイメージビットへのポインター。詳細については、「解説」セクションを参照してください。

lpbmi

BITMAPINFO*

DIB に関する情報を格納する BITMAPINFO 構造体へのポインター。

iUsage

DIB_USAGE

BITMAPINFO 構造体の bmiColors メンバーが指定されているかどうか、指定されている場合は bmiColors が明示的な赤、緑、青 (RGB) の値を格納しているか、それともインデックスを格納しているかを指定します。iUsage パラメーターは、次の値のいずれかでなければなりません。

値	意味
DIB_PAL_COLORS	配列には、変換元デバイスコンテキストの論理パレットへの 16 ビットインデックスが格納されます。
DIB_RGB_COLORS	カラーテーブルには、リテラルの RGB 値が格納されます。

詳細については、「解説」セクションを参照してください。

rop

ROP_CODE

変換元ピクセル、変換先デバイスコンテキストの現在のブラシ、および変換先ピクセルをどのように組み合わせて新しいイメージを形成するかを指定するラスター演算コード。一般的なラスター演算コードの一覧については、BitBlt を参照してください。

戻り値の型: INT

公式ドキュメント

StretchDIBits 関数は、DIB、JPEG、または PNG イメージ内のピクセル矩形のカラーデータを、指定された変換先矩形にコピーします。

戻り値

関数が成功した場合、戻り値はコピーされたスキャンラインの数です。なお、ミラー化されたコンテンツの場合、この値は負になることがあります。

関数が失敗した場合、またはスキャンラインが 1 つもコピーされなかった場合、戻り値は 0 です。

ドライバーが StretchDIBits に渡された JPEG または PNG ファイルイメージをサポートできない場合、関数は失敗し GDI_ERROR を返します。失敗が発生した場合、アプリケーションは独自の JPEG または PNG サポートにフォールバックしてイメージをビットマップへ展開し、そのビットマップを StretchDIBits に渡す必要があります。

解説(Remarks)

ボトムアップ DIB の原点は左下隅であり、トップダウン DIB の原点は左上隅です。

StretchDIBits は、nSrcWidth と nDestWidth パラメーターの符号が異なる場合、または nSrcHeight と nDestHeight パラメーターの符号が異なる場合に、ビットマップのミラーイメージを作成します。nSrcWidth と nDestWidth の符号が異なる場合、関数は x 軸に沿ったビットマップのミラーイメージを作成します。nSrcHeight と nDestHeight の符号が異なる場合、関数は y 軸に沿ったビットマップのミラーイメージを作成します。

StretchDIBits は、DIB の BITMAPINFOHEADER 構造体の biHeight メンバーの符号が負の場合、トップダウンイメージを作成します。コード例については、Sizing a JPEG or PNG Image を参照してください。

この関数では、変換元イメージとして JPEG または PNG イメージを渡すことができます。各パラメーターの使用方法は同じですが、次の点が異なります。

BITMAPINFOHEADER の biCompression メンバーが BI_JPEG または BI_PNG の場合、lpBits はそれぞれ JPEG または PNG イメージを格納するバッファーを指します。BITMAPINFOHEADER 構造体の biSizeImage メンバーは、バッファーのサイズを指定します。iUsage パラメーターは DIB_RGB_COLORS に設定する必要があります。dwRop パラメーターは SRCCOPY に設定する必要があります。
印刷時にメタファイルが適切にスプールされるようにするには、StretchDIBits を呼び出す前に、プリンターが JPEG または PNG イメージをそれぞれ認識することを確認するために、アプリケーションは CHECKJPEGFORMAT または CHECKPNGFORMAT エスケープを呼び出す必要があります。

ICM: SetICMMode を iEnableICM パラメーターを ICM_ON に設定して呼び出すことでカラーマネジメントが有効になっている場合、カラーマネジメントが実行されます。lpBitsInfo で指定されたビットマップが、gamma および endpoints メンバーを指定する BITMAPV4HEADER を持つ場合、または gamma および endpoints メンバーか profileData および profileSize メンバーのいずれかを指定する BITMAPV5HEADER を持つ場合、この呼び出しはビットマップのピクセルを、デバイスコンテキストの変換元カラースペースではなく、それらのメンバーで記述されたカラースペースで表現されているものとして扱います。

Examples

例については、Sizing a JPEG or PNG Image を参照してください。

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

各言語での呼び出し定義

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

INT StretchDIBits(
    HDC hdc,
    INT xDest,
    INT yDest,
    INT DestWidth,
    INT DestHeight,
    INT xSrc,
    INT ySrc,
    INT SrcWidth,
    INT SrcHeight,
    const void* lpBits,   // optional
    const BITMAPINFO* lpbmi,
    DIB_USAGE iUsage,
    ROP_CODE rop
);

[DllImport("GDI32.dll", ExactSpelling = true)]
static extern int StretchDIBits(
    IntPtr hdc,   // HDC
    int xDest,   // INT
    int yDest,   // INT
    int DestWidth,   // INT
    int DestHeight,   // INT
    int xSrc,   // INT
    int ySrc,   // INT
    int SrcWidth,   // INT
    int SrcHeight,   // INT
    IntPtr lpBits,   // void* optional
    IntPtr lpbmi,   // BITMAPINFO*
    uint iUsage,   // DIB_USAGE
    uint rop   // ROP_CODE
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function StretchDIBits(
    hdc As IntPtr,   ' HDC
    xDest As Integer,   ' INT
    yDest As Integer,   ' INT
    DestWidth As Integer,   ' INT
    DestHeight As Integer,   ' INT
    xSrc As Integer,   ' INT
    ySrc As Integer,   ' INT
    SrcWidth As Integer,   ' INT
    SrcHeight As Integer,   ' INT
    lpBits As IntPtr,   ' void* optional
    lpbmi As IntPtr,   ' BITMAPINFO*
    iUsage As UInteger,   ' DIB_USAGE
    rop As UInteger   ' ROP_CODE
) As Integer
End Function

' hdc : HDC
' xDest : INT
' yDest : INT
' DestWidth : INT
' DestHeight : INT
' xSrc : INT
' ySrc : INT
' SrcWidth : INT
' SrcHeight : INT
' lpBits : void* optional
' lpbmi : BITMAPINFO*
' iUsage : DIB_USAGE
' rop : ROP_CODE
Declare PtrSafe Function StretchDIBits Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal xDest As Long, _
    ByVal yDest As Long, _
    ByVal DestWidth As Long, _
    ByVal DestHeight As Long, _
    ByVal xSrc As Long, _
    ByVal ySrc As Long, _
    ByVal SrcWidth As Long, _
    ByVal SrcHeight As Long, _
    ByVal lpBits As LongPtr, _
    ByVal lpbmi As LongPtr, _
    ByVal iUsage As Long, _
    ByVal rop As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

StretchDIBits = ctypes.windll.gdi32.StretchDIBits
StretchDIBits.restype = ctypes.c_int
StretchDIBits.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    ctypes.c_int,  # xDest : INT
    ctypes.c_int,  # yDest : INT
    ctypes.c_int,  # DestWidth : INT
    ctypes.c_int,  # DestHeight : INT
    ctypes.c_int,  # xSrc : INT
    ctypes.c_int,  # ySrc : INT
    ctypes.c_int,  # SrcWidth : INT
    ctypes.c_int,  # SrcHeight : INT
    ctypes.POINTER(None),  # lpBits : void* optional
    ctypes.c_void_p,  # lpbmi : BITMAPINFO*
    wintypes.DWORD,  # iUsage : DIB_USAGE
    wintypes.DWORD,  # rop : ROP_CODE
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
StretchDIBits = Fiddle::Function.new(
  lib['StretchDIBits'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_INT,  # xDest : INT
    Fiddle::TYPE_INT,  # yDest : INT
    Fiddle::TYPE_INT,  # DestWidth : INT
    Fiddle::TYPE_INT,  # DestHeight : INT
    Fiddle::TYPE_INT,  # xSrc : INT
    Fiddle::TYPE_INT,  # ySrc : INT
    Fiddle::TYPE_INT,  # SrcWidth : INT
    Fiddle::TYPE_INT,  # SrcHeight : INT
    Fiddle::TYPE_VOIDP,  # lpBits : void* optional
    Fiddle::TYPE_VOIDP,  # lpbmi : BITMAPINFO*
    -Fiddle::TYPE_INT,  # iUsage : DIB_USAGE
    -Fiddle::TYPE_INT,  # rop : ROP_CODE
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn StretchDIBits(
        hdc: *mut core::ffi::c_void,  // HDC
        xDest: i32,  // INT
        yDest: i32,  // INT
        DestWidth: i32,  // INT
        DestHeight: i32,  // INT
        xSrc: i32,  // INT
        ySrc: i32,  // INT
        SrcWidth: i32,  // INT
        SrcHeight: i32,  // INT
        lpBits: *const (),  // void* optional
        lpbmi: *const BITMAPINFO,  // BITMAPINFO*
        iUsage: u32,  // DIB_USAGE
        rop: u32  // ROP_CODE
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("GDI32.dll")]
public static extern int StretchDIBits(IntPtr hdc, int xDest, int yDest, int DestWidth, int DestHeight, int xSrc, int ySrc, int SrcWidth, int SrcHeight, IntPtr lpBits, IntPtr lpbmi, uint iUsage, uint rop);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_StretchDIBits' -Namespace Win32 -PassThru
# $api::StretchDIBits(hdc, xDest, yDest, DestWidth, DestHeight, xSrc, ySrc, SrcWidth, SrcHeight, lpBits, lpbmi, iUsage, rop)

#uselib "GDI32.dll"
#func global StretchDIBits "StretchDIBits" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; StretchDIBits hdc, xDest, yDest, DestWidth, DestHeight, xSrc, ySrc, SrcWidth, SrcHeight, lpBits, varptr(lpbmi), iUsage, rop   ; 戻り値は stat
; hdc : HDC -> "sptr"
; xDest : INT -> "sptr"
; yDest : INT -> "sptr"
; DestWidth : INT -> "sptr"
; DestHeight : INT -> "sptr"
; xSrc : INT -> "sptr"
; ySrc : INT -> "sptr"
; SrcWidth : INT -> "sptr"
; SrcHeight : INT -> "sptr"
; lpBits : void* optional -> "sptr"
; lpbmi : BITMAPINFO* -> "sptr"
; iUsage : DIB_USAGE -> "sptr"
; rop : ROP_CODE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "GDI32.dll"
#cfunc global StretchDIBits "StretchDIBits" sptr, int, int, int, int, int, int, int, int, sptr, var, int, int
; res = StretchDIBits(hdc, xDest, yDest, DestWidth, DestHeight, xSrc, ySrc, SrcWidth, SrcHeight, lpBits, lpbmi, iUsage, rop)
; hdc : HDC -> "sptr"
; xDest : INT -> "int"
; yDest : INT -> "int"
; DestWidth : INT -> "int"
; DestHeight : INT -> "int"
; xSrc : INT -> "int"
; ySrc : INT -> "int"
; SrcWidth : INT -> "int"
; SrcHeight : INT -> "int"
; lpBits : void* optional -> "sptr"
; lpbmi : BITMAPINFO* -> "var"
; iUsage : DIB_USAGE -> "int"
; rop : ROP_CODE -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "GDI32.dll"
#cfunc global StretchDIBits "StretchDIBits" sptr, int, int, int, int, int, int, int, int, sptr, sptr, int, int
; res = StretchDIBits(hdc, xDest, yDest, DestWidth, DestHeight, xSrc, ySrc, SrcWidth, SrcHeight, lpBits, varptr(lpbmi), iUsage, rop)
; hdc : HDC -> "sptr"
; xDest : INT -> "int"
; yDest : INT -> "int"
; DestWidth : INT -> "int"
; DestHeight : INT -> "int"
; xSrc : INT -> "int"
; ySrc : INT -> "int"
; SrcWidth : INT -> "int"
; SrcHeight : INT -> "int"
; lpBits : void* optional -> "sptr"
; lpbmi : BITMAPINFO* -> "sptr"
; iUsage : DIB_USAGE -> "int"
; rop : ROP_CODE -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。