Date: Tue, 5 Aug 2008 21:37:33 +0000 Subject: added documentation --- docs/output/files2/docs/client_time-txt.html | 39 ++++++ docs/output/files2/docs/prediction-txt.html | 51 ++++++++ docs/output/files2/docs/server_op-txt.html | 69 ++++++++++ docs/output/files2/docs/snapshots-txt.html | 63 +++++++++ docs/output/files2/e_if_client-h.html | 127 +++++++++++++++++++ docs/output/files2/e_if_gfx-h.html | 139 ++++++++++++++++++++ docs/output/files2/e_if_inp-h.html | 73 +++++++++++ docs/output/files2/e_if_modc-h.html | 69 ++++++++++ docs/output/files2/e_if_mods-h.html | 71 +++++++++++ docs/output/files2/e_if_msg-h.html | 59 +++++++++ docs/output/files2/e_if_other-h.html | 89 +++++++++++++ docs/output/files2/e_if_server-h.html | 59 +++++++++ docs/output/files2/e_if_snd-h.html | 53 ++++++++ docs/output/files2/e_system-h.html | 183 +++++++++++++++++++++++++++ 14 files changed, 1144 insertions(+) create mode 100644 docs/output/files2/docs/client_time-txt.html create mode 100644 docs/output/files2/docs/prediction-txt.html create mode 100644 docs/output/files2/docs/server_op-txt.html create mode 100644 docs/output/files2/docs/snapshots-txt.html create mode 100644 docs/output/files2/e_if_client-h.html create mode 100644 docs/output/files2/e_if_gfx-h.html create mode 100644 docs/output/files2/e_if_inp-h.html create mode 100644 docs/output/files2/e_if_modc-h.html create mode 100644 docs/output/files2/e_if_mods-h.html create mode 100644 docs/output/files2/e_if_msg-h.html create mode 100644 docs/output/files2/e_if_other-h.html create mode 100644 docs/output/files2/e_if_server-h.html create mode 100644 docs/output/files2/e_if_snd-h.html create mode 100644 docs/output/files2/e_system-h.html (limited to 'docs/output/files2') diff --git a/docs/output/files2/docs/client_time-txt.html b/docs/output/files2/docs/client_time-txt.html new file mode 100644 index 00000000..ff97b67e --- /dev/null +++ b/docs/output/files2/docs/client_time-txt.html @@ -0,0 +1,39 @@ + + +Time on the client + + + + + + + + + +

Time on the client

tick, intratick predtick, predintratick

+ +

+ + + + + + + + + + + + + + + +

+ + + \ No newline at end of file diff --git a/docs/output/files2/docs/prediction-txt.html b/docs/output/files2/docs/prediction-txt.html new file mode 100644 index 00000000..893064fa --- /dev/null +++ b/docs/output/files2/docs/prediction-txt.html @@ -0,0 +1,51 @@ + + +Prediction + + + + + + + + + +

Prediction

The engine calls modc_predict when reprediction is required. This happens usally when new data has arrived from the server. modc_predict should to prediction from the current snapshot and current snapshot tick (client_tick + 1) upto and including the tick returned by client_predtick.

Predicted input sent to the server can be retrived by calling client_get_input with the corresponding tick that you want the input for. Here is a simple example of how it might look.

void modc_predict()
+{
+  int tick;
+  prediction_reset();
+
+  for(tick = client_tick()+1; tick <= client_predtick(); tick++)
+  {
+      MY_INPUT *input = (MY_INPUT *)client_get_input();
+      if(input)
+          prediction_apply_input(input);
+      prediction_tick();
+  }
+}

+ +

+ + + + + + + + + + +

void modc_predict()

TODO

int client_tick()

Returns the tick of the current snapshot.

int client_predtick()

Returns the current predicted tick.

int *client_get_input( int tick )

TODO

+ + + + +

+ + + \ No newline at end of file diff --git a/docs/output/files2/docs/server_op-txt.html b/docs/output/files2/docs/server_op-txt.html new file mode 100644 index 00000000..aa25fe67 --- /dev/null +++ b/docs/output/files2/docs/server_op-txt.html @@ -0,0 +1,69 @@ + + +Server Operation + + + + + + + + + +

Server Operation

Summary

Server Operation
Init
Running	Here is an graph over how the server operates on each refresh.
Reinit
Shutdown

+ +

Init

+ +

Running

Here is an graph over how the server operates on each refresh.

load map
+init mod
+
+while running
+    if map change then
+        load new map
+        shutdown mod <mods_shutdown>
+        reset clients to init state
+        init mod <mods_init>
+    end if
+
+    if new tick then
+        call <mods_tick>
+        for each client do
+            create snapshot <mods_snap>
+            send snapshot
+        end for
+    end
+
+    process new network messages
+end while
+
+unload map

+ +

Reinit

+ +

Shutdown

+ +

+ + + + + + + + + + + + + + + +

+ + + \ No newline at end of file diff --git a/docs/output/files2/docs/snapshots-txt.html b/docs/output/files2/docs/snapshots-txt.html new file mode 100644 index 00000000..9654118a --- /dev/null +++ b/docs/output/files2/docs/snapshots-txt.html @@ -0,0 +1,63 @@ + + +Snapshots + + + + + + + + + +

Snapshots

Summary

Snapshots
Overview
Definitions
Structure	A snapshot contains a series of items.
Server Side
Creating	Items can be added when mods_snap is called using the snap_new_item function to insert an item to the snapshot.
Client Side
Inspection	modc_newsnapshot is called when a new snapshot has arrived for processing.
Rendering	DOCTODO
In depth
Compression	After a snapshot have been created, compression is applyed to reduce the bandwidth.
Interval	The interval for how often a client recives a snapshot changes during the course of the connection.

+ +

Overview

Summary

Definitions
Structure	A snapshot contains a series of items.

+ +

Definitions

Snapshot. A is a serialized game state from which a client can render the game from. They are sent from the server at a regular interval and is created specificly for each client in order to reduce bandwidth.
Delta Snapshot. A set of data that can be applied to a snapshot in order to create a new snapshot with the updated game state.

+ +

Structure

A snapshot contains a series of items. Each item have a type, id and data.

Type. Type of item. Could be projectile or character for example.
Id. A unique id so the client can identify the item between two snapshots.
Data. A series of 32-bit integers that contains the per item type specific data.

+ +

Server Side

Summary

Creating

Items can be added when mods_snap is called using the snap_new_item function to insert an item to the snapshot.

+ +

Creating

Items can be added when mods_snap is called using the snap_new_item function to insert an item to the snapshot. The server can not inspect the snapshot that is in progress of being created.

+ +

Client Side

Summary

Inspection	modc_newsnapshot is called when a new snapshot has arrived for processing.
Rendering	DOCTODO

+ +

Inspection

modc_newsnapshot is called when a new snapshot has arrived for processing. snap_num_items, snap_get_item and snap_find_item can be used to inspect the current and previous snapshot. This can be done anywhere while the client is running and not just in the modc_newsnapshot function. The client can also call snap_invalidate_item if an item contains improper information that could harm the operation of the client. This should however be done in modc_newsnapshot to assure that no bad data propagates into the rest of the client.

+ +

Rendering

DOCTODO

+ +

In depth

Summary

Compression	After a snapshot have been created, compression is applyed to reduce the bandwidth.
Interval	The interval for how often a client recives a snapshot changes during the course of the connection.

+ +

Compression

After a snapshot have been created, compression is applyed to reduce the bandwidth. There are several steps taken inorder to reduce the size of the size of the snapshot.

Delta. The server looks in a clients backlog of snapshots to find a previous acked snapshot. It then compares the two snapshots and creates a delta snapshot containing the changes from the previous acked snapshot to the new one.
Variable Integers. The delta snapshot which is only consisting of 32-bit integers is then encoded into variable integers similar to UTF-8. Each byte has a bit that tells the decoder that it needs one more byte to decode the 32-bit integer. The first byte also contains a bit for telling the sign of the integer.

ESDDDDDD EDDDDDDD EDDDDDDD EDDDDDDD

E = extend
+S = sign
+D = data bit

Huffman. The last step is to compress the buffer with a huffman encoder. It uses a static tree that is weighted towards 0 because it’s where most of the data will be because of the delta compression.

+ +

Interval

The interval for how often a client recives a snapshot changes during the course of the connection. There are three different snapshot rates.

Init. 5 snapshots per second. Used when a client is connecting and used until the client has acknowlaged a snapshot. This mechanism is used because the first snapshot because no delta compression can be done.
Full. Snapshot for every tick or every even tick depending on server configuration. This is used during normal gameplay and everything is running smooth.
Recovery. 1 snapshot each second. A client enters recovery rate when it havn’t acknowlaged a snapshot over 1 second. This is to let the client to beable to recover if it has a slow connection.

+ +

+ + + + + + + + + + +

void mods_snap( int cid )

Called to create the snapshot for a client.

void *snap_new_item( int type,
int id,
int size )

Creates a new item that should be sent.

void modc_newsnapshot()

Called when the client progressed to a new snapshot.

int snap_num_items( int snapid )

