Module libif:gfxwin - Graphics windowing system interface library

Graphics windowing system interface library. This provides a variety of routines that can be used to interact with the RMoX graphics windowing subsystem. To use:

#INCLUDE "gfxproto.inc"
 #INCLUDE "winproto.inc"

For static modules:

#USE "libif/gfxwin"

For dynamic modules:

#INCLUDE "gfxwin_if.inc"

Index

Declarations

gfxwin.occ:68Process gfxwin.connect

PROC gfxwin.connect (BOOL ok, SHARED CT.KERNEL! krnl, VAL []BYTE device, RESULT SHARED CT.GFXPROTO! gfx)

Connect to the graphics windowing system. This uses a interface to connect to the specified windowing system. If device is given as an empty string, the "gfxwinsys" device is used.

Parameters:

BOOL ok Test and set success.
SHARED CT.KERNEL! krnl Connection to the kernel.
VAL []BYTE device Graphics windowing device.
RESULT SHARED CT.GFXPROTO! gfx Returned connection.

gfxwin.occ:94Process gfxwin.disconnect

PROC gfxwin.disconnect (BOOL ok, SHARED CT.GFXPROTO! gfx)

Disconnect from the windowing system.

Parameters:

BOOL ok Check and set success.
SHARED CT.GFXPROTO! gfx Connection to graphics subsystem.

gfxwin.occ:122Process gfxwin.create.canvas

PROC gfxwin.create.canvas (BOOL ok, SHARED CT.GFXPROTO! gfx, VAL INT x, y, width, height, RESULT SHARED CT.GFXCANVAS! canvas, RESULT GFX.CANVAS canvas.info)

Creates a new canvas.

Parameters:

BOOL ok Check and set success.
SHARED CT.GFXPROTO! gfx Connection to graphics subsystem.
VAL INT x Default X position of canvas on screen.
VAL INT y Default Y position of canvas on screen.
VAL INT width Width of canvas.
VAL INT height Height of canvas.
RESULT SHARED CT.GFXCANVAS! canvas Returned connection to graphics canvas.
RESULT GFX.CANVAS canvas.info Returned information about canvas (see GFX.CANVAS).

gfxwin.occ:144Process gfxwin.destroy.canvas

PROC gfxwin.destroy.canvas (BOOL ok, SHARED CT.GFXCANVAS! canvas)

Destroys a canvas.

Parameters:

BOOL ok Check and set success.
SHARED CT.GFXCANVAS! canvas Connection to graphics canvas.

gfxwin.occ:168Process gfxwin.screen.size

PROC gfxwin.screen.size (BOOL ok, SHARED CT.GFXPROTO! gfx, RESULT INT width, height)

Queries the screen dimensions.

Parameters:

BOOL ok Check and set success.
SHARED CT.GFXPROTO! gfx Connection to graphics subsystem.
RESULT INT width Returned width.
RESULT INT height Returned height.

gfxwin.occ:191Process gfxwin.canvas.wincontrol

PROC gfxwin.canvas.wincontrol (BOOL ok, SHARED CT.GFXCANVAS! canvas, RESULT SHARED CT.WINPROTO! wctl)

Gets hold of the window control channels for a canvas.

Parameters:

BOOL ok Check and set success.
SHARED CT.GFXCANVAS! canvas Connection to canvas object.
RESULT SHARED CT.WINPROTO! wctl Returned window control connection.

gfxwin.occ:218Process gfxwin.uwin.seteventmask

PROC gfxwin.uwin.seteventmask (BOOL ok, CT.WINPROTO! window, VAL INT32 mask, VAL BOOL discard)

Sets the window event mask. If discard is TRUE, events received before the new mask takes effect will be thrown away. This is the preferred mode of operation.

Parameters:

BOOL ok Check and set success.
CT.WINPROTO! window Connection to window process.
VAL INT32 mask Event mask.
VAL BOOL discard Whether or not to discard events.

gfxwin.occ:267Process gfxwin.win.seteventmask

PROC gfxwin.win.seteventmask (BOOL ok, SHARED CT.WINPROTO! window, VAL INT32 mask, VAL BOOL discard)

Sets the window event mask. If discard is TRUE, events received before the new mask takes effect will be thrown away. This is the preferred mode of operation.

Parameters:

BOOL ok Check and set success.
SHARED CT.WINPROTO! window Connection to window process.
VAL INT32 mask Event mask.
VAL BOOL discard Whether or not to discard events.

gfxwin.occ:283Process gfxwin.uwin.settitle

PROC gfxwin.uwin.settitle (BOOL ok, CT.WINPROTO! window, VAL []BYTE title)

Sets the window title.

Parameters:

BOOL ok Check and set success.
CT.WINPROTO! window Connection to window process.
VAL []BYTE title Window title.

gfxwin.occ:298Process gfxwin.win.settitle

PROC gfxwin.win.settitle (BOOL ok, SHARED CT.WINPROTO! window, VAL []BYTE title)

Sets the window title.

Parameters:

BOOL ok Check and set success.
SHARED CT.WINPROTO! window Connection to window process.
VAL []BYTE title Window title.

gfxwin.occ:314Process gfxwin.uwin.playsound

PROC gfxwin.uwin.playsound (BOOL ok, CT.WINPROTO! window, VAL INT sample)

Ask the windowing system to play a pre-defined sample.

Parameters:

BOOL ok Check and set success.
CT.WINPROTO! window Connection to window process.
VAL INT sample Sound sample to play (see GFXAUD.SAMPLE).

gfxwin.occ:329Process gfxwin.win.playsound

PROC gfxwin.win.playsound (BOOL ok, SHARED CT.WINPROTO! window, VAL INT sample)

Ask the windowing system to play a pre-defined sample.

Parameters:

BOOL ok Check and set success.
SHARED CT.WINPROTO! window Connection to window process.
VAL INT sample Sound sample to play (see GFXAUD.SAMPLE).