summaryrefslogtreecommitdiff
path: root/include/libnsfb.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/libnsfb.h')
-rw-r--r--include/libnsfb.h20
1 files changed, 20 insertions, 0 deletions
diff --git a/include/libnsfb.h b/include/libnsfb.h
index 5975768..41490ad 100644
--- a/include/libnsfb.h
+++ b/include/libnsfb.h
@@ -15,9 +15,29 @@
typedef struct nsfb_cursor_s nsfb_cursor_t;
typedef struct nsfb_s nsfb_t;
+
+/** representation of a colour.
+ *
+ * The colour value comprises of four components arranged in the order ABGR:
+ * bits 24-31 are the alpha value and represent the opacity. 0 is
+ * transparent i.e. there would be no change in the target surface if
+ * this colour were to be used and 0xFF is opaque.
+ *
+ * bits 16-23 are the Blue component of the colour.
+ *
+ * bits 8-15 are the Green component of the colour.
+ *
+ * bits 0-7 are the Red component of the colour.
+ */
typedef uint32_t nsfb_colour_t;
typedef struct nsfb_event_s nsfb_event_t;
+/** co-ordinate for plotting operations */
+typedef struct nsfb_point_s {
+ int x;
+ int y;
+} nsfb_point_t;
+
/** bounding box for plotting operations */
typedef struct nsfb_bbox_s {
int x0;