Library	Applet	Graphics	Pixmap	Font
LcdDeInitialize	LcdAppletActive	LcdClear	LcdCreatePixmap	LcdDeleteFont
LcdInitialize	LcdAppletEnabled	LcdDrawLine	LcdDeletePixmap	LcdDrawText
LcdLastError	LcdAppletOpened	LcdDrawOval	LcdDrawPixmap	LcdLoadFont
	LcdButtonState	LcdDrawRect	LcdDrawPixmapRect	LcdSetFont
	LcdConfigState	LcdEnableAntiAlias	LcdLoadAnimPixmap	LcdStringHeight
	LcdCreateApplet	LcdSetColor	LcdLoadPixmap	LcdStringWidth
	LcdDeleteApplet	LcdSetLineWidth	LcdPixmapHeight
	LcdSelectDevice	LcdSetRotation	LcdPixmapWidth
	LcdSetEventHandler	LcdSetTarget
	LcdSetPriority
	LcdUpdate
	LcdWaitActivation

Library functions

int LcdDeInitialize()
Description	Deinitializes the library.
Information	Calling this function while applets, pixmaps or fonts are still in use may result in undefined behaviour. You should therefore delete all objects using LcdDeleteApplet, LcdDeletePixmap and LcdDeleteFont.

int LcdInitialize()
Description	Initializes the library.
Information	You need to call this function before creating an applet, pixmap or font. If this function does not succeed you should assume that the Logitech software is not installed and therefore disable all LCD-related functionality.
Returns	LCD_OK if initialization was successful, otherwise LCD_ERROR.

int LcdLastError()
Description	Returns the error code after a function failed and returned NULL.
Information	The return value can be one of the following constants. LCD_OK LCD_ERROR LCD_ERROR_NOT_INITIALIZED LCD_ERROR_INVALID_PARAMETER LCD_ERROR_NOT_FOUND

Applet functions

int LcdAppletActive(LCDAPPLET pApplet)
Description	Checks if an applet is active.
Information	You should suspend rendering until the applet is active. You can also use LcdWaitActivation to block the calling thread until the applet gets activated. [This function is device-specific.]
Returns	true if the applet is both enabled and opened, otherwise false or LCD_DEVICE_INVALID if the LCD Manager is no longer avaliable.

int LcdAppletEnabled(LCDAPPLET pApplet)
Description	Checks if an applet is currently enabled.
Returns	true if the applet is enabled in the LCD Manager, otherwise false.

int LcdAppletOpened(LCDAPPLET pApplet)
Description	Checks if an applet is opened on the currently selected device.
Information	Use LcdSelectDevice to specify the current device. [This function is device-specific.]
Returns	true if the applet is opened on the device, otherwise false.

int LcdButtonState(LCDAPPLET pApplet, int nButton)
Description	Determines the button status.
Information	You can also use LcdSetEventHandler for asynchronous event handling. [This function is device-specific.]
Returns	true if nButton is currently pressed, otherwise false.

int LcdConfigState(LCDAPPLET pApplet)
Description	Determines the configuration status.
Information	You can also use LcdSetEventHandler for asynchronous event handling.
Returns	true if the user pressed the 'Configure...' button in the LCD Manager since the last call of this method, otherwise false.

LCDAPPLET LcdCreateApplet(const wchar_t *pName, int nDevices, int bConfigurable, bAutostart)
Description	Creates a new applet.
Information	Parameter nDevices specifies the device types and can be a combination of the following values. Device type Description LCD_DEVICE_MONO Support for monochrome displays (G13, G15 and Z-10) LCD_DEVICE_COLOR Support for color displays (G19) If the applet supports both device types, all information (e.g. current color, font, render target, etc.) is stored separately for each device. Use the LcdSelectDevice function to select the target device for all subsequent device-specific operations.Functions that affect only the current device are marked as [device-specific] in this documentation. If bConfigurable is true, the 'Configure...' button in the LCD Manager will be enabled and the applet will receive an LCD_EVENT_CONFIGURE event through its event handler when the user clicks on in. If bAutostart is true, the applet can automatically be launched by the LCD Manager, otherwise the user has to start it manually. You should delete the applet with LcdDeleteApplet if it is no longer needed and before you call LcdDeInitialize. Also implemented as ANSI version.

int LcdDeleteApplet(LCDAPPLET pApplet)
Description	Deletes the applet.
Information	You should delete all applets before you call LcdDeInitialize.

