oc_lcdtft.h File Reference

The file with interface for LCDTFT driver. More...

#include <oc_driver.h>
#include <oc_stdlib.h>
#include <oc_ioctl.h>
#include <oc_lcdtft_lld.h>
#include <oc_stdtypes.h>
#include <oc_color.h>
#include <oc_font.h>
#include <oc_pixel.h>
#include <oc_frequency.h>

Go to the source code of this file.

Data Structures
struct	oC_LCDTFT_Config_t
	LCDTFT driver configuration structure. More...

Typedefs
typedef struct Context_t *	oC_LCDTFT_Context_t
	The LCDTFT context structure. More...

Functions
oC_ErrorCode_t	oC_LCDTFT_TurnOn (void)
	turns on the module More...
oC_ErrorCode_t	oC_LCDTFT_TurnOff (void)
	Turns off the LCDTFT driver. More...
bool	oC_LCDTFT_IsTurnedOn (void)
	checks if the driver is turned on More...
oC_ErrorCode_t	oC_LCDTFT_Configure (const oC_LCDTFT_Config_t *Config, oC_LCDTFT_Context_t *outContext)
	configures LCDTFT pins to work More...
oC_ErrorCode_t	oC_LCDTFT_Unconfigure (const oC_LCDTFT_Config_t *Config, oC_LCDTFT_Context_t *outContext)
	Unconfigures the driver. More...
oC_ErrorCode_t	oC_LCDTFT_Ioctl (oC_LCDTFT_Context_t Context, oC_Ioctl_Command_t Command, void *Data)
	handles input/output driver commands More...

Detailed Description

---

File based on driver.h Ver 1.1.0

Author

Patryk Kubiak - (Created on: 2016-02-06 - 11:43:03)

Copyright

Copyright (C) 2016 Patryk Kubiak patry.nosp@m.k.ku.nosp@m.biak9.nosp@m.0@gm.nosp@m.ail.c.nosp@m.om

        This program is free software; you can redistribute it and/or modify
        it under the terms of the GNU General Public License as published by
        the Free Software Foundation; either version 2 of the License, or
        (at your option) any later version.

        This program is distributed in the hope that it will be useful,
        but WITHOUT ANY WARRANTY; without even the implied warranty of
        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
        GNU General Public License for more details.

        You should have received a copy of the GNU General Public License
        along with this program; if not, write to the Free Software
        Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

Definition in file oc_lcdtft.h.

Typedef Documentation

typedef struct Context_t* oC_LCDTFT_Context_t

This is the structure with dynamic allocated data for the LCDTFT. It stores a HANDLE for a driver and it can be used to identify the driver context. You should get this pointer from the oC_LCDTFT_Configure function, but note, that not all drivers use it. In many cases it is just not needed, and it just will store NULL then. You should keep this pointer as long as it is necessary for you, and when it will not be anymore, you should call oC_LCDTFT_Unconfigure function to destroy it.

Definition at line 118 of file oc_lcdtft.h.