Check the number of items in a snapshot.

void *snap_get_item( int snapid,
int index,
SNAP_ITEM * item )

Gets an item from a snapshot.

void *snap_find_item( int snapid,
int type,
int id )

Searches a snapshot for an item.

void snap_invalidate_item( int snapid,
int index )

Marks an item as invalid byt setting type and id to 0xffffffff.

+ + + + +

+ + + \ No newline at end of file diff --git a/docs/output/files2/e_if_client-h.html b/docs/output/files2/e_if_client-h.html new file mode 100644 index 00000000..dae39f94 --- /dev/null +++ b/docs/output/files2/e_if_client-h.html @@ -0,0 +1,127 @@ + + +Client Interface + + + + + + + + + +

Client Interface

Summary

Client Interface
Constants
Constants
Client States
Image Formats
Texture Loading Flags
Server Browser Sorting
Structures
SERVER_INFO_PLAYER
SERVER_INFO
Functions
Time
client_tick	Returns the tick of the current snapshot.
client_intratick	Returns the current intratick.
client_predtick	Returns the current predicted tick.
client_predintratick	Returns the current preticted intra tick.
client_ticktime	TODO
client_tickspeed	Returns how many ticks per second the client is doing.
client_frametime	Returns how long time the last frame took to process.
client_localtime	Returns the clients local time.
Server Browser
client_serverbrowse_refresh	Issues a refresh of the server browser.
client_serverbrowse_sorted_get	Returns server info from the sorted list.
client_serverbrowse_sorted_num	Returns how many servers there are in the sorted list.
client_serverbrowse_get	TODO
client_serverbrowse_num	TODO
client_serverbrowse_num_requests	TODO
client_serverbrowse_update	TODO
client_serverbrowse_lan	TODO
Actions
client_connect	Connects to a server at the specified address.
client_disconnect	Disconnects from the current server.
client_quit	Tells to client to shutdown.
client_rcon	Sends a command to the server to execute on it’s console.
client_rcon_auth	TODO
client_rcon_authed	TODO
Other
client_get_input	TODO
client_direct_input	TODO
client_error_string	TODO
client_connection_problems	Returns 1 if the client is connection problems.
client_state	Returns the state of the client.
client_mapdownload_amount	TODO
client_mapdownload_totalsize	TODO
client_save_line	TODO

+ +

Constants

Summary

Constants
Client States
Image Formats
Texture Loading Flags
Server Browser Sorting

+ +

Constants

+ +

Client States

CLIENTSTATE_OFFLINE	The client is offline.
CLIENTSTATE_CONNECTING	The client is trying to connect to a server.
CLIENTSTATE_LOADING	The client has connected to a server and is loading resources.
CLIENTSTATE_ONLINE	The client is connected to a server and running the game.
CLIENTSTATE_QUITING	The client is quiting.

+ +

Image Formats

IMG_AUTO	Lets the engine choose the format.
IMG_RGB	8-Bit uncompressed RGB
IMG_RGBA	8-Bit uncompressed RGBA
IMG_ALPHA	8-Bit uncompressed alpha

+ +

Texture Loading Flags

TEXLOAD_NORESAMPLE

Prevents the texture from any resampling

+ +

Server Browser Sorting

BROWSESORT_NAME	Sort by name.
BROWSESORT_PING	Sort by ping.
BROWSESORT_MAP	Sort by map
BROWSESORT_GAMETYPE	Sort by game type. DM, TDM etc.
BROWSESORT_PROGRESSION	Sort by progression.
BROWSESORT_NUMPLAYERS	Sort after how many players there are on the server.

+ +

Structures

+ +

SERVER_INFO_PLAYER

+ +

SERVER_INFO

+ +

Functions

Summary

Time
client_tick	Returns the tick of the current snapshot.
client_intratick	Returns the current intratick.
client_predtick	Returns the current predicted tick.
client_predintratick	Returns the current preticted intra tick.
client_ticktime	TODO
client_tickspeed	Returns how many ticks per second the client is doing.
client_frametime	Returns how long time the last frame took to process.
client_localtime	Returns the clients local time.
Server Browser
client_serverbrowse_refresh	Issues a refresh of the server browser.
client_serverbrowse_sorted_get	Returns server info from the sorted list.
client_serverbrowse_sorted_num	Returns how many servers there are in the sorted list.
client_serverbrowse_get	TODO
client_serverbrowse_num	TODO
client_serverbrowse_num_requests	TODO
client_serverbrowse_update	TODO
client_serverbrowse_lan	TODO
Actions
client_connect	Connects to a server at the specified address.
client_disconnect	Disconnects from the current server.
client_quit	Tells to client to shutdown.
client_rcon	Sends a command to the server to execute on it’s console.
client_rcon_auth	TODO
client_rcon_authed	TODO
Other
client_get_input	TODO
client_direct_input	TODO
client_error_string	TODO
client_connection_problems	Returns 1 if the client is connection problems.
client_state	Returns the state of the client.
client_mapdownload_amount	TODO
client_mapdownload_totalsize	TODO
client_save_line	TODO

+ +

Time

+ +

client_tick

int client_tick()

Returns the tick of the current snapshot.

+ +

client_intratick

float client_intratick()

Returns the current intratick.

Remarks

The intratick is how far gone the time is from the previous snapshot to the current. 0.0 means that it on the previous snapshot. 0.5 means that it’s halfway to the current, and 1.0 means that it is on the current snapshot. It can go beyond 1.0 which means that the client has started to extrapolate due to lack of data from the server.

client_predtick

int client_predtick()

Returns the current predicted tick.

+ +

client_predintratick

float client_predintratick()

Returns the current preticted intra tick.

Remarks

This is the same as client_intratick but for the current predicted tick and previous predicted tick.

client_ticktime

float client_ticktime()

TODO

Arguments

arg1

desc

Returns

client_tickspeed

int client_tickspeed()

Returns how many ticks per second the client is doing.

Remarks

This will be the same as the server tick speed.

+ +

client_frametime

float client_frametime()

Returns how long time the last frame took to process.

+ +

client_localtime

float client_localtime()

Returns the clients local time.

Remarks

The local time is set to 0 when the client starts and when it connects to a server. Can be used for client side effects.

+ +

Server Browser

+ +

client_serverbrowse_refresh

void client_serverbrowse_refresh( int lan )

Issues a refresh of the server browser.

Arguments

lan	Tells the function if it should do a LAN listing or an Internet listing.

Remarks

This will cause a broadcast on the local network if the lan argument is set. Otherwise it call ask all the master servers for their servers lists.

+ +

client_serverbrowse_sorted_get

SERVER_INFO *client_serverbrowse_sorted_get( int index )

Returns server info from the sorted list.

Arguments

index

Zero based index into the sorted list.

client_serverbrowse_sorted_num

int client_serverbrowse_sorted_num()

Returns how many servers there are in the sorted list.

client_serverbrowse_get

SERVER_INFO *client_serverbrowse_get( int index )

TODO

Arguments

arg1

desc

Returns

client_serverbrowse_num

int client_serverbrowse_num()

TODO

Arguments

arg1

desc

Returns

client_serverbrowse_num_requests

int client_serverbrowse_num_requests()

TODO

Arguments

arg1

desc

Returns

client_serverbrowse_update

void client_serverbrowse_update()

TODO

Arguments

arg1

desc

Returns

client_serverbrowse_lan

int client_serverbrowse_lan()

TODO

Arguments

arg1

desc

Returns

Actions

+ +

client_connect

void client_connect( const char * address )

Connects to a server at the specified address.

Arguments

address

Address of the server to connect to.

client_disconnect

void client_disconnect()

Disconnects from the current server.

Remarks

Does nothing if not connected to a server.

client_quit

void client_quit()

Tells to client to shutdown.

client_rcon

void client_rcon( const char * cmd )

Sends a command to the server to execute on it’s console.

Arguments

cmd	The command to send.

Remarks

The client must have the correct rcon password to connect.

client_rcon_auth

void client_rcon_auth( const char * name,
const char * password )

TODO

Arguments

arg1

desc

Returns

client_rcon_authed

int client_rcon_authed()

TODO

Arguments

arg1

desc

Returns

Other

+ +

client_get_input

int *client_get_input( int tick )

TODO

Arguments

arg1

desc

Returns

client_direct_input

void client_direct_input( int * input,
int size )

TODO

Arguments

arg1

desc

Returns

client_error_string

const char *client_error_string()

TODO

Arguments

arg1

desc

Returns

client_connection_problems

int client_connection_problems()

Returns 1 if the client is connection problems.

Remarks

Connections problems usually means that the client havn’t recvived any data from the server in a while.

+ +

client_state

int client_state()

Returns the state of the client.

client_mapdownload_amount

int client_mapdownload_amount()

TODO

Arguments

arg1

desc

Returns

client_mapdownload_totalsize

int client_mapdownload_totalsize()

TODO

Arguments

arg1

desc

Returns

client_save_line

void client_save_line( const char * line )

TODO

Arguments

arg1

desc

Returns

Graphics

Summary

