aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormrfaptastic <12006953+mrfaptastic@users.noreply.github.com>2020-07-30 23:21:08 +0100
committermrfaptastic <12006953+mrfaptastic@users.noreply.github.com>2020-07-30 23:21:08 +0100
commit80d5ddff4c01564ea020b8f6ab00a1a3224f0fe3 (patch)
tree19291fea6eea66be4932c3855d5f78ccf8fd99fb
parent17ded79658192f32065d3e4527cb35255fcc56dd (diff)
Minor wording fixes
-rw-r--r--README.md12
-rw-r--r--SPLIT_MEMORY_MODE.md8
2 files changed, 6 insertions, 14 deletions
diff --git a/README.md b/README.md
index 90e78a9..36706a0 100644
--- a/README.md
+++ b/README.md
@@ -70,17 +70,9 @@ This library has only been tested with a 64 pixel (wide) and 32 (high) RGB panel
### New Feature
-With version 1.1.0 of the library onwards, there is now a 'feature' to split the framebuffer over two memory 'blocks' (mallocs) to work around the fact that typically the ESP32 upon 'boot up' has 2 x ~100kb chunks of memory available to use (ideally we'd want one massive chunk, but for whatever reasons this isn't the case). This allows non-contiguous memory allocations to be joined-up potentially allowing for 512x64 resolution or greater. No guarantees however.
+With version 1.1.0 of the library onwards, there is now a 'feature' to split the framebuffer over two memory 'blocks' (mallocs) to work around the fact that typically the ESP32 upon 'boot up' has 2 x ~100kb chunks of memory available to use (ideally we'd want one massive chunk, but for whatever reasons this isn't the case). This allows non-contiguous memory allocations to be joined-up potentially allowing for 512x64 resolution or greater (no guarantees however). This is enabled by default.
-```
-// At the top of 'ESP32-RGB64x32MatrixPanel-I2S-DMA.h':
-//
-// Experimental: Split the framebuffer into two smaller memory allocations.
-// Can allow a bigger resolution due to the fragmented memory
-// map of the typical Arduino sketch even before setup().
-#define SPLIT_MEMORY_MODE 1
-```
-Refer to [to this](SPLIT_MEMORY_MODE.md) for more details.
+[Refer to this](SPLIT_MEMORY_MODE.md) for more details.
## Ghosting
diff --git a/SPLIT_MEMORY_MODE.md b/SPLIT_MEMORY_MODE.md
index b57a99f..903bdf0 100644
--- a/SPLIT_MEMORY_MODE.md
+++ b/SPLIT_MEMORY_MODE.md
@@ -1,13 +1,13 @@
# SPLIT_MEMORY_MODE
-To enable split framebuffer memory mode, uncomment line:
+Aka. the enabling of the 'feature' (enabled by default) with:
```
-//#define SPLIT_MEMORY_MODE 1
+#define SPLIT_MEMORY_MODE 1
```
-in 'ESP32-RGB64x32MatrixPanel-I2S-DMA.h'
+...in 'ESP32-RGB64x32MatrixPanel-I2S-DMA.h'
## What is it trying to resolve?
-For whatever reason, and this may not be consistent across all ESP32 environments, when `heap_caps_print_heap_info(MALLOC_CAP_DMA)` is executed to print information about the available memory blocks that are DMA capable (which we need for a DMA-enabled pixel framebuffer), you may see something like this:
+For whatever reason (and this may not be consistent across all ESP32 environments) when `heap_caps_print_heap_info(MALLOC_CAP_DMA)` is executed to print information about the available memory blocks that are DMA capable (which we need for a DMA-enabled pixel framebuffer), you may see something like this:
```
Heap summary for capabilities 0x00000008: