Missing definition for `ICompositionTexture` #1760

MarijnS95 · 2023-12-12T12:28:09Z

In c41ef74 a new ICompositorInterop2 interface is added to generation/WinSDK/RecompiledIdlHeaders/winrt/windows.ui.composition.interop.h which makes use of ICompositionTexture that is only defined in generation/WinSDK/RecompiledIdlHeaders/winrt/windows.ui.composition.h. This file is not listed under --traverse in generation\WinSDK\Partitions\WinRT.Composition\settings.rsp, causing the winmd to not have a definition for ICompositionTexture (only a type reference). windows-rs requires a type definition to understand how it behaves, and will otherwise crash (with a still rather-obscure error):

microsoft/windows-rs#2539 (comment)

Simply adding <IncludeRoot>/winrt/windows.ui.composition.h to --traverse to scrape the whole file results in many errors that I cannot immediately resolve (duplicates in namespace Apis, many missing references to types from Windows.Foundation.Numerics).

Is it okay to open a PR that adds ICompositorInterop2 to --exclude for now, until someone figures out how to successfully scrape windows.ui.composition.h?

The text was updated successfully, but these errors were encountered:

riverar · 2023-12-14T05:16:51Z

I don't see ICompositorTexture defined in windows.ui.composition.h or anywhere else. Am I missing something?

riverar · 2023-12-14T05:19:03Z

@mikebattista Think we're missing a header or idl here?

robmikh · 2023-12-14T06:07:23Z

Composition textures were added in 22621, I'm able to see it in the WinRT metadata from the SDK.

I'd only expect the interop interfaces to be included here.

riverar · 2023-12-14T06:40:12Z

@robmikh I'm looking at 22621 and don't see ICompositorTexture in there. Am I blind? 😂

robmikh · 2023-12-14T06:50:52Z

Before I comment on your eyesight, where are you pulling the metadata? I'm looking at Windows Kits\10\UnionMetadata\10.0.22621.0\Windows.winmd:

EDIT: Ah, the name is ICompositionTexture not ICompositorTexture. That may be the issue.

MarijnS95 · 2023-12-14T08:14:43Z

Looks like I misspelled it in the issue description, while writing it the correct way in the title.

https://github.com/microsoft/win32metadata/blob/3d65d3752a1a957de011a11c8b9f9745df2ad106/generation/WinSDK/RecompiledIdlHeaders/winrt/windows.ui.composition.h#L10500

riverar · 2023-12-14T09:25:05Z

Got it, thanks!

// \winrt\windows.ui.composition.interop.h

#if (NTDDI_VERSION >= NTDDI_WIN10_NI)

#undef INTERFACE
#define INTERFACE ICompositorInterop2
DECLARE_INTERFACE_IID_(ICompositorInterop2, IUnknown, "D3EEF34C-0667-4AFC-8D13-867607B0FE91")
{
    IFACEMETHOD(CheckCompositionTextureSupport)(
        _In_ IUnknown * renderingDevice,
        _Out_ BOOL * supportsCompositionTextures) PURE;

    IFACEMETHOD(CreateCompositionTexture)(
        _In_ IUnknown * d3dTexture,
-       _Outptr_ ICompositionTexture ** compositionTexture) PURE;
};

...

// \10.0.22621.0\winrt\windows.ui.composition.idl
[contract(Windows.Foundation.UniversalApiContract, 15.0)]
[exclusiveto(Windows.UI.Composition.CompositionTexture)]
[uuid(347D03A0-1C0A-4C0B-B232-8570B2B1A4EA)]
-interface ICompositionTexture : IInspectable
{
	[propget] HRESULT SourceRect([out] [retval] Windows.Graphics.RectInt32* value);
	[propput] HRESULT SourceRect([in] Windows.Graphics.RectInt32 value);
	[propget] HRESULT AlphaMode([out] [retval] Windows.Graphics.DirectX.DirectXAlphaMode* value);
	[propput] HRESULT AlphaMode([in] Windows.Graphics.DirectX.DirectXAlphaMode value);
	[propget] HRESULT ColorSpace([out] [retval] Windows.Graphics.DirectX.DirectXColorSpace* value);
	[propput] HRESULT ColorSpace([in] Windows.Graphics.DirectX.DirectXColorSpace value);
}

Will try getting this added in tomorrow.