int LcdSelectDevice(LCDAPPLET pApplet, int nDevice)
Description	Determines the target of subsequent, device-specific operations.
Information	You only need to call this function if the applet supports both monochrome and color devices. If only one device type is supported the device will be selected automatically.

int LcdSetEventHandler(LCDAPPLET pApplet, LCDEVENTHANDLER pEventHandler, void *pContext)
Description	Sets the event handler for configuration and button events.
Information	The event type is indicated by the nEvent parameter which can be one of the following values. Event type Description LCD_EVENT_CONFIGURE The user pressed the 'Configure...' button in the LCD Manager. LCD_EVENT_BUTTON The user pressed or released a soft button. Parameter nData contains a bitmask of buttons. Note that the event handler is executed in the context of the LCD Manager and is therefore running in a different thread. You need to ensure thread safety if the event handler shares resources with threads in your application.

int LcdSetPriority(LCDAPPLET pApplet, int nPriority, int bForeground)
Description	Sets an applets' priority and foreground status.
Information	Parameter nPriority can be one of the following values. LCD_PRIORITY_LOW LCD_PRIORITY_NORMAL LCD_PRIORITY_HIGH Specify true for bForeground to stop the LCD Manager from automatically switching between all running applets or false to continue with automatic switching. Note that an applet can easily lose its foreground status when the user manually switches between different applets or returns to the applet menu.

int LcdUpdate(LCDAPPLET pApplet, int bSync)
Description	Shows the content of the back-buffer render target on the LCD.
Information	Note that the applet only becomes visible after the first call to this function. That way you can do applet-specific initializations without the applet being displayed on the device. If bSync is true this method will return immediately after sending the buffer data to the LCD Manager, otherwise it will wait until the data is actually displayed which takes about 30 milliseconds or more. [This function is device-specific.]

int LcdWaitActivation(LCDAPPLET pApplet)
Description	Waits until an applet gets activated.
Information	If the return value is LCD_DEVICE_INVALID the connection to the LCD Manager is lost and cannot be restored. In this case, the applet should stop all of its LCD-related functionality or exit.
Returns	The devices that are currently active or LCD_DEVICE_INVALID if the LCD Manager is no longer avaliable.

Graphics functions

int LcdClear(LCDAPPLET pApplet, int nColor)
Description	Deletes the content of the current render target.
Information	Parameter nColor specifies the color in RGB format. Note that any alpha component of the color will be ignored. [This function is device-specific.]

int LcdDrawLine(LCDAPPLET pApplet, int nX1, int nY1, int nX2, int nY2)
Description	Draws a line.
Information	[This function is device-specific.]

int LcdDrawOval(LCDAPPLET pApplet, int nX, int nY, int nWidth, int nHeight, int bFill)
Description	Draws an oval.
Information	Set bFill to false in order to draw only the outline of the oval. [This function is device-specific.]

int LcdDrawRect(LCDAPPLET pApplet, int nX, int nY, int nWidth, int nHeight, int bFill)
Description	Draws a rectangle.
Information	Set bFill to false in order to draw only the outline of the rectangle. [This function is device-specific.]

int LcdEnableAntiAlias(LCDAPPLET pApplet, int bEnable)
Description	Enables or disables anti-aliasing.
Information	Note that anti-aliasing is only avaliable for color devices. [This function is device-specific.]

int LcdSetColor(int nColor)
Description	Sets the current drawing color.
Information	Parameter nColor specifies the color in RGB format. Note that any alpha component of the color will be ignored. You can also use the following color constants for monochrome displays. Constant Description LCD_COLOR_VISIBLE Makes pixels visible (similar to white on color displays). LCD_COLOR_INVISIBLE Makes pixels invisible (similar to black on color displays). The default color is white or LCD_COLOR_VISIBLE. [This function is device-specific.]

int LcdSetLineWidth(LCDAPPLET pApplet, float fWidth)
Description	Sets the current line width.
Information	The line width affects the LcdDrawLine function as well as LcdDrawRect and LcdDrawOval if the bFill parameter is false. [This function is device-specific.]

int LcdSetRotation(LCDAPPLET pApplet, float fRotation, int nCenterX, int nCenterY)
Description	Sets the current rotation.
Information	You can also specify the center of the rotation using nX and nY. This function affects all subsequent calls to LcdDrawLine, LcdDrawRect and LcdDrawOval. Note that pixmaps and text cannot be rotated. [This function is device-specific.]

