GradientFill

関数

矩形または三角形に色のグラデーションを塗りつぶす。

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

シグネチャ

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

BOOL GradientFill(
    HDC hdc,
    TRIVERTEX* pVertex,
    DWORD nVertex,
    void* pMesh,
    DWORD nMesh,
    GRADIENT_FILL ulMode
);

パラメーター

名前

型

方向

説明

hdc

HDC

描画先デバイスコンテキストへのハンドルです。

pVertex

TRIVERTEX*

頂点をそれぞれ定義する TRIVERTEX 構造体の配列へのポインターです。

nVertex

DWORD

pVertex 内の頂点の数です。

pMesh

void*

三角形モードでは GRADIENT_TRIANGLE 構造体の配列、矩形モードでは GRADIENT_RECT 構造体の配列です。

nMesh

DWORD

pMesh 内の要素(三角形または矩形)の数です。

ulMode

GRADIENT_FILL

グラデーション塗りつぶしモードです。このパラメーターには次のいずれかの値を指定できます。

値	意味
GRADIENT_FILL_RECT_H	このモードでは、2 つの端点が矩形を表します。矩形は、左右の辺について一定の色(TRIVERTEX 構造体で指定)を持つように定義されます。GDI は左辺から右辺へ色を補間し、内部を塗りつぶします。
GRADIENT_FILL_RECT_V	このモードでは、2 つの端点が矩形を表します。矩形は、上下の辺について一定の色(TRIVERTEX 構造体で指定)を持つように定義されます。GDI は上辺から下辺へ色を補間し、内部を塗りつぶします。
GRADIENT_FILL_TRIANGLE	このモードでは、TRIVERTEX 構造体の配列と、個々の三角形を表す配列インデックスのリストが GDI に渡されます。GDI は三角形の頂点間で線形補間を行い、内部を塗りつぶします。描画は 24 bpp および 32 bpp モードでは直接行われます。16、8、4、1 bpp モードではディザリングが行われます。

戻り値の型: BOOL

公式ドキュメント

GradientFill 関数は、矩形および三角形の構造体を塗りつぶします。

戻り値

関数が成功した場合、戻り値は TRUE です。

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

解説(Remarks)

三角形にスムーズシェーディングを追加するには、3 つの三角形の端点を指定して GradientFill 関数を呼び出します。GDI は線形補間を行い、三角形を塗りつぶします。シェーディングされた三角形の描画出力を以下に示します。

Illustration of a triangle that fills from orange at the top point to magenta on the bottom line

矩形にスムーズシェーディングを追加するには、矩形の左上と右下の座標を指定して GradientFill を呼び出します。矩形を描画する際には 2 つのシェーディングモードが使用されます。水平モードでは、矩形は左から右へシェーディングされます。垂直モードでは、矩形は上から下へシェーディングされます。シェーディングされた 2 つの矩形(一方は水平モード、もう一方は垂直モード)の描画出力を以下に示します。 Illustration of a rectangle that shades from dark on the left side to light on the right side

Illustration of a rectangle that shades from dark on the left side to light on the right side

Illustration of a rectangle that shades from dark on the top to light on the bottom

GradientFill 関数は、描画するオブジェクトの端点を指定するためにメッシュ方式を使用します。すべての頂点は pVertex 配列で GradientFill に渡されます。pMesh パラメーターは、これらの頂点をどのように接続してオブジェクトを形成するかを指定します。矩形を塗りつぶす場合、pMesh は GRADIENT_RECT 構造体の配列を指します。各 GRADIENT_RECT 構造体は、pVertex 配列内の 2 つの頂点のインデックスを指定します。これら 2 つの頂点が、1 つの矩形の左上と右下の境界を形成します。

三角形を塗りつぶす場合、pMesh は GRADIENT_TRIANGLE 構造体の配列を指します。各 GRADIENT_TRIANGLE 構造体は、pVertex 配列内の 3 つの頂点のインデックスを指定します。これら 3 つの頂点が 1 つの三角形を形成します。

ハードウェアアクセラレーションを簡素化するため、このルーチンは三角形の内部においてピクセル単位で完全であることは要求されません。

GradientFill は TRIVERTEX 構造体の Alpha メンバーを使用しないことに注意してください。GradientFill を透過性とともに使用するには、GradientFill を呼び出した後、各頂点のアルファチャネルに目的の値を指定して AlphaBlend を呼び出します。

詳細については、スムーズシェーディング、シェーディングされた三角形の描画、およびシェーディングされた矩形の描画を参照してください。

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

各言語での呼び出し定義

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