Graphics
Structures
IMAGE_INFO
Variables
width	Contains the width of the image
height	Contains the height of the image
format	Contains the format of the image.
data	Pointer to the image data.
VIDEO_MODE
Functions
Quads
gfx_quads_begin	Begins a quad drawing session.
gfx_quads_end	Ends a quad session.
gfx_quads_setrotation	Sets the rotation to use when drawing a quad.
gfx_quads_setsubset	Sets the uv coordinates to use.
gfx_quads_setsubset_free	TODO
gfx_quads_drawTL	Draws a quad by specifying the top-left point.
gfx_quads_draw	Draws a quad by specifying the center point.
gfx_quads_draw_freeform	Draws a quad by specifying the corner points.
gfx_quads_text	TODO
Lines
gfx_lines_begin	TODO
gfx_lines_draw	TODO
gfx_lines_end	TODO
Text
gfx_text	TODO
gfx_text_width	TODO
gfx_text_color	TODO
gfx_text_set_default_font	TODO
Other
gfx_get_video_modes	Fetches a list of all the available video modes.
gfx_load_png	Loads a PNG image from disk.
gfx_load_texture	Loads a texture from a file.
gfx_load_texture_raw	Loads a texture from memory.
gfx_texture_set	Sets the active texture.
gfx_unload_texture	Unloads a texture.
gfx_clear	Clears the screen with the specified color.
gfx_screenaspect	Returns the aspect ratio between width and height.
gfx_screenwidth	Returns the screen width.
gfx_screenheight	Returns the screen height.
gfx_mapscreen	Specifies the coordinate system for the screen.
gfx_blend_normal	Set the active blending mode to normal (src, 1-src).
gfx_blend_additive	Set the active blending mode to additive (src, one).
gfx_blend_none	Disables blending
gfx_setcolorvertex	Sets the color of a vertex.
gfx_setcolor	Sets the color of all the vertices.
gfx_getscreen	TODO
gfx_memory_usage	TODO
gfx_screenshot	TODO
gfx_clip_enable	TODO
gfx_clip_disable	TODO

+ +

Structures

+ +

IMAGE_INFO

Summary

Variables
width	Contains the width of the image
height	Contains the height of the image
format	Contains the format of the image.
data	Pointer to the image data.

+ +

Variables

+ +

width

int width

Contains the width of the image

+ +

height

int height

Contains the height of the image

+ +

format

int format

Contains the format of the image. See Image Formats for more information.

+ +

data

void *data

Pointer to the image data.

+ +

VIDEO_MODE

+ +

Functions

Summary

Quads
gfx_quads_begin	Begins a quad drawing session.
gfx_quads_end	Ends a quad session.
gfx_quads_setrotation	Sets the rotation to use when drawing a quad.
gfx_quads_setsubset	Sets the uv coordinates to use.
gfx_quads_setsubset_free	TODO
gfx_quads_drawTL	Draws a quad by specifying the top-left point.
gfx_quads_draw	Draws a quad by specifying the center point.
gfx_quads_draw_freeform	Draws a quad by specifying the corner points.
gfx_quads_text	TODO
Lines
gfx_lines_begin	TODO
gfx_lines_draw	TODO
gfx_lines_end	TODO
Text
gfx_text	TODO
gfx_text_width	TODO
gfx_text_color	TODO
gfx_text_set_default_font	TODO
Other
gfx_get_video_modes	Fetches a list of all the available video modes.
gfx_load_png	Loads a PNG image from disk.
gfx_load_texture	Loads a texture from a file.
gfx_load_texture_raw	Loads a texture from memory.
gfx_texture_set	Sets the active texture.
gfx_unload_texture	Unloads a texture.
gfx_clear	Clears the screen with the specified color.
gfx_screenaspect	Returns the aspect ratio between width and height.
gfx_screenwidth	Returns the screen width.
gfx_screenheight	Returns the screen height.
gfx_mapscreen	Specifies the coordinate system for the screen.
gfx_blend_normal	Set the active blending mode to normal (src, 1-src).
gfx_blend_additive	Set the active blending mode to additive (src, one).
gfx_blend_none	Disables blending
gfx_setcolorvertex	Sets the color of a vertex.
gfx_setcolor	Sets the color of all the vertices.
gfx_getscreen	TODO
gfx_memory_usage	TODO
gfx_screenshot	TODO
gfx_clip_enable	TODO
gfx_clip_disable	TODO

+ +

Quads

+ +

gfx_quads_begin

void gfx_quads_begin()

Begins a quad drawing session.

Remarks

This functions resets the rotation, color and subset. End the session by using gfx_quads_end. You can’t change texture or blending mode during a session.

gfx_quads_end

void gfx_quads_end()

Ends a quad session.

gfx_quads_setrotation

void gfx_quads_setrotation( float angle )

Sets the rotation to use when drawing a quad.

Arguments

angle

Angle in radians.

Remarks

The angle is reset when gfx_quads_begin is called.

+ +

gfx_quads_setsubset

void gfx_quads_setsubset( float tl_u,
float tl_v,
float br_u,
float br_v )

Sets the uv coordinates to use.

Arguments

tl_u	Top-left U value.
tl_v	Top-left V value.
br_u	Bottom-right U value.
br_v	Bottom-right V value.

Remarks

O,0 is top-left of the texture and 1,1 is bottom-right. The color is reset when gfx_quads_begin is called.

+ +

gfx_quads_setsubset_free

void gfx_quads_setsubset_free( float x0,
float y0,
float x1,
float y1,
float x2,
float y2,
float x3,
float y3 )

TODO

Arguments

arg1

desc

Returns

gfx_quads_drawTL

void gfx_quads_drawTL( float x,
float y,
float width,
float height )

Draws a quad by specifying the top-left point.

Arguments

x	X coordinate of the top-left corner.
y	Y coordinate of the top-left corner.
width	Width of the quad.
height	Height of the quad.

Remarks

Rotation still occurs from the center of the quad. You must call gfx_quads_begin before calling this function.

gfx_quads_draw

void gfx_quads_draw( float x,
float y,
float w,
float h )

Draws a quad by specifying the center point.

Arguments

x	X coordinate of the center.
y	Y coordinate of the center.
width	Width of the quad.
height	Height of the quad.

Remarks

You must call gfx_quads_begin before calling this function.

gfx_quads_draw_freeform

void gfx_quads_draw_freeform( float x0,
float y0,
float x1,
float y1,
float x2,
float y2,
float x3,
float y3 )

Draws a quad by specifying the corner points.

Arguments

x0, y0	Coordinates of the upper left corner.
x1, y1	Coordinates of the upper right corner.
x2, y2	Coordinates of the lower left corner. // TODO: DOUBLE CHECK!!!
x3, y3	Coordinates of the lower right corner. // TODO: DOUBLE CHECK!!!

gfx_quads_text

void gfx_quads_text( float x,
float y,
float size,
const char * text )

TODO

Arguments

arg1

desc

Returns

Lines

+ +

gfx_lines_begin

void gfx_lines_begin()

TODO

Arguments

arg1

desc

Returns

gfx_lines_draw

void gfx_lines_draw( float x0,
float y0,
float x1,
float y1 )

TODO

Arguments

arg1

desc

Returns

gfx_lines_end

void gfx_lines_end()

TODO

Arguments

arg1

desc

Returns

Text

+ +

gfx_text

void gfx_text( void * font,
float x,
float y,
float size,
const char * text,
int max_width )

TODO

Arguments

arg1

desc

Returns

returns the number of lines written See Also: <other_func>

+ +

gfx_text_width

float gfx_text_width( void * font,
float size,
const char * text,
int length )

TODO

Arguments

arg1

desc

Returns

gfx_text_color

void gfx_text_color( float r,
float g,
float b,
float a )

TODO

Arguments

arg1

desc

Returns

gfx_text_set_default_font

void gfx_text_set_default_font( void * font )

TODO

Arguments

arg1

desc

Returns

Other

+ +

gfx_get_video_modes

int gfx_get_video_modes( VIDEO_MODE * list,
int maxcount )

Fetches a list of all the available video modes.

Arguments

list	An array to recive the modes. Must be able to contain maxcount number of modes.
maxcount	The maximum number of modes to fetch.

Returns

The number of video modes that was fetched.

+ +

gfx_load_png

int gfx_load_png( IMAGE_INFO * img,
const char * filename )

Loads a PNG image from disk.

Arguments

img	Pointer to an structure to be filled out with the image information.
filename	Filename of the image to load.

Returns

Returns non-zero on success and zero on error.

Remarks

The caller are responsible for cleaning up the allocated memory in the IMAGE_INFO structure.

gfx_load_texture

int gfx_load_texture( const char * filename,
int store_format,
int flags )

Loads a texture from a file. TGA and PNG supported.

Arguments

filename	Null terminated string to the file to load.
store_format	What format to store on gfx card as.
flags	controls how the texture is uploaded

Returns

An ID to the texture. -1 on failure.

gfx_load_texture_raw

int gfx_load_texture_raw( int w,
int h,
int format,
const void * data,
int store_format,
int flags )

Loads a texture from memory.

Arguments

