Win32 API 日本語リファレンス
ホーム › Storage.Xps › IXpsOMBrush

IXpsOMBrush

COM
📘 Microsoft Learn (日本語) · English
IID56a3f80c-ea4c-4187-a57b-a2a473b2b42b継承元IXpsOMShareable自前メソッド開始 vtbl5

公式ドキュメント

グラフィック オブジェクトの描画に使用されるオブジェクトを定義します。IXpsOMBrush から派生したクラスは、領域をどのように描画するかを記述します。

メソッド 2

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 5 HRESULT GetOpacity(FLOAT* opacity)

ブラシの不透明度を取得します。

opacityFLOAT*outブラシの不透明度の値。

戻り値

このメソッドは HRESULT を返します。指定される値には、以下の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS ドキュメントのエラーを参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_POINTER
 opacity が NULL です。

解説(Remarks)

opacity は 0.0 から 1.0 までの値で表されます。0.0 はブラシが完全に透明であること、0.5 は 50 パーセントの不透明度であること、1.0 は完全に不透明であることを示します。

vtbl 6 HRESULT SetOpacity(FLOAT opacity)

ブラシの不透明度を設定します。

opacityFLOATinブラシの不透明度の値。

戻り値

このメソッドは HRESULT を返します。指定される値には、以下の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS ドキュメントのエラーを参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_INVALIDARG
 opacity が有効な値ではありません。「解説」セクションを参照してください。

解説(Remarks)

opacity は 0.0 から 1.0 までの値で表されます。0.0 はブラシが完全に透明であること、0.5 は 50 パーセントの不透明度であること、1.0 は完全に不透明であることを示します。

opacity が 0.0 未満または 1.0 を超える場合、このメソッドはエラーを返します。

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

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数: 
#define global IID_IXpsOMBrush "{56A3F80C-EA4C-4187-A57B-A2A473B2B42B}"
#usecom global IXpsOMBrush IID_IXpsOMBrush "{}"
#comfunc global IXpsOMBrush_GetOpacity  5 var
#comfunc global IXpsOMBrush_SetOpacity  6 float
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。