Xiqual 0.9.1

typedef struct xiglob

Global structure for Xiqual's automatic handling of miscellaneous data

SDL_Surface* screen

This is the SDL surface returned by SDL_SetVideoMode()

xiview* cursor

An xiview for the main cursor

int hotx

Cursor X offset

int hoty

Cursor Y offset

SDL_Surface* tscreen

Default surface for tile blits.

struct xitiles *tileset

Default tileset to blit from

int audio_rate

Sample rate.

int audio_chan

Number of channels to use.

int numchans

Maximum number of channels to mix.

int audio_bufsize

Size of audio buffers.

Uint16 audio_fmt

Audio format.

List sounds

Sound nodes.

List music

Music nodes.

List images

Image nodes.

List sprites

Sprite nodes.

void (*mainloop)(Uint8* keystate, SDLMod modstate, Uint8 mousestate, int mx, int my)

User-definable hook, called once each time xi_main() is called.

SDL_Surface* mesh

Mesh overlay for disabled gadgets.

gadget* hl

Pointer to the currently highlighted gadget.

List gadgets

List of LUI gadgets.

List inputs

List of input areas.

lui_msg* msg

Currently shown message box

Documentation

Global structure for Xiqual's automatic handling of miscellaneous data

SDL_Surface* screen

This is the SDL surface returned by SDL_SetVideoMode()

xiview* cursor

An xiview for the main cursor

int hotx

Cursor X offset

int hoty

Cursor Y offset

SDL_Surface* tscreen

Default surface for tile blits.

See Also:

xit_setdefaults(), xit_qdraw()

struct xitiles *tileset

Default tileset to blit from

int audio_rate

Sample rate. Measured in samples per second. Default is 44100 Hz.

int audio_chan

Number of channels to use. Use 1 for mono and 2 for stereo.

int numchans

Maximum number of channels to mix. Default is eight.

int audio_bufsize

Size of audio buffers. This doesn't have to be a particularly large number, but must be a factor of two. Defaults to 4096 bytes.

Uint16 audio_fmt

Audio format. The format definitions are in SDL_mixer.h.

List sounds

Sound nodes. Contents TBA.

List music

Music nodes. Contents TBA.

List images

Image nodes. Contents TBA.

List sprites

Sprite nodes. Contents TBA.

void (*mainloop)(Uint8* keystate, SDLMod modstate, Uint8 mousestate, int mx, int my)

User-definable hook, called once each time xi_main() is called.

Parameters:

keystate - A pointer to an array of Uint8. Currently pressed keys are non-zero.
modstate - State of modifier keys
mousestate - Flags for current mouse state (buttons).
mx - Current X position of mouse cursor within the main SDL surface
my - Current Y position of mouse cursor within the main SDL surface

Author:

Ronny Bangsund

See Also:

xi_main(), SDL_input.h

SDL_Surface* mesh

Mesh overlay for disabled gadgets. When a gadget is "ghosted", this surface is copied over it.

See Also:

lui_ghost()

gadget* hl

Pointer to the currently highlighted gadget. NULL if the cursor is not hovering above a gadget that can be highlighted. You are free to abuse the highlight method of a gadget for just knowing when the cursor is above it.

See Also:

lui_highlight(), gadget

List gadgets

List of LUI gadgets. Any gadgets in this list are automatically freed when xi_quit()/lui_quit() is called.

List inputs

List of input areas. Any inputs in this list are automatically freed when xi_quit()/lui_quit() is called.

lui_msg* msg

Currently shown message box

Alphabetic index