MiniGUI API Reference (MiniGUI-Threads)  v3.2.0
A mature and proven cross-platform GUI system for embedded and smart IoT devices
Data Structures | Typedefs | Functions | Variables
xvfb.h File Reference

This file includes global and miscellaneous interfaces of xVFB for MiniGUI. More...

Go to the source code of this file.

Data Structures

struct  _XVFBHeader
 
struct  _XVFBKEYDATA
 
struct  _XVFBMOUSEDATA
 
struct  _XVFBEVENT
 
struct  _XVFBPalEntry
 

Typedefs

typedef struct _XVFBHeader XVFBHeader
 
typedef struct _XVFBKEYDATA XVFBKEYDATA
 
typedef struct _XVFBMOUSEDATA XVFBMOUSEDATA
 
typedef struct _XVFBEVENT XVFBEVENT
 
typedef struct _XVFBPalEntry XVFBPalEntry
 

Functions

MG_EXPORT XVFBHeader *GUIAPI xVFBAllocVirtualFrameBuffer (int width, int height, int depth, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask, BOOL MSBLeft)
 create virtual framebuffer More...
 
MG_EXPORT void GUIAPI xVFBFreeVirtualFrameBuffer (XVFBHeader *buf)
 free virtual framebuffer. More...
 
MG_EXPORT void *GUIAPI xVFBCreateEventBuffer (int nr_events)
 create event circular buffer. More...
 
MG_EXPORT void GUIAPI xVFBDestroyEventBuffer (void *event_buf)
 destroy event circular buffer. More...
 
MG_EXPORT int GUIAPI xVFBNotifyNewEvent (const void *xvfb_event_buffer, XVFBEVENT *event)
 put a event to event circular buffer More...
 

Variables

MG_EXPORT void * __mg_rtos_xvfb_event_buffer
 shared memory header of x virtual framebuffer. More...
 

Detailed Description

This file includes global and miscellaneous interfaces of xVFB for MiniGUI.

Author
FMSoft
Date
2007/10/25
   This file is part of MiniGUI, a mature cross-platform windowing 
   and Graphics User Interface (GUI) support system for embedded systems
   and smart IoT devices.

   Copyright (C) 2007~2018, Beijing FMSoft Technologies Co., Ltd.

   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 3 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, see <http://www.gnu.org/licenses/>.

   Or,

   As this program is a library, any link to this program must follow
   GNU General Public License version 3 (GPLv3). If you cannot accept
   GPLv3, you need to be licensed from FMSoft.

   If you have got a commercial license of this program, please use it
   under the terms and conditions of the commercial license.

   For more information about the commercial license, please refer to
   <http://www.minigui.com/en/about/licensing-policy/>.

Definition in file xvfb.h.

Function Documentation

XVFBHeader * xVFBAllocVirtualFrameBuffer ( int  width,
int  height,
int  depth,
Uint32  Rmask,
Uint32  Gmask,
Uint32  Bmask,
Uint32  Amask,
BOOL  MSBLeft 
)

create virtual framebuffer

Parameters
widththe width of virtual framebuffer
heightthe height of virtual framebuffer
depththe color depth of virtual framebuffer
Rmaskthe pixel red color mask
Gmaskthe pixel green color mask
Bmaskthe pixel blue color mask
Amaskthe pixel alpha mask
MSBLeftThe flag indicating the Most Significant Bits (MSB) \ is left when depth is less than 8.
Returns
the header of virtual framebuffer
void *GUIAPI xVFBCreateEventBuffer ( int  nr_events)

create event circular buffer.

Parameters
nr_eventscapability of the event buffer
Returns
the address of event circular buffer.
void GUIAPI xVFBDestroyEventBuffer ( void *  event_buf)

destroy event circular buffer.

Parameters
event_bufThe pointer to event circular buffer.
void GUIAPI xVFBFreeVirtualFrameBuffer ( XVFBHeader buf)

free virtual framebuffer.

Parameters
bufThe pointer to virtual framebuffer.
int xVFBNotifyNewEvent ( const void *  xvfb_event_buffer,
XVFBEVENT event 
)

put a event to event circular buffer

Parameters
xvfb_event_bufferevent circular buffer
eventevent shall be put into xvfb_event_buffer
Returns
  • 0 indicate the event has been put into buffer
  • 1 indicate the buffer is full
  • 2 the buffer has been distroyed (MiniGUI terminated).