DrawDibBegin

関数

DrawDib描画環境を初期化して準備する。

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

シグネチャ

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

BOOL DrawDibBegin(
    INT_PTR hdd,
    HDC hdc,   // optional
    INT dxDst,
    INT dyDst,
    BITMAPINFOHEADER* lpbi,
    INT dxSrc,
    INT dySrc,
    DWORD wFlags
);

パラメーター

名前

型

方向

説明

hdd

INT_PTR

DrawDib DC へのハンドル。

hdc

HDC

inoptional

描画用 DC へのハンドル。このパラメーターは省略可能です。

dxDst

INT

コピー先矩形の幅(MM_TEXT クライアント単位)。

dyDst

INT

コピー先矩形の高さ(MM_TEXT クライアント単位)。

lpbi

BITMAPINFOHEADER*

画像フォーマットを格納した BITMAPINFOHEADER 構造体へのポインター。DIB のカラーテーブルは画像フォーマットの後に続き、biHeight メンバーは正の値でなければなりません。

dxSrc

INT

コピー元矩形の幅(ピクセル単位)。

dySrc

INT

コピー元矩形の高さ(ピクセル単位)。

wFlags

DWORD

この関数に適用されるフラグ。次の値が定義されています。

値	意味
DDF_ANIMATE	パレットアニメーションを許可します。この値が指定されている場合、DrawDib は LOGPALETTE 構造体の palPalEntry 配列エントリに PC_RESERVED を設定することで可能な限り多くのエントリを予約し、DrawDibChangePalette 関数を使用してパレットをアニメーション化できます。アプリケーションが DrawDibBegin 関数を DrawDibDraw 関数とともに使用する場合は、この値を DrawDibDraw ではなく DrawDibBegin で設定してください。
DDF_BACKGROUNDPAL	描画に使用するパレットをバックグラウンドタスクとして実現し、現在ディスプレイで使用されているパレットは変更しません。(この値は DDF_SAME_HDC と相互排他です。)
DDF_BUFFER	DrawDib にオフスクリーンバッファーの使用を試みさせ、DDF_UPDATE を使用できるようにします。これにより、解凍および画面への直接描画は無効になります。DrawDib がオフスクリーンバッファーを作成できない場合は、解凍または画面への直接描画を行います。詳細については、DrawDibDraw で説明されている DDF_UPDATE および DDF_DONTDRAW の値を参照してください。
DDF_DONTDRAW	現在の画像は描画されませんが、解凍されます。後で DDF_UPDATE を使用して画像を描画できます。このフラグは DDF_PREROLL フラグに優先します。
DDF_FULLSCREEN	サポートされていません。
DDF_HALFTONE	DIB のパレットに関係なく、常に DIB を標準パレットへディザリングします。アプリケーションが DrawDibBegin を DrawDibDraw とともに使用する場合は、この値を DrawDibDraw ではなく DrawDibBegin で設定してください。
DDF_JUSTDRAWIT	GDI を使用して画像を描画します。DrawDib 関数による画像の解凍、伸縮、ディザリングを禁止します。これにより、DrawDib を StretchDIBits 関数と区別する機能が取り除かれます。
DDF_SAME_DRAW	DrawDibDraw に対して現在の描画パラメーターを使用します。この値は、DrawDibDraw または DrawDibBegin の使用以降に lpbi、dxDest、dyDest、dxSrc、dySrc が変更されていない場合にのみ使用してください。このフラグは DDF_SAME_DIB および DDF_SAME_SIZE フラグに優先します。
DDF_SAME_HDC	現在の DC ハンドルおよびその DC に現在関連付けられているパレットを使用します。
DDF_UPDATE	最後にバッファリングされたビットマップを再描画する必要があります。この値で描画が失敗した場合、バッファリングされた画像は利用できず、ディスプレイを更新する前に新しい画像を指定する必要があります。

戻り値の型: BOOL

公式ドキュメント

DrawDibBegin 関数は、DrawDib DC のパラメーターを変更するか、新しい DrawDib DC を初期化します。

戻り値

成功した場合は TRUE を、それ以外の場合は FALSE を返します。

解説(Remarks)

この関数は、lpbi で指定された DIB を DC に描画する準備を行います。画像は dxDest および dyDest で指定されたサイズに伸縮されます。dxDest と dyDest を −1 に設定した場合、DIB は伸縮されずに 1:1 のスケールで描画されます。

DrawDib DC のフラグは、新しいフラグを指定して DrawDibBegin を再発行し、dxDest、dyDest、lpbi、dxSrc、dySrc のうち少なくとも 1 つの設定を変更することで更新できます。

DrawDibBegin のパラメーターが変更されていない場合、以降の関数呼び出しは効果を持ちません。

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

各言語での呼び出し定義

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

BOOL DrawDibBegin(
    INT_PTR hdd,
    HDC hdc,   // optional
    INT dxDst,
    INT dyDst,
    BITMAPINFOHEADER* lpbi,
    INT dxSrc,
    INT dySrc,
    DWORD wFlags
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("MSVFW32.dll", ExactSpelling = true)]
static extern bool DrawDibBegin(
    IntPtr hdd,   // INT_PTR
    IntPtr hdc,   // HDC optional
    int dxDst,   // INT
    int dyDst,   // INT
    IntPtr lpbi,   // BITMAPINFOHEADER*
    int dxSrc,   // INT
    int dySrc,   // INT
    uint wFlags   // DWORD
);

