1
0
Fork 0
mirror of https://github.com/Ellpeck/MLEM.git synced 2024-11-24 21:48:35 +01:00

Compare commits

...

2 commits

9 changed files with 23 additions and 45 deletions

View file

@ -1,5 +1,5 @@
# Changelog # Changelog
MLEM tries to adhere to [semantic versioning](https://semver.org/). Breaking changes are written in *italics*. MLEM tries to adhere to [semantic versioning](https://semver.org/). Breaking changes are written in **bold**.
Jump to version: Jump to version:
- [5.2.0 (Unreleased)](#520-unreleased) - [5.2.0 (Unreleased)](#520-unreleased)
@ -17,6 +17,7 @@ Additions
- Added DrawExtendedAutoTile to the AutoTiling class - Added DrawExtendedAutoTile to the AutoTiling class
Improvements Improvements
- **Moved AutoTiling to Graphics namespace**
- Cache TokenizedString inner offsets for non-Left text alignments to improve performance - Cache TokenizedString inner offsets for non-Left text alignments to improve performance
- Exposed Camera's RoundPosition - Exposed Camera's RoundPosition
- Exposed the epsilon value used by Camera - Exposed the epsilon value used by Camera
@ -28,6 +29,9 @@ Improvements
Fixes Fixes
- Fixed some end-of-line inconsistencies when using the Right text alignment - Fixed some end-of-line inconsistencies when using the Right text alignment
Removals
- **Removed deprecated Misc versions of SoundEffectInfo and SoundEffectInstanceHandler**
### MLEM.Ui ### MLEM.Ui
Additions Additions
- Allow specifying a maximum amount of characters for a TextField - Allow specifying a maximum amount of characters for a TextField
@ -35,9 +39,9 @@ Additions
- Added a formatting code to allow for inline font changes - Added a formatting code to allow for inline font changes
Improvements Improvements
- *Made Image ScaleToImage take ui scale into account* - **Made Image ScaleToImage take ui scale into account**
- *Added style properties for a lot of hardcoded default element styles* - **Added style properties for a lot of hardcoded default element styles**
- *Allow setting a custom effect and depth stencil state for ui drawing* - **Allow setting a custom effect and depth stencil state for ui drawing**
- Exposed the epsilon value used by Element calculations - Exposed the epsilon value used by Element calculations
- Allow style properties to set style values with a higher priority, which allows elements to style their default children - Allow style properties to set style values with a higher priority, which allows elements to style their default children
- Allow changing the entire ui style for a single element - Allow changing the entire ui style for a single element
@ -52,7 +56,7 @@ Fixes
- Fixed some inconsistencies with element transformations and mouse interaction - Fixed some inconsistencies with element transformations and mouse interaction
Removals Removals
- *Removed ScrollBar ScrollerOffset* - **Removed ScrollBar ScrollerOffset**
### MLEM.Data ### MLEM.Data
Additions Additions
@ -60,7 +64,7 @@ Additions
- Added JsonTypeSafeWrapper and JsonTypeSafeGenericDataHolder - Added JsonTypeSafeWrapper and JsonTypeSafeGenericDataHolder
Improvements Improvements
- *Use TitleContainer for opening streams where possible* - **Use TitleContainer for opening streams where possible**
- Set GraphicsResource Name when loading assets using RawContentManager - Set GraphicsResource Name when loading assets using RawContentManager
## 5.1.0 ## 5.1.0
@ -69,8 +73,8 @@ Additions
- Added RotateBy to Direction2Helper - Added RotateBy to Direction2Helper
Improvements Improvements
- *Moved ColorHelper.Invert to ColorExtensions.Invert* - **Moved ColorHelper.Invert to ColorExtensions.Invert**
- *Allow enumerating SoundEffectInstanceHandler entries* - **Allow enumerating SoundEffectInstanceHandler entries**
- Improved NinePatch memory usage - Improved NinePatch memory usage
- Moved sound-related classes into Sound namespace - Moved sound-related classes into Sound namespace
- Added customizable overloads for Keybind, Combination and GenericInput ToString methods - Added customizable overloads for Keybind, Combination and GenericInput ToString methods
@ -87,7 +91,7 @@ Additions
- Added a masking character to TextField to allow for password-style text fields - Added a masking character to TextField to allow for password-style text fields
Improvements Improvements
- *Explicitly disallow creating Paragraphs without fonts to make starting out with MLEM.Ui less confusing* - **Explicitly disallow creating Paragraphs without fonts to make starting out with MLEM.Ui less confusing**
- Removed LINQ Any and All usage in various methods to improve memory usage - Removed LINQ Any and All usage in various methods to improve memory usage
- Allow adding Link children to non-Paragraph elements - Allow adding Link children to non-Paragraph elements
@ -125,7 +129,7 @@ Additions
- Added text alignment options to tokenized strings - Added text alignment options to tokenized strings
Improvements Improvements
- *Replaced TextInputWrapper with a more refined MlemPlatform that includes the ability to open links on various platforms* - **Replaced TextInputWrapper with a more refined MlemPlatform that includes the ability to open links on various platforms**
- Allow NinePatches to be drawn tiled rather than stretched - Allow NinePatches to be drawn tiled rather than stretched
- Added the ability for Direction2 to be used as flags - Added the ability for Direction2 to be used as flags
- Made Padding and Direction2 DataContracts - Made Padding and Direction2 DataContracts
@ -140,8 +144,8 @@ Fixes
- Fixed UnderlineCode ending in the wrong places because it was marked as a font-changing code - Fixed UnderlineCode ending in the wrong places because it was marked as a font-changing code
Removals Removals
- *Removed the array-based GetRandomEntry method* - **Removed the array-based GetRandomEntry method**
- *Removed obsolete ColorExtension methods* - **Removed obsolete ColorExtension methods**
### MLEM.Ui ### MLEM.Ui
Additions Additions
@ -155,7 +159,7 @@ Additions
- Added text alignment options to paragraphs - Added text alignment options to paragraphs
Improvements Improvements
- *Removed unnecessary GraphicsDevice references from UiSystem* - **Removed unnecessary GraphicsDevice references from UiSystem**
- Stop a panel's scroll bar from being removed from its children list automatically - Stop a panel's scroll bar from being removed from its children list automatically
- Dispose of panels' render targets to avoid memory leaks - Dispose of panels' render targets to avoid memory leaks
- Allow changing the color that a panel renders its texture with - Allow changing the color that a panel renders its texture with

View file

@ -1,6 +1,6 @@
using Microsoft.Xna.Framework; using Microsoft.Xna.Framework;
using Microsoft.Xna.Framework.Graphics; using Microsoft.Xna.Framework.Graphics;
using MLEM.Misc; using MLEM.Graphics;
using MLEM.Startup; using MLEM.Startup;
namespace Demos { namespace Demos {

View file

@ -1,5 +1,6 @@
using Microsoft.Xna.Framework; using Microsoft.Xna.Framework;
using Microsoft.Xna.Framework.Graphics; using Microsoft.Xna.Framework.Graphics;
using MLEM.Graphics;
using MLEM.Misc; using MLEM.Misc;
using MLEM.Textures; using MLEM.Textures;

View file

@ -1,7 +1,7 @@
using Microsoft.Xna.Framework; using Microsoft.Xna.Framework;
using Microsoft.Xna.Framework.Graphics; using Microsoft.Xna.Framework.Graphics;
namespace MLEM.Misc { namespace MLEM.Graphics {
/// <summary> /// <summary>
/// This class contains a <see cref="DrawAutoTile"/> method that allows users to easily draw a tile with automatic connections, as well as a more complex <see cref="DrawExtendedAutoTile"/> method. /// This class contains a <see cref="DrawAutoTile"/> method that allows users to easily draw a tile with automatic connections, as well as a more complex <see cref="DrawExtendedAutoTile"/> method.
/// Note that <see cref="StaticSpriteBatch"/> can also be used for drawing by using the <see cref="AddAutoTile"/> and <see cref="AddExtendedAutoTile"/> methods instead. /// Note that <see cref="StaticSpriteBatch"/> can also be used for drawing by using the <see cref="AddAutoTile"/> and <see cref="AddExtendedAutoTile"/> methods instead.

View file

@ -5,7 +5,7 @@ using Microsoft.Xna.Framework;
using Microsoft.Xna.Framework.Graphics; using Microsoft.Xna.Framework.Graphics;
using MLEM.Extensions; using MLEM.Extensions;
namespace MLEM.Misc { namespace MLEM.Graphics {
/// <summary> /// <summary>
/// A static sprite batch is a variation of <see cref="SpriteBatch"/> that keeps all batched items in a <see cref="VertexBuffer"/>, allowing for them to be drawn multiple times. /// A static sprite batch is a variation of <see cref="SpriteBatch"/> that keeps all batched items in a <see cref="VertexBuffer"/>, allowing for them to be drawn multiple times.
/// To add items to a static sprite batch, use <see cref="BeginBatch"/> to begin batching, <see cref="ClearBatch"/> to clear currently batched items, <c>Add</c> and its various overloads to add batch items, <see cref="Remove"/> to remove them again, and <see cref="EndBatch"/> to end batching. /// To add items to a static sprite batch, use <see cref="BeginBatch"/> to begin batching, <see cref="ClearBatch"/> to clear currently batched items, <c>Add</c> and its various overloads to add batch items, <see cref="Remove"/> to remove them again, and <see cref="EndBatch"/> to end batching.

View file

@ -1,14 +0,0 @@
using System;
using Microsoft.Xna.Framework.Audio;
namespace MLEM.Misc {
/// <inheritdoc />
[Obsolete("This class has been moved to MLEM.Sound.SoundEffectInfo in 5.1.0")]
public class SoundEffectInfo : Sound.SoundEffectInfo {
/// <inheritdoc />
public SoundEffectInfo(SoundEffect sound, float volume = 1, float pitch = 0, float pan = 0) : base(sound, volume, pitch, pan) {
}
}
}

View file

@ -1,14 +0,0 @@
using System;
using Microsoft.Xna.Framework;
namespace MLEM.Misc {
/// <inheritdoc cref="Sound.SoundEffectInstanceHandler"/>
[Obsolete("This class has been moved to MLEM.Sound.SoundEffectInstanceHandler in 5.1.0")]
public class SoundEffectInstanceHandler : Sound.SoundEffectInstanceHandler {
/// <inheritdoc cref="Sound.SoundEffectInstanceHandler(Game)"/>
public SoundEffectInstanceHandler(Game game) : base(game) {
}
}
}

View file

@ -86,7 +86,7 @@ namespace MLEM.Sound {
} }
/// <summary> /// <summary>
/// Adds a new <see cref="Misc.SoundEffectInfo"/> to this handler. /// Adds a new <see cref="SoundEffectInfo"/> to this handler.
/// This also starts playing the created instance. /// This also starts playing the created instance.
/// </summary> /// </summary>
/// <param name="info">The info for which to add a <see cref="SoundEffectInstance"/></param> /// <param name="info">The info for which to add a <see cref="SoundEffectInstance"/></param>

View file

@ -1,6 +1,7 @@
using Microsoft.Xna.Framework; using Microsoft.Xna.Framework;
using Microsoft.Xna.Framework.Graphics; using Microsoft.Xna.Framework.Graphics;
using MLEM.Extensions; using MLEM.Extensions;
using MLEM.Graphics;
using MLEM.Misc; using MLEM.Misc;
namespace MLEM.Textures { namespace MLEM.Textures {