yocto_display.h File Reference

#include "yocto_api.h"
#include <cfloat>
#include <cmath>
#include <map>

Include dependency graph for yocto_display.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	YDisplay
class	YDisplayLayer

Macros
#define	_Y_ALIGN
#define	_Y_DISPLAYTYPE_ENUM
#define	_Y_ENABLED_ENUM
#define	_Y_ORIENTATION_ENUM
#define	Y_BRIGHTNESS_INVALID   (YAPI_INVALID_UINT)
#define	Y_COMMAND_INVALID   (YAPI_INVALID_STRING)
#define	Y_DISPLAYHEIGHT_INVALID   (YAPI_INVALID_UINT)
#define	Y_DISPLAYWIDTH_INVALID   (YAPI_INVALID_UINT)
#define	Y_LAYERCOUNT_INVALID   (YAPI_INVALID_UINT)
#define	Y_LAYERHEIGHT_INVALID   (YAPI_INVALID_UINT)
#define	Y_LAYERWIDTH_INVALID   (YAPI_INVALID_UINT)
#define	Y_STARTUPSEQ_INVALID   (YAPI_INVALID_STRING)

Typedefs
typedef void(*	YDisplayValueCallback) (YDisplay *func, const string &functionValue)

Enumerations
enum	Y_ALIGN {   Y_ALIGN_TOP_LEFT = 0, Y_ALIGN_CENTER_LEFT = 1, Y_ALIGN_BASELINE_LEFT = 2, Y_ALIGN_BOTTOM_LEFT = 3,   Y_ALIGN_TOP_CENTER = 4, Y_ALIGN_CENTER = 5, Y_ALIGN_BASELINE_CENTER = 6, Y_ALIGN_BOTTOM_CENTER = 7,   Y_ALIGN_TOP_DECIMAL = 8, Y_ALIGN_CENTER_DECIMAL = 9, Y_ALIGN_BASELINE_DECIMAL = 10, Y_ALIGN_BOTTOM_DECIMAL = 11,   Y_ALIGN_TOP_RIGHT = 12, Y_ALIGN_CENTER_RIGHT = 13, Y_ALIGN_BASELINE_RIGHT = 14, Y_ALIGN_BOTTOM_RIGHT = 15 }
enum	Y_DISPLAYTYPE_enum { Y_DISPLAYTYPE_MONO = 0, Y_DISPLAYTYPE_GRAY = 1, Y_DISPLAYTYPE_RGB = 2, Y_DISPLAYTYPE_INVALID = -1 }
enum	Y_ENABLED_enum {   Y_ENABLED_FALSE = 0, Y_ENABLED_TRUE = 1, Y_ENABLED_INVALID = -1, Y_ENABLED_FALSE = 0,   Y_ENABLED_TRUE = 1, Y_ENABLED_INVALID = -1, Y_ENABLED_FALSE = 0, Y_ENABLED_TRUE = 1,   Y_ENABLED_INVALID = -1, Y_ENABLED_FALSE = 0, Y_ENABLED_TRUE = 1, Y_ENABLED_INVALID = -1,   Y_ENABLED_FALSE = 0, Y_ENABLED_TRUE = 1, Y_ENABLED_INVALID = -1, Y_ENABLED_FALSE = 0,   Y_ENABLED_TRUE = 1, Y_ENABLED_INVALID = -1 }
enum	Y_ORIENTATION_enum {   Y_ORIENTATION_LEFT = 0, Y_ORIENTATION_UP = 1, Y_ORIENTATION_RIGHT = 2, Y_ORIENTATION_DOWN = 3,   Y_ORIENTATION_INVALID = -1 }

Functions
YDisplay *	yFindDisplay (const string &func)
YDisplay *	yFirstDisplay (void)

Macro Definition Documentation

#define _Y_ALIGN

Definition at line 93 of file yocto_display.h.

#define _Y_DISPLAYTYPE_ENUM

Definition at line 73 of file yocto_display.h.

#define _Y_ENABLED_ENUM

Definition at line 55 of file yocto_display.h.

#define _Y_ORIENTATION_ENUM

Definition at line 63 of file yocto_display.h.

#define Y_BRIGHTNESS_INVALID   (YAPI_INVALID_UINT)

Definition at line 82 of file yocto_display.h.

#define Y_COMMAND_INVALID   (YAPI_INVALID_STRING)

Definition at line 88 of file yocto_display.h.

