summaryrefslogtreecommitdiffstats
path: root/blog/data/2016-02-08-18:57:19-libhffwk-v0-5-0.txt
blob: df4fbf90dc7c2a0c3be1c57472ed551c3732bc41 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
Title: Harmonic Flow Framework v0-5-0
Tags: harmonic-flow-news, harmonic-flow-framework, libhffwk
Date: 2016-02-08 18:57:19
Format: markdown

### What's new in version 0.5.0:

> * Documented all public classes, methods, enums, structs, typedefs
etc that a Game will interact with. Documentation is done according to
Doxygen standards. Documentation can be generated by running
'**doxygen Doxyfile**' in the '**docs/**' folder. Documentation release
packages can be generated by running
'**./linux-gen-docs-release --version=X.X.X**' in '**build_scripts**' folder.
> * Converted all source files from dos to unix utf8.
> * Moved PakInterface stuff into HFCore namespace.
> * Moved HFPak stuff into HFTools namespace.
> * Moved base64 stuff into class with static methods.
> * Moved Crypto stuff into class with static methods.
> * Crypto: Added sha1/sha224/sha256/sha384/sha512 checksum support.
> * Fixed memory leak in SDLHelper.
> * HFDataTypes: **HF_RENDERER_DIRECT3D** is defined on Windows D3D.
> * SoundPlayer: Added new enums, audio defines and also tweaked API.
> * Moved HFFileHandle to HFDataTypes.h and changed name.
> * Yearly copyright update.
> * Updated README.SDL with doxygen packages needed.
> * Added script for generating doxygen docs release. See
'**linux-gen-docs-release.sh**' in '**build_scripts**' folder.
__CUT__

### API changes:

Renamed / moved enums, structs, typedefs, class methods and so on to keep
it within HFCore namespace or within class space. This means old code
could break here and there. It shouldn't be any major changes needed
though.

### Namespace thoughts:

**HFCore** is the namespace where all engine core functionality will reside.

**HFModule** is where all optional modules will reside. Currently the only
module is '**tmxparser**'. Optional stuff outside of engine core will be
placed here. Modules will not be compiled by default and needs to be
enabled. '**tmxparser**' is enabled by setting pre-processor flag
'**HF_MODULE_TMXPARSER**' and compiling the sources within
'**modules/tmxparser**' folder. Build scripts supplied supports this
automatically by just adding '**--enable-module-tmxparser**' for example
('**./configure --help**' when using autotools directly for available
options).

Download the latest version
[here](/harmonicflow-framework/download.php). Submit any bugs or
thoughts [here](/contact.php).