int LcdSetTarget(LCDAPPLET pApplet, LCDPIXMAP pPixmap)
Description	Sets the current render target.
Information	Parameter pPixmap specifies the pixmap that will be used as render target. Note that only pixmaps created by LcdCreatePixmap are suitable render targets. Drawing to pixmaps that are loaded from image files is not supported. Specify NULL for pPixmap to reset the render target. [This function is device-specific.]

Pixmap functions

LCDPIXMAP LcdCreatePixmap(int nWidth, int nHeight, int nDevice)
Description	Creates a new render target pixmap.
Information	Parameter nDevice indicates the device type of the pixmap. You should use the pixmap only with the device type that it was created for. See LcdCreateApplet for valid device types. You should delete the pixmap with LcdDeletePixmap if it is no longer needed and before you call LcdDeInitialize.

int LcdDeletePixmap(LCDPIXMAP pPixmap)
Description	Deletes a pixmap.
Information	You should delete all pixmaps before you call LcdDeInitialize.

int LcdDrawPixmap(LCDAPPLET pApplet, LCDPIXMAP pPixmap, int nX, int nY, int nFrame)
Description	Draws a pixmap.
Information	Parameter nFrame specifies the frame number if the pixmap was created with the LcdLoadAnimPixmap function. [This function is device-specific.]

int LcdDrawPixmapRect(LCDAPPLET pApplet, LCDPIXMAP pPixmap, int nX, int nY, int nSx, int nSy, int nWidth, int nHeight, int nFrame)
Description	Draws a rectangular area of a pixmap.
Information	Parameters nSx, nSy, nWidth and nHeight specify the source rectangle of pPixmap to be drawn. [This function is device-specific.]

LCDPIXMAP LcdLoadAnimPixmap(const wchar_t *pFile, int nFrameWidth, int nFrameHeight, int nFrames)
Description	Loads an animated pixmap from an image file.
Information	Supported file formats are PNG, JPEG, BMP, TIFF, GIF.Parameters nFrameWidth and nFrameHeight indicate the size of a single frame in the pixmap. The pixmap has to be nFrameWidth * nFrame pixels wide and nFrameHeight pixels high, because the size of all frames has to be equal. You should delete the pixmap with #LcdDeletePixmap if it is no longer needed and before you call LcdDeInitialize. Also implemented as ANSI version.

LCDPIXMAP LcdLoadPixmap(const wchar_t *pFile)
Description	Loads a pixmap from an image file.
Information	Supported file formats are PNG, JPEG, BMP, TIFF and GIF. You should delete the pixmap with LcdDeletePixmap if it is no longer needed and before you call LcdDeInitialize.

int LcdPixmapWidth(LCDPIXMAP pPixmap)
Description	Returns the width of a pixmap.

int LcdPixmapHeight(LCDPIXMAP pPixmap)
Description	Returns the height of a pixmap.

Font functions

int LcdDeleteFont(LCDFONT pFont)
Description	Deletes a font.
Information	You should delete all fonts before you call LcdDeInitialize.

int LcdDrawText(LCDAPPLET pApplet, const wchar_t *pString, int nX, int nY)
Description	Draws a text string.
Information	[This function is device-specific.] Also implemented as ANSI version.

LCDFONT LcdLoadFont(const wchar_t *pFamily, int nHeight, int nFlags, const wchar_t *pFile)
Description	Loads a font from the system or a font file.
Information	The font is loaded from the system by default. If you want to load it from a TTF or OTF file, specify the relative path and filename for parameter pFile. Parameter nFlags can be LCD_FONT_DEFAULT or a combination of the following values. LCD_FONT_BOLD LCD_FONT_ITALIC LCD_FONT_UNDERLINE You should delete the font with LcdDeleteFont if it is no longer needed and before you call LcdDeInitialize. Also implemented as ANSI version.

int LcdSetFont(LCDAPPLET pApplet, LCDFONT pFont)
Description	Sets the current font.
Information	This function affects all subsequent calls to LcdDrawText. [This function is device-specific.]

int LcdStringHeight(LCDAPPLET pApplet, const wchar_t *pString)
Description	Calculates the height of a string.
Information	This function uses the currently selected font to measure the string's height. [This function is device-specific.] Also implemented as ANSI version.

int LcdStringWidth(LCDAPPLET pApplet, const wchar_t *pString)
Description	Calculates the width of a string.
Information	This function uses the currently selected font to measure the string's width. [This function is device-specific.] Also implemented as ANSI version.

Copyright © Christian Klaussner