This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project gfxprim.git. The branch, master has been updated via 6339f5f64899ddc8158072a7354703eb71ef2e49 (commit) from 15959b401d7f06790ed593ba0515b9502fce9502 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- http://repo.or.cz/w/gfxprim.git/commit/6339f5f64899ddc8158072a7354703eb71ef2... commit 6339f5f64899ddc8158072a7354703eb71ef2e49 Author: Cyril Hrubis <metan@ucw.cz> Date: Tue Dec 18 18:42:47 2012 +0100 doc: input: further fixes. diff --git a/doc/input.txt b/doc/input.txt index cdb7cc9..35ff473 100644 --- a/doc/input.txt +++ b/doc/input.txt @@ -53,7 +53,7 @@ typedef struct GP_Event { } GP_Event; ------------------------------------------------------------------------------- -The GP_Event structure is basic block that describes input event (i.e. key was +The 'GP_Event' structure describes an input event (i.e. key was pressed/released, mouse was moved, window was resized by user). [source,c] @@ -70,9 +70,9 @@ enum GP_EventType { The event 'type' determines highlevel nature of the event. * Key events covers keyboard button presses, mouse buttons, etc. -* Relative events covers mostly mouse coordinates +* Relative events covers mouse coordinates, mouse wheel, etc. * Absolute events covers touchscreens and tablets -* System events are used mostly for propagating window close and window +* System events are used for propagating window close and window resize events * Values greater than 'GP_EV_MAX' are free for user events @@ -137,16 +137,16 @@ struct GP_EventSys { }; ------------------------------------------------------------------------------- -The event value is a union that could hold different information. The right -format of the data is known from the 'type' and 'code'. For some types of the -events it's not used at all. +The event 'value' is a union that could hold different information. The right +format of the data is known from the 'type' and 'code'. Some types of the +events has no value at all. * The relative coordinates are used for 'GP_EV_REL_POS' and absolute coordinates for 'GP_EV_ABS_POS'. * The key event value is used for keypresses, additionally it holds the key value mapped to ASCII if conversion is applicable otherwise it's set to - zero. You should consult the header 'input/GP_Event.h' for comprehensive + zero. You should consult the header 'input/GP_Event.h' for the comprehensive list of key values. * And finally the system event is used with 'GP_EV_SYS_RESIZE' and informs you @@ -199,7 +199,7 @@ by ev pointer. void GP_EventDump(struct GP_Event *ev); ------------------------------------------------------------------------------- -Dumps event in human-readable format into the 'stdout'. +The 'GP_EventDump' dumps event in human-readable format into the 'stdout'. [source,c] ------------------------------------------------------------------------------- @@ -215,8 +215,6 @@ void GP_EventSetScreenCursor(uint32_t x, uint32_t y); Sets screen size and pointer position, which is needed for calculating the 'cursor_x' and 'cursor_y' coordinates. -void GP_EventPushRel(int32_t rx, int32_t ry, struct timeval *time); - [source,c] ------------------------------------------------------------------------------- #include <GP.h> @@ -224,6 +222,12 @@ void GP_EventPushRel(int32_t rx, int32_t ry, struct timeval *time); #include <input/GP_Event.h> /* + * Pushes relative event. + */ +void GP_EventPushRel(int32_t rx, int32_t ry, struct timeval *time); + + +/* * Produces relative event that moves to the point x, y */ void GP_EventPushRelTo(uint32_t x, uint32_t y, struct timeval *time); ----------------------------------------------------------------------- Summary of changes: doc/input.txt | 24 ++++++++++++++---------- 1 files changed, 14 insertions(+), 10 deletions(-) repo.or.cz automatic notification. Contact project admin jiri.bluebear.dluhos@gmail.com if you want to unsubscribe, or site admin admin@repo.or.cz if you receive no reply. -- gfxprim.git ("A simple 2D graphics library with emphasis on correctness and well-defined operation.")