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