fleg
/
Arduboy2
mirror of https://github.com/MLXXXp/Arduboy2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Make display buffer array public

This commit is contained in:
Scott Allen 2016-12-23 09:27:45 -05:00
parent 388f8abb9f
commit 4607f087a2
1 changed files with 22 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
src/Arduboy2.h
View File

@ -153,7 +153,6 @@ struct Point
class Arduboy2Base : public Arduboy2Core class Arduboy2Base : public Arduboy2Core
{ {
friend class Arduboy2Ex; friend class Arduboy2Ex;
friend class Sprites;
public: public:
Arduboy2Base(); Arduboy2Base();
@ -519,12 +518,19 @@ class Arduboy2Base : public Arduboy2Core
/** \brief /** \brief
* Get a pointer to the display buffer in RAM. * Get a pointer to the display buffer in RAM.
* *
* \return A pointer to the display buffer array in RAM * \return A pointer to the display buffer array in RAM.
* *
* \details * \details
* The location of the display buffer in RAM, which is displayed using * The location of the display buffer in RAM, which is displayed using
* `display()`, can be gotten using this function. The buffer can then be * `display()`, can be gotten using this function. The buffer can then be
* read and directly manipulated. * read and directly manipulated.
*
* \note
* The display buffer array, `sBuffer`, is public. A sketch can access it
* directly. Doing so may be more efficient than accessing it via the
* pointer returned by `getBuffer()`.
*
* \see sBuffer
*/ */
uint8_t* getBuffer(); uint8_t* getBuffer();
@ -766,7 +772,7 @@ class Arduboy2Base : public Arduboy2Core
bool justReleased(uint8_t button); bool justReleased(uint8_t button);
/** \brief /** \brief
* Test if a point falls within a rectangle * Test if a point falls within a rectangle.
* *
* \param point A structure describing the location of the point. * \param point A structure describing the location of the point.
* \param rect A structure describing the location and size of the rectangle. * \param rect A structure describing the location and size of the rectangle.
@ -796,13 +802,23 @@ class Arduboy2Base : public Arduboy2Core
*/ */
bool collide(Rect rect1, Rect rect2); bool collide(Rect rect1, Rect rect2);
/** \brief
* The display buffer array in RAM.
*
* The display buffer (also known as the screen buffer) contains an
* image bitmap of the desired contents of the display, which is written
* to the display using the `display()` function. The drawing functions of
* this library manipulate the contents of the display buffer. A sketch can
* also access the display buffer directly.
*
* \see getBuffer()
*/
static uint8_t sBuffer[(HEIGHT*WIDTH)/8];
protected: protected:
// helper function for sound enable/disable system control // helper function for sound enable/disable system control
void sysCtrlSound(uint8_t buttons, uint8_t led, uint8_t eeVal); void sysCtrlSound(uint8_t buttons, uint8_t led, uint8_t eeVal);
// Screen buffer
static uint8_t sBuffer[(HEIGHT*WIDTH)/8];
// For button handling // For button handling
uint8_t currentButtonState; uint8_t currentButtonState;
uint8_t previousButtonState; uint8_t previousButtonState;