Client Library - Surface API

---

Detailed Description

s_surface_* api is very internal, and is used for initializing the video buffer, that will print on.

the initialization method is choosen by the server - linear video buffer, linear shadow buffer, streaming buffer -. programmers do not need to use these functions unless they do not want to change the behaviour of server/ client interraction.

Data Structures
struct	s_surface_s
	surface struct More...
Enumerations
enum	S_SURFACE_MODE { SURFACE_REAL = 0x1, SURFACE_VIRTUAL = 0x2, SURFACE_NEEDEXPOSE = 0x4, SURFACE_NEEDSTREAM = 0x8 }
	surface modes More...
Functions
int	s_surface_init (s_window_t *window)
	initialize the main video buffer surface struct
void	s_surface_create (s_window_t *window)
	create and attach the device buffer to surface
void	s_surface_shm_attach (s_window_t *window)
	attach to the matrix buffer
void	s_surface_linear (s_window_t *window)
	attach to the video buffer
void	s_surface_uninit (s_window_t *window)
	uninitialize the surface struct
void	s_surface_changed (s_window_t *window, s_rect_t *changed)
	expose event handler

---

Enumeration Type Documentation

enum S_SURFACE_MODE

surface modes

Enumerator:

SURFACE_REAL	graphics will be drawn on real buffer
SURFACE_VIRTUAL	graphics will be drawn on virtual buffer
SURFACE_NEEDEXPOSE	window will send expose event (just the rectangular area) to the server
SURFACE_NEEDSTREAM	window will send expose event (rectanglar area, and the buffer) to the server

---

Function Documentation

void s_surface_changed	(	s_window_t *	window,
		s_rect_t *	changed
	)

expose event handler

Parameters:

	*window	- the window
	*changed	- the rectangular area that will be updated

Returns:

no return

void s_surface_create

(

s_window_t *

window

)

create and attach the device buffer to surface

Parameters:

*window

- the window

Returns:

no return

int s_surface_init

(

s_window_t *

window

)

initialize the main video buffer surface struct

Parameters:

*window

- the window

Returns:

0 on success

void s_surface_linear

(

s_window_t *

window

)

attach to the video buffer

Parameters:

*window

- the window

Returns:

no return

void s_surface_shm_attach

(

s_window_t *

window

)

attach to the matrix buffer

Parameters:

*window

- the window

Returns:

no return

void s_surface_uninit

(

s_window_t *

window

)

uninitialize the surface struct

Parameters:

*window

- the window

Returns:

no return

---