MarijnS95 · 2023-12-14T10:41:28Z

@riverar the diff context is somewhat malformed without a leading space; what are we looking at? Is your idea to remove this type / argument from CreateCompositionTexture? I don't think you should remove the interface declaration from windows.ui.composition.idl while leaving the annotations and block with function declarations in place?

riverar · 2023-12-14T15:55:39Z

Was just talking notes and using the diff format to gain a highlighter. Not a real diff, apologies for any confusion ha!

MarijnS95 · 2023-12-14T16:01:58Z

@riverar don't forget to look at the linked main...MarijnS95:win32metadata:winrt-composition-exclude-interop2 then! I've already done the work necessary to exclude it without botching/modifying the existing headers.

MarijnS95 · 2023-12-14T16:02:17Z

Note that I proposed to just PR that, in case you're thinking of doing the exact same.

riverar · 2023-12-14T16:11:44Z

I was going to take a stab at including it, don't think we want to exclude it from metadata.

MarijnS95 · 2023-12-14T16:23:38Z

That might be even nicer, but probably a lot of work. I recall reading somewhere that "WinRT bindings are provided in a different file/way" (Microsoft.Windows.SDK.Contracts) but can't find the mention anymore. These are WinRT headers if the file is to be believed, and I shortly thought that the interop header was specifically for "Win32 bindings" into it?

riverar · 2023-12-14T19:23:24Z

Upon closer inspection, doesn't look like there's any work to be done here.

Metadata is emitting the correct definition and pointing to the correct external source (Windows.Foundation.UniversalApiContract).

.method public hidebysig newslot abstract virtual 
instance valuetype [Windows.Win32.winmd]Windows.Win32.Foundation.HRESULT CreateCompositionTexture (
	[in] class [Windows.Win32.winmd]Windows.Win32.System.Com.IUnknown d3dTexture,
+	[out] class [Windows.Foundation.UniversalApiContract]Windows.UI.Composition.ICompositionTexture* compositionTexture
) cil managed 
{
} // end of method ICompositorInterop2::CreateCompositionTexture

riverar · 2023-12-14T22:10:16Z

Closing for now but feel free to holler or hit me if we're missing something here.

MarijnS95 · 2023-12-14T23:18:03Z

Is this possibly the only non-Win32 reference in Win32 metadata? It's the only (external) TypeRef that windows-rs' riddle is failing on.

robmikh · 2023-12-15T00:40:26Z

ICompositionSurface should be in the same boat, and that's usable today from windows-rs. Maybe the WinRT metadata is out of date?

robmikh · 2023-12-15T00:42:28Z

Ah, maybe you're right. ICompositionTexture has a typedef in the interop header, which is unusual. That may be at play here when parsed.

riverar · 2023-12-15T01:11:34Z

It's not the only reference tied to UniversalApiContract.

Metadata has references to Windows.Foundation.UniversalApiContract 10.0 and 14.0, but ICompositionTexture requires contract 15.0. Will re-open this to track fixing that.

riverar · 2023-12-15T01:29:26Z

Complicating matters is that it appears ICompositionTexture was added to 22621.2428's variant of contract 15.0, whilst not in 22621.755's contract 15.0. Or in other words, Microsoft forgot to increment the contract version again.

Note to self: I'll need to update the Rust side too.

riverar · 2023-12-15T07:14:17Z

