Detailed Description

Extention of Display to access GrLib functionality in capable displays.

============================================================================

Driver include

The display header file should be included in an application as follows:

#include <ti/DisplayExt.h>

Operation

This extension depends on an already opened Display interface, and accesses the global Display_config object.

Note: All Display statements will be removed and no display operations will take place if the symbol Display_DISABLE_ALL is defined globally, or before Display.h is included.

Using the extension

First, the regular Display interface must be opened, and after that, APIs in this extension become usable.

#include <ti/display/Display.h>
#include <ti/display/DisplayExt.h>
#include <ti/grlib/grlib.h>
//...
Display_Handle    handle;
Display_Params    params;
Display_Params_init(&params);
Display_open(Display_Type_GRLIB, &params);
//Display_open(Display_ALL, &params);
Graphics_Context *pContext = DisplayExt_getGraphicsContext();
Graphics_Rectangle rect = {
    .sXMin = 10,
    .sXMax = 30,
    .sYMin = 10,
    .sYMax = 20,
};
// It's possible that no compatible Display is available or opened.
if (pContext != NULL)
{
    Graphics_fillRectangle(pContext, &rect);
    Graphics_flushBuffer(pContext);
}

Implementation

This interface expects that all Display implementations that report type Display_Type_GRLIB will also 'inherit' the DisplayGrLib_Object so that the implementation specific instance object can be cast to the type DisplayGrLib_Object.

In practice this means that the Graphics_Context object used to control GrLib by the display implementation must be the first member of the Object structure used by that implementation.

For example, Display_SharpObject can be cast to DisplayGrLib_Object to access the Graphics_Context object, without this interface having prior knowledge about the Sharp display implementation.

Instrumentation

The Display interface produces log statements if instrumentation is enabled.

Diagnostics Mask	Log details
Diags_USER1	basic operations performed
Diags_USER2	detailed operations performed

#include <ti/display/Display.h>
#include <ti/grlib/grlib.h>

Include dependency graph for DisplayExt.h:

Go to the source code of this file.

Data Structures
struct	DisplayGrLib_Object

Macros
#define	DisplayExt_getGraphicsContext(handle) DisplayExt_doGetGraphicsContext(handle)

Typedefs
typedef struct DisplayGrLib_Object	DisplayGrLib_Object

typedef struct DisplayGrLib_Object *	DisplayGrLib_Handle

Functions
Graphics_Context *	DisplayExt_doGetGraphicsContext (Display_Handle handle)
	Get the Graphics_Context object of the first available and open Display that uses GrLib for output. More...

Macro Definition Documentation

§ DisplayExt_getGraphicsContext

#define DisplayExt_getGraphicsContext ( handle ) DisplayExt_doGetGraphicsContext(handle)

Get Graphics_Context of first opened Display that uses GrLib

See also: Display_doGetGrlibContext()

Typedef Documentation

§ DisplayGrLib_Object

typedef struct DisplayGrLib_Object DisplayGrLib_Object

§ DisplayGrLib_Handle

typedef struct DisplayGrLib_Object * DisplayGrLib_Handle

Function Documentation

§ DisplayExt_doGetGraphicsContext()

Graphics_Context* DisplayExt_doGetGraphicsContext ( Display_Handle handle )

Get the Graphics_Context object of the first available and open Display that uses GrLib for output.

Useful for drawing graphics if you know that the display is GrLib capable.

Note: Calling GrLib functions directly is not thread-safe, and can conflict with Display calls or other GrLib calls.

Returns: Graphics_Context pointer or NULL if no open display is found.