diff options
Diffstat (limited to '')
-rw-r--r-- | src/others/mimesh/libg3d-0.0.8/doc/api/xml/material.xml | 142 |
1 files changed, 142 insertions, 0 deletions
diff --git a/src/others/mimesh/libg3d-0.0.8/doc/api/xml/material.xml b/src/others/mimesh/libg3d-0.0.8/doc/api/xml/material.xml new file mode 100644 index 0000000..e7240da --- /dev/null +++ b/src/others/mimesh/libg3d-0.0.8/doc/api/xml/material.xml | |||
@@ -0,0 +1,142 @@ | |||
1 | <?xml version="1.0"?> | ||
2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" | ||
3 | "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> | ||
4 | <refentry id="libg3d-material"> | ||
5 | <refmeta> | ||
6 | <refentrytitle role="top_of_page" id="libg3d-material.top_of_page">material</refentrytitle> | ||
7 | <manvolnum>3</manvolnum> | ||
8 | <refmiscinfo>LIBG3D Library</refmiscinfo> | ||
9 | </refmeta> | ||
10 | |||
11 | <refnamediv> | ||
12 | <refname>material</refname> | ||
13 | <refpurpose>Material generation and manipulation</refpurpose> | ||
14 | <!--[<xref linkend="desc" endterm="desc.title"/>]--> | ||
15 | </refnamediv> | ||
16 | |||
17 | <refsynopsisdiv id="libg3d-material.synopsis" role="synopsis"> | ||
18 | <title role="synopsis.title">Synopsis</title> | ||
19 | |||
20 | <synopsis> | ||
21 | |||
22 | #include <g3d/material.h> | ||
23 | |||
24 | <link linkend="G3DMaterial">G3DMaterial</link>; | ||
25 | <link linkend="G3DMaterial">G3DMaterial</link>* <link linkend="g3d-material-new">g3d_material_new</link> (void); | ||
26 | <link linkend="void">void</link> <link linkend="g3d-material-free">g3d_material_free</link> (<link linkend="G3DMaterial">G3DMaterial</link> *material); | ||
27 | </synopsis> | ||
28 | </refsynopsisdiv> | ||
29 | |||
30 | |||
31 | |||
32 | |||
33 | |||
34 | |||
35 | |||
36 | |||
37 | |||
38 | <refsect1 id="libg3d-material.description" role="desc"> | ||
39 | <title role="desc.title">Description</title> | ||
40 | <para> | ||
41 | A material contains all color, shading and texture information for a | ||
42 | <link linkend="G3DFace"><type>G3DFace</type></link>.</para> | ||
43 | <para> | ||
44 | |||
45 | </para> | ||
46 | </refsect1> | ||
47 | |||
48 | <refsect1 id="libg3d-material.details" role="details"> | ||
49 | <title role="details.title">Details</title> | ||
50 | <refsect2 id="G3DMaterial" role="struct"> | ||
51 | <title>G3DMaterial</title> | ||
52 | <indexterm zone="G3DMaterial"><primary>G3DMaterial</primary></indexterm><programlisting>typedef struct { | ||
53 | gchar *name; | ||
54 | G3DFloat r, g, b, a; | ||
55 | G3DFloat shininess; | ||
56 | G3DFloat specular[4]; | ||
57 | guint32 flags; | ||
58 | |||
59 | G3DImage *tex_image; | ||
60 | } G3DMaterial; | ||
61 | </programlisting> | ||
62 | <para> | ||
63 | A material object.</para> | ||
64 | <para> | ||
65 | |||
66 | </para><variablelist role="struct"> | ||
67 | <varlistentry> | ||
68 | <term><link linkend="gchar">gchar</link> *<structfield>name</structfield>;</term> | ||
69 | <listitem><simpara> name of material | ||
70 | </simpara></listitem> | ||
71 | </varlistentry> | ||
72 | <varlistentry> | ||
73 | <term><link linkend="G3DFloat">G3DFloat</link> <structfield>r</structfield>;</term> | ||
74 | <listitem><simpara> red component of color | ||
75 | </simpara></listitem> | ||
76 | </varlistentry> | ||
77 | <varlistentry> | ||
78 | <term><link linkend="G3DFloat">G3DFloat</link> <structfield>g</structfield>;</term> | ||
79 | <listitem><simpara> green component of color | ||
80 | </simpara></listitem> | ||
81 | </varlistentry> | ||
82 | <varlistentry> | ||
83 | <term><link linkend="G3DFloat">G3DFloat</link> <structfield>b</structfield>;</term> | ||
84 | <listitem><simpara> blue component of color | ||
85 | </simpara></listitem> | ||
86 | </varlistentry> | ||
87 | <varlistentry> | ||
88 | <term><link linkend="G3DFloat">G3DFloat</link> <structfield>a</structfield>;</term> | ||
89 | <listitem><simpara> alpha component of color | ||
90 | </simpara></listitem> | ||
91 | </varlistentry> | ||
92 | <varlistentry> | ||
93 | <term><link linkend="G3DFloat">G3DFloat</link> <structfield>shininess</structfield>;</term> | ||
94 | <listitem><simpara> shiny color | ||
95 | </simpara></listitem> | ||
96 | </varlistentry> | ||
97 | <varlistentry> | ||
98 | <term><link linkend="G3DFloat">G3DFloat</link> <structfield>specular</structfield>[4];</term> | ||
99 | <listitem><simpara> specular color | ||
100 | </simpara></listitem> | ||
101 | </varlistentry> | ||
102 | <varlistentry> | ||
103 | <term><link linkend="guint32">guint32</link> <structfield>flags</structfield>;</term> | ||
104 | <listitem><simpara> flags | ||
105 | </simpara></listitem> | ||
106 | </varlistentry> | ||
107 | <varlistentry> | ||
108 | <term><link linkend="G3DImage">G3DImage</link> *<structfield>tex_image</structfield>;</term> | ||
109 | <listitem><simpara> texture image (optional, may be NULL) | ||
110 | </simpara></listitem> | ||
111 | </varlistentry> | ||
112 | </variablelist></refsect2> | ||
113 | <refsect2 id="g3d-material-new" role="function"> | ||
114 | <title>g3d_material_new ()</title> | ||
115 | <indexterm zone="g3d-material-new"><primary>g3d_material_new</primary></indexterm><programlisting><link linkend="G3DMaterial">G3DMaterial</link>* g3d_material_new (void);</programlisting> | ||
116 | <para> | ||
117 | Generates a new material with a default color.</para> | ||
118 | <para> | ||
119 | |||
120 | </para><variablelist role="params"> | ||
121 | <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new material or NULL on error | ||
122 | </simpara></listitem></varlistentry> | ||
123 | </variablelist></refsect2> | ||
124 | <refsect2 id="g3d-material-free" role="function"> | ||
125 | <title>g3d_material_free ()</title> | ||
126 | <indexterm zone="g3d-material-free"><primary>g3d_material_free</primary></indexterm><programlisting><link linkend="void">void</link> g3d_material_free (<link linkend="G3DMaterial">G3DMaterial</link> *material);</programlisting> | ||
127 | <para> | ||
128 | Frees all memory allocated for that material.</para> | ||
129 | <para> | ||
130 | |||
131 | </para><variablelist role="params"> | ||
132 | <varlistentry><term><parameter>material</parameter> :</term> | ||
133 | <listitem><simpara> the material to free | ||
134 | </simpara></listitem></varlistentry> | ||
135 | </variablelist></refsect2> | ||
136 | |||
137 | </refsect1> | ||
138 | |||
139 | |||
140 | |||
141 | |||
142 | </refentry> | ||