#define Y_DISPLAYHEIGHT_INVALID   (YAPI_INVALID_UINT)

Definition at line 84 of file yocto_display.h.

#define Y_DISPLAYWIDTH_INVALID   (YAPI_INVALID_UINT)

Definition at line 83 of file yocto_display.h.

#define Y_LAYERCOUNT_INVALID   (YAPI_INVALID_UINT)

Definition at line 87 of file yocto_display.h.

#define Y_LAYERHEIGHT_INVALID   (YAPI_INVALID_UINT)

Definition at line 86 of file yocto_display.h.

#define Y_LAYERWIDTH_INVALID   (YAPI_INVALID_UINT)

Definition at line 85 of file yocto_display.h.

#define Y_STARTUPSEQ_INVALID   (YAPI_INVALID_STRING)

Definition at line 81 of file yocto_display.h.

Typedef Documentation

typedef void(* YDisplayValueCallback) (YDisplay *func, const string &functionValue)

Definition at line 53 of file yocto_display.h.

Enumeration Type Documentation

enum Y_ALIGN

Enumerator
Y_ALIGN_TOP_LEFT
Y_ALIGN_CENTER_LEFT
Y_ALIGN_BASELINE_LEFT
Y_ALIGN_BOTTOM_LEFT
Y_ALIGN_TOP_CENTER
Y_ALIGN_CENTER
Y_ALIGN_BASELINE_CENTER
Y_ALIGN_BOTTOM_CENTER
Y_ALIGN_TOP_DECIMAL
Y_ALIGN_CENTER_DECIMAL
Y_ALIGN_BASELINE_DECIMAL
Y_ALIGN_BOTTOM_DECIMAL
Y_ALIGN_TOP_RIGHT
Y_ALIGN_CENTER_RIGHT
Y_ALIGN_BASELINE_RIGHT
Y_ALIGN_BOTTOM_RIGHT

Definition at line 94 of file yocto_display.h.

enum Y_DISPLAYTYPE_enum

Enumerator
Y_DISPLAYTYPE_MONO
Y_DISPLAYTYPE_GRAY
Y_DISPLAYTYPE_RGB
Y_DISPLAYTYPE_INVALID

Definition at line 74 of file yocto_display.h.

enum Y_ENABLED_enum

Enumerator
Y_ENABLED_FALSE
Y_ENABLED_TRUE
Y_ENABLED_INVALID
Y_ENABLED_FALSE
Y_ENABLED_TRUE
Y_ENABLED_INVALID
Y_ENABLED_FALSE
Y_ENABLED_TRUE
Y_ENABLED_INVALID
Y_ENABLED_FALSE
Y_ENABLED_TRUE
Y_ENABLED_INVALID
Y_ENABLED_FALSE
Y_ENABLED_TRUE
Y_ENABLED_INVALID
Y_ENABLED_FALSE
Y_ENABLED_TRUE
Y_ENABLED_INVALID

Definition at line 56 of file yocto_display.h.

enum Y_ORIENTATION_enum

Enumerator
Y_ORIENTATION_LEFT
Y_ORIENTATION_UP
Y_ORIENTATION_RIGHT
Y_ORIENTATION_DOWN
Y_ORIENTATION_INVALID

Definition at line 64 of file yocto_display.h.

Function Documentation

YDisplay* yFindDisplay ( const string &  func )

inline

Retrieves a display for a given identifier. The identifier can be specified using several formats:

• FunctionLogicalName
• ModuleSerialNumber.FunctionIdentifier
• ModuleSerialNumber.FunctionLogicalName
• ModuleLogicalName.FunctionIdentifier
• ModuleLogicalName.FunctionLogicalName

This function does not require that the display is online at the time it is invoked. The returned object is nevertheless valid. Use the method YDisplay.isOnline() to test if the display is indeed online at a given time. In case of ambiguity when looking for a display by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.

If a call to this object's is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.

Parameters

func	: a string that uniquely characterizes the display

Returns

a YDisplay object allowing you to drive the display.

Definition at line 1101 of file yocto_display.h.

YDisplay* yFirstDisplay ( void  )

inline

Starts the enumeration of displays currently accessible. Use the method YDisplay.nextDisplay() to iterate on next displays.

Returns

a pointer to a YDisplay object, corresponding to the first display currently online, or a NULL pointer if there are none.

Definition at line 1112 of file yocto_display.h.