w	Width of the texture.
h	Height of the texture.
data	Pointer to the pixel data.
format	Format of the pixel data.
store_format	The format to store the texture on the graphics card.
flags	controls how the texture is uploaded

Returns

An ID to the texture. -1 on failure.

Remarks

The pixel data should be in RGBA format with 8 bit per component. So the total size of the data should be w*h*4.

gfx_texture_set

void gfx_texture_set( int id )

Sets the active texture.

Arguments

id	ID to the texture to set.

+ +

gfx_unload_texture

int gfx_unload_texture( int id )

Unloads a texture.

Arguments

id	ID to the texture to unload.

Remarks

NOT IMPLEMENTED

+ +

gfx_clear

void gfx_clear( float r,
float g,
float b )

Clears the screen with the specified color.

Arguments

r	Red component.
g	Green component.
b	Red component.

Remarks

The value of the components are given in 0.0

1.0 ranges.

+ +

gfx_screenaspect

float gfx_screenaspect()

Returns the aspect ratio between width and height.

gfx_screenwidth

int gfx_screenwidth()

Returns the screen width.

gfx_screenheight

int gfx_screenheight()

Returns the screen height.

gfx_mapscreen

void gfx_mapscreen( float tl_x,
float tl_y,
float br_x,
float br_y )

Specifies the coordinate system for the screen.

Arguments

tl_x	Top-left X
tl_y	Top-left Y
br_x	Bottom-right X
br_y	Bottom-right y

+ +

gfx_blend_normal

void gfx_blend_normal()

Set the active blending mode to normal (src, 1-src).

Remarks

This must be used before calling gfx_quads_begin. This is equal to glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA).

gfx_blend_additive

void gfx_blend_additive()

Set the active blending mode to additive (src, one).

Remarks

This must be used before calling gfx_quads_begin. This is equal to glBlendFunc(GL_SRC_ALPHA, GL_ONE).

gfx_blend_none

void gfx_blend_none()

Disables blending

Remarks

This must be used before calling gfx_quads_begin.

gfx_setcolorvertex

void gfx_setcolorvertex( int i,
float r,
float g,
float b,
float a )

Sets the color of a vertex.

Arguments

i	Index to the vertex.
r	Red value.
g	Green value.
b	Blue value.
a	Alpha value.

Remarks

The color values are from 0.0 to 1.0. The color is reset when gfx_quads_begin is called.

+ +

gfx_setcolor

void gfx_setcolor( float r,
float g,
float b,
float a )

Sets the color of all the vertices.

Arguments

r	Red value.
g	Green value.
b	Blue value.
a	Alpha value.

Remarks

The color values are from 0.0 to 1.0. The color is reset when gfx_quads_begin is called.

+ +

gfx_getscreen

void gfx_getscreen( float * tl_x,
float * tl_y,
float * br_x,
float * br_y )

TODO

Arguments

arg1

desc

Returns

gfx_memory_usage

int gfx_memory_usage()

TODO

Arguments

arg1

desc

Returns

gfx_screenshot

void gfx_screenshot()

TODO

Arguments

arg1

desc

Returns

gfx_clip_enable

void gfx_clip_enable( int x,
int y,
int w,
int h )

TODO

Arguments

arg1

desc

Returns

gfx_clip_disable

void gfx_clip_disable()

TODO

Arguments

arg1

desc

Returns

Input

Summary

Input
INPUT_EVENT
Functions
inp_mouse_relative	Fetches the mouse movements.
inp_mouse_scroll	TODO
inp_key_pressed	Checks if a key is pressed.
inp_key_was_pressed	TODO
inp_key_down	TODO
inp_num_events	TODO
inp_get_event	TODO
inp_clear_events	TODO
inp_mouse_doubleclick	TODO
inp_key_presses	TODO
inp_key_releases	TODO
inp_key_state	TODO
inp_key_name	TODO
inp_key_code	TODO
inp_clear_key_states	TODO

+ +

INPUT_EVENT

Summary

Functions
inp_mouse_relative	Fetches the mouse movements.
inp_mouse_scroll	TODO
inp_key_pressed	Checks if a key is pressed.
inp_key_was_pressed	TODO
inp_key_down	TODO
inp_num_events	TODO
inp_get_event	TODO
inp_clear_events	TODO
inp_mouse_doubleclick	TODO
inp_key_presses	TODO
inp_key_releases	TODO
inp_key_state	TODO
inp_key_name	TODO
inp_key_code	TODO
inp_clear_key_states	TODO

+ +

Functions

+ +

inp_mouse_relative

void inp_mouse_relative( int * x,
int * y )

Fetches the mouse movements.

Arguments

x	Pointer to the variable that should get the X movement.
y	Pointer to the variable that should get the Y movement.

+ +

inp_mouse_scroll

int inp_mouse_scroll()

TODO

Arguments

arg1

desc

Returns

inp_key_pressed

int inp_key_pressed( int key )

Checks if a key is pressed.

Arguments

key	Index to the key to check

Returns

Returns 1 if the button is pressed, otherwise 0.

Remarks

Check keys.h for the keys.

+ +

inp_key_was_pressed

int inp_key_was_pressed( int key )

TODO

Arguments

arg1

desc

Returns

inp_key_down

int inp_key_down( int key )

TODO

Arguments

arg1

desc

Returns

inp_num_events

int inp_num_events()

TODO

Arguments

arg1

desc

Returns

inp_get_event

INPUT_EVENT inp_get_event( int index )

TODO

Arguments

arg1

desc

Returns

inp_clear_events

void inp_clear_events()

TODO

Arguments

arg1

desc

Returns

inp_mouse_doubleclick

int inp_mouse_doubleclick()

TODO

Arguments

arg1

desc

Returns

inp_key_presses

int inp_key_presses( int key )

TODO

Arguments

arg1

desc

Returns

inp_key_releases

int inp_key_releases( int key )

TODO

Arguments

arg1

desc

Returns

inp_key_state

int inp_key_state( int key )

TODO

Arguments

arg1

desc

Returns

inp_key_name

const char *inp_key_name( int k )

TODO

Arguments

arg1

desc

Returns

inp_key_code

int inp_key_code( const char * key_name )

TODO

Arguments

arg1

desc

Returns

inp_clear_key_states

void inp_clear_key_states()

TODO

Arguments

arg1

desc

Returns

Client Hooks

Summary

Client Hooks
Functions
modc_console_init	TODO
modc_rcon_line	TODO
modc_save_config	TODO
modc_init	Called when the client starts.
modc_newsnapshot	Called when the client progressed to a new snapshot.
modc_entergame	Called when the client has successfully connect to a server and loaded a map.
modc_shutdown	Called when the client closes down.
modc_render	Called every frame to let the game render it self.
modc_statechange	Called every time client changes state.
modc_connected	TODO
modc_message	TODO
modc_predict	TODO
modc_snap_input	TODO
modc_net_version	TODO

+ +

Functions

+ +

modc_console_init

void modc_console_init()

TODO

+ +

modc_rcon_line

void modc_rcon_line( const char * line )

TODO

+ +

modc_save_config

void modc_save_config()

TODO

+ +

modc_init

void modc_init()

Called when the client starts.

Remarks

The game should load resources that are used during the entire time of the game. No map is loaded.

+ +

modc_newsnapshot

void modc_newsnapshot()

Called when the client progressed to a new snapshot.

Remarks

The client can check for items in the snapshot and perform one time events like playing sounds, spawning client side effects etc.

+ +

modc_entergame

void modc_entergame()

Called when the client has successfully connect to a server and loaded a map.

Remarks

The client can check for items in the map and load them.

+ +

modc_shutdown

void modc_shutdown()

Called when the client closes down.

+ +

modc_render

void modc_render()

Called every frame to let the game render it self.

+ +

modc_statechange

void modc_statechange( int new_state,
int old_state )

Called every time client changes state.

+ +

modc_connected

void modc_connected()

TODO

Arguments

arg1

desc

Returns

modc_message

void modc_message( int msg )

TODO

Arguments

arg1

desc

Returns

modc_predict

void modc_predict()

TODO

Arguments

arg1

desc

Returns

modc_snap_input

int modc_snap_input( int * data )

TODO

Arguments

arg1

desc

Returns

modc_net_version

const char *modc_net_version()

TODO

Arguments

arg1

desc

Returns

Server Hooks

Summary

Server Hooks
Functions
mods_console_init	TODO
mods_init	Called when the server is started.
mods_shutdown	Called when the server quits.
mods_client_enter	Called when a client has joined the game.
mods_client_drop	Called when a client drops from the server.
mods_client_direct_input	Called when the server recives new input from a client.
mods_client_predicted_input	Called when the server applys the predicted input on the client.
mods_tick	Called with a regular interval to progress the gameplay.
mods_presnap	Called before the server starts to construct snapshots for the clients.
mods_snap	Called to create the snapshot for a client.
mods_postsnap	Called after the server is done sending the snapshots.
mods_connected	TODO
mods_net_version	TODO
mods_version	TODO
mods_message	TODO

+ +

Functions

+ +

mods_console_init

void mods_console_init()

TODO