<DllImport("MSVFW32.dll", ExactSpelling:=True)>
Public Shared Function DrawDibBegin(
    hdd As IntPtr,   ' INT_PTR
    hdc As IntPtr,   ' HDC optional
    dxDst As Integer,   ' INT
    dyDst As Integer,   ' INT
    lpbi As IntPtr,   ' BITMAPINFOHEADER*
    dxSrc As Integer,   ' INT
    dySrc As Integer,   ' INT
    wFlags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hdd : INT_PTR
' hdc : HDC optional
' dxDst : INT
' dyDst : INT
' lpbi : BITMAPINFOHEADER*
' dxSrc : INT
' dySrc : INT
' wFlags : DWORD
Declare PtrSafe Function DrawDibBegin Lib "msvfw32" ( _
    ByVal hdd As LongPtr, _
    ByVal hdc As LongPtr, _
    ByVal dxDst As Long, _
    ByVal dyDst As Long, _
    ByVal lpbi As LongPtr, _
    ByVal dxSrc As Long, _
    ByVal dySrc As Long, _
    ByVal wFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DrawDibBegin = ctypes.windll.msvfw32.DrawDibBegin
DrawDibBegin.restype = wintypes.BOOL
DrawDibBegin.argtypes = [
    ctypes.c_ssize_t,  # hdd : INT_PTR
    wintypes.HANDLE,  # hdc : HDC optional
    ctypes.c_int,  # dxDst : INT
    ctypes.c_int,  # dyDst : INT
    ctypes.c_void_p,  # lpbi : BITMAPINFOHEADER*
    ctypes.c_int,  # dxSrc : INT
    ctypes.c_int,  # dySrc : INT
    wintypes.DWORD,  # wFlags : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MSVFW32.dll')
DrawDibBegin = Fiddle::Function.new(
  lib['DrawDibBegin'],
  [
    Fiddle::TYPE_INTPTR_T,  # hdd : INT_PTR
    Fiddle::TYPE_VOIDP,  # hdc : HDC optional
    Fiddle::TYPE_INT,  # dxDst : INT
    Fiddle::TYPE_INT,  # dyDst : INT
    Fiddle::TYPE_VOIDP,  # lpbi : BITMAPINFOHEADER*
    Fiddle::TYPE_INT,  # dxSrc : INT
    Fiddle::TYPE_INT,  # dySrc : INT
    -Fiddle::TYPE_INT,  # wFlags : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "msvfw32")]
extern "system" {
    fn DrawDibBegin(
        hdd: isize,  // INT_PTR
        hdc: *mut core::ffi::c_void,  // HDC optional
        dxDst: i32,  // INT
        dyDst: i32,  // INT
        lpbi: *mut BITMAPINFOHEADER,  // BITMAPINFOHEADER*
        dxSrc: i32,  // INT
        dySrc: i32,  // INT
        wFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("MSVFW32.dll")]
public static extern bool DrawDibBegin(IntPtr hdd, IntPtr hdc, int dxDst, int dyDst, IntPtr lpbi, int dxSrc, int dySrc, uint wFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MSVFW32_DrawDibBegin' -Namespace Win32 -PassThru
# $api::DrawDibBegin(hdd, hdc, dxDst, dyDst, lpbi, dxSrc, dySrc, wFlags)

#uselib "MSVFW32.dll"
#func global DrawDibBegin "DrawDibBegin" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; DrawDibBegin hdd, hdc, dxDst, dyDst, varptr(lpbi), dxSrc, dySrc, wFlags   ; 戻り値は stat
; hdd : INT_PTR -> "sptr"
; hdc : HDC optional -> "sptr"
; dxDst : INT -> "sptr"
; dyDst : INT -> "sptr"
; lpbi : BITMAPINFOHEADER* -> "sptr"
; dxSrc : INT -> "sptr"
; dySrc : INT -> "sptr"
; wFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "MSVFW32.dll"
#cfunc global DrawDibBegin "DrawDibBegin" sptr, sptr, int, int, var, int, int, int
; res = DrawDibBegin(hdd, hdc, dxDst, dyDst, lpbi, dxSrc, dySrc, wFlags)
; hdd : INT_PTR -> "sptr"
; hdc : HDC optional -> "sptr"
; dxDst : INT -> "int"
; dyDst : INT -> "int"
; lpbi : BITMAPINFOHEADER* -> "var"
; dxSrc : INT -> "int"
; dySrc : INT -> "int"
; wFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "MSVFW32.dll"
#cfunc global DrawDibBegin "DrawDibBegin" sptr, sptr, int, int, sptr, int, int, int
; res = DrawDibBegin(hdd, hdc, dxDst, dyDst, varptr(lpbi), dxSrc, dySrc, wFlags)
; hdd : INT_PTR -> "sptr"
; hdc : HDC optional -> "sptr"
; dxDst : INT -> "int"
; dyDst : INT -> "int"
; lpbi : BITMAPINFOHEADER* -> "sptr"
; dxSrc : INT -> "int"
; dySrc : INT -> "int"
; wFlags : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。