Skip to content

Improve XML docs for EffectFactory #911

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Sergio0694 merged 1 commit into from
Apr 13, 2025
Merged

Improve XML docs for EffectFactory #911

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/ComputeSharp.D2D1/Interfaces/Descriptors/ID2D1PixelShaderDescriptor{T}.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ public interface ID2D1PixelShaderDescriptor<T>
/// This only applies to effects created from <see cref="D2D1PixelShaderEffect"/>.
/// </para>
/// <para>
/// 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>.
/// 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>,
/// 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.
/// </para>
/// </remarks>
static abstract nint EffectFactory { get; }
Expand Down
5 changes: 4 additions & 1 deletion src/ComputeSharp.D2D1/Shaders/Interop/D2D1PixelShaderEffect.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,11 @@ public static ref readonly Guid GetEffectId<T>()
/// </para>
/// <para>
/// This method is guaranteed to never throw an exception, and can be used directly in a method exported to native code.
/// </para>
/// <para>
/// The main use case scenario for calling <see cref="CreateEffectUnsafe"/> is to produce the factory for
/// <a href="https://learn.microsoft.com/windows/win32/api/d2d1_1/nf-d2d1_1-id2d1factory1-registereffectfromstring"><c>ID2D1Factory1::RegisterEffectFromString</c></a>.
/// <a href="https://learn.microsoft.com/windows/win32/api/d2d1_1/nf-d2d1_1-id2d1factory1-registereffectfromstring"><c>ID2D1Factory1::RegisterEffectFromString</c></a>,
/// which should then be returned from <see cref="ID2D1PixelShaderDescriptor{T}.EffectFactory"/> implementations (either generated or manually authored).
/// </para>
/// </remarks>
public static int CreateEffectUnsafe<T>(void** effectImpl)
Expand Down