Skip to content

Change the constructor of PixelTypeInfo and ImageMetadata from internal to public so that a user can implement IImageInfo #1929

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
merged 4 commits into from
Jan 11, 2022
Merged

Change the constructor of PixelTypeInfo and ImageMetadata from internal to public so that a user can implement IImageInfo #1929

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bd4eb34
internal constructor to public constructor
jz5 Jan 8, 2022
92f47fc
Update the PixelTypeInfo constructor to use separate overloads with a…
jz5 Jan 10, 2022
edfc2b2
Merge branch 'master' into metadata
antonfirsov Jan 10, 2022
b4662e6
Merge branch 'master' into metadata
JimBobSquarePants Jan 11, 2022
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
2 changes: 1 addition & 1 deletion src/ImageSharp/Formats/PixelTypeInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ public class PixelTypeInfo
/// </summary>
/// <param name="bitsPerPixel">Color depth, in number of bits per pixel.</param>
/// <param name="alpha">Tthe pixel alpha transparency behavior.</param>
internal PixelTypeInfo(int bitsPerPixel, PixelAlphaRepresentation? alpha = null)
public PixelTypeInfo(int bitsPerPixel, PixelAlphaRepresentation? alpha = null)
Copy link
Member

@JimBobSquarePants JimBobSquarePants Jan 9, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@antonfirsov I'm wondering whether we should avoid the nullable parameter here and either provide an overload or break things for V2.

I'm not overly concerned about the implications of making this public because I'd like to do a thorough review for V3 to make sure we capture everything we should.

Copy link
Member

@antonfirsov antonfirsov Jan 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be refactored into 2 constructors for now. In long term, I would explore init-only setters for such API-s.

Copy link
Member

@antonfirsov antonfirsov Jan 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As for the V3 API concern: I think minor breaking changes are fine in advanced API-s.

Copy link
Member

@JimBobSquarePants JimBobSquarePants Jan 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, that keeps with our pattern for avoiding nullable parameters when possible. @jz5 Could you please update the PixelTypeInfo constructor to use separate overloads with and without the PixelAlphaRepresentation (not nullable) parameter. Thanks!

Copy link
Contributor Author

@jz5 jz5 Jan 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've updated it. How about this?

{
this.BitsPerPixel = bitsPerPixel;
this.AlphaRepresentation = alpha;
Expand Down
2 changes: 1 addition & 1 deletion src/ImageSharp/Metadata/ImageMetadata.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ public sealed class ImageMetadata : IDeepCloneable<ImageMetadata>
/// <summary>
/// Initializes a new instance of the <see cref="ImageMetadata"/> class.
/// </summary>
internal ImageMetadata()
public ImageMetadata()
{
this.horizontalResolution = DefaultHorizontalResolution;
this.verticalResolution = DefaultVerticalResolution;
Expand Down