DisplayRet Namespace Reference

Enumerations
enum	Ret_Codes_e : uint8_t {   Success = 0 , Reserved = 1 , FontDataEmpty = 2 , FontDataTooSmall = 3 ,   CharScreenBounds = 4 , CharFontASCIIRange = 5 , CharArrayNullptr = 6 , BitmapDataEmpty = 7 ,   BitmapScreenBounds = 8 , BitmapLargerThanScreen = 9 , BitmapVerticalSize = 10 , BitmapHorizontalSize = 11 ,   BitmapSize = 12 , BufferSize = 13 , BufferEmpty = 14 , I2CbeginFail = 15 ,   I2CNotConnected = 16 , GenericError = 17 , ShapeScreenBounds = 18 }

Detailed Description

namespace for the return code enum

Enumeration Type Documentation

Ret_Codes_e

enum DisplayRet::Ret_Codes_e : uint8_t

Enum to define a standard return code for most functions in all files that return failures

Enumerator
Success	Success, Function ran without defined Error :)
Reserved	Reserved for future use
FontDataEmpty	The Font container is an invalid empty object
FontDataTooSmall	Font is no small must be at least contain 5 bytes
CharScreenBounds	Text Character is out of Screen bounds, Check x and y
CharFontASCIIRange	Text Character is outside of chosen Fonts ASCII range, Check the selected Fonts ASCII range.
CharArrayNullptr	Text Character Array is an invalid pointer object
BitmapDataEmpty	The Bitmap container is an invalid object
BitmapScreenBounds	The Bitmap starting point is outside screen bounds, check x and y
BitmapLargerThanScreen	The Bitmap is larger than screen, check w and h
BitmapVerticalSize	A vertical Bitmap's height must be divisible by 8.
BitmapHorizontalSize	A horizontal Bitmap's width must be divisible by 8
BitmapSize	Size of the Bitmap is incorrect: BitmapSize(vertical)!=(w*(h/8),BitmapSize(horizontal)!=(w/8)*h
BufferSize	Size of the Buffer is incorrect: BufferSize(vertical)!=(w*(h/8)
BufferEmpty	The Buffer data container is an empty object
I2CbeginFail	Failed to open I2C
I2CNotConnected	I2C not connected as per checkConnection() tests
GenericError	Generic Error message
ShapeScreenBounds	Shape out of screen bounds