+ +

mods_init

void mods_init()

Called when the server is started.

Remarks

It’s called after the map is loaded so all map items are available.

+ +

mods_shutdown

void mods_shutdown()

Called when the server quits.

Remarks

Should be used to clean up all resources used.

+ +

mods_client_enter

void mods_client_enter( int cid )

Called when a client has joined the game.

Arguments

cid	Client ID. Is 0 - MAX_CLIENTS.

Remarks

It’s called when the client is finished loading and should enter gameplay.

+ +

mods_client_drop

void mods_client_drop( int cid )

Called when a client drops from the server.

Arguments

cid	Client ID. Is 0 - MAX_CLIENTS

+ +

mods_client_direct_input

void mods_client_direct_input( int cid,
void * input )

Called when the server recives new input from a client.

Arguments

cid	Client ID. Is 0 - MAX_CLIENTS.
input	Pointer to the input data.
size	Size of the data. (NOT IMPLEMENTED YET)

+ +

mods_client_predicted_input

void mods_client_predicted_input( int cid,
void * input )

Called when the server applys the predicted input on the client.

Arguments

cid	Client ID. Is 0 - MAX_CLIENTS.
input	Pointer to the input data.
size	Size of the data. (NOT IMPLEMENTED YET)

+ +

mods_tick

void mods_tick()

Called with a regular interval to progress the gameplay.

Remarks

The SERVER_TICK_SPEED tells the number of ticks per second.

+ +

mods_presnap

void mods_presnap()

Called before the server starts to construct snapshots for the clients.

+ +

mods_snap

void mods_snap( int cid )

Called to create the snapshot for a client.

Arguments

cid	Client ID. Is 0 - MAX_CLIENTS.

Remarks

The game should make a series of calls to snap_new_item to construct the snapshot for the client.

+ +

mods_postsnap

void mods_postsnap()

Called after the server is done sending the snapshots.

+ +

mods_connected

void mods_connected( int client_id )

TODO

Arguments

arg1

desc

Returns

mods_net_version

const char *mods_net_version()

TODO

Arguments

arg1

desc

Returns

mods_version

const char *mods_version()

TODO

Arguments

arg1

desc

Returns

mods_message

void mods_message( int msg,
int client_id )

TODO

Arguments

arg1

desc

Returns

Messaging

Summary

Messaging
Functions
msg_pack_start	TODO
msg_pack_int	TODO
msg_pack_string	TODO
msg_pack_raw	TODO
msg_pack_end	TODO
msg_unpack_int	TODO
msg_unpack_string	TODO
msg_unpack_raw	TODO
msg_unpack_error	TODO

+ +

Functions

+ +

msg_pack_start

void msg_pack_start( int msg,
int flags )

TODO

Arguments

arg1

desc

Returns

msg_pack_int

void msg_pack_int( int i )

TODO

Arguments

arg1

desc

Returns

msg_pack_string

void msg_pack_string( const char * p,
int limit )

TODO

Arguments

arg1

desc

Returns

msg_pack_raw

void msg_pack_raw( const void * data,
int size )

TODO

Arguments

arg1

desc

Returns

msg_pack_end

void msg_pack_end()

TODO

Arguments

arg1

desc

Returns

msg_unpack_int

int msg_unpack_int()

TODO

Arguments

arg1

desc

Returns

msg_unpack_string

const char *msg_unpack_string()

TODO

Arguments

arg1

desc

Returns

msg_unpack_raw

const unsigned char *msg_unpack_raw( int size )

TODO

Arguments

arg1

desc

Returns

msg_unpack_error

int msg_unpack_error()

TODO

Arguments

arg1

desc

Returns

Engine Interface

Summary

Engine Interface
SNAP_ITEM
CLIENT_INFO
Map
Functions
map_is_loaded	Checks if a map is loaded.
map_num_items	Checks the number of items in the loaded map.
map_find_item	Searches the map for an item.
map_get_item	Gets an item from the loaded map from index.
map_get_type	Gets the index range of an item type.
map_get_data	Fetches a pointer to a raw data chunk in the map.
map_get_data_swapped	TODO
Network (Server)
Functions
snap_new_item	Creates a new item that should be sent.
snap_num_items	Check the number of items in a snapshot.
snap_get_item	Gets an item from a snapshot.
snap_find_item	Searches a snapshot for an item.
snap_invalidate_item	Marks an item as invalid byt setting type and id to 0xffffffff.
snap_input	Sets the input data to send to the server.
snap_set_staticsize	Tells the engine how big a specific item always will be.
server_send_msg	TODO
client_send_msg	TODO
snap_new_id	TODO
snap_free_id	TODO
map_unload_data	TODO

+ +

SNAP_ITEM

+ +

CLIENT_INFO

+ +

Map

Summary

Functions
map_is_loaded	Checks if a map is loaded.
map_num_items	Checks the number of items in the loaded map.
map_find_item	Searches the map for an item.
map_get_item	Gets an item from the loaded map from index.
map_get_type	Gets the index range of an item type.
map_get_data	Fetches a pointer to a raw data chunk in the map.
map_get_data_swapped	TODO

+ +

Functions

+ +

map_is_loaded

int map_is_loaded()

Checks if a map is loaded.

Returns

Returns 1 if the button is pressed, otherwise 0.

+ +

map_num_items

int map_num_items()

Checks the number of items in the loaded map.

Returns

Returns the number of items. 0 if no map is loaded.

+ +

map_find_item

void *map_find_item( int type,
int id )

Searches the map for an item.

Arguments

type	Item type.
id	Item ID.

Returns

Returns a pointer to the item if it exists, otherwise it returns NULL.

+ +

map_get_item

void *map_get_item( int index,
int * type,
int * id )

Gets an item from the loaded map from index.

Arguments

index	Item index.
type	Pointer that recives the item type (can be NULL).
id	Pointer that recives the item id (can be NULL).

Returns

Returns a pointer to the item if it exists, otherwise it returns NULL.

+ +

map_get_type

void map_get_type( int type,
int * start,
int * num )

Gets the index range of an item type.

Arguments

type	Item type to search for.
start	Pointer that recives the starting index.
num	Pointer that recives the number of items.

Returns

If the item type is not in the map, start and num will be set to 0.

+ +

map_get_data

void *map_get_data( int index )

Fetches a pointer to a raw data chunk in the map.

Arguments

index

Index to the data to fetch.

Returns

A pointer to the raw data, otherwise 0.

+ +

map_get_data_swapped

void *map_get_data_swapped( int index )

TODO

Arguments

arg1

desc

Returns

Network (Server)

Summary

Functions
snap_new_item	Creates a new item that should be sent.
snap_num_items	Check the number of items in a snapshot.
snap_get_item	Gets an item from a snapshot.
snap_find_item	Searches a snapshot for an item.
snap_invalidate_item	Marks an item as invalid byt setting type and id to 0xffffffff.
snap_input	Sets the input data to send to the server.
snap_set_staticsize	Tells the engine how big a specific item always will be.
server_send_msg	TODO
client_send_msg	TODO
snap_new_id	TODO
snap_free_id	TODO
map_unload_data	TODO

+ +

Functions

+ +

snap_new_item

void *snap_new_item( int type,
int id,
int size )

Creates a new item that should be sent.

Arguments

type	Type of the item.
id	ID of the item.
size	Size of the item.

Returns

A pointer to the item data, otherwise 0.

Remarks

The item data should only consist pf 4 byte integers as they are subject to byte swapping. This means that the size argument should be dividable by 4.

+ +

snap_num_items

int snap_num_items( int snapid )

Check the number of items in a snapshot.

Arguments

snapid

Snapshot ID to the data to fetch.

SNAP_PREV for previous snapshot.
SNAP_CUR for current snapshot.

Returns

The number of items in the snapshot.

+ +

snap_get_item

void *snap_get_item( int snapid,
int index,
SNAP_ITEM * item )

Gets an item from a snapshot.

Arguments

snapid

Snapshot ID to the data to fetch.

SNAP_PREV for previous snapshot.
SNAP_CUR for current snapshot.

index	Index of the item.
item	Pointer that recives the item info.

Returns

Returns a pointer to the item if it exists, otherwise NULL.

+ +

snap_find_item

void *snap_find_item( int snapid,
int type,
int id )

Searches a snapshot for an item.

Arguments

snapid

Snapshot ID to the data to fetch.

SNAP_PREV for previous snapshot.
SNAP_CUR for current snapshot.

type	Type of the item.
id	ID of the item.

Returns

Returns a pointer to the item if it exists, otherwise NULL.

+ +

snap_invalidate_item

void snap_invalidate_item( int snapid,
int index )

Marks an item as invalid byt setting type and id to 0xffffffff.

Arguments

snapid

Snapshot ID to the data to fetch.

SNAP_PREV for previous snapshot.
SNAP_CUR for current snapshot.

index

Index of the item.

+ +

snap_input

void snap_input( void * data,
int size )

Sets the input data to send to the server.

Arguments

data	Pointer to the data.
size	Size of the data.

Remarks

The data should only consist of 4 bytes integer as they are subject to byte swapping.

