IDCompositionTarget::SetRoot メソッド (dcomp.h)

ビジュアルオブジェクトをビジュアルツリーの新しいルートオブジェクトとして設定します。

構文

HRESULT SetRoot(
  [in, optional] IDCompositionVisual *visual
);

[in, optional] visual

このビジュアルツリーの新しいルートであるビジュアルオブジェクト。このパラメーターは、NULL でもかまいません。

型: HRESULT

関数が成功した場合は、S_OK を返します。そうでない場合は、HRESULT エラーコードを返します。エラーコードの一覧については、「 DirectComposition エラーコード」を参照してください。

ビジュアルには、単一のビジュアルツリーのルートまたは別のビジュアルの子を指定できますが、両方を同時に指定することはできません。 visual パラメーターが既に別の ビジュアル ツリーのルートであるか、別のビジュアルの子である場合、このメソッドは失敗します。

visual が NULL の場合、ビジュアルツリーは空です。以前に NULL 以外のルートビジュアルがあった場合、そのビジュアルは、別のビジュアルツリーのルートとして、または別のビジュアルの子として使用できるようになります。

例については、「単純なビジュアルツリーを構築する方法」を参照してください。