Xiqual 0.9.1

typedef struct inputarea

An inputarea for testing mouse and other controllers in specific screen coordinates.

struct inputarea *next

Next area if in a list-

struct inputarea *prev

Previous area if in a list

char* name

The optional name.

void* data

User-definable data.

int x

X coordinate of upper left corner

int y

Y coordinate of upper left corner

int w

Width of rectangle

int h

Height of rectangle

void (*lmbfunc)(void* )

Left mousebutton activation

void (*mmbfunc)(void* )

Middle mousebutton activation

void (*rmbfunc)(void* )

Right mousebutton activation

void (*pfunc)(void* )

Mouse passing over without buttons pressed

ulong inputs

Mask of controllers to respond to.

ulong id

Mandatory ID.

Uint8 mb

Mousebutton mask.

Uint8 jb

Mask of joybuttons.

Uint32 tick

Point when this inputarea was last activated.

Uint32 delay

Delay in milliseconds before allowing another activation.

Documentation

An inputarea for testing mouse and other controllers in specific screen coordinates. The inputarea gets its function hooks filled from the tags supplied by iarea_new().

struct inputarea *next

Next area if in a list-

struct inputarea *prev

Previous area if in a list

char* name

The optional name. Little used, but could allow associating areas by name if they're all part of a complex gadget.

void* data

User-definable data. Passed on to all the activation hooks.

int x

X coordinate of upper left corner

int y

Y coordinate of upper left corner

int w

Width of rectangle

int h

Height of rectangle

void (*lmbfunc)(void* )

Left mousebutton activation

void (*mmbfunc)(void* )

Middle mousebutton activation

void (*rmbfunc)(void* )

Right mousebutton activation

void (*pfunc)(void* )

Mouse passing over without buttons pressed

ulong inputs

Mask of controllers to respond to. IA_CTL_MOUSE and/or IA_CTL_JOY.

ulong id

Mandatory ID. iarea_check() returns this when a check is positive. It would be daft to supply a zero value. Zero means failure.

Uint8 mb

Mousebutton mask. IA_LMBMASK, IA_MMB_MASK and/or IA_RMB_MASK. These are all aliases for SDL flags with slightly longer names, because I am terminally lazy.

Uint8 jb

Mask of joybuttons. These have no presets, as which button is the first and which is the last depends on the joystick/pad in question. Bit #0 will most likely be near one of your thumbs, though.

Uint32 tick

Point when this inputarea was last activated. This is the point at which this inputarea was last activated. It uses SDL_GetTicks() to get its value, but the way delays are calculated shouldn't be affected by the 49-day limit.

Note, however, that there is something else you are doing wrong if you have a game running for 49 days.

Uint32 delay

Delay in milliseconds before allowing another activation. Use the IA_DELAY tag when creating to set this.

Author:

Ronny Bangsund

See Also:

iarea_new(), iarea_free()

Alphabetic index