+ +

snap_set_staticsize

void snap_set_staticsize( int type,
int size )

Tells the engine how big a specific item always will be. This helps the engine to compress snapshots better.

Arguments

type	Item type
size	Size of the data.

Remarks

Size must be in a multiple of 4.

+ +

server_send_msg

int server_send_msg( int client_id )

TODO

Arguments

arg1

desc

Returns

client_send_msg

int client_send_msg()

TODO

Arguments

arg1

desc

Returns

snap_new_id

int snap_new_id()

TODO

Arguments

arg1

desc

Returns

snap_free_id

void snap_free_id( int id )

TODO

Arguments

arg1

desc

Returns

map_unload_data

void map_unload_data( int index )

TODO

Arguments

arg1

desc

Returns

Server Interface

Summary

Server Interface
Functions
server_getclientinfo	TODO
server_clientname	TODO
server_latestinput	TODO
server_setclientname	TODO
server_setclientscore	TODO
server_setbrowseinfo	TODO
server_kick	TODO
server_tick	TODO
server_tickspeed	TODO

+ +

Functions

+ +

server_getclientinfo

int server_getclientinfo( int client_id,
CLIENT_INFO * info )

TODO

Arguments

arg1

desc

Returns

server_clientname

const char *server_clientname( int client_id )

TODO

Arguments

arg1

desc

Returns

server_latestinput

int *server_latestinput( int client_id,
int * size )

TODO

Arguments

arg1

desc

Returns

server_setclientname

void server_setclientname( int client_id,
const char * name )

TODO

Arguments

arg1

desc

Returns

server_setclientscore

void server_setclientscore( int client_id,
int score )

TODO

Arguments

arg1

desc

Returns

server_setbrowseinfo

void server_setbrowseinfo( int game_type,
int progression )

TODO

Arguments

arg1

desc

Returns

server_kick

void server_kick( int client_id,
const char * reason )

TODO

Arguments

arg1

desc

Returns

server_tick

int server_tick()

TODO

Arguments

arg1

desc

Returns

server_tickspeed

int server_tickspeed()

TODO

Arguments

arg1

desc

Returns

Sound

Summary

Sound
Functions
snd_set_channel	Sets the parameters for a sound channel.
snd_load_wv	Loads a wavpack compressed sound.
snd_play_at	Plays a sound at a specified postition.
snd_play	Plays a sound.
snd_stop	Stops a currenly playing sound.
snd_set_listener_pos	Sets the listener posititon.

+ +

Functions

+ +

snd_set_channel

void snd_set_channel( int cid,
float vol,
float pan )

Sets the parameters for a sound channel.

Arguments

cid	Channel ID
vol	Volume for the channel. 0.0 to 1.0.
pan	Panning for the channel. -1.0 is all left. 0.0 is equal distribution. 1.0 is all right.

+ +

snd_load_wv

int snd_load_wv( const char * filename )

Loads a wavpack compressed sound.

Arguments

filename

Filename of the file to load

Returns

The id of the loaded sound. -1 on failure.

+ +

snd_play_at

int snd_play_at( int cid,
int sid,
int flags,
float x,
float y )

Plays a sound at a specified postition.

Arguments

cid	Channel id of the channel to use.
sid	Sound id of the sound to play.
flags	TODO
x	TODO
y	TODO

Returns

An id to the voice. -1 on failure.

snd_play

int snd_play( int cid,
int sid,
int flags )

Plays a sound.

Arguments

Arguments: cid - Channel id of the channel to use. sid - Sound id of the sound to play. flags - TODO

Returns

An id to the voice. -1 on failure.

snd_stop

void snd_stop( int id )

Stops a currenly playing sound.

Arguments

id	The ID of the voice to stop.

snd_set_listener_pos

void snd_set_listener_pos( float x,
float y )

Sets the listener posititon.

Arguments

x	TODO
y	TODO

+ +

+ + + + + + + + + + +

void snd_set_channel( int cid,
float vol,
float pan )

Sets the parameters for a sound channel.

int snd_load_wv( const char * filename )

Loads a wavpack compressed sound.

int snd_play_at( int cid,
int sid,
int flags,
float x,
float y )

Plays a sound at a specified postition.

int snd_play( int cid,
int sid,
int flags )

Plays a sound.

void snd_stop( int id )

Stops a currenly playing sound.

void snd_set_listener_pos( float x,
float y )

Sets the listener posititon.

+ + + + +

+ + + \ No newline at end of file diff --git a/docs/output/files2/e_system-h.html b/docs/output/files2/e_system-h.html new file mode 100644 index 00000000..9333e410 --- /dev/null +++ b/docs/output/files2/e_system-h.html @@ -0,0 +1,183 @@ + + +OS Abstraction + + + + + + + + + +

OS Abstraction

Summary

OS Abstraction
Debug
dbg_assert	Breaks into the debugger based on a test.
dbg_break	Breaks into the debugger.
dbg_msg	Prints a debug message.
Memory
mem_alloc	Allocates memory.
mem_free	Frees a block allocated through mem_alloc.
mem_copy	Copies a a memory block.
mem_move	Copies a a memory block
mem_zero	Sets a complete memory block to 0
mem_comp	Compares two blocks of memory
File IO
io_open	Opens a file.
io_read	Reads data into a buffer from a file.
io_skip	Skips data in a file.
io_write	Writes data from a buffer to file.
io_seek	Seeks to a specified offset in the file.
io_tell	Gets the current position in the file.
io_length	Gets the total length of the file.
io_close	Closes a file.
io_flush	Empties all buffers and writes all pending data.
io_stdin	Returns an <IOHANDLE> to the standard input.
io_stdout	Returns an <IOHANDLE> to the standard output.
io_stderr	Returns an <IOHANDLE> to the standard error.
Threads
thread_sleep	Suspends the current thread for a given period.
thread_create	Creates a new thread.
thread_wait	Waits for a thread to be done or destroyed.
thread_destoy	Destroys a thread.
thread_yeild	Yeild the current threads execution slice.
Locks
Timer
time_get	Fetches a sample from a high resolution timer.
time_freq	Returns the frequency of the high resolution timer.
time_timestamp	Retrives the current time as a UNIX timestamp
Network General
net_init	Initiates network functionallity.
net_host_lookup	Does a hostname lookup by name and fills out the passed NETADDR struct with the recieved details.
net_addr_comp	Compares two network addresses.
net_addr_str	Turns a network address into a representive string.
Network UDP
net_udp_create	Creates a UDP socket and binds it to a port.
net_udp_send	Sends a packet over an UDP socket.
net_udp_recv	Recives a packet over an UDP socket.
net_udp_close	Closes an UDP socket.
Network TCP
net_tcp_create	Creates a TCP socket.
net_tcp_listen	Makes the socket start listening for new connections.
net_tcp_accept	Polls a listning socket for a new connection.
net_tcp_connect	Connects one socket to another.
net_tcp_send	Sends data to a TCP stream.
net_tcp_recv	Recvives data from a TCP stream.
net_tcp_close	Closes a TCP socket.
Strings
str_append	Appends a string to another.
str_copy	Copies a string to another.
str_format	Performs printf formating into a buffer.
str_sanitize_strong	Replaces all characters below 32 and above 127 with whitespace.
str_sanitize	Replaces all characters below 32 and above 127 with whitespace with exception to \r, \n and \r.
str_comp_nocase	Compares to strings case insensitive.
str_find_nocase	Finds a string inside another string case insensitive.
str_hex	Takes a datablock and generates a hexstring of it.
Filesystem
fs_listdir	Lists the files in a directory
fs_makedir	Creates a directory
fs_storage_path	Fetches per user configuration directory.
Undocumented
net_tcp_connect_non_blocking	DOCTODO: serp
net_tcp_set_non_blocking	DOCTODO: serp
net_tcp_set_non_blocking	DOCTODO: serp
net_errno	DOCTODO: serp
net_would_block	DOCTODO: serp

+ +

Debug

+ +

dbg_assert

void dbg_assert( int test,
const char * msg )

Breaks into the debugger based on a test.

Parameters

test	Result of the test.
msg	Message that should be printed if the test fails.

Remarks

Does nothing in release version of the library.

dbg_break

void dbg_break()

Breaks into the debugger.

Remarks

Does nothing in release version of the library.

dbg_msg

void dbg_msg( const char * sys,
const char * fmt,
... )

Prints a debug message.

Parameters

sys	A string that describes what system the message belongs to
fmt	A printf styled format string.

Remarks

Does nothing in relase version of the library.

Memory

+ +

mem_alloc

void *mem_alloc_debug( const char * filename,
int line,
unsigned size,
unsigned alignment )

Allocates memory.

Parameters

size	Size of the needed block.
alignment	Alignment for the block.

Returns

Returns a pointer to the newly allocated block. Returns a null pointer if the memory couldn’t be allocated.

Remarks

Passing 0 to size will allocated the smallest amount possible and return a unique pointer.

mem_free

void mem_free( void * block )

Frees a block allocated through mem_alloc.

Remarks

In the debug version of the library the function will assert if a non-valid block is passed, like a null pointer or a block that isn’t allocated.

