/usr/share/doc/s3d/ch02s03.html

<?xml version="1.0" encoding="ANSI_X3.4-1968" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ANSI_X3.4-1968" /><title>Data types</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /><meta name="keywords" content="s3d, API, handbook, guide" /><link rel="home" href="index.html" title="S3D - a 3D Desktop Environment" /><link rel="up" href="ch02.html" title="Chapter&#160;2.&#160;libs3d - The S3D API" /><link rel="prev" href="ch02s02.html" title="function reference" /><link rel="next" href="ch02s04.html" title="Definitions" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Data types</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch02s02.html">Prev</a>&#160;</td><th width="60%" align="center">Chapter&#160;2.&#160;libs3d - The S3D API</th><td width="20%" align="right">&#160;<a accesskey="n" href="ch02s04.html">Next</a></td></tr></table><hr /></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="data_types"></a>Data types</h2></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="structs3d_evt"></a>struct s3d_evt</h3></div></div></div><pre class="programlisting">struct <a class="link" href="ch02s03.html#structs3d_evt" title="struct s3d_evt">s3d_evt</a> {
	uint8_t event;
	int length;
	char *buf;
	struct <a class="link" href="ch02s03.html#structs3d_evt" title="struct s3d_evt">s3d_evt</a> *next;
}</pre><p>This is the event information holder.     </p><div class="variablelist"><dl class="variablelist"><dt><span class="term">event</span></dt><dd><p>gives the event type         </p></dd><dt><span class="term">length</span></dt><dd><p>gives the length of the buffer *buf         </p></dd><dt><span class="term">buf</span></dt><dd><p>is the pointer to the multiple purpose buffer, which will have more specific information about the object         </p></dd><dt><span class="term">next</span></dt><dd><p>can be safely ignored ;)         </p></dd></dl></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="structmcp_object"></a>struct mcp_object</h3></div></div></div><pre class="programlisting">struct <a class="link" href="ch02s03.html#structmcp_object" title="struct mcp_object">mcp_object</a> {
	uint32_t object;
	float trans_x;
	float trans_y;
	float trans_z;
	float r;
	char name;
}</pre><p>Deprecated</p><p>don't use, to be removed soon (use struct <a class="link" href="ch02s03.html#structs3d_but_info" title="struct s3d_but_info">s3d_but_info</a>). ;)     </p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="structs3d_obj_info"></a>struct s3d_obj_info</h3></div></div></div><pre class="programlisting">struct <a class="link" href="ch02s03.html#structs3d_obj_info" title="struct s3d_obj_info">s3d_obj_info</a> {
	uint32_t object;
	uint32_t flags;
	float trans_x;
	float trans_y;
	float trans_z;
	float rot_x;
	float rot_y;
	float rot_z;
	float scale;
	float r;
	char name;
}</pre><p>Can be used on the buffer of an event of type S3D_EVENT_OBJ_INFO. name will usually contain nothing for usual objects, but mcp objects will contain the applications names here. r is the radius of the convex sphere an object, which will also be interesting for the mcp.</p><p>Special objects like camera, pointer will have the "sys_" prefix in the name and will be named "pointer0", "pointer1" ... or "cam0", "cam1" ... For cam object, scale will contain the aspect ratio.     </p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="structs3d_but_info"></a>struct s3d_but_info</h3></div></div></div><pre class="programlisting">struct <a class="link" href="ch02s03.html#structs3d_but_info" title="struct s3d_but_info">s3d_but_info</a> {
	uint8_t button;
	uint8_t state;
}</pre><p>Can be used on the buffer of an event of type S3D_EVENT_MBUTTON.     </p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="structs3d_key_event"></a>struct s3d_key_event</h3></div></div></div><pre class="programlisting">struct <a class="link" href="ch02s03.html#structs3d_key_event" title="struct s3d_key_event">s3d_key_event</a> {
	uint16_t keysym;
	uint16_t unicode;
	uint16_t modifier;
	uint16_t state;
}</pre><p>Can be used on the buffer of an event of type S3D_EVENT_KEY*.     </p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="s3d_cb"></a>typedef s3d_cb</h3></div></div></div><pre class="programlisting">typedef int(* <a class="link" href="ch02s03.html#s3d_cb" title="typedef s3d_cb">s3d_cb</a>)(struct <a class="link" href="ch02s03.html#structs3d_evt" title="struct s3d_evt">s3d_evt</a> *)</pre><p>This defines the callback format. Each callback should return void and take an argument of struct <a class="link" href="ch02s03.html#structs3d_evt" title="struct s3d_evt">s3d_evt</a> *. Callbacks can be defined with <a class="link" href="ch02s02.html#s3d_set_callback" title="s3d_set_callback">s3d_set_callback</a>().         </p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch02s02.html">Prev</a>&#160;</td><td width="20%" align="center"><a accesskey="u" href="ch02.html">Up</a></td><td width="40%" align="right">&#160;<a accesskey="n" href="ch02s04.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">function reference&#160;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&#160;Definitions</td></tr></table></div></body></html>
s3d-doc 0.2.2-10 / usr / share / doc / s3d / ch02s03.html
