Skip to content

Commit 2afd050

Browse files
committed
Improve XML docs for 'EffectFactory'
1 parent 1141f48 commit 2afd050

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

src/ComputeSharp.D2D1/Interfaces/Descriptors/ID2D1PixelShaderDescriptor{T}.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,8 @@ public interface ID2D1PixelShaderDescriptor<T>
6060
/// This only applies to effects created from <see cref="D2D1PixelShaderEffect"/>.
6161
/// </para>
6262
/// <para>
63-
/// The returned function pointer should have a signature matching <a href="https://learn.microsoft.com/windows/win32/api/d2d1_1/nc-d2d1_1-pd2d1_effect_factory"><c>PD2D1_EFFECT_FACTORY</c></a>.
63+
/// The returned function pointer should have a signature matching <a href="https://learn.microsoft.com/windows/win32/api/d2d1_1/nc-d2d1_1-pd2d1_effect_factory"><c>PD2D1_EFFECT_FACTORY</c></a>,
64+
/// and it should point to a method calling <see cref="D2D1PixelShaderEffect.CreateEffectUnsafe"/>. Using other D2D effect implementations is not a supported scenario, and might not work correctly.
6465
/// </para>
6566
/// </remarks>
6667
static abstract nint EffectFactory { get; }

src/ComputeSharp.D2D1/Shaders/Interop/D2D1PixelShaderEffect.cs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,11 @@ public static ref readonly Guid GetEffectId<T>()
8686
/// </para>
8787
/// <para>
8888
/// This method is guaranteed to never throw an exception, and can be used directly in a method exported to native code.
89+
/// </para>
90+
/// <para>
8991
/// The main use case scenario for calling <see cref="CreateEffectUnsafe"/> is to produce the factory for
90-
/// <a href="https://learn.microsoft.com/windows/win32/api/d2d1_1/nf-d2d1_1-id2d1factory1-registereffectfromstring"><c>ID2D1Factory1::RegisterEffectFromString</c></a>.
92+
/// <a href="https://learn.microsoft.com/windows/win32/api/d2d1_1/nf-d2d1_1-id2d1factory1-registereffectfromstring"><c>ID2D1Factory1::RegisterEffectFromString</c></a>,
93+
/// which should then be returned from <see cref="ID2D1PixelShaderDescriptor{T}.EffectFactory"/> implementations (either generated or manually authored).
9194
/// </para>
9295
/// </remarks>
9396
public static int CreateEffectUnsafe<T>(void** effectImpl)

0 commit comments

Comments
 (0)