BOOL GradientFill(
    HDC hdc,
    TRIVERTEX* pVertex,
    DWORD nVertex,
    void* pMesh,
    DWORD nMesh,
    GRADIENT_FILL ulMode
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("MSIMG32.dll", ExactSpelling = true)]
static extern bool GradientFill(
    IntPtr hdc,   // HDC
    IntPtr pVertex,   // TRIVERTEX*
    uint nVertex,   // DWORD
    IntPtr pMesh,   // void*
    uint nMesh,   // DWORD
    uint ulMode   // GRADIENT_FILL
);

<DllImport("MSIMG32.dll", ExactSpelling:=True)>
Public Shared Function GradientFill(
    hdc As IntPtr,   ' HDC
    pVertex As IntPtr,   ' TRIVERTEX*
    nVertex As UInteger,   ' DWORD
    pMesh As IntPtr,   ' void*
    nMesh As UInteger,   ' DWORD
    ulMode As UInteger   ' GRADIENT_FILL
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hdc : HDC
' pVertex : TRIVERTEX*
' nVertex : DWORD
' pMesh : void*
' nMesh : DWORD
' ulMode : GRADIENT_FILL
Declare PtrSafe Function GradientFill Lib "msimg32" ( _
    ByVal hdc As LongPtr, _
    ByVal pVertex As LongPtr, _
    ByVal nVertex As Long, _
    ByVal pMesh As LongPtr, _
    ByVal nMesh As Long, _
    ByVal ulMode As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GradientFill = ctypes.windll.msimg32.GradientFill
GradientFill.restype = wintypes.BOOL
GradientFill.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    ctypes.c_void_p,  # pVertex : TRIVERTEX*
    wintypes.DWORD,  # nVertex : DWORD
    ctypes.POINTER(None),  # pMesh : void*
    wintypes.DWORD,  # nMesh : DWORD
    wintypes.DWORD,  # ulMode : GRADIENT_FILL
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MSIMG32.dll')
GradientFill = Fiddle::Function.new(
  lib['GradientFill'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_VOIDP,  # pVertex : TRIVERTEX*
    -Fiddle::TYPE_INT,  # nVertex : DWORD
    Fiddle::TYPE_VOIDP,  # pMesh : void*
    -Fiddle::TYPE_INT,  # nMesh : DWORD
    -Fiddle::TYPE_INT,  # ulMode : GRADIENT_FILL
  ],
  Fiddle::TYPE_INT)

#[link(name = "msimg32")]
extern "system" {
    fn GradientFill(
        hdc: *mut core::ffi::c_void,  // HDC
        pVertex: *mut TRIVERTEX,  // TRIVERTEX*
        nVertex: u32,  // DWORD
        pMesh: *mut (),  // void*
        nMesh: u32,  // DWORD
        ulMode: u32  // GRADIENT_FILL
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("MSIMG32.dll")]
public static extern bool GradientFill(IntPtr hdc, IntPtr pVertex, uint nVertex, IntPtr pMesh, uint nMesh, uint ulMode);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MSIMG32_GradientFill' -Namespace Win32 -PassThru
# $api::GradientFill(hdc, pVertex, nVertex, pMesh, nMesh, ulMode)

#uselib "MSIMG32.dll"
#func global GradientFill "GradientFill" sptr, sptr, sptr, sptr, sptr, sptr
; GradientFill hdc, varptr(pVertex), nVertex, pMesh, nMesh, ulMode   ; 戻り値は stat
; hdc : HDC -> "sptr"
; pVertex : TRIVERTEX* -> "sptr"
; nVertex : DWORD -> "sptr"
; pMesh : void* -> "sptr"
; nMesh : DWORD -> "sptr"
; ulMode : GRADIENT_FILL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "MSIMG32.dll"
#cfunc global GradientFill "GradientFill" sptr, var, int, sptr, int, int
; res = GradientFill(hdc, pVertex, nVertex, pMesh, nMesh, ulMode)
; hdc : HDC -> "sptr"
; pVertex : TRIVERTEX* -> "var"
; nVertex : DWORD -> "int"
; pMesh : void* -> "sptr"
; nMesh : DWORD -> "int"
; ulMode : GRADIENT_FILL -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "MSIMG32.dll"
#cfunc global GradientFill "GradientFill" sptr, sptr, int, sptr, int, int
; res = GradientFill(hdc, varptr(pVertex), nVertex, pMesh, nMesh, ulMode)
; hdc : HDC -> "sptr"
; pVertex : TRIVERTEX* -> "sptr"
; nVertex : DWORD -> "int"
; pMesh : void* -> "sptr"
; nMesh : DWORD -> "int"
; ulMode : GRADIENT_FILL -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。