d7/da1/oc__screen_8h_source.html

 #ifndef SYSTEM_CORE_INC_GUI_OC_SCREEN_H_
 #define SYSTEM_CORE_INC_GUI_OC_SCREEN_H_

 #include <oc_errors.h>
 #include <oc_driverman.h>
 #include <oc_colormap.h>

 #define _________________________________________TYPES______________________________________________________________________________________

 //==========================================================================================================================================
 //==========================================================================================================================================
 typedef struct Screen_t * oC_Screen_t;

 #undef  _________________________________________TYPES______________________________________________________________________________________

 #define _________________________________________FUNCTION_SECTION___________________________________________________________________________

 extern oC_Screen_t          oC_Screen_New           ( oC_Driver_t Driver , const void * Config , const char * Name );
 extern bool                 oC_Screen_IsCorrect    ( oC_Screen_t Screen );
 extern bool                 oC_Screen_Delete        ( oC_Screen_t * Screen );
 extern bool                 oC_Screen_IsConfigured  ( oC_Screen_t Screen );
 extern oC_ErrorCode_t       oC_Screen_Configure     ( oC_Screen_t Screen );
 extern oC_ErrorCode_t       oC_Screen_Unconfigure   ( oC_Screen_t Screen );
 extern oC_ErrorCode_t       oC_Screen_ReadColorMap  ( oC_Screen_t Screen , oC_ColorMap_t ** outColorMap );
 extern oC_ErrorCode_t       oC_Screen_ReadResolution( oC_Screen_t Screen , oC_Pixel_ResolutionUInt_t * outWidth , oC_Pixel_ResolutionUInt_t * outHeight );
 extern const char *         oC_Screen_GetName       ( oC_Screen_t Screen );
 extern oC_Driver_t          oC_Screen_GetDriver     ( oC_Screen_t Screen );

 #undef  _________________________________________FUNCTION_SECTION___________________________________________________________________________


 #endif /* SYSTEM_CORE_INC_GUI_OC_SCREEN_H_ */
oc_colormap.h
FILE_DESCRIPTION

oC_Screen_GetName
const char * oC_Screen_GetName(oC_Screen_t Screen)
returns name of the screen
Definition: oc_screen.c:386

Screen_t::Name
char Name[30]
Name of the screen - useful for screen identification.
Definition: oc_screen.c:47

oC_Screen_New
oC_Screen_t oC_Screen_New(oC_Driver_t Driver, const void *Config, const char *Name)
creates new screen object
Definition: oc_screen.c:101

oC_Screen_Delete
bool oC_Screen_Delete(oC_Screen_t *Screen)
Destroys the Screen object.
Definition: oc_screen.c:185

oC_Screen_t
struct Screen_t * oC_Screen_t
Screen object pointer.
Definition: oc_screen.h:88

oC_Screen_ReadResolution
oC_ErrorCode_t oC_Screen_ReadResolution(oC_Screen_t Screen, oC_Pixel_ResolutionUInt_t *outWidth, oC_Pixel_ResolutionUInt_t *outHeight)
reads resolution of the screen
Definition: oc_screen.c:356

Screen_t
stores screen object data
Definition: oc_screen.c:43

Screen_t::Driver
oC_Driver_t Driver
Pointer to the graphic driver that handles the screen.
Definition: oc_screen.c:46

oC_Screen_IsConfigured
bool oC_Screen_IsConfigured(oC_Screen_t Screen)
checks if the screen is configured to work
Definition: oc_screen.c:234

oC_Screen_Configure
oC_ErrorCode_t oC_Screen_Configure(oC_Screen_t Screen)
configures graphics driver to work
Definition: oc_screen.c:257

oC_Screen_GetDriver
oC_Driver_t oC_Screen_GetDriver(oC_Screen_t Screen)
returns driver associated with the screen
Definition: oc_screen.c:415

oc_driverman.h
The file with drivers manager interface.

oC_ColorMap_t
Definition: oc_colormap.h:57

oC_Screen_IsCorrect
bool oC_Screen_IsCorrect(oC_Screen_t Screen)
checks if the Screen object is correct
Definition: oc_screen.c:160

oC_Screen_ReadColorMap
oC_ErrorCode_t oC_Screen_ReadColorMap(oC_Screen_t Screen, oC_ColorMap_t **outColorMap)
reads pointer to the color map
Definition: oc_screen.c:324

Screen_t::Config
void * Config
Pointer to the screen configuration.
Definition: oc_screen.c:48

oC_Screen_Unconfigure
oC_ErrorCode_t oC_Screen_Unconfigure(oC_Screen_t Screen)
unconfigures graphics driver
Definition: oc_screen.c:292