MX_ATOM
Base class for reference counting and delete locking
MX_ATOM is an object intended to be used as a base class to implement reference counting and delete locking in the derived class.
Properly constructed MX_ATOM objects are bit-copy-correct which means that a binary copy retains proper functioning. The copied object should not be used after the binary copy.
Because MX_ATOM is bit-copy-correct it can safely be placed in a MX_VECTOR
or the memory realloc'd.
(../include/deds/atom.h)
(library deds : module atom)
MX_LOCK
Stop MX_ATOMs from getting deleted
This object implements a delete lock for an MX_ATOM. While a valid MX_LOCK exists for an MX_ATOM object (or one derived from it) the object is guaranteed not be deleted. An object can have multiple locks placed on it.
MX_LOCK is NOT bit-copy-correct so it cannot safely be placed in a MX_VECTOR
or in memory that gets realloc'd.
(../include/deds/atom.h)
(library deds : module atom)
# define MX_REF(type)
A reference type, a typed MX_LOCK
This macro defines a MX_LOCK where the target is of some defined type.
A reference functions the same way as a MX_LOCK except the locked (i.e. referenced)
object is available in a typesafe way. A pointer to the reference target is
available with the MXREF macro.
(../include/deds/atom.h)
(library deds : module atom)
#define MX_DLLIST(type)
Double linked list
This macro declares a double linked list structure. The list
surrounding type can then be manipulated by the other mx_dllist_* and
MX_DLLIST_* macros. The type should be initialized with all zeros.
(../include/deds/dllist.h)
(library deds : module dllist)
#define MX_DLLIST_ELEM(type)
Elements for a double linked list
This macro declares elements for a double linked list structure.
This delcaration must be included in a struct with an appropriate type. The
surrounding type can then be manipulated by the other mx_dllist_* and
MX_DLLIST_* macros. The surrounding type should be initialized with all
zeros.
(../include/deds/dllist.h)
(library deds : module dllist)
#define MX_DLLIST_NODE(type,list)
Elements for a double linked list node
This macro declares elements for a double linked list node
structure. This delcaration must be included in a struct with an appropriate
type. The surrounding type can then be manipulated by the other mx_dllist_*
and MX_DLLIST_* macros. The surrounding type should be initialized with all
zeros.
(../include/deds/dllist.h)
(library deds : module dllist)
typedef void* (*MX_ALLOC) (size_t bytes);
A stdlib malloc-like function.
(../include/deds/memtype.h)
(library deds : module memtype)
typedef void* (*MX_REALLOC) (void* ptr, size_t bytes);
A stdlib realloc-like function.
(../include/deds/memtype.h)
(library deds : module memtype)
typedef void (*MX_FREE) (void* ptr);
A stdlib free-like function.
(../include/deds/memtype.h)
(library deds : module memtype)
MX_ALLOCATOR
A standard memory alloc/realloc/free tool
(../include/deds/memtype.h)
(library deds : module memtype)
MX_RECT
A basic rectangle
This type is a basic rectangle with an upper-left at x1,y1 and lower-right at x2, y2. (../include/deds/rect.h)
member: int x1 Left coordinate (../include/deds/rect.h)
member: int y1 Upper coordinate (../include/deds/rect.h)
member: int x2 Right coordinate (../include/deds/rect.h)
member:
int y2 Lower coordinate
(../include/deds/rect.h)
(library deds : module rect)
MX_RECTATOM_DATA
MX_RECT with reference counting
(../include/deds/rectatom.h)
(library deds : module rectatom)
MX_STRING
A string object
(../include/deds/string.h)
(library deds : module string)
#define MX_VECTOR(type)
A 100% typesafe generic vector for C
This macro functions as a type delaration for a vector of user-defined
type.
(../include/deds/vector.h)
(library deds : module vector)
#define MX_VECTOR_ITERATOR(type)
An iterator for a MX_VECTOR
This macro functions as a type declaration for an iterator for a
similarly typed MX_VECTOR.
(../include/deds/vector.h)
(library deds : module vector)
MX_BITMAP
A bitmap type
(../include/degfx/bitmap.h)
(library degfx : module bitmap)
typedef MX_PIXEL* MX_BITMAP_ITER;
Fast pixel-level iterator for a bitmap
(../include/degfx/bitmap.h)
(library degfx : module bitmap)
MX_GFX_ARGS
Graphic driver information
The basic graphic driver arguments and parameters. All elements can be replaced with 0 and a default choice will be made. (../include/degfx/driver.h)
member: int w, h, c; The graphics width, height and color depth in bits. (../include/degfx/driver.h)
member: const char *title; The title of the graphics window (for windowed modes) (../include/degfx/driver.h)
member: struct MX_BITMAP *buffer; The buffer used for redrawing. Larger buffers mean more efficient redraws at the cost of more memory. (../include/degfx/driver.h)
member: const struct MX_DRIVER *driver; The requested driver. (../include/degfx/driver.h)
member: MX_REDRAW_FUNC redraw; The redraw function. (../include/degfx/driver.h)
member: MX_RECT screen; The area of the graphics screen. (../include/degfx/driver.h)
member: unsigned int session; The session counter is incremented every time the graphics mode is changed. Keeping track of the session number you can check if the graphics mode has been changed. (../include/degfx/driver.h)
member:
MX_BITFIELD(pointer); The pointer field is non-zero if the platform draws it's
own mouse.
(../include/degfx/driver.h)
(library degfx : module driver)
MX_FONT
A font
(../include/degfx/font.h)
(library degfx : module font)
MX_ALERT
Basic alert window
(../include/depui/alert.h)
(library depui : module alert)
MX_EVENT
Event types
(../include/depui/corepui.h)
(library depui : module corepui)
typedef void (*MX_HANDLER) (struct MX_WIN* win);
Event handler
Functions of this type are assoctaied with windows. These functions process
all events bieng passed to all objects within the window.
(../include/depui/corepui.h)
(library depui : module corepui)
MX_WIN
A window object
(../include/depui/corepui.h)
(library depui : module corepui)
MX_EDITTEXT
An editable text object
(../include/depui/edittext.h)
(library depui : module edittext)
MX_FILESEL
File selector window
This type is a standard DEPUI file selector.
(../include/depui/filesel.h)
(library depui : module filesel)
MX_FONTSEL
A font seletion window
(../include/depui/fontsel.h)
(library depui : module fontsel)
MX_GFXSEL
Graphics mode selector
(../include/depui/gfxsel.h)
(library depui : module gfxsel)
MX_GFXSEL_INFO
Graphics mode selector information
When a graphics mode has been selected by the dialog a MX_GFXSEL_OK
event is sent to the parent window. Then mx_gfxsel_info() can be called to
get information about the graphics mode selected. A pointer to this type is
returned.
(../include/depui/gfxsel.h)
(library depui : module gfxsel)
MX_LISTELEM
A list element type
(../include/depui/list.h)
(library depui : module list)
MX_LIST
A scrollable list object
This object contains a number of selecteable elements in a (if necessary)
scrollable area.
(../include/depui/list.h)
(library depui : module list)
MX_SCROLL
Scrollable area
This is an scrollable area object.
(../include/depui/scroll.h)
(library depui : module scroll)
MX_SCROLL2
Scrollable area with title
This is an scrollable area object with a title.
(../include/depui/scroll.h)
(library depui : module scroll)
MX_SLIDER
Slider type
(../include/depui/slider.h)
(library depui : module slider)
MX_TEXTEDITOR
Text editor
(../include/depui/textedit.h)
(library depui : module textedit)
MX_THEMESEL
A theme seletion window
(../include/depui/themesel.h)
(library depui : module themesel)
#define MX_BITFIELD(a)
Portable bitfield
A macro to define a bitfield variable.
(../include/detk/bitfield.h)
(library detk : module bitfield)
typedef void (*MX_FLUSH_FUNC) (MX_RECT* rect);
Flush callback function for dirty rectangle updating
This typedef defines a user defined callback function where dirty
portions of the screen are determined. Inside the callback the user should
place code to actually update the screen area. The updating rectangle can be
modified by the callback to indicate what portions of the screen are actually
updated.
(../include/detk/drs.h)
(library detk : module drs)
typedef MX_VECTOR(MX_RECT) MX_REGION;
Regions are vectors of rectangles
(../include/detk/region.h)
(library detk : module region)
Generated by MXDOC 2.2 on Sun Feb 4 15:16:26 2007