@@ -5,33 +5,41 @@ uCompression provides RLE compression and decompression functions for microcontr
5
5
## Compressing data
6
6
7
7
``` javascript
8
- uint16_t uCompression:: RLEcompress ( const uint8_t *uncompressedData , uint8_t *compressedData , uint16_t chunkSize );
8
+ uint16_t uCompression:: RLEcompress ( const uint8_t * uncompressedData ,
9
+ uint8_t * compressedData ,
10
+ uint16_t chunkSize );
9
11
` ` `
10
- or
12
+ or when compressing data already stored in the program memory:
11
13
12
14
` ` ` javascript
13
- uint16_t uCompression:: pgm_RLEcompress ( const uint8_t *uncompressedData , uint8_t *compressedData , uint16_t chunkSize );
15
+ uint16_t uCompression:: pgm_RLEcompress ( const uint8_t * uncompressedData ,
16
+ uint8_t * compressedData ,
17
+ uint16_t chunkSize );
14
18
` ` `
15
- if you need to compress data stored in the program memory (e.g. on AVR systems).
16
-
17
19
18
20
## Uncompressing data
19
21
If the compressed data is stored in RAM, it can be uncompressed by
20
22
21
23
` ` ` javascript
22
- const uint8_t *uCompression: :RLEdecompress ( const uint8_t *compressedData , uint8_t *uncompressedData , uint16_t chunkSize );
24
+ const uint8_t * uCompression: :RLEdecompress ( const uint8_t * compressedData ,
25
+ uint8_t * uncompressedData ,
26
+ uint16_t chunkSize );
23
27
` ` `
24
28
25
29
If the compressed data is stored in the program memory, the data can be decompressed with
26
30
27
31
` ` ` javascript
28
- const uint8_t *uCompression: :pgm_RLEdecompress ( const uint8_t *compressedData , uint8_t *uncompressedData , uint16_t chunkSize );
32
+ const uint8_t * uCompression: :pgm_RLEdecompress ( const uint8_t * compressedData ,
33
+ uint8_t * uncompressedData ,
34
+ uint16_t chunkSize );
29
35
` ` `
30
36
31
37
In the common case that the chunk size doesn't exceed 256 bytes, a slightly smaller and faster version can be used:
32
38
33
39
` ` ` javascript
34
- const uint8_t *uCompression: :pgm_RLEdecompress256 ( const uint8_t *compressedData , uint8_t *uncompressedData , uint8_t chunkSize );
40
+ const uint8_t * uCompression: :pgm_RLEdecompress256 ( const uint8_t * compressedData ,
41
+ uint8_t * uncompressedData ,
42
+ uint8_t chunkSize );
35
43
` ` `
36
44
37
45
0 commit comments