mem_copy

void mem_copy( void * dest,
const void * source,
unsigned size )

Copies a a memory block.

Parameters

dest	Destination.
source	Source to copy.
size	Size of the block to copy.

Remarks

This functions DOES NOT handles cases where source and destination is overlapping.

mem_move

void mem_move( void * dest,
const void * source,
unsigned size )

Copies a a memory block

Parameters

dest	Destination
source	Source to copy
size	Size of the block to copy

Remarks

This functions handles cases where source and destination is overlapping

mem_zero

void mem_zero( void * block,
unsigned size )

Sets a complete memory block to 0

Parameters

block	Pointer to the block to zero out
size	Size of the block

+ +

mem_comp

int mem_comp( const void * a,
const void * b,
int size )

Compares two blocks of memory

Parameters

a	First block of data
b	Second block of data
size	Size of the data to compare

Returns

<0	Block a is lesser then block b
0	Block a is equal to block b

0 - Block a is greater then block b

+ +

File IO

+ +

io_open

IOHANDLE io_open( const char * filename,
int flags )

Opens a file.

Parameters

filename	File to open.
flags	A set of flags. IOFLAG_READ, IOFLAG_WRITE, IOFLAG_RANDOM.

Returns

Returns a handle to the file on success and 0 on failure.

+ +

io_read

unsigned io_read( IOHANDLE io,
void * buffer,
unsigned size )

Reads data into a buffer from a file.

Parameters

io	Handle to the file to read data from.
buffer	Pointer to the buffer that will recive the data.
size	Number of bytes to read from the file.

Returns

Number of bytes read.

+ +

io_skip

unsigned io_skip( IOHANDLE io,
unsigned size )

Skips data in a file.

Parameters

io	Handle to the file.
size	Number of bytes to skip.

Returns

Number of bytes skipped.

+ +

io_write

unsigned io_write( IOHANDLE io,
const void * buffer,
unsigned size )

Writes data from a buffer to file.

Parameters

io	Handle to the file.
buffer	Pointer to the data that should be written.
size	Number of bytes to write.

Returns

Number of bytes written.

+ +

io_seek

int io_seek( IOHANDLE io,
int offset,
int origin )

Seeks to a specified offset in the file.

Parameters

io	Handle to the file.
offset	Offset from pos to stop.
origin	Position to start searching from.

Returns

Returns 0 on success.

+ +

io_tell

long int io_tell( IOHANDLE io )

Gets the current position in the file.

Parameters

io	Handle to the file.

Returns

Returns the current position. -1L if an error occured.

+ +

io_length

long int io_length( IOHANDLE io )

Gets the total length of the file. Resetting cursor to the beginning

Parameters

io	Handle to the file.

Returns

Returns the total size. -1L if an error occured.

+ +

io_close

int io_close( IOHANDLE io )

Closes a file.

Parameters

io	Handle to the file.

Returns

Returns 0 on success.

+ +

io_flush

int io_flush( IOHANDLE io )

Empties all buffers and writes all pending data.

Parameters

io	Handle to the file.

Returns

Returns 0 on success.

+ +

io_stdin

IOHANDLE io_stdin()

Returns an <IOHANDLE> to the standard input.

+ +

io_stdout

IOHANDLE io_stdout()

Returns an <IOHANDLE> to the standard output.

+ +

io_stderr

IOHANDLE io_stderr()

Returns an <IOHANDLE> to the standard error.

+ +

Threads

+ +

thread_sleep

void thread_sleep( int milliseconds )

Suspends the current thread for a given period.

Parameters

milliseconds

Number of milliseconds to sleep.

+ +

thread_create

void *thread_create( void (*threadfunc)(void *),
void * user )

Creates a new thread.

Parameters

threadfunc	Entry point for the new thread.
user	Pointer to pass to the thread.

+ +

thread_wait

void thread_wait( void * thread )

Waits for a thread to be done or destroyed.

Parameters

thread

Thread to wait for.

+ +

thread_destoy

Destroys a thread.

Parameters

thread

Thread to destroy.

+ +

thread_yeild

Yeild the current threads execution slice.

+ +

Locks

+ +

Timer

+ +

time_get

int64 time_get()

Fetches a sample from a high resolution timer.

Returns

Current value of the timer.

Remarks

To know how fast the timer is ticking, see time_freq.

+ +

time_freq

int64 time_freq()

Returns the frequency of the high resolution timer.

Returns

Returns the frequency of the high resolution timer.

+ +

time_timestamp

unsigned time_timestamp()

Retrives the current time as a UNIX timestamp

Returns

The time as a UNIX timestamp

+ +

Network General

+ +

net_init

int net_init()

Initiates network functionallity.

Returns

Returns 0 on success,

Remarks

You must call this function before using any other network functions.

+ +

net_host_lookup

int net_host_lookup( const char * hostname,
NETADDR * addr,
int types )

Does a hostname lookup by name and fills out the passed NETADDR struct with the recieved details.

Returns

0 on success.

+ +

net_addr_comp

int net_addr_comp( const NETADDR * a,
const NETADDR * b )

Compares two network addresses.

Parameters

a	Address to compare
b	Address to compare to.

Returns

<0	Address a is lesser then address b
0	Address a is equal to address b

0 - Address a is greater then address b

+ +

net_addr_str

int net_addr_str( const NETADDR * addr,
char * string,
int max_length )

Turns a network address into a representive string.

Parameters

addr	Address to turn into a string.
string	Buffer to fill with the string.
max_length	Maximum size of the string.

Remarks

The string will always be zero terminated

+ +

Network UDP

+ +

net_udp_create

NETSOCKET net_udp_create( NETADDR bindaddr )

Creates a UDP socket and binds it to a port.

Parameters

bindaddr

Address to bind the socket to.

Returns

On success it returns an handle to the socket. On failure it returns NETSOCKET_INVALID.

+ +

net_udp_send

int net_udp_send( NETSOCKET sock,
const NETADDR * addr,
const void * data,
int size )

Sends a packet over an UDP socket.

Parameters

sock	Socket to use.
addr	Where to send the packet.
data	Pointer to the packet data to send.
size	Size of the packet.

Returns

On success it returns the number of bytes sent. Returns -1 on error.

+ +

net_udp_recv

int net_udp_recv( NETSOCKET sock,
NETADDR * addr,
void * data,
int maxsize )

Recives a packet over an UDP socket.

Parameters

sock	Socket to use.
addr	Pointer to an NETADDR that will recive the address.
data	Pointer to a buffer that will recive the data.
maxsize	Maximum size to recive.

Returns

On success it returns the number of bytes recived. Returns -1 on error.

+ +

net_udp_close

int net_udp_close( NETSOCKET sock )

Closes an UDP socket.

Parameters

sock	Socket to close.

Returns

Returns 0 on success. -1 on error.

+ +

Network TCP

+ +

net_tcp_create

NETSOCKET net_tcp_create( const NETADDR * a )

Creates a TCP socket.

Parameters

bindaddr

Address to bind the socket to.

Returns

On success it returns an handle to the socket. On failure it returns NETSOCKET_INVALID.

+ +

net_tcp_listen

int net_tcp_listen( NETSOCKET sock,
int backlog )

Makes the socket start listening for new connections.

Parameters

sock	Socket to start listen to.
backlog	Size of the queue of incomming connections to keep.

Returns

Returns 0 on success.

+ +

net_tcp_accept

int net_tcp_accept( NETSOCKET sock,
NETSOCKET * new_sock,
NETADDR * addr )

Polls a listning socket for a new connection.

Parameters

sock	Listning socket to poll.
new_sock	Pointer to a socket to fill in with the new socket.
addr	Pointer to an address that will be filled in the remote address (optional, can be NULL).

Returns

Returns a non-negative integer on success. Negative integer on failure.

+ +

net_tcp_connect

int net_tcp_connect( NETSOCKET sock,
const NETADDR * addr )

Connects one socket to another.

Parameters

sock	Socket to connect.
addr	Address to connect to.

Returns

Returns 0 on success.

+ +

net_tcp_send

int net_tcp_send( NETSOCKET sock,
const void * data,
int size )

Sends data to a TCP stream.

Parameters

sock	Socket to send data to.
data	Pointer to the data to send.
size	Size of the data to send.

Returns

Number of bytes sent. Negative value on failure.

+ +

net_tcp_recv

int net_tcp_recv( NETSOCKET sock,
void * data,
int maxsize )

Recvives data from a TCP stream.

Parameters

sock	Socket to recvive data from.
data	Pointer to a buffer to write the data to
max_size	Maximum of data to write to the buffer.

Returns

Number of bytes recvived. Negative value on failure.

+ +

net_tcp_close

int net_tcp_close( NETSOCKET sock )

Closes a TCP socket.

Parameters

sock	Socket to close.

Returns

Returns 0 on success. Negative value on failure.

+ +

Strings

+ +

str_append

void str_append( char * dst,
const char * src,
int dst_size )

Appends a string to another.

Parameters

dst	Pointer to a buffer that contains a string.
src	String to append.
dst_size	Size of the buffer of the dst string.

