Skip to content

Commit 7a4dc3e

Browse files
committed
(#63) Docs: document the breaking and major changes
1 parent d4aa32f commit 7a4dc3e

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,27 @@ All notable changes to this project will be documented in this file.
33

44
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning v2.0.0](https://semver.org/spec/v2.0.0.html).
55

6+
## [Unreleased] (0.13.0)
7+
### Changed
8+
- **(Breaking change.)** The library is now distributes in the form of two assemblies: `WpfMath` and `WpfMath.Shared` (as a future cross-platform core of the library).
9+
10+
Both of the assemblies are still distributed in the same NuGet package.
11+
12+
A lot of types were moved to `WpfMath.Shared` assembly (preserving their namespaces).
13+
- **(Breaking change.)** It is no longer recommended to create instances of `TexEnvironment` using the public constructor. Use `WpfMath.Rendering.WpfTeXEnvironment::Create` instead.
14+
- **(Breaking change.)** It is no longer recommended to create instances of `TexFormulaParser` using public constructors. Use `WpfMath.Parsers.WpfTeXFormulaParser::Instance` instead.
15+
- **(Breaking change.)** WPF-specific `WpfMath.Rendering.IBrush` has been replaced with `WpfMath.Rendering.IBrush` in most of the public interfaces. Use `WpfMath.Rendering.WpfBrushExtensions` to convert back and forth to the WPF type.
16+
- **(Breaking change.)** `WpfMath.Rendering.IElementRenderer` has been updated:
17+
- `RenderGlyphRun` has been replaced with `RenderCharacter` method (not reliant on any WPF-specific types),
18+
- `RenderRectangle` now receives an instance of a new `WpfMath.Rendering.Rectangle` type (decoupled from WPF).
19+
- `WpfMath.TexRenderer` is now obsolete. Consult the documentation on new recommended ways to perform custom rendering. There are new extension methods in two classes (`WpfMath.Rendering.WpfTeXFormulaExtensions` and `WpfMath.Rendering.TeXFormulaExtensions`) that are the main way to render formulae now.
20+
21+
### Added
22+
- `WpfMath.CharInfo`: a new public type to work with a font character. Use `WpfMath.Fonts.WpfCharInfoEx::GetGlyphRun` if you need to get a `System.Windows.Media.GlyphRun` from it.
23+
- `WpfMath.Rendering.WpfTeXFormulaExtensions` to render a `WpfMath.TexFormula` into a `System.Windows.Media.Imaging.BitmapSource` or `System.Windows.Media.Geometry`.
24+
- New classes for WPF-Math porting to platforms other than WPF (consult the `WpfMath.Rendering.IElementRenderer` interface and `TexFormulaParser` constructor parameters to know more).
25+
26+
627
## [0.12.0] - 2023-01-07
728
### Added
829
- TeX's environment support with only one environment for now: `\begin{pmatrix}` (see [#329][pull-329]).

0 commit comments

Comments
 (0)