IDCompositionVisualDebug
COM公式ドキュメント
デバッグ用のビジュアルを表します。
メソッド 4
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
オーバードローが発生している領域を示すビジュアルのヒートマップを有効にします。
| color | D2D1_COLOR_F* | in | ヒートマップ表示に用いる色を指定するD2D1_COLOR_F構造体へのポインタである。 |
戻り値
関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。エラーコードの一覧については、DirectComposition Error Codes を参照してください。
解説(Remarks)
ヒートマップは EnableHeatMap を呼び出すことで有効にできます。ヒートマップは VisualDebug のビジュアルおよびその子ビジュアルのソースに描画されます。ヒートマップは、すべてのビジュアルコンテンツについて指定された色で表現されます。重なり合ったオーバードロー領域を確認できるようにするため、ヒートマップの色には透明度が必要です。色付けされたサーフェスがブレンドされることで、すべてのオーバードロー領域を 1 つのビューでビジュアルに確認できます。
ビジュアルのヒートマップを無効にします。
戻り値
関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。エラーコードの一覧については、DirectComposition Error Codes を参照してください。
コンテンツが再描画される際に、ビジュアルを強調表示する機能を有効にします。
戻り値
関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。エラーコードの一覧については、DirectComposition Error Codes を参照してください。
解説(Remarks)
再描画領域の強調表示は EnableRedrawRegions を呼び出すことで有効にできます。この関数を使用すると、ビジュアルが更新されたフレームごとに、再描画されたクライアント領域がビジュアルに強調表示されます。再描画領域は VisualDebug のビジュアルおよびその子ビジュアルのソースに描画されます。再描画は、ビジュアルのプロパティが更新されたときにトリガーされます。再描画をトリガーするために、更新されたビジュアルの見た目が必ずしも変化する必要はありません。強調表示は青、黄、ピンク、緑の順に循環し、どのコンテンツが更新されているかの順序を示します。再描画領域は、VisualDebug のウィンドウが更新されている間のみ表示されます。
ビジュアルの再描画領域の表示を無効にします。
戻り値
関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。エラーコードの一覧については、DirectComposition Error Codes を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IDCompositionVisualDebug "{FED2B808-5EB4-43A0-AEA3-35F65280F91B}" #usecom global IDCompositionVisualDebug IID_IDCompositionVisualDebug "{}" #comfunc global IDCompositionVisualDebug_EnableHeatMap 22 var #comfunc global IDCompositionVisualDebug_DisableHeatMap 23 #comfunc global IDCompositionVisualDebug_EnableRedrawRegions 24 #comfunc global IDCompositionVisualDebug_DisableRedrawRegions 25 ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_IDCompositionVisualDebug "{FED2B808-5EB4-43A0-AEA3-35F65280F91B}" #usecom global IDCompositionVisualDebug IID_IDCompositionVisualDebug "{}" #comfunc global IDCompositionVisualDebug_EnableHeatMap 22 sptr #comfunc global IDCompositionVisualDebug_DisableHeatMap 23 #comfunc global IDCompositionVisualDebug_EnableRedrawRegions 24 #comfunc global IDCompositionVisualDebug_DisableRedrawRegions 25 ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。