Remarks

The strings are treated as zero-termineted strings.
Garantees that dst string will contain zero-termination.

+ +

str_copy

void str_copy( char * dst,
const char * src,
int dst_size )

Copies a string to another.

Parameters

dst	Pointer to a buffer that shall recive the string.
src	String to be copied.
dst_size	Size of the buffer dst.

Remarks

The strings are treated as zero-termineted strings.
Garantees that dst string will contain zero-termination.

+ +

str_format

void str_format( char * buffer,
int buffer_size,
const char * format,
... )

Performs printf formating into a buffer.

Parameters

buffer	Pointer to the buffer to recive the formated string.
buffer_size	Size of the buffer.
format	printf formating string.
...	Parameters for the formating.

Remarks

See the C manual for syntax for the printf formating string.
The strings are treated as zero-termineted strings.
Garantees that dst string will contain zero-termination.

+ +

str_sanitize_strong

void str_sanitize_strong( char * str )

Replaces all characters below 32 and above 127 with whitespace.

Parameters

str	String to sanitize.

Remarks

The strings are treated as zero-termineted strings.

+ +

str_sanitize

void str_sanitize( char * str )

Replaces all characters below 32 and above 127 with whitespace with exception to \r, \n and \r.

Parameters

str	String to sanitize.

Remarks

The strings are treated as zero-termineted strings.

+ +

str_comp_nocase

int str_comp_nocase( const char * a,
const char * b )

Compares to strings case insensitive.

Parameters

a	String to compare.
b	String to compare.

Returns

<0	String a is lesser then string b
0	String a is equal to string b

0 - String a is greater then string b

Remarks

Only garanted to work with a-z/A-Z.
The strings are treated as zero-termineted strings.

+ +

str_find_nocase

const char *str_find_nocase( const char * haystack,
const char * needle )

Finds a string inside another string case insensitive.

Parameters

haystack	String to search in
needle	String to search for

Returns

A pointer into haystack where the needle was found. Returns NULL of needle could not be found.

Remarks

Only garanted to work with a-z/A-Z.
The strings are treated as zero-termineted strings.

+ +

str_hex

void str_hex( char * dst,
int dst_size,
const void * data,
int data_size )

Takes a datablock and generates a hexstring of it.

Parameters

dst	Buffer to fill with hex data
dst_size	size of the buffer
data	Data to turn into hex
data	Size of the data

Remarks

The desination buffer will be zero-terminated

+ +

Filesystem

+ +

fs_listdir

typedef void ( * fs_listdir_callback )(const char *name, int is_dir, void *user)

Lists the files in a directory

Parameters

dir	Directory to list
cb	Callback function to call for each entry
user	Pointer to give to the callback

Returns

Always returns 0.

+ +

fs_makedir

int fs_makedir( const char * path )

Creates a directory

Parameters

path	Directory to create

Returns

Returns 0 on success. Negative value on failure.

Remarks

Does not create several directories if needed. “a/b/c” will result in a failure if b or a does not exist.

+ +

fs_storage_path

int fs_storage_path( const char * appname,
char * path,
int max )

Fetches per user configuration directory.

Returns

Returns 0 on success. Negative value on failure.

Remarks

Returns ~/.appname on UNIX based systems
Returns ~/Library/Applications Support/appname on Mac OS X
Returns %APPDATA%/Appname on Windows based systems

+ +

Undocumented

+ +

net_tcp_connect_non_blocking

int net_tcp_connect_non_blocking( NETSOCKET sock,
const NETADDR * a )

DOCTODO: serp

+ +

net_tcp_set_non_blocking

int net_tcp_set_non_blocking( NETSOCKET sock )

DOCTODO: serp

+ +

net_tcp_set_non_blocking

DOCTODO: serp

+ +

net_errno

int net_errno()

DOCTODO: serp

+ +

net_would_block

int net_would_block()

DOCTODO: serp

+ +

+ + + + + + + + + + +

void dbg_assert( int test,
const char * msg )

Breaks into the debugger based on a test.

void dbg_break()

Breaks into the debugger.

void dbg_msg( const char * sys,
const char * fmt,
... )

Prints a debug message.

void *mem_alloc_debug( const char * filename,
int line,
unsigned size,
unsigned alignment )

Allocates memory.

void mem_free( void * block )

Frees a block allocated through mem_alloc.

void mem_copy( void * dest,
const void * source,
unsigned size )

Copies a a memory block.

void mem_move( void * dest,
const void * source,
unsigned size )

Copies a a memory block

void mem_zero( void * block,
unsigned size )

Sets a complete memory block to 0

int mem_comp( const void * a,
const void * b,
int size )

Compares two blocks of memory

IOHANDLE io_open( const char * filename,
int flags )

Opens a file.

unsigned io_read( IOHANDLE io,
void * buffer,
unsigned size )

Reads data into a buffer from a file.

unsigned io_skip( IOHANDLE io,
unsigned size )

Skips data in a file.

unsigned io_write( IOHANDLE io,
const void * buffer,
unsigned size )

Writes data from a buffer to file.

int io_seek( IOHANDLE io,
int offset,
int origin )

Seeks to a specified offset in the file.

long int io_tell( IOHANDLE io )

Gets the current position in the file.

long int io_length( IOHANDLE io )

Gets the total length of the file.

int io_close( IOHANDLE io )

Closes a file.

int io_flush( IOHANDLE io )

Empties all buffers and writes all pending data.

IOHANDLE io_stdin()

Returns an IOHANDLE to the standard input.

IOHANDLE io_stdout()

Returns an IOHANDLE to the standard output.

IOHANDLE io_stderr()

Returns an IOHANDLE to the standard error.

void thread_sleep( int milliseconds )

Suspends the current thread for a given period.

void *thread_create( void (*threadfunc)(void *),
void * user )

Creates a new thread.

void thread_wait( void * thread )

Waits for a thread to be done or destroyed.

int64 time_get()

Fetches a sample from a high resolution timer.

int64 time_freq()

Returns the frequency of the high resolution timer.

unsigned time_timestamp()

Retrives the current time as a UNIX timestamp

int net_init()

Initiates network functionallity.

int net_host_lookup( const char * hostname,
NETADDR * addr,
int types )

Does a hostname lookup by name and fills out the passed NETADDR struct with the recieved details.

int net_addr_comp( const NETADDR * a,
const NETADDR * b )

Compares two network addresses.

int net_addr_str( const NETADDR * addr,
char * string,
int max_length )

Turns a network address into a representive string.

NETSOCKET net_udp_create( NETADDR bindaddr )

Creates a UDP socket and binds it to a port.

int net_udp_send( NETSOCKET sock,
const NETADDR * addr,
const void * data,
int size )

Sends a packet over an UDP socket.

int net_udp_recv( NETSOCKET sock,
NETADDR * addr,
void * data,
int maxsize )

Recives a packet over an UDP socket.

int net_udp_close( NETSOCKET sock )

Closes an UDP socket.

NETSOCKET net_tcp_create( const NETADDR * a )

Creates a TCP socket.

int net_tcp_listen( NETSOCKET sock,
int backlog )

Makes the socket start listening for new connections.

int net_tcp_accept( NETSOCKET sock,
NETSOCKET * new_sock,
NETADDR * addr )

Polls a listning socket for a new connection.

int net_tcp_connect( NETSOCKET sock,
const NETADDR * addr )

Connects one socket to another.

int net_tcp_send( NETSOCKET sock,
const void * data,
int size )

Sends data to a TCP stream.

int net_tcp_recv( NETSOCKET sock,
void * data,
int maxsize )

Recvives data from a TCP stream.

int net_tcp_close( NETSOCKET sock )

Closes a TCP socket.

void str_append( char * dst,
const char * src,
int dst_size )

Appends a string to another.

void str_copy( char * dst,
const char * src,
int dst_size )

Copies a string to another.

void str_format( char * buffer,
int buffer_size,
const char * format,
... )

Performs printf formating into a buffer.

void str_sanitize_strong( char * str )

Replaces all characters below 32 and above 127 with whitespace.

void str_sanitize( char * str )

Replaces all characters below 32 and above 127 with whitespace with exception to \r, \n and \r.

int str_comp_nocase( const char * a,
const char * b )

Compares to strings case insensitive.

const char *str_find_nocase( const char * haystack,
const char * needle )

Finds a string inside another string case insensitive.

void str_hex( char * dst,
int dst_size,
const void * data,
int data_size )

Takes a datablock and generates a hexstring of it.

typedef void ( * fs_listdir_callback )(const char *name, int is_dir, void *user)

Lists the files in a directory

int fs_makedir( const char * path )

Creates a directory

int fs_storage_path( const char * appname,
char * path,
int max )

Fetches per user configuration directory.

int net_tcp_connect_non_blocking( NETSOCKET sock,
const NETADDR * a )

DOCTODO: serp

int net_tcp_set_non_blocking( NETSOCKET sock )

DOCTODO: serp

int net_errno()

DOCTODO: serp

int net_would_block()

DOCTODO: serp

+ + + + +

+ + + \ No newline at end of file -- cgit 1.4.1