source: NonGTP/FCollada/Documentation/class_f_c_d_effect_parameter_surface_init_volume.html @ 964

Revision 964, 10.4 KB checked in by igarcia, 18 years ago (diff)
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3<title>FCollada: FCDEffectParameterSurfaceInitVolume Class Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.4.6-NO -->
8<div class="tabs">
9  <ul>
10    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11    <li><a href="modules.html"><span>Modules</span></a></li>
12    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
13    <li id="current"><a href="classes.html"><span>Classes</span></a></li>
14    <li><a href="files.html"><span>Files</span></a></li>
15    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
16  </ul></div>
17<div class="tabs">
18  <ul>
19    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
20    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
21    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
22    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
23  </ul></div>
24<h1>FCDEffectParameterSurfaceInitVolume Class Reference</h1><!-- doxytag: class="FCDEffectParameterSurfaceInitVolume" --><!-- doxytag: inherits="FCDEffectParameterSurfaceInit" -->A volumetric surface initialization method. 
25<a href="#_details">More...</a>
26<p>
27<code>#include &lt;<a class="el" href="_f_c_d_effect_parameter_surface_8h-source.html">FCDEffectParameterSurface.h</a>&gt;</code>
28<p>
29<p>Inheritance diagram for FCDEffectParameterSurfaceInitVolume:
30<p><center><img src="class_f_c_d_effect_parameter_surface_init_volume.png" usemap="#FCDEffectParameterSurfaceInitVolume_map" border="0" alt=""></center>
31<map name="FCDEffectParameterSurfaceInitVolume_map">
32<area href="class_f_c_d_effect_parameter_surface_init.html" alt="FCDEffectParameterSurfaceInit" shape="rect" coords="0,0,232,24">
33</map>
34<a href="class_f_c_d_effect_parameter_surface_init_volume-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
35<tr><td></td></tr>
36<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
37<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface_init_volume.html#26c9418850b0c0d5a6c685b4ce4d890b">VolumeType</a> { <b>ALL</b>,
38<a class="el" href="class_f_c_d_effect_parameter_surface_init_volume.html#26c9418850b0c0d5a6c685b4ce4d890b13ca69673f7e1aa87c61d5ef49df4512">PRIMARY</a>
39 }</td></tr>
40
41<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The types of volumetric surfaces initialization.  <a href="class_f_c_d_effect_parameter_surface_init_volume.html#26c9418850b0c0d5a6c685b4ce4d890b">More...</a><br></td></tr>
42<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
43<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="06132d8a624304e2b2a738d57eeaeb0f"></a><!-- doxytag: member="FCDEffectParameterSurfaceInitVolume::FCDEffectParameterSurfaceInitVolume" ref="06132d8a624304e2b2a738d57eeaeb0f" args="()" -->
44&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface_init_volume.html#06132d8a624304e2b2a738d57eeaeb0f">FCDEffectParameterSurfaceInitVolume</a> ()</td></tr>
45
46<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor: builds a new volumetric surface initialization method. <br></td></tr>
47<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="131f222e9900bc43683051e97c243ea0"></a><!-- doxytag: member="FCDEffectParameterSurfaceInitVolume::~FCDEffectParameterSurfaceInitVolume" ref="131f222e9900bc43683051e97c243ea0" args="()" -->
48virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface_init_volume.html#131f222e9900bc43683051e97c243ea0">~FCDEffectParameterSurfaceInitVolume</a> ()</td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
51<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter_surface_init_factory.html#65e74f1159865702cac5236dd5d83892">FCDEffectParameterSurfaceInitFactory::InitType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface_init_volume.html#d0490f5d50b8babd77b3294277f4fde5">GetInitType</a> () const </td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the initialization type.  <a href="#d0490f5d50b8babd77b3294277f4fde5"></a><br></td></tr>
54<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter_surface_init.html">FCDEffectParameterSurfaceInit</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface_init_volume.html#e67e3573dec7f41c0be35b4bb04992d8">Clone</a> ()</td></tr>
55
56<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a full copy of the surface initialization parameter.  <a href="#e67e3573dec7f41c0be35b4bb04992d8"></a><br></td></tr>
57<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
58<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ad5bb8a564f3583dce34eb2b916d87e7"></a><!-- doxytag: member="FCDEffectParameterSurfaceInitVolume::volumeType" ref="ad5bb8a564f3583dce34eb2b916d87e7" args="" -->
59<a class="el" href="class_f_c_d_effect_parameter_surface_init_volume.html#26c9418850b0c0d5a6c685b4ce4d890b">VolumeType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface_init_volume.html#ad5bb8a564f3583dce34eb2b916d87e7">volumeType</a></td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The type of volumetric initialization. <br></td></tr>
62</table>
63<hr><a name="_details"></a><h2>Detailed Description</h2>
64A volumetric surface initialization method.
65<p>
66<hr><h2>Member Enumeration Documentation</h2>
67<a class="anchor" name="26c9418850b0c0d5a6c685b4ce4d890b"></a><!-- doxytag: member="FCDEffectParameterSurfaceInitVolume::VolumeType" ref="26c9418850b0c0d5a6c685b4ce4d890b" args="" --><p>
68<table class="mdTable" cellpadding="2" cellspacing="0">
69  <tr>
70    <td class="mdRow">
71      <table cellpadding="0" cellspacing="0" border="0">
72        <tr>
73          <td class="md" nowrap valign="top">enum <a class="el" href="class_f_c_d_effect_parameter_surface_init_volume.html#26c9418850b0c0d5a6c685b4ce4d890b">FCDEffectParameterSurfaceInitVolume::VolumeType</a>          </td>
74        </tr>
75      </table>
76    </td>
77  </tr>
78</table>
79<table cellspacing="5" cellpadding="0" border="0">
80  <tr>
81    <td>
82      &nbsp;
83    </td>
84    <td>
85
86<p>
87The types of volumetric surfaces initialization.
88<p>
89<dl compact><dt><b>Enumerator: </b></dt><dd>
90<table border="0" cellspacing="2" cellpadding="0">
91<tr><td valign="top"><em><a class="anchor" name="26c9418850b0c0d5a6c685b4ce4d890b13ca69673f7e1aa87c61d5ef49df4512"></a><!-- doxytag: member="PRIMARY" ref="26c9418850b0c0d5a6c685b4ce4d890b13ca69673f7e1aa87c61d5ef49df4512" args="" -->PRIMARY</em>&nbsp;</td><td>
92Load the first mip-level from the image file. </td></tr>
93</table>
94</dl>
95    </td>
96  </tr>
97</table>
98<hr><h2>Member Function Documentation</h2>
99<a class="anchor" name="e67e3573dec7f41c0be35b4bb04992d8"></a><!-- doxytag: member="FCDEffectParameterSurfaceInitVolume::Clone" ref="e67e3573dec7f41c0be35b4bb04992d8" args="()" --><p>
100<table class="mdTable" cellpadding="2" cellspacing="0">
101  <tr>
102    <td class="mdRow">
103      <table cellpadding="0" cellspacing="0" border="0">
104        <tr>
105          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter_surface_init.html">FCDEffectParameterSurfaceInit</a>* FCDEffectParameterSurfaceInitVolume::Clone           </td>
106          <td class="md" valign="top">(&nbsp;</td>
107          <td class="mdname1" valign="top" nowrap>          </td>
108          <td class="md" valign="top">&nbsp;)&nbsp;</td>
109          <td class="md" nowrap><code> [virtual]</code></td>
110        </tr>
111      </table>
112    </td>
113  </tr>
114</table>
115<table cellspacing="5" cellpadding="0" border="0">
116  <tr>
117    <td>
118      &nbsp;
119    </td>
120    <td>
121
122<p>
123Creates a full copy of the surface initialization parameter.
124<p>
125<dl compact><dt><b>Returns:</b></dt><dd>The surface initialization parameter. You will need to delete this pointer. </dd></dl>
126
127<p>
128Implements <a class="el" href="class_f_c_d_effect_parameter_surface_init.html#264b13ea36edb1906c9fbe13d3c2d467">FCDEffectParameterSurfaceInit</a>.    </td>
129  </tr>
130</table>
131<a class="anchor" name="d0490f5d50b8babd77b3294277f4fde5"></a><!-- doxytag: member="FCDEffectParameterSurfaceInitVolume::GetInitType" ref="d0490f5d50b8babd77b3294277f4fde5" args="() const " --><p>
132<table class="mdTable" cellpadding="2" cellspacing="0">
133  <tr>
134    <td class="mdRow">
135      <table cellpadding="0" cellspacing="0" border="0">
136        <tr>
137          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter_surface_init_factory.html#65e74f1159865702cac5236dd5d83892">FCDEffectParameterSurfaceInitFactory::InitType</a> FCDEffectParameterSurfaceInitVolume::GetInitType           </td>
138          <td class="md" valign="top">(&nbsp;</td>
139          <td class="mdname1" valign="top" nowrap>          </td>
140          <td class="md" valign="top">&nbsp;)&nbsp;</td>
141          <td class="md" nowrap> const<code> [inline, virtual]</code></td>
142        </tr>
143      </table>
144    </td>
145  </tr>
146</table>
147<table cellspacing="5" cellpadding="0" border="0">
148  <tr>
149    <td>
150      &nbsp;
151    </td>
152    <td>
153
154<p>
155Retrieves the initialization type.
156<p>
157You cannot modify this value. To change the initialization type of a surface parameter, create a new surface initialization structure of the correct type. <dl compact><dt><b>Returns:</b></dt><dd>The initialization type. </dd></dl>
158
159<p>
160Implements <a class="el" href="class_f_c_d_effect_parameter_surface_init.html#d0109233e63c892e5963a3ca67f7108f">FCDEffectParameterSurfaceInit</a>.    </td>
161  </tr>
162</table>
163<hr>The documentation for this class was generated from the following file:<ul>
164<li>FCDocument/<a class="el" href="_f_c_d_effect_parameter_surface_8h-source.html">FCDEffectParameterSurface.h</a></ul>
165<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:42 2006 for FCollada by&nbsp;
166<a href="http://www.doxygen.org/index.html">
167<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
168</body>
169</html>
Note: See TracBrowser for help on using the repository browser.