qf/quakeforge
0
0
Fork 0
mirror of https://git.code.sf.net/p/quake/quakeforge synced 2025-01-31 13:10:34 +00:00
Code Issues Projects Releases Packages Wiki Activity

Begin documenting qtv.

Browse source
This commit is contained in:
Bill Currie 2010-12-21 09:25:17 +09:00
parent 92714b19bf
commit 1018203f19
3 changed files with 48 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/Makefile.am
View file

@ -13,7 +13,8 @@ EXTRA_DIST= qf.ico \
config/gib/adjustvolume.gib config/gib/infobot.gib config/gib/ln.gib \
config/gib/qfadmin.gib config/gib/sshot.gib config/gib/zoom.gib \
\
progs/vm-exec.c progs/vm-mem.fig
progs/vm-exec.c progs/vm-mem.fig \
qtv/qwtv.fig
%.png: %.fig
@mkdir -p `dirname $@`
@ -28,6 +29,8 @@ clean-local:
progs/vm-mem.png: progs/vm-mem.fig
progs/vm-mem.eps: progs/vm-mem.fig
qtv/qwtv.png: qtv/qwtv.fig
qtv/qwtv.eps: qtv/qwtv.fig
doc: quakeforge.dox progs/vm-mem.png progs/vm-mem.eps
doc: quakeforge.dox progs/vm-mem.png progs/vm-mem.eps qtv/qwtv.png qtv/qwtv.eps
doxygen quakeforge.dox

1
doc/quakeforge.dox.in
View file

@ -690,6 +690,7 @@ EXAMPLE_RECURSIVE = NO
IMAGE_PATH = @TOPSRC@/doc
IMAGE_PATH += @builddir@
IMAGE_PATH += @builddir@/progs
IMAGE_PATH += @builddir@/qtv
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program

46
qtv/include/qtv.h
View file

@ -32,12 +32,22 @@
#ifndef __qtv_h
#define __qtv_h
#define PORT_QTV 27501
/** \defgroup qtv QuakeForge QTV Proxy
\image html qwtv.png
\image latex qwtv.eps "VM memory map"
*/
/** \defgroup qtv_general General Functions
\ingroup qtv
*/
//@{
#define PORT_QTV 27501 ///< Default port to listen for connecting clients.
typedef enum {
RD_NONE,
RD_CLIENT,
RD_PACKET,
RD_NONE, ///< No redirection. Default state.
RD_CLIENT, ///< Output is sent to a specific client connection.
RD_PACKET, ///< Output is sent as a connectionless packet.
} redirect_t;
extern double realtime;
@ -48,8 +58,36 @@ extern struct cvar_s *sv_timeout;
struct client_s;
/** Formatted console printing with possible redirection.
Parameters are as per printf.
Calling qtv_begin_redirect() before, and qtv_end_redirect() after a series
of calls will redirect output.
*/
void qtv_printf (const char *fmt, ...) __attribute__((format(printf,1,2)));
/** Begin redirection of console printing.
All calls to qtv_printf() between a call to this and qtv_end_redirect()
will be redirected.
\param rd Redirection type.
\param cl Destination client of redirected output. Ignored for
RD_PACKET redirection, required for RD_CLIENT.
*/
void qtv_begin_redirect (redirect_t rd, struct client_s *cl);
/** End redirection of console printing.
All calls to qtv_printf() between a call to qtv_begin_redirect() and this
will be redirected.
Causes the redirected output to be flushed to the destination set by
qtv_begin_redirect ();
*/
void qtv_end_redirect (void);
//@}
#endif//__qtv_h