xvfb.h File Reference

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
  

• MG_EXPORT void GUIAPI xVFBFreeVirtualFrameBuffer (XVFBHeader *buf)

  free virtual framebuffer.
  

• MG_EXPORT void GUIAPI xVFBDestroyEventBuffer (void *event_buf)

  destroy event circular buffer.
  

• MG_EXPORT int GUIAPI xVFBNotifyNewEvent (const void *xvfb_event_buffer, XVFBEVENT *event)

  create event circular buffer.
  

Variables

• MG_EXPORT void * __mg_rtos_xvfb_event_buffer

  shared memory header of x virtual framebuffer.
  

---

Detailed Description

Author:

Feynman Software

Date:

2007/10/25

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

    Copyright (C) 2002-2009 Feynman Software.
    Copyright (C) 1998-2002 Wei Yongming.

    All rights reserved by Feynman Software.

    This file is part of MiniGUI, a compact cross-platform Graphics 
    User Interface (GUI) support system for real-time embedded systems.

 

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:

	width	the width of virtual framebuffer
	height	the height of virtual framebuffer
	depth	the color depth of virtual framebuffer
	Rmask	the pixel red color mask
	Gmask	the pixel green color mask
	Bmask	the pixel blue color mask
	Amask	the pixel alpha mask
	MSBLeft	The flag indicating the Most Significant Bits (MSB) \ is left when depth is less than 8.

Returns:

the header of virtual framebuffer

void GUIAPI xVFBDestroyEventBuffer

(

void *

event_buf

)

destroy event circular buffer.

Parameters:

event_buf

The pointer to event circular buffer.

void GUIAPI xVFBFreeVirtualFrameBuffer

(

XVFBHeader *

buf

)

free virtual framebuffer.

Parameters:

buf

The pointer to virtual framebuffer.

int xVFBNotifyNewEvent	(	const void *	xvfb_event_buffer,
		XVFBEVENT *	event
	)

create event circular buffer.

put a event to event circular buffer

Parameters:

nr_events

capability of the event buffer

Returns:

the address of event circular buffer.

Parameters:

	xvfb_event_buffer	event circular buffer
	event	event 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).