🚧Refactor GlyphMetrics to readonly record

[CalvinWilkinson]

Complete The Item Below

• I have updated the title without removing the 🚧 emoji.

Description

Refactor the GlyphMetrics struct to a readonly record struct. This will provide performance benefits as well as make the struct data immutable. When refactoring the code, use the with keyword.

This struct holds data required for creating font atlas textures when loading fonts, which dictates how the text will be rendered with a particular font.

Also, refactor the properties to public init properties. This will provide the ability to set the initial values of the properties as well as keep the structure immutable.

Make sure that the XML docs for the properties have been updated.
Example:

/// <summary>
- /// Gets or sets the value.
+ /// Gets the value.
/// </summary>
- public uint MyProp { get; set; };
+ public uint MyProp { get; init; }

Note
Please use the full prop definitions as shown above. Do not use any primary constructors.
Further changes are coming down the road related to primary constructors and some research needs to be done first.

Warning
Be careful with refactoring code related to this struct. The impact could entirely break the font creation process and in turn how text is rendered. This code is especially sensitive because unsafe code is used to bit shift values on this struct based on 32bit vs 64bit processor architectures. This sensitive code is located in the FontService class.

Warning
This issue will introduce https://github.com/KinsonDigital/Velaptor/labels/%F0%9F%A7%A8breaking%20changes due to the GlyphMetrics struct being part of the public API.

Things To Consider:

• The IEquatable<T> is not required for record's. This is because the Equals() method that the interface provides is built into records.
• Methods like the Equals() override bool Equals() and GetHashCode() are built-into records

Delete the GlyphMetricsTests file. The struct is so simple combined with the removal of the Equals() methods, that there is nothing to test anymore.

Acceptance Criteria

• The GlyphMetrics structure has been refactored to a readonly record struct.
• Related code that uses the struct has been refactored
• The GlyphMetricsTests file has been deleted.
• XML docs updated where applicable

ToDo Items

• Change type labels added to this issue. Refer to the Change Type Labels section below.
• Priority label added to this issue. Refer to the Priority Type Labels section below.
• Issue linked to the correct milestone (if applicable).

Issue Dependencies

No response

Related Work

No response

Additional Information:

Change Type Labels

Change Type	Label
Bug Fixes	🐛bug
Breaking Changes	🧨breaking changes
New Feature	✨new feature
CICD Changes	♻️cicd
Config Changes	⚙️config
Performance Improvements	🏎️performance
Code Doc Changes	🗒️documentation/code
Product Doc Changes	📝documentation/product

Priority Type Labels

Priority Type	Label
Low Priority	low priority
Medium Priority	medium priority
High Priority	high priority

Code of Conduct

• I agree to follow this project's Code of Conduct.

[map-b]

Starting work on this.

[CalvinWilkinson]

Starting work on this.

@map-b I have assigned the issue to you.

Please note, I added a note in the description above stating to make sure to keep the prop definitions in the struct and to not use primary constructors.

Cheers!!

[map-b]

Of course! I didn't see it helpful in this case yesterday. I don't know if keeping the definition of the constructor although It isn't used?

[CalvinWilkinson]

Of course! I didn't see it helpful in this case yesterday. I don't know if keeping the definition of the constructor although It isn't used?

Thanks. I appreciate that!!

As of right now, it looks like I will be avoiding primary constructors when it comes to dependency injection, and then data holding types will probably move to primary constructors. But I need to think about what problems might arise, performance, .editorconfig setup for analyzers, etc.

I am super excited to move to dotnet 8 though!!

If you are interested in following (watching) issue #810 as I keep adding to it and doing research, you are welcome to.

If you are interested in knowing the state of the entire organization and all of it's projects, you can view the org project here