Name

giiSetEventMask, giiGetEventMask, giiAddEventMask, giiRemoveEventMask — Set the types of events queued

Synopsis

#include <ggi/gii.h>
int giiSetEventMask(inp,  
 evm); 
gii_input_t  inp;
gii_event_mask  evm;
gii_event_mask giiGetEventMask(inp); 
gii_input_t  inp;
int giiAddEventMask(inp,  
 mask); 
gii_input_t  inp;
gii_event_mask  mask;
int giiRemoveEventMask(inp,  
 mask); 
gii_input_t  inp;
gii_event_mask  mask;

Description

Calling giiSetEventMask indicates to LibGII that only the types of events that match the specified event mask will be read by the application in subsequent giiEventPoll or giiEventRead calls. LibGII can then save time and memory by skipping checks and not allocating queues for events that will never be read out. The default mask allows all events.

giiAddEventMask and giiRemoveEventMask are macros that set or delete individual bits in the bitmask.

Note

giiSetEventMask is an advisory call. For correct operation, the application still needs to pass a restrictive event mask to the event reading functions.

Return value

giiSetEventMask, giiAddEventMask and giiRemoveEventMask return 0 on success or an error code otherwise.

giiGetEventMask returns the currently set mask.