Markdowinfy changelog, improve wording

This commit is contained in:
Dmitry Marakasov 2016-01-22 16:54:07 +03:00
parent cdfb6e9069
commit 725ba1c922

View File

@ -2,159 +2,161 @@
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/). This project adheres to [Semantic Versioning](http://semver.org/).
## [0.11.0] - 2015-11-30 ## 0.11.0 - 2015-11-30
### Added ### Added
* GetDrawable{Width,Height,Size} Window functions (@csoren) * New ```Window``` methods: ```Window::GetDrawableWidth()```, ```Window::GetDrawableHeight()```, ```Window::GetSize()``` (@csoren)
* Point and Rect less-than operators and std::hash support * ```Point``` and ```Rect``` less-than operators and std::hash support which makes them usable as map/unordered_map/set/unordered_set keys
* Rect: more methods, wider constexpr support * More ```Rect``` methods and wider constexpr support
### Fixed ### Fixed
* Rect documentation fixes * ```Rect``` documentation fixes
* Unused variable warnings (@vladimirgamalian) * Unused variable warnings (@vladimirgamalian)
* Incorrect return value handling in Surface::SetClipRect * Incorrect return value handling in ```Surface::SetClipRect()```
## [0.10.0] - 2015-10-14 ## 0.10.0 - 2015-10-14
### Fixed ### Fixed
* Improved cygwin compatibility * Improved cygwin compatibility
* Missing SDL2pp::SDL methods * Missing ```SDL``` method implementations
* Return and argument types to match upstream API (SDL2pp::Window, SDL2pp::Font, SDL2pp::Mixer) * Return and argument types to match upstream API for ```Window```, ```Font``` and ```Mixer```
* Infinite loop in StreamRWops * Infinite loop in ```StreamRWops```
* Documentation improvements * Documentation improvements
* Build without SDL_mixer support * Build without [SDL_mixer](https://www.libsdl.org/projects/SDL_mixer/) support
## [0.9.0] - 2015-09-07 ## 0.9.0 - 2015-09-07
### Added ### Added
* SDL_mixer support * [SDL_mixer](https://www.libsdl.org/projects/SDL_mixer/) support
* more Point operators: remainder; multiplication, division and remainder counterparts which take another Point * More ```Point``` operators: ```*```, ```/```, ```%``` for integer multiplication, division and remainder by a number of another ```Point```
* Point and Rect better inlining and constexpr support * ```Point``` and ```Rect``` better inlining and constexpr support
* Surface::GetFormat() * New method: ```Surface::GetFormat()```
* Texture::Update() taking pixels from Surface * ```Texture::Update()``` overload which takes Surface as pixel source
## [0.8.2] - 2015-07-28 ## 0.8.2 - 2015-07-28
### Fixed ### Fixed
* Add missing Font::IsGlyphProvided implementation (@vladimirgamalian) * Add missing ```Font::IsGlyphProvided()``` implementation (@vladimirgamalian)
* Fix glyph rectangle calculation in Font::GetGlyphRect (@vladimirgamalian) * Fix glyph rectangle calculation in ```Font::GetGlyphRect()``` (@vladimirgamalian)
## [0.8.1] - 2015-06-29 ## 0.8.1 - 2015-06-29
### Fixed ### Fixed
* Use correct type flags in RWops::Size, fixing mingw build (@vladimirgamalian) * Use correct type flags in ```RWops::Size()```, fixing MinGW build (@vladimirgamalian)
## [0.8.0] - 2015-06-10 ## 0.8.0 - 2015-06-10
### Added ### Added
* Render::Copy() overload which takes target Point instead of a Rect * ```Render::Copy()``` overload which takes target ```Point``` instead of a ```Rect```
* Render::FillCopy() which fills target rect with repeated texture * New method ```Render::FillCopy()``` which fills target rect with repeated texture
* Improved UTF-16 font rendering support * Improved UTF-16 font rendering support
* CMake module file * CMake module file
## [0.7.1] - 2015-03-27 ## 0.7.1 - 2015-03-27
### Fixed ### Fixed
* Miscellaneous style, documentation and build system fixes * Miscellaneous style, documentation and build system fixes
## [0.7.0] - 2015-01-22 ## 0.7.0 - 2015-01-22
### Added ### Added
* More Texture, Renderer (both complete now) and Window methods * More ```Texture```, ```Renderer``` (both complete now) and ```Window``` methods
* Point::Clamp(), Point::Wrap(), Rect::Extend(), Rect::IntersectLine() * New methods: ```Point::Clamp()```, ```Point::Wrap()```, ```Rect::Extend()```, ```Rect::IntersectLine()```
* Stream output for Point and Rect * STL stream output for ```Point``` and ```Rect``` (as in ```std::cout << Rect(10, 20, 30 40);```)
### Changed ### Changed
* Most setters now return reference to self to allow method chaining * Most setters now return reference to self to allow method chaining
* Exception now stores both SDL error and name of function which caused it; what() message now contains these both, so SDL2pp exceptions may be conveniently handled with ```catch (std::exception&)``` * Exception now stores both SDL error and name of function which caused it; ```what()``` message now contains these both, so SDL2pp exceptions may be conveniently handled with ```catch (std::exception&)```
* pkg-config file now provides SDL libraries along with SDL2pp, so users don't need to care of SDL2 flags in addition to SDL2pp's. * pkg-config file now provides SDL libraries along with SDL2pp, so users don't need to care of SDL2 flags in addition to SDL2pp's
### Removed ### Removed
* Deprecated Point and Rect methods (Null(), IsNull(), Get()) * Deprecated ```Point``` and ```Rect``` methods (```Null()```, ```IsNull()```, ```Get()```)
### Fixed ### Fixed
* Use move, not copy in constructing RWops from CustomRWops-derived class * Use move, not copy in constructing ```RWops``` from ```CustomRWops```-derived class
## [0.6.0] - 2015-01-11
## 0.6.0 - 2015-01-11
### Added ### Added
* Doxygen documentation for the whole library * Doxygen documentation for the whole library
* Wrapper over SDL_image initialization/deinitialization * Wrapper around [SDL_image](https://www.libsdl.org/projects/SDL_image/) initialization/deinitialization: ```SDLImage``` class
* SDL_Surface wrapper with SDL_image support; it's now possible to construct Texture from Surface * [SDL_Surface](https://wiki.libsdl.org/SDL_Surface) wrapper with [SDL_image](https://www.libsdl.org/projects/SDL_image/) support. It's now also possible to construct ```Texture``` from ```Surface```.
* Bunch of constructors from existing SDL objects (e.g. Window(SDL_Window*)) for Point, Rect, Window, Renderer, Texture * Bunch of constructors from existing SDL objects (e.g. ```Window::Window(SDL_Window*)```) for ```Point```, ```Rect```, ```Window```, ```Renderer```, ```Texture```
* Complete SDL_ttf support * Complete [SDL_ttf](https://www.libsdl.org/projects/SDL_ttf/) support
* Consistent GetWidth()/GetHeight()/GetSize() for Texture and Surface * Consistent ```GetWidth()```/```GetHeight()```/```GetSize()``` for ```Texture``` and ```Surface```
* More operators, constructors and methods for Point and Rect * More operators, constructors and methods for ```Point``` and ```Rect```
### Fixed ### Fixed
* Added proper error checking for SDL_image-using Texture constructors * Added proper error checking for SDL_image-using Texture constructors
* Multiple fixes in build system * Multiple fixes in build system
## [0.5.2] - 2014-12-30 ## 0.5.2 - 2014-12-30
### Fixed ### Fixed
* Added missing include file to installation * Added missing include file to installation
## [0.5.1] - 2014-12-27 ## 0.5.1 - 2014-12-27
### Fixed ### Fixed
* Potential problems with SDL2 error handling * Potential problems with SDL2 error handling
## [0.5.0] - 2014-12-26 ## 0.5.0 - 2014-12-26
### Added ### Added
* AudioDevice::LockHandle is now copyable * ```AudioDevice::LockHandle``` is now copyable
* + - += -= operators supported to offset a Rect by a Point * ```+``` ```-``` ```+=``` ```-=``` operators supported to offset a ```Rect``` by a ```Point```
* Optional class to pass optional values * ```Optional``` class to pass optional values
* possibility to use c++1y and detection of available useful c++1y features with c++11 * Possibility to use c++1y standard and detection of available useful c++1y features with c++11
* default argument for Texture::Lock() * Default argument for ```Texture::Lock()```
* bunch of Window functions (Maximize(), Minimize(), Hide(), Restore(), Raise(), Show(), SetFullscreen(), SetSize()) * Bunch of ```Window``` functions: ```Window::Maximize()```, ```Window::Minimize()```, ```Window::Hide()```, ```Window::Restore()```, ```Window::Raise()```, ```Window::Show()```, ```Window::SetFullscreen()```, ```Window::SetSize()```
* More granular build options for tests and examples * More granular build options for tests and examples
### Changed ### Changed
* Point and Rect no longer have invalid (Null) states and are now directly derived from SDL_Point and SDL_Rect. In places where null states were usable (e.g. usually null Rect would mean "whole area", like in Texture::Lock()), Optional is now used. Use SDL2pp::NullOpt instead of SDL2pp::(Point|Rect)::Null(). * ```Point``` and ```Rect``` no longer have invalid (Null) states and are now directly derived from [SDL_Point](https://wiki.libsdl.org/SDL_Point) and [SDL_Rect](https://wiki.libsdl.org/SDL_Rect) structures. In places where null states were usable (e.g. usually null ```Rect``` would mean "whole area", like in ```Texture::Lock()```), ```Optional``` class is now used. Use ```NullOpt``` instead of ```Point::Null()``` and ```Rect::Null()```
## [0.4.0] - 2014-12-19 ## 0.4.0 - 2014-12-19
### Added ### Added
* StreamRWops which work with STL streams * ```StreamRWops``` which work with STL streams
* AudioDevice and Texture LockHandle's now have empty constructors, so you may create them in one place and initialize later * ```AudioDevice``` and ```Texture``` ```LockHandle```s now have empty constructors, locks now may be initialized after construction
* (Read|Write)(LE|BE)(16|32|64) RWops functions * ```RWops``` (Read|Write)(LE|BE)(16|32|64) methods
* pkg-config file * pkg-config file
### Changed ### Changed
* Plain ContainerRWops is able to work with both const and non-const containers, so ConstContainerRWops class is no longer needed * Plain ```ContainerRWops``` is now able to work with both const and mutable containers
* Audio callback is now tied to AudioDevice, not AudioSpec. This is cleaner and easier to use. * Audio callback is now tied to ```AudioDevice```, not ```AudioSpec```, which is cleaner and easier to use
### Removed
* ```ConstContainerRWops``` which is no longer needed
### Fixed ### Fixed
* Exception safety when changing audio callback * Exception safety when changing audio callback
* Make -Werror conditional for user convenience * Made ```-Werror``` flag conditional for user convenience
## [0.3.0] - 2014-11-30 ## 0.3.0 - 2014-11-30
### Added ### Added
* SDL audio functionality * [SDL audio](https://wiki.libsdl.org/CategoryAudio) functionality
### Fixed ### Fixed
* Proper self-assignment handling in move assignment operators * Proper self-assignment handling in move assignment operators
## [0.2.0] - 2014-11-25 ## 0.2.0 - 2014-11-25
### Added ### Added
* Getters for texture properties (width/height/format/access) * Getters for ```Texture``` properties: ```Texture::GetWidth()```, ```Texture::GetHeight()```, ```Texture::GetFormat()```, ```Texture::GetAccess()```
* Texture locking * ```Texture``` locking
* Rect method to check if it contains a Point * ```Rect``` method to check if it contains a ```Point```: ```Rect::Contains()```
## [0.1.1] - 2014-09-09 ## 0.1.1 - 2014-09-09
### Added ### Added
* Installation * Installation
* Library version * Library version
## [0.1.0] - 2014-09-05 ## 0.1.0 - 2014-09-05
### Added ### Added
* SDL2_image support * [SDL2_image](https://www.libsdl.org/projects/SDL_image/) support
* RWops * ```RWops``` support
* New Renderer methods: SetClipRect(), SetScale(), SetViewport(), TargetSupported() * New ```Renderer``` methods: ```Renderer::SetClipRect()```, ```Renderer::SetScale()```, ```Renderer::SetViewport()```, ```Renderer::TargetSupported()```
* New SDL methods: WasInit(), InitSubsystem(), QuitSubSystem() * New ```SDL``` methods: ```SDL::WasInit()```, ```SDL::InitSubsystem()```, ```SDL::QuitSubSystem()```
* Basic MSVC support * Basic MSVC support
* Arithmetic operators for Point * Arithmetic operators for ```Point```
### Fixed ### Fixed
* GUI tests which are sensible to OpenGL implementation behavior are no longer fatal * GUI tests which are sensible to OpenGL implementation-specific behavior are no longer fatal
## [0.0.2] - 2014-02-11 ## 0.0.2 - 2014-02-11
### Added ### Added
* Tests * Unit tests
* New Window methods: GetSize(), GetWidth(), GetHeight(), SetTitle() * New ```Window``` methods: ```Window::GetSize()```, ```Window::GetWidth()```, ```Window::GetHeight()```, ```Window::SetTitle()```
* New Renderer method: ReadPixels() * New ```Renderer``` method: ```Renderer::ReadPixels()```
* Point and Rect setters and comparison operators * ```Point``` and ```Rect``` setters and comparison operators
## [0.0.1] - 2014-02-01 ## 0.0.1 - 2014-02-01
### Added ### Added
* Initial release supporting basic Window, Renderer, Texture, Rect and Point handling. * Initial release supporting basic ```Window```, ```Renderer```, ```Texture```, ```Rect``` and ```Point``` handling