---

white_interface.h File Reference

An automatically generated file for whitebox C in VCC. More...

#include <Stratego_DrawSprite.h>
#include <VCC_Whitebox_C_Types.h>
#include <Stratego_move.h>
#include <Stratego_PrintString.h>
#include <Stratego_button.h>

Go to the source code of this file.

Functions
int	button_in_Enabled ()
	Detect if button_in port is enabled. More...
button *	button_in_Value ()
	Get value at button_in port. More...
int	move_in_Enabled ()
	Detect if move_in port is enabled. More...
move *	move_in_Value ()
	Get value at move_in port. More...
void	button_out_Post (button *)
	Send value down the button_out Port. More...
void	move_out_Post (move *)
	Send value down the move_out Port. More...
void	draw_Post (DrawSprite *)
	Send value down the draw Port. More...
void	print_Post (PrintString *)
	Send value down the print_out Port. More...
Variables
button	button_in
move	move_in
button	button_out
move	move_out
DrawSprite	draw
PrintString	print

---

Detailed Description

An automatically generated file for whitebox C in VCC.

This file is automatically generated by VCC. It provides information for the ports being used, as well as
the predefined functions that can be used to check the status of a port and also get the value that it may have
at a specific moment.

The core module is connected to:

• The Input module by the button_in and move_in ports, indicating a button and a move command being generated by the
  player or his opponent and that is entering the core module for processing.
  
• The Graphics module by the draw and print ports representing either that a move is legal and some pieces need to be
  drawn, or that a message should be printed on the players' screen.
  
• The bluetooth module by the move_out and button_out ports representing that the player has performed some actions
  (moved or pressed a button) and that other modules (opponent and observers) need to know so that they update their
  data structures and their screen as well.

---

Function Documentation

int button_in_Enabled (    )

Detect if button_in port is enabled. Function that checks whether the button_in port of the core module is enabled or not Returns: int being 1 if port enabled , 0 if not

button* button_in_Value (    )

Get value at button_in port. This function returns a button pointer. It is used to get the button value of the button_in port when it is enabled Returns: button* being the button sent by the input module

void button_out_Post (  button *    )

Send value down the button_out Port. Function used to output a button value on the button_out port Returns: void

void draw_Post (  DrawSprite *    )

Send value down the draw Port. Function used to output a DrawSprite value on the draw port Returns: void

int move_in_Enabled (    )

Detect if move_in port is enabled. Function that checks whether the move_in port of the core module is enabled or not Returns: int being 1 if port enabled , 0 if not

move* move_in_Value (    )

Get value at move_in port. This function returns a move pointer. It is used to get the move value of the move_in port when it is enabled Returns: move* being the move command sent by the input module

void move_out_Post (  move *    )

Send value down the move_out Port. Function used to output a move value on the move_out port Returns: void

void print_Post (  PrintString *    )

Send value down the print_out Port. Function used to output a PrintString value on the print port Returns: void

---

Variable Documentation

button button_in

The port connected to the Input module indicating that a button has been pressed either by the user or by his opponent

button button_out

Port connected to the bluetooth module to indicate that the user has pressed a button and that all other modules should be updated accordingly

DrawSprite draw

A port connected to the Graphics module to indicate that a specific bitmap should be drawn on the screen at the specified coordinates

move move_in

The port connected to the Input module indicating that a move has been performed either by the user or by his opponent

move move_out

Port connected to the bluetooth module to indicate that the user has performed a move and that all other modules should be updated accordingly

PrintString print

A port connected to the Graphics module to indicate that a specific string should be displayed on the screen at the specified coordinates

---