SptDimBuffer() | TFT & EPD Graphic Library 2

Syntax

SptDimBuffer(bBuffer As Byte, wPixels As Word), Byte

Overview

Dimension a sprite buffer. Before a sprite buffer can be used, its size must be defined in terms of pixels.
This operation performs a linear allocation, partitioning the dedicated global graphic RAM space.

Parameters

Parameter	Description
bBuffer	Index of the buffer to be dimensioned
wPixels	Buffer size in pixels

Return value

Value	Meaning
0	Operation successful
1	Invalid buffer index
2	Buffer exceeds the allowed RAM space
3	Buffer size is 1 pixel (invalid)
4	No change in buffer size (new size equals current size)

Important

When downsizing a sprite buffer, all subsequent buffers are shifted down accordingly, preserving their data. The current buffer will have its width and height set to zero, rendering it invalid for direct rendering until valid dimension metadata is reassigned.
When upsizing a sprite buffer, all subsequent buffers are shifted up accordingly. If any buffer exceeds the total allocated GRAM, it is rendered invalid by setting its width and height metadata to zero. The current buffer’s data and metadata are preserved, provided it does not exceed the total allocated GRAM.

Created with the Personal Edition of HelpNDoc: Create iPhone web-based documentation