display.h: Move get_FrameBuffer() up in the interface file

This commit is contained in:
Federico Amedeo Izzo 2020-10-04 18:30:36 +02:00 committed by Niccolò Izzo
parent f5fbe40b96
commit 810586aa5b
1 changed files with 15 additions and 15 deletions

View File

@ -54,6 +54,21 @@
*/ */
void display_init(); void display_init();
/**
* Get pointer to framebuffer. Being this a standard interface for all the
* low-level display drivers, this function returns a pointer to void: it's up
* to the caller performing the correct cast to one of the standard types used
* for color coding.
* Changes to the framebuffer will not be reflected on the display until
* display_render() or display_renderRows() are called.
*
*
* WARNING: no bound check is performed! Do not call free() on the pointer
* returned, doing so will destroy the framebuffer!
* @return pointer to framebuffer.
*/
void *display_getFrameBuffer();
/** /**
* When called, this function turns off backlight, shuts down backlight control * When called, this function turns off backlight, shuts down backlight control
* and deallocates the framebuffer. * and deallocates the framebuffer.
@ -100,19 +115,4 @@ void display_render();
*/ */
bool display_renderingInProgress(); bool display_renderingInProgress();
/**
* Get pointer to framebuffer. Being this a standard interface for all the
* low-level display drivers, this function returns a pointer to void: it's up
* to the caller performing the correct cast to one of the standard types used
* for color coding.
* Changes to the framebuffer will not be reflected on the display until
* display_render() or display_renderRows() are called.
*
*
* WARNING: no bound check is performed! Do not call free() on the pointer
* returned, doing so will destroy the framebuffer!
* @return pointer to framebuffer.
*/
void *display_getFrameBuffer();
#endif /* DISPLAY_H */ #endif /* DISPLAY_H */