ICompositionTextureInterop::GetAvailableFence method (windows.ui.composition.interop.h)

  • Article

Important

Some information relates to a prerelease product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Retrieves a Direct3D synchronization fence/value pair that indicates when the composition texture will become available, if that info is known. The value returned depends on the availability state of the composition texture. An availability state specifies whether, and when, it's safe to render to the composition texture.

See the Remarks section of IDCompositionTexture::GetAvailableFence for the availability states, their descriptions, and how GetAvailableFence behaves for each state.

If a composition texture becomes available, then your app must be careful to issue rendering only to the exact subregion of the Direct3D texture that it refers to.

Syntax

HRESULT GetAvailableFence(
  UINT64 *fenceValue,
  REFIID iid,
  void   **availableFence
);

Parameters

fenceValue

Type: _Out_ UINT64*

The returned fence value.

iid

Type: _In_ REFIID

An interface identifier.

availableFence

Type: _Outptr_result_maybenull_ void**

The returned available fence, or nullptr, depending on the availability state of the composition texture. For details, see the Remarks section of IDCompositionTexture::GetAvailableFence.

Return value

Type: HRESULT

If the function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Requirement Value
Header windows.ui.composition.interop.h

See also