tftframebuffer.h File Reference

#include "ultibo/globaltypes.h"
#include "ultibo/globalconst.h"
#include "ultibo/framebuffer.h"
#include "ultibo/gpio.h"
#include "ultibo/spi.h"

Go to the source code of this file.

Data Structures
struct	_TFT_FRAMEBUFFER

Macros
#define	TFT_FRAMEBUFFER_FRAME_RATE_DEFAULT   20
	Default frame rate of 20 frames per second refresh.

Typedefs
typedef struct _TFT_FRAMEBUFFER	TFT_FRAMEBUFFER
typedef uint32_t STDCALL(*	tft_framebuffer_initialize_proc) (TFT_FRAMEBUFFER *framebuffer, FRAMEBUFFER_PROPERTIES *defaults)
typedef uint32_t STDCALL(*	tft_framebuffer_deinitialize_proc) (TFT_FRAMEBUFFER *framebuffer)
typedef uint32_t STDCALL(*	tft_framebuffer_get_defaults_proc) (TFT_FRAMEBUFFER *framebuffer, FRAMEBUFFER_PROPERTIES *properties, FRAMEBUFFER_PROPERTIES *defaults)
typedef uint32_t STDCALL(*	tft_framebuffer_set_write_address_proc) (TFT_FRAMEBUFFER *framebuffer, uint32_t x1, uint32_t y1, uint32_t x2, uint32_t y2)
typedef uint32_t STDCALL(*	tft_framebuffer_write_memory_proc) (TFT_FRAMEBUFFER *framebuffer, size_t address, uint32_t size)

Functions
uint32_t STDCALL	tft_framebuffer_allocate (FRAMEBUFFER_DEVICE *framebuffer, FRAMEBUFFER_PROPERTIES *properties)
	Implementation of FramebufferDeviceAllocate API for TFT Framebuffer.
uint32_t STDCALL	tft_framebuffer_release (FRAMEBUFFER_DEVICE *framebuffer)
	Implementation of FramebufferDeviceRelease API for TFT Framebuffer.
uint32_t STDCALL	tft_framebuffer_mark (FRAMEBUFFER_DEVICE *framebuffer, uint32_t x, uint32_t y, uint32_t width, uint32_t height, uint32_t flags)
	Implementation of FramebufferDeviceMark API for TFT Framebuffer.
uint32_t STDCALL	tft_framebuffer_commit (FRAMEBUFFER_DEVICE *framebuffer, size_t address, uint32_t size, uint32_t flags)
	Implementation of FramebufferDeviceCommit API for TFT Framebuffer.
void STDCALL	tft_framebuffer_update_display (TFT_FRAMEBUFFER *framebuffer)
	Timer function for display dirty region redraw.

Macro Definition Documentation

TFT_FRAMEBUFFER_FRAME_RATE_DEFAULT

#define TFT_FRAMEBUFFER_FRAME_RATE_DEFAULT   20

Default frame rate of 20 frames per second refresh.

TFTFramebuffer specific constants

Typedef Documentation

TFT_FRAMEBUFFER

typedef struct _TFT_FRAMEBUFFER TFT_FRAMEBUFFER

TFTFramebuffer specific types

tft_framebuffer_initialize_proc

typedef uint32_t STDCALL(* tft_framebuffer_initialize_proc) (TFT_FRAMEBUFFER *framebuffer, FRAMEBUFFER_PROPERTIES *defaults)

TFTFramebuffer Device Methods

tft_framebuffer_deinitialize_proc

typedef uint32_t STDCALL(* tft_framebuffer_deinitialize_proc) (TFT_FRAMEBUFFER *framebuffer)

tft_framebuffer_get_defaults_proc

typedef uint32_t STDCALL(* tft_framebuffer_get_defaults_proc) (TFT_FRAMEBUFFER *framebuffer, FRAMEBUFFER_PROPERTIES *properties, FRAMEBUFFER_PROPERTIES *defaults)

tft_framebuffer_set_write_address_proc

typedef uint32_t STDCALL(* tft_framebuffer_set_write_address_proc) (TFT_FRAMEBUFFER *framebuffer, uint32_t x1, uint32_t y1, uint32_t x2, uint32_t y2)

tft_framebuffer_write_memory_proc

typedef uint32_t STDCALL(* tft_framebuffer_write_memory_proc) (TFT_FRAMEBUFFER *framebuffer, size_t address, uint32_t size)

Function Documentation

tft_framebuffer_allocate()

uint32_t STDCALL tft_framebuffer_allocate	(	FRAMEBUFFER_DEVICE *	framebuffer,
		FRAMEBUFFER_PROPERTIES *	properties )

Implementation of FramebufferDeviceAllocate API for TFT Framebuffer.

TFTFramebuffer Functions

Note

Not intended to be called directly by applications, use FramebufferDeviceAllocate instead

tft_framebuffer_release()

uint32_t STDCALL tft_framebuffer_release

(

FRAMEBUFFER_DEVICE *

framebuffer

)

Implementation of FramebufferDeviceRelease API for TFT Framebuffer.

Note

Not intended to be called directly by applications, use FramebufferDeviceRelease instead

tft_framebuffer_mark()

uint32_t STDCALL tft_framebuffer_mark	(	FRAMEBUFFER_DEVICE *	framebuffer,
		uint32_t	x,
		uint32_t	y,
		uint32_t	width,
		uint32_t	height,
		uint32_t	flags )

Implementation of FramebufferDeviceMark API for TFT Framebuffer.

Note

Not intended to be called directly by applications, use FramebufferDeviceMark instead

Marks full lines only, X and Width are ignored for TFT Framebuffer

tft_framebuffer_commit()

uint32_t STDCALL tft_framebuffer_commit	(	FRAMEBUFFER_DEVICE *	framebuffer,
		size_t	address,
		uint32_t	size,
		uint32_t	flags )

Implementation of FramebufferDeviceCommit API for TFT Framebuffer.

Note

Not intended to be called directly by applications, use FramebufferDeviceCommit instead

tft_framebuffer_update_display()

void STDCALL tft_framebuffer_update_display

(

TFT_FRAMEBUFFER *

framebuffer

)

Timer function for display dirty region redraw.

Note

Not intended to be called directly by applications