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

LOGBRUSH

構造体
サイズx64: 16 バイト / x86: 12 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
lbStyleBRUSH_STYLE4+0+0

ブラシのスタイル。lbStyle メンバーは次のいずれかのスタイルでなければなりません。

意味
BS_DIBPATTERN デバイス非依存ビットマップ (DIB) の指定によって定義されるパターンブラシです。lbStyleBS_DIBPATTERN の場合、lbHatch メンバーにはパックド DIB へのハンドルが格納されます。詳細については、lbHatch の説明を参照してください。
BS_DIBPATTERN8X8 BS_DIBPATTERN を参照してください。
BS_DIBPATTERNPT デバイス非依存ビットマップ (DIB) の指定によって定義されるパターンブラシです。lbStyleBS_DIBPATTERNPT の場合、lbHatch メンバーにはパックド DIB へのポインターが格納されます。詳細については、lbHatch の説明を参照してください。
BS_HATCHED ハッチブラシです。
BS_HOLLOW 中空ブラシです。
BS_NULL BS_HOLLOW と同じです。
BS_PATTERN メモリビットマップによって定義されるパターンブラシです。
BS_PATTERN8X8 BS_PATTERN を参照してください。
BS_SOLID 単色ブラシです。
lbColorCOLORREF4+4+4

ブラシの描画に使用する色。lbStyleBS_HOLLOW または BS_PATTERN スタイルの場合、lbColor は無視されます。

lbStyleBS_DIBPATTERN または BS_DIBPATTERNPT の場合、lbColor の下位ワードは、BITMAPINFO 構造体の bmiColors メンバーが明示的な赤、緑、青 (RGB) の値を含むのか、それとも現在実現されている論理パレットへのインデックスを含むのかを指定します。lbColor メンバーは次のいずれかの値でなければなりません。

意味
DIB_PAL_COLORS カラーテーブルは、現在実現されている論理パレットへの 16 ビットインデックスの配列で構成されます。
DIB_RGB_COLORS カラーテーブルには RGB 値がそのまま格納されます。

lbStyleBS_HATCHED または BS_SOLID の場合、lbColorCOLORREF の色値です。COLORREF の色値を作成するには、RGB マクロを使用します。

lbHatchUINT_PTR8/4+8+8

ハッチスタイル。その意味は lbStyle で定義されるブラシスタイルによって異なります。

lbStyleBS_DIBPATTERN の場合、lbHatch メンバーにはパックド DIB へのハンドルが格納されます。このハンドルを取得するには、アプリケーションは GMEM_MOVEABLE を指定して GlobalAlloc 関数 (または LMEM_MOVEABLE を指定して LocalAlloc) を呼び出してメモリブロックを割り当て、そのメモリにパックド DIB を格納します。パックド DIB は、BITMAPINFO 構造体と、その直後に続くビットマップのピクセルを定義するバイト配列で構成されます。

lbStyleBS_DIBPATTERNPT の場合、lbHatch メンバーにはパックド DIB へのポインターが格納されます。このポインターは、LMEM_FIXED を設定した LocalAlloc または GMEM_FIXED を設定した GlobalAlloc で作成されたメモリブロックから得られるか、あるいは LocalLock (handle_to_the_dib) のような呼び出しが返すポインターです。パックド DIB は、BITMAPINFO 構造体と、その直後に続くビットマップのピクセルを定義するバイト配列で構成されます。

lbStyleBS_HATCHED の場合、lbHatch メンバーはハッチの作成に使用する線の向きを指定します。次のいずれかの値を指定できます。

意味
HS_BDIAGONAL 左から右に向かって上がる 45 度のハッチ
HS_CROSS 水平と垂直の格子状ハッチ
HS_DIAGCROSS 45 度の格子状ハッチ
HS_FDIAGONAL 左から右に向かって下がる 45 度のハッチ
HS_HORIZONTAL 水平のハッチ
HS_VERTICAL 垂直のハッチ

lbStyleBS_PATTERN の場合、lbHatch はパターンを定義するビットマップへのハンドルです。このビットマップに、CreateDIBSection 関数で作成される DIB セクションビットマップを使用することはできません。

lbStyleBS_SOLID または BS_HOLLOW の場合、lbHatch は無視されます。

公式ドキュメント

LOGBRUSH 構造体は、物理ブラシのスタイル、色、パターンを定義します。CreateBrushIndirect 関数および ExtCreatePen 関数で使用されます。

解説(Remarks)

lbColor はハッチブラシの前景色を制御しますが、背景色は SetBkMode 関数および SetBkColor 関数によって制御されます。

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

各言語での定義

#include <windows.h>

// LOGBRUSH  (x64 16 / x86 12 バイト)
typedef struct LOGBRUSH {
    BRUSH_STYLE lbStyle;
    COLORREF lbColor;
    UINT_PTR lbHatch;
} LOGBRUSH;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct LOGBRUSH
{
    public uint lbStyle;
    public uint lbColor;
    public UIntPtr lbHatch;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure LOGBRUSH
    Public lbStyle As UInteger
    Public lbColor As UInteger
    Public lbHatch As UIntPtr
End Structure
import ctypes
from ctypes import wintypes

class LOGBRUSH(ctypes.Structure):
    _fields_ = [
        ("lbStyle", wintypes.DWORD),
        ("lbColor", wintypes.DWORD),
        ("lbHatch", ctypes.c_size_t),
    ]
#[repr(C)]
pub struct LOGBRUSH {
    pub lbStyle: u32,
    pub lbColor: u32,
    pub lbHatch: usize,
}
import "golang.org/x/sys/windows"

type LOGBRUSH struct {
	lbStyle uint32
	lbColor uint32
	lbHatch uintptr
}
type
  LOGBRUSH = record
    lbStyle: DWORD;
    lbColor: DWORD;
    lbHatch: NativeUInt;
  end;
const LOGBRUSH = extern struct {
    lbStyle: u32,
    lbColor: u32,
    lbHatch: usize,
};
type
  LOGBRUSH {.bycopy.} = object
    lbStyle: uint32
    lbColor: uint32
    lbHatch: uint
struct LOGBRUSH
{
    uint lbStyle;
    uint lbColor;
    size_t lbHatch;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; LOGBRUSH サイズ: 12 バイト(x86)
dim st, 3    ; 4byte整数×3(構造体サイズ 12 / 4 切り上げ)
; lbStyle : BRUSH_STYLE (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; lbColor : COLORREF (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; lbHatch : UINT_PTR (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; LOGBRUSH サイズ: 16 バイト(x64)
dim st, 4    ; 4byte整数×4(構造体サイズ 16 / 4 切り上げ)
; lbStyle : BRUSH_STYLE (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; lbColor : COLORREF (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; lbHatch : UINT_PTR (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global LOGBRUSH
    #field int lbStyle
    #field int lbColor
    #field intptr lbHatch
#endstruct

stdim st, LOGBRUSH        ; NSTRUCT 変数を確保
st->lbStyle = 100
mes "lbStyle=" + st->lbStyle