diff options
| author | Johannes Schickel | 2013-06-08 21:37:16 +0200 |
|---|---|---|
| committer | Johannes Schickel | 2013-06-08 21:56:48 +0200 |
| commit | 4da5d11e1f7eff787144289af08dd50cd788423e (patch) | |
| tree | 8936d85ea9d5725c4df3692268cef01afb9d36e4 /common | |
| parent | 4efc9b152c89aafe8a8b4f47c7f0d3d9db945df8 (diff) | |
| download | scummvm-rg350-4da5d11e1f7eff787144289af08dd50cd788423e.tar.gz scummvm-rg350-4da5d11e1f7eff787144289af08dd50cd788423e.tar.bz2 scummvm-rg350-4da5d11e1f7eff787144289af08dd50cd788423e.zip | |
COMMON: Try to document the SineTable/CosineTable table entries.
Diffstat (limited to 'common')
| -rw-r--r-- | common/cosinetables.h | 9 | ||||
| -rw-r--r-- | common/sinetables.h | 7 |
2 files changed, 15 insertions, 1 deletions
diff --git a/common/cosinetables.h b/common/cosinetables.h index f9fb6fd59a..f5c95ec003 100644 --- a/common/cosinetables.h +++ b/common/cosinetables.h @@ -36,7 +36,14 @@ public: ~CosineTable(); /** - * Get pointer to table + * Get pointer to table. + * + * This table contains 2^bitPrecision/2 entries. + * The layout of this table is as follows: + * - Entries 0 up to (excluding) 2^bitPrecision/4: + * cos(0) till (excluding) cos(1/2*pi) + * - Entries 2^bitPrecision/4 up to (excluding) 2^bitPrecision/2: + * cos(3/2*pi) till (excluding) cos(2*pi) */ const float *getTable() { return _table; } diff --git a/common/sinetables.h b/common/sinetables.h index 16e203f26d..3489663661 100644 --- a/common/sinetables.h +++ b/common/sinetables.h @@ -37,6 +37,13 @@ public: /** * Get pointer to table + * + * This table contains 2^bitPrecision/2 entries. + * The layout of this table is as follows: + * - Entries 0 up to (excluding) 2^bitPrecision/4: + * sin(0) till (excluding) sin(1/2*pi) + * - Entries 2^bitPrecision/4 up to (excluding) 2^bitPrecision/2: + * sin(pi) till (excluding) sin(3/2*pi) */ const float *getTable() { return _table; } |