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

Revision 964, 9.5 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: FCDEffectParameterSurfaceInitFactory 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>FCDEffectParameterSurfaceInitFactory Class Reference<br>
25<small>
26[<a class="el" href="group___f_c_d_effect.html">COLLADA Effect Classes [ColladaFX]</a>]</small>
27</h1><!-- doxytag: class="FCDEffectParameterSurfaceInitFactory" -->[INTERNAL] The factory for COLLADA effect parameter surface initialization. 
28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="_f_c_d_effect_parameter_surface_8h-source.html">FCDEffectParameterSurface.h</a>&gt;</code>
31<p>
32<a href="class_f_c_d_effect_parameter_surface_init_factory-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
33<tr><td></td></tr>
34<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
35<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_factory.html#65e74f1159865702cac5236dd5d83892">InitType</a> { <br>
36&nbsp;&nbsp;<a class="el" href="class_f_c_d_effect_parameter_surface_init_factory.html#65e74f1159865702cac5236dd5d83892a87c1f6872f211a3f525c11557149e4d">FROM</a>,
37<a class="el" href="class_f_c_d_effect_parameter_surface_init_factory.html#65e74f1159865702cac5236dd5d8389290f0b3c1c0dfe447ea2f973141eb0b1c">AS_NULL</a>,
38<a class="el" href="class_f_c_d_effect_parameter_surface_init_factory.html#65e74f1159865702cac5236dd5d83892d1baa0ff12391ddc3dd1f9c40ea77906">AS_TARGET</a>,
39<a class="el" href="class_f_c_d_effect_parameter_surface_init_factory.html#65e74f1159865702cac5236dd5d83892e2d69f0436ba18d343605f554e30ed22">CUBE</a>,
40<br>
41&nbsp;&nbsp;<a class="el" href="class_f_c_d_effect_parameter_surface_init_factory.html#65e74f1159865702cac5236dd5d83892328076a8538f429eb5988879c0e643cd">VOLUME</a>,
42<a class="el" href="class_f_c_d_effect_parameter_surface_init_factory.html#65e74f1159865702cac5236dd5d838925c8434819c6046c14dff8f793841ac51">PLANAR</a>
43<br>
44 }</td></tr>
45
46<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The supported initialization types.  <a href="class_f_c_d_effect_parameter_surface_init_factory.html#65e74f1159865702cac5236dd5d83892">More...</a><br></td></tr>
47<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
48<tr><td class="memItemLeft" nowrap align="right" valign="top">static <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_factory.html#609b1b659d62286c64b057f0e872907d">Create</a> (<a class="el" href="class_f_c_d_effect_parameter_surface_init_factory.html#65e74f1159865702cac5236dd5d83892">InitType</a> type)</td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Creates a new effect surface initialization parameter, given a type.  <a href="#609b1b659d62286c64b057f0e872907d"></a><br></td></tr>
51</table>
52<hr><a name="_details"></a><h2>Detailed Description</h2>
53[INTERNAL] The factory for COLLADA effect parameter surface initialization.
54<p>
55<hr><h2>Member Enumeration Documentation</h2>
56<a class="anchor" name="65e74f1159865702cac5236dd5d83892"></a><!-- doxytag: member="FCDEffectParameterSurfaceInitFactory::InitType" ref="65e74f1159865702cac5236dd5d83892" args="" --><p>
57<table class="mdTable" cellpadding="2" cellspacing="0">
58  <tr>
59    <td class="mdRow">
60      <table cellpadding="0" cellspacing="0" border="0">
61        <tr>
62          <td class="md" nowrap valign="top">enum <a class="el" href="class_f_c_d_effect_parameter_surface_init_factory.html#65e74f1159865702cac5236dd5d83892">FCDEffectParameterSurfaceInitFactory::InitType</a>          </td>
63        </tr>
64      </table>
65    </td>
66  </tr>
67</table>
68<table cellspacing="5" cellpadding="0" border="0">
69  <tr>
70    <td>
71      &nbsp;
72    </td>
73    <td>
74
75<p>
76The supported initialization types.
77<p>
78<dl compact><dt><b>Enumerator: </b></dt><dd>
79<table border="0" cellspacing="2" cellpadding="0">
80<tr><td valign="top"><em><a class="anchor" name="65e74f1159865702cac5236dd5d83892a87c1f6872f211a3f525c11557149e4d"></a><!-- doxytag: member="FROM" ref="65e74f1159865702cac5236dd5d83892a87c1f6872f211a3f525c11557149e4d" args="" -->FROM</em>&nbsp;</td><td>
81Loads a surface from one simple image file.
82<p>
83<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_f_c_d_effect_parameter_surface_init_from.html">FCDEffectParameterSurfaceInitFrom</a> </dd></dl>
84</td></tr>
85<tr><td valign="top"><em><a class="anchor" name="65e74f1159865702cac5236dd5d8389290f0b3c1c0dfe447ea2f973141eb0b1c"></a><!-- doxytag: member="AS_NULL" ref="65e74f1159865702cac5236dd5d8389290f0b3c1c0dfe447ea2f973141eb0b1c" args="" -->AS_NULL</em>&nbsp;</td><td>
86No initialization.
87<p>
88This surface may be initialized by some future effect parameter override. </td></tr>
89<tr><td valign="top"><em><a class="anchor" name="65e74f1159865702cac5236dd5d83892d1baa0ff12391ddc3dd1f9c40ea77906"></a><!-- doxytag: member="AS_TARGET" ref="65e74f1159865702cac5236dd5d83892d1baa0ff12391ddc3dd1f9c40ea77906" args="" -->AS_TARGET</em>&nbsp;</td><td>
90Initializes an engine-specific render target for offscreen rendering.
91<p>
92In this case, the dimensions should be provided by the surface effect parameter. </td></tr>
93<tr><td valign="top"><em><a class="anchor" name="65e74f1159865702cac5236dd5d83892e2d69f0436ba18d343605f554e30ed22"></a><!-- doxytag: member="CUBE" ref="65e74f1159865702cac5236dd5d83892e2d69f0436ba18d343605f554e30ed22" args="" -->CUBE</em>&nbsp;</td><td>
94Loads a cube-map from one complex image file or six simple image files.
95<p>
96<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_f_c_d_effect_parameter_surface_init_cube.html">FCDEffectParameterSurfaceInitCube</a> </dd></dl>
97</td></tr>
98<tr><td valign="top"><em><a class="anchor" name="65e74f1159865702cac5236dd5d83892328076a8538f429eb5988879c0e643cd"></a><!-- doxytag: member="VOLUME" ref="65e74f1159865702cac5236dd5d83892328076a8538f429eb5988879c0e643cd" args="" -->VOLUME</em>&nbsp;</td><td>
99Loads a 3D images for one image file.
100<p>
101<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_f_c_d_effect_parameter_surface_init_volume.html">FCDEffectParameterSurfaceInitVolume</a> </dd></dl>
102</td></tr>
103<tr><td valign="top"><em><a class="anchor" name="65e74f1159865702cac5236dd5d838925c8434819c6046c14dff8f793841ac51"></a><!-- doxytag: member="PLANAR" ref="65e74f1159865702cac5236dd5d838925c8434819c6046c14dff8f793841ac51" args="" -->PLANAR</em>&nbsp;</td><td>
104Loads a surface from one simple image file. </td></tr>
105</table>
106</dl>
107    </td>
108  </tr>
109</table>
110<hr><h2>Member Function Documentation</h2>
111<a class="anchor" name="609b1b659d62286c64b057f0e872907d"></a><!-- doxytag: member="FCDEffectParameterSurfaceInitFactory::Create" ref="609b1b659d62286c64b057f0e872907d" args="(InitType type)" --><p>
112<table class="mdTable" cellpadding="2" cellspacing="0">
113  <tr>
114    <td class="mdRow">
115      <table cellpadding="0" cellspacing="0" border="0">
116        <tr>
117          <td class="md" nowrap valign="top">static <a class="el" href="class_f_c_d_effect_parameter_surface_init.html">FCDEffectParameterSurfaceInit</a>* FCDEffectParameterSurfaceInitFactory::Create           </td>
118          <td class="md" valign="top">(&nbsp;</td>
119          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter_surface_init_factory.html#65e74f1159865702cac5236dd5d83892">InitType</a>&nbsp;</td>
120          <td class="mdname1" valign="top" nowrap> <em>type</em>          </td>
121          <td class="md" valign="top">&nbsp;)&nbsp;</td>
122          <td class="md" nowrap><code> [static]</code></td>
123        </tr>
124      </table>
125    </td>
126  </tr>
127</table>
128<table cellspacing="5" cellpadding="0" border="0">
129  <tr>
130    <td>
131      &nbsp;
132    </td>
133    <td>
134
135<p>
136[INTERNAL] Creates a new effect surface initialization parameter, given a type.
137<p>
138<dl compact><dt><b>Parameters:</b></dt><dd>
139  <table border="0" cellspacing="2" cellpadding="0">
140    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>The type of initialization parameter to create. </td></tr>
141  </table>
142</dl>
143    </td>
144  </tr>
145</table>
146<hr>The documentation for this class was generated from the following file:<ul>
147<li>FCDocument/<a class="el" href="_f_c_d_effect_parameter_surface_8h-source.html">FCDEffectParameterSurface.h</a></ul>
148<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:42 2006 for FCollada by&nbsp;
149<a href="http://www.doxygen.org/index.html">
150<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
151</body>
152</html>
Note: See TracBrowser for help on using the repository browser.