qf/quakeforge
0
0
Fork 0
mirror of https://git.code.sf.net/p/quake/quakeforge synced 2025-03-21 18:01:15 +00:00
Code Issues Projects Releases Packages Wiki Activity

[input] Move some IMT documentation

Browse source 
And update to reflect some of the changed concepts (context vs keydest)
This commit is contained in:
Bill Currie 2021-11-27 12:01:07 +09:00
parent 413cea6b4a
commit fe9241e573
2 changed files with 26 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
include/QF/input/imt.h
View file

@ -86,8 +86,34 @@ int IMT_CreateContext (const char *name);
int IMT_GetContext (void) __attribute__ ((pure));
void IMT_SetContext (int ctx);
void IMT_SetContextCbuf (int ctx, struct cbuf_s *cbuf);
/** Find an Input Mapping Table by name.
Searches through all contexts for the named imt. The search is case
insensitive.
\param imt_name The name of the imt to find. Case insensitive.
\return The named imt, or null if not found.
*/
imt_t *IMT_FindIMT (const char *name) __attribute__ ((pure));
imt_switcher_t *IMT_FindSwitcher (const char *name) __attribute__ ((pure));
/** Create a new imt and attach it to the specified context.
The name of the new imt must be unique (case insensitive) across all
contexts. This is to simplify the in_bind command.
If \a chain_imt_name is not null, then it species the fallback imt for when
the input is not bound in the new imt. It must be an already existing imt
in the specified context. This is to prevent loops and other weird
behavior.
\param context The context to which the new imt will be attached.
\param imt_name The name for the new imt. Must be unique (case
insensitive).
\param chain_imt_name The name of the fallback imt if not null. Must
already exist on the specified context.
*/
int IMT_CreateIMT (int context, const char *imt_name,
const char *chain_imt_name);
int IMT_CreateSwitcher (const char *switcher_name,

26
include/QF/keys.h
View file

@ -448,33 +448,7 @@ struct cbuf_s;
void Key_Init (struct cbuf_s *cb);
void Key_Init_Cvars (void);
/** Find an Input Mapping Table by name.
Searches through all keydest targets for the named imt. The search is case
insensitive.
\param imt_name The name of the imt to find. Case insensitive.
\return The named imt, or null if not found.
*/
struct imt_s *Key_FindIMT (const char *imt_name) __attribute__((pure));
/** Create a new imt and attach it to the specified keydest target.
The name of the new imt must be unique (case insensitive) across all
keydest targets. This is to simplify the in_bind command.
If \a chain_imt_name is not null, then it species the fallback imt for when
the key is not bound in the new imt. It must be an already existing imt in
the specified keydest target. This is to prevent loops and other weird
behavior.
\param kd The keydest target to which the new imt will be attached.
\param imt_name The name for the new imt. Must be unique (case
insensitive).
\param chain_imt_name The name of the fallback imt if not null. Must
already exist on the specified keydest target.
*/
void Key_CreateIMT (keydest_t kd, const char *imt_name,
const char *chain_imt_name);