@MarijnS95 Corrected that contract (#1763) and kicked off a metadata update @ microsoft/windows-rs#2745. Want to give those a whirl?

MarijnS95 · 2023-12-16T00:39:27Z

@riverar thanks, yeah, the Windows SDK update in microsoft/windows-rs#2745 makes me able to pull in a new Win32 winmd - without the workaround to disable ICompositorInterop2 proposed above - and it generates fine now without the error observed in microsoft/windows-rs#2742.

Good to know that there are multiple reasons for a TypeRef, this makes a lot of sense but the diagnostics are just missing.

AArnott · 2024-02-22T23:22:50Z

I'm having a similar problem in CsWin32 whilst trying to update the metadata it consumes. It's failing to generate ICompositorInterop2 because of its reference to ICompositionTexture:

.method public hidebysig newslot abstract virtual 
		instance valuetype [Windows.Win32.winmd]Windows.Win32.Foundation.HRESULT CreateCompositionTexture (
			[in] class [Windows.Win32.winmd]Windows.Win32.System.Com.IUnknown d3dTexture,
			[out] class [Windows.Foundation.UniversalApiContract]Windows.UI.Composition.ICompositionTexture* compositionTexture
		) cil managed

But here's the rub: as defined in the Windows.Foundation.UniversalApiContract dll, the ICompositionTexture interface is internal!

So while CsWin32 can generate ICompositorInterop2, the code fails to compile in the user's project with this error:

error CS0122: 'ICompositionTexture' is inaccessible due to its protection level

Generally speaking, C# doesn't let a public API such as ICompositorInterop2 reference an internal API in another assembly.

How can we reconcile this?

riverar · 2024-02-22T23:44:44Z

I don't think the access modifiers for the types in Windows.Foundation.UniversalApiContract.winmd are meant to be used that way. Note that most of the interface types in that file are internal, which is probably incorrect.

kennykerr · 2024-02-22T23:57:57Z

The metadata should never refer to exclusive interfaces. They should be replaced by the class that implements the exclusive interface.

AArnott · 2024-02-23T00:18:21Z

I don't think the access modifiers for the types in Windows.Foundation.UniversalApiContract.winmd are meant to be used that way.

It isn't up to me. This is passed to the C# compiler as a reference assembly, and C# is going to honor them.

riverar · 2024-02-23T00:43:58Z

Looks like we'll need to fix up these references again (emitter.settings.rsp):

# Windows 10 (19041.1)
IPropertyValue(interface)=<Windows.Foundation.FoundationContract, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null>Windows.Foundation.IPropertyValue
IPropertySet(interface)=<Windows.Foundation.FoundationContract, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null>Windows.Foundation.Collections.IPropertySet
ICompositionSurface(interface)=<Windows.Foundation.UniversalApiContract, Version=10.0.0.0, Culture=neutral, PublicKeyToken=null>Windows.UI.Composition.ICompositionSurface
ICompositionCapabilities(interface)=<Windows.Foundation.UniversalApiContract, Version=10.0.0.0, Culture=neutral, PublicKeyToken=null>Windows.UI.Composition.CompositionCapabilities
ICompositionGraphicsDevice(interface)=<Windows.Foundation.UniversalApiContract, Version=10.0.0.0, Culture=neutral, PublicKeyToken=null>Windows.UI.Composition.CompositionGraphicsDevice
ICompositor(interface)=<Windows.Foundation.UniversalApiContract, Version=10.0.0.0, Culture=neutral, PublicKeyToken=null>Windows.UI.Composition.Compositor
IGraphicsEffectSource(interface)=<Windows.Foundation.UniversalApiContract, Version=10.0.0.0, Culture=neutral, PublicKeyToken=null>Windows.Graphics.Effects.IGraphicsEffectSource
IDesktopWindowTarget(interface)=<Windows.Foundation.UniversalApiContract, Version=10.0.0.0, Culture=neutral, PublicKeyToken=null>Windows.UI.Composition.Desktop.DesktopWindowTarget
IDispatcherQueueController(interface)=<Windows.Foundation.UniversalApiContract, Version=10.0.0.0, Culture=neutral, PublicKeyToken=null>Windows.System.DispatcherQueueController
# Windows 11 (22000.194)
IPropertySetSerializer(interface)=<Windows.Foundation.UniversalApiContract, Version=14.0.0.0, Culture=neutral, PublicKeyToken=null>Windows.Storage.Streams.IPropertySetSerializer
# Windows 11 (22621.2428)
ICompositionTexture(interface)=<Windows.Foundation.UniversalApiContract, Version=15.0.0.0, Culture=neutral, PublicKeyToken=null>Windows.UI.Composition.ICompositionTexture

riverar · 2024-02-23T00:46:16Z

Actually think most of them are okay, just not the one I added back in 2023 🥲

riverar · 2024-02-23T01:19:31Z

Fix in the pipe, have to figure out what's going on with failing tests though.

AArnott · 2024-03-20T17:24:16Z

@mikebattista any idea when the next metadata will be published to nuget.org with the fix for this so I can get a CsWin32 update out?

MarijnS95 · 2024-03-20T17:33:26Z

Just saying, I'd love for the next release to include #1757 in addition to the Agility SDK upgrade recently, if we can wait for that 🤞

This was referenced Dec 12, 2023

Implement type_name() for TypeRef microsoft/windows-rs#2539

Closed

Improve diagnostics when encountering TypeRef in metadata microsoft/windows-rs#2742

Closed

riverar closed this as not planned Won't fix, can't repro, duplicate, stale Dec 14, 2023

riverar reopened this Dec 15, 2023

riverar mentioned this issue Dec 15, 2023

Correct external contract assembly references #1763

Merged

mikebattista closed this as completed in #1763 Dec 15, 2023

AArnott reopened this Feb 22, 2024

AArnott added the blocking A projection cannot use the latest version label Feb 22, 2024

AArnott mentioned this issue Feb 22, 2024

Bump metadata versions: SDK: 60.0.34, WDK: 0.11.4 microsoft/CsWin32#1148

Merged

riverar mentioned this issue Feb 23, 2024

Correct ICompositionTexture reference #1853

Merged

mikebattista closed this as completed in #1853 Feb 27, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Missing definition for `ICompositionTexture` #1760

Missing definition for `ICompositionTexture` #1760

MarijnS95 commented Dec 12, 2023 •

edited

Loading

riverar commented Dec 14, 2023

riverar commented Dec 14, 2023

robmikh commented Dec 14, 2023

riverar commented Dec 14, 2023

robmikh commented Dec 14, 2023 •

edited

Loading

MarijnS95 commented Dec 14, 2023

riverar commented Dec 14, 2023 •

edited

Loading

MarijnS95 commented Dec 14, 2023

riverar commented Dec 14, 2023

MarijnS95 commented Dec 14, 2023

MarijnS95 commented Dec 14, 2023

riverar commented Dec 14, 2023

MarijnS95 commented Dec 14, 2023

riverar commented Dec 14, 2023

riverar commented Dec 14, 2023

MarijnS95 commented Dec 14, 2023

robmikh commented Dec 15, 2023

robmikh commented Dec 15, 2023

riverar commented Dec 15, 2023

riverar commented Dec 15, 2023

riverar commented Dec 15, 2023

MarijnS95 commented Dec 16, 2023

AArnott commented Feb 22, 2024

riverar commented Feb 22, 2024 •

edited

Loading

kennykerr commented Feb 22, 2024

AArnott commented Feb 23, 2024

riverar commented Feb 23, 2024

riverar commented Feb 23, 2024

riverar commented Feb 23, 2024

AArnott commented Mar 20, 2024

MarijnS95 commented Mar 20, 2024

Missing definition for ICompositionTexture #1760

Missing definition for ICompositionTexture #1760

Comments

MarijnS95 commented Dec 12, 2023 • edited Loading

riverar commented Dec 14, 2023

riverar commented Dec 14, 2023

robmikh commented Dec 14, 2023

riverar commented Dec 14, 2023

robmikh commented Dec 14, 2023 • edited Loading

MarijnS95 commented Dec 14, 2023

riverar commented Dec 14, 2023 • edited Loading

MarijnS95 commented Dec 14, 2023

riverar commented Dec 14, 2023

MarijnS95 commented Dec 14, 2023

MarijnS95 commented Dec 14, 2023

riverar commented Dec 14, 2023

MarijnS95 commented Dec 14, 2023

riverar commented Dec 14, 2023

riverar commented Dec 14, 2023

MarijnS95 commented Dec 14, 2023

robmikh commented Dec 15, 2023

robmikh commented Dec 15, 2023

riverar commented Dec 15, 2023

riverar commented Dec 15, 2023

riverar commented Dec 15, 2023

MarijnS95 commented Dec 16, 2023

AArnott commented Feb 22, 2024

riverar commented Feb 22, 2024 • edited Loading

kennykerr commented Feb 22, 2024

AArnott commented Feb 23, 2024

riverar commented Feb 23, 2024

riverar commented Feb 23, 2024

riverar commented Feb 23, 2024

AArnott commented Mar 20, 2024

MarijnS95 commented Mar 20, 2024

Missing definition for `ICompositionTexture` #1760

Missing definition for `ICompositionTexture` #1760

MarijnS95 commented Dec 12, 2023 •

edited

Loading

robmikh commented Dec 14, 2023 •

edited

Loading

riverar commented Dec 14, 2023 •

edited

Loading

riverar commented Feb 22, 2024 •

edited

Loading