search

dotnet / dotnet-api-docs

.NET API reference documentation (.NET 5+, .NET Core, .NET Framework)
https://docs.microsoft.com/dotnet/api/
Other
702 stars 1.55k forks source link

PixelFormats.Prgba64 docs has invalid statement (channel bits : 32, instead of 16) #7538

Open SoLaRGit opened 2 years ago

SoLaRGit commented 2 years ago

Documentation on PixelFormats.Prgba64 member has following invalid statement ("Each channel (...) is allocated 32 bits per pixel"): <summary>Gets the <see cref="P:System.Windows.Media.PixelFormats.Prgba64" /> pixel format. <see cref="P:System.Windows.Media.PixelFormats.Prgba64" /> is a sRGB format with 64 bits per pixel (BPP). Each channel (blue, green, red, and alpha) is allocated 32 bits per pixel (BPP). Each color channel is pre-multiplied by the alpha value. This format has a gamma of 1.0.</summary>

Obviously it should state the following ("Each channel (...) is allocated 16 bits per pixel" instead): <summary>Gets the <see cref="P:System.Windows.Media.PixelFormats.Prgba64" /> pixel format. <see cref="P:System.Windows.Media.PixelFormats.Prgba64" /> is a sRGB format with 64 bits per pixel (BPP). Each channel (blue, green, red, and alpha) is allocated 16 bits per pixel (BPP). Each color channel is pre-multiplied by the alpha value. This format has a gamma of 1.0.</summary>

32 bits per channel is misleading, someone might think it's 128 bits pixel format, or some magic composition of values is happening like in RGBE WIC pixel format.

Also it bothers me missing 'with', shouldn't it state : "Each channel (...) is allocated with N bits per pixel"? All members in PixelFormats class have missing 'with', but it's not big concern (it transfers the idea correctly).

dotnet-issue-labeler[bot] commented 2 years ago

I couldn't figure out the best area label to add to this issue. If you have write-permissions please help me learn by adding exactly one area label.