[964] | 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: FCDEffectParameterSurface 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 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 Pages</span></a></li> |
---|
| 16 | </ul></div> |
---|
| 17 | <div class="tabs"> |
---|
| 18 | <ul> |
---|
| 19 | <li><a href="classes.html"><span>Alphabetical List</span></a></li> |
---|
| 20 | <li><a href="annotated.html"><span>Class List</span></a></li> |
---|
| 21 | <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
---|
| 22 | <li><a href="functions.html"><span>Class Members</span></a></li> |
---|
| 23 | </ul></div> |
---|
| 24 | <h1>FCDEffectParameterSurface 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="FCDEffectParameterSurface" --><!-- doxytag: inherits="FCDEffectParameter" -->A COLLADA surface parameter. |
---|
| 28 | <a href="#_details">More...</a> |
---|
| 29 | <p> |
---|
| 30 | <code>#include <<a class="el" href="_f_c_d_effect_parameter_surface_8h-source.html">FCDEffectParameterSurface.h</a>></code> |
---|
| 31 | <p> |
---|
| 32 | <p>Inheritance diagram for FCDEffectParameterSurface: |
---|
| 33 | <p><center><img src="class_f_c_d_effect_parameter_surface.png" usemap="#FCDEffectParameterSurface_map" border="0" alt=""></center> |
---|
| 34 | <map name="FCDEffectParameterSurface_map"> |
---|
| 35 | <area href="class_f_c_d_effect_parameter.html" alt="FCDEffectParameter" shape="rect" coords="0,112,174,136"> |
---|
| 36 | <area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="0,56,174,80"> |
---|
| 37 | <area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="0,0,174,24"> |
---|
| 38 | </map> |
---|
| 39 | <a href="class_f_c_d_effect_parameter_surface-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> |
---|
| 40 | <tr><td></td></tr> |
---|
| 41 | <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
---|
| 42 | <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface.html#365475eff0f265c84c0b749b9d6e6e0d">FCDEffectParameterSurface</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document)</td></tr> |
---|
| 43 | |
---|
| 44 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor: do not use directly. <a href="#365475eff0f265c84c0b749b9d6e6e0d"></a><br></td></tr> |
---|
| 45 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface.html#ca4e01369df53ced292ff7cabbb9710c">~FCDEffectParameterSurface</a> ()</td></tr> |
---|
| 46 | |
---|
| 47 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor: do not use directly. <a href="#ca4e01369df53ced292ff7cabbb9710c"></a><br></td></tr> |
---|
| 48 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter.html#1efe74553d2ed199435085c171743b08">Type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface.html#48e1ec0933996bc9ebb5ef1ec9b8e334">GetType</a> () const </td></tr> |
---|
| 49 | |
---|
| 50 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the type of effect parameter class. <a href="#48e1ec0933996bc9ebb5ef1ec9b8e334"></a><br></td></tr> |
---|
| 51 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_effect_parameter_surface_init.html">FCDEffectParameterSurfaceInit</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface.html#1b399c2a8fbf1444d3978017f8abee01">GetInitMethod</a> ()</td></tr> |
---|
| 52 | |
---|
| 53 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the initialization method for the surface parameter. <a href="#1b399c2a8fbf1444d3978017f8abee01"></a><br></td></tr> |
---|
| 54 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6450a67e0c01706ff96363d2e86ee6f0"></a><!-- doxytag: member="FCDEffectParameterSurface::GetInitMethod" ref="6450a67e0c01706ff96363d2e86ee6f0" args="() const " --> |
---|
| 55 | const <a class="el" href="class_f_c_d_effect_parameter_surface_init.html">FCDEffectParameterSurfaceInit</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface.html#6450a67e0c01706ff96363d2e86ee6f0">GetInitMethod</a> () const </td></tr> |
---|
| 56 | |
---|
| 57 | <tr><td class="mdescLeft"> </td><td class="mdescRight">See above. <br></td></tr> |
---|
| 58 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface.html#eabfcc4c49e58c2838442a7812d8089e">SetInitMethod</a> (<a class="el" href="class_f_c_d_effect_parameter_surface_init.html">FCDEffectParameterSurfaceInit</a> *method)</td></tr> |
---|
| 59 | |
---|
| 60 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the initialization method for the surface parameter. <a href="#eabfcc4c49e58c2838442a7812d8089e"></a><br></td></tr> |
---|
| 61 | <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface.html#443aec0a023b31f27ffd8e1d182774fe">GetImageCount</a> () const </td></tr> |
---|
| 62 | |
---|
| 63 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the number of COLLADA images that make up this surface. <a href="#443aec0a023b31f27ffd8e1d182774fe"></a><br></td></tr> |
---|
| 64 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classvector.html">FCDImageList</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface.html#2817975ff6c2f3b84398b97117c7f2cd">GetImages</a> ()</td></tr> |
---|
| 65 | |
---|
| 66 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the list of images that make up this surface. <a href="#2817975ff6c2f3b84398b97117c7f2cd"></a><br></td></tr> |
---|
| 67 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9315d48ede476e01663240a2d57cfadd"></a><!-- doxytag: member="FCDEffectParameterSurface::GetImages" ref="9315d48ede476e01663240a2d57cfadd" args="() const " --> |
---|
| 68 | const <a class="el" href="classvector.html">FCDImageList</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface.html#9315d48ede476e01663240a2d57cfadd">GetImages</a> () const </td></tr> |
---|
| 69 | |
---|
| 70 | <tr><td class="mdescLeft"> </td><td class="mdescRight">See above. <br></td></tr> |
---|
| 71 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_image.html">FCDImage</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface.html#f4276ec08cfb3d4221ce194e853e035a">GetImage</a> (size_t index=0)</td></tr> |
---|
| 72 | |
---|
| 73 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a specific image. <a href="#f4276ec08cfb3d4221ce194e853e035a"></a><br></td></tr> |
---|
| 74 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5d1101a0718e31566ee4aba117a09df7"></a><!-- doxytag: member="FCDEffectParameterSurface::GetImage" ref="5d1101a0718e31566ee4aba117a09df7" args="(size_t index=0) const " --> |
---|
| 75 | const <a class="el" href="class_f_c_d_image.html">FCDImage</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface.html#5d1101a0718e31566ee4aba117a09df7">GetImage</a> (size_t index=0) const </td></tr> |
---|
| 76 | |
---|
| 77 | <tr><td class="mdescLeft"> </td><td class="mdescRight">See above. <br></td></tr> |
---|
| 78 | <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface.html#18ad28d3f7f968be42d64a3dcbdca6e4">FindImage</a> (const <a class="el" href="class_f_c_d_image.html">FCDImage</a> *image) const </td></tr> |
---|
| 79 | |
---|
| 80 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the index that matches the given image. <a href="#18ad28d3f7f968be42d64a3dcbdca6e4"></a><br></td></tr> |
---|
| 81 | <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface.html#3c372157a340d2532a34cda26f846a2a">AddImage</a> (<a class="el" href="class_f_c_d_image.html">FCDImage</a> *image)</td></tr> |
---|
| 82 | |
---|
| 83 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Adds an image to the list. <a href="#3c372157a340d2532a34cda26f846a2a"></a><br></td></tr> |
---|
| 84 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface.html#04c6197912f5111a3e8a880b448445f2">RemoveImage</a> (<a class="el" href="class_f_c_d_image.html">FCDImage</a> *image)</td></tr> |
---|
| 85 | |
---|
| 86 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Removes an image from the list. <a href="#04c6197912f5111a3e8a880b448445f2"></a><br></td></tr> |
---|
| 87 | <tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="class_f_m_vector3.html">FMVector3</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface.html#efdd7adb3a0405f786a0c2a4f3974067">GetSize</a> () const </td></tr> |
---|
| 88 | |
---|
| 89 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the wanted dimensions of the surface. <a href="#efdd7adb3a0405f786a0c2a4f3974067"></a><br></td></tr> |
---|
| 90 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface.html#ba3e88b59a7126a5ce96cc8f9cb9e124">SetSize</a> (const <a class="el" href="class_f_m_vector3.html">FMVector3</a> &dimensions)</td></tr> |
---|
| 91 | |
---|
| 92 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the wanted dimensions of the surface. <a href="#ba3e88b59a7126a5ce96cc8f9cb9e124"></a><br></td></tr> |
---|
| 93 | <tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface.html#6fe1ab43fe3939de50d6da9fe4968bd8">GetViewportRatio</a> () const </td></tr> |
---|
| 94 | |
---|
| 95 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the viewport ratio to use when the surface is a render target. <a href="#6fe1ab43fe3939de50d6da9fe4968bd8"></a><br></td></tr> |
---|
| 96 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface.html#88a5a9addf40ad180fcca095864f1bf1">SetViewportRatio</a> (float ratio)</td></tr> |
---|
| 97 | |
---|
| 98 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the viewport ratio to use when the surface is a render target. <a href="#88a5a9addf40ad180fcca095864f1bf1"></a><br></td></tr> |
---|
| 99 | <tr><td class="memItemLeft" nowrap align="right" valign="top">uint16 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface.html#ce5c0d37199d08306cd98c37b492f5ae">GetMipLevelCount</a> () const </td></tr> |
---|
| 100 | |
---|
| 101 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the wanted number of mip-levels. <a href="#ce5c0d37199d08306cd98c37b492f5ae"></a><br></td></tr> |
---|
| 102 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface.html#f6e4d39fce4cebf06f5a04025952c56f">SetMipLevelCount</a> (uint16 levelCount)</td></tr> |
---|
| 103 | |
---|
| 104 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the wanted number of mip-levels. <a href="#f6e4d39fce4cebf06f5a04025952c56f"></a><br></td></tr> |
---|
| 105 | <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface.html#0e48c062f07a3590da200d38b1001b6e">IsGenerateMipMaps</a> () const </td></tr> |
---|
| 106 | |
---|
| 107 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves whether to generate the mip-map levels on load. <a href="#0e48c062f07a3590da200d38b1001b6e"></a><br></td></tr> |
---|
| 108 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface.html#034a5471a03ed630a821343f927f1ae6">SetGenerateMipMaps</a> (bool _generateMipmaps)</td></tr> |
---|
| 109 | |
---|
| 110 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets whether to generate the mip-map levels of load. <a href="#034a5471a03ed630a821343f927f1ae6"></a><br></td></tr> |
---|
| 111 | <tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface.html#28a8ffd639296280a17677e74295f9de">GetName</a> (size_t index=0) const </td></tr> |
---|
| 112 | |
---|
| 113 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a specific sub-id. <a href="#28a8ffd639296280a17677e74295f9de"></a><br></td></tr> |
---|
| 114 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface.html#b9ade5c8f79c22fdd0e001f73a1504b8">Clone</a> ()</td></tr> |
---|
| 115 | |
---|
| 116 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a full copy of the effect parameter. <a href="#b9ade5c8f79c22fdd0e001f73a1504b8"></a><br></td></tr> |
---|
| 117 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface.html#152bf2814b0ab48add562f52109c400a">Overwrite</a> (<a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> *target)</td></tr> |
---|
| 118 | |
---|
| 119 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Overwrites the target parameter with this parameter. <a href="#152bf2814b0ab48add562f52109c400a"></a><br></td></tr> |
---|
| 120 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_u_status.html">FUStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface.html#c21a50c6bb603ff70d771e5cac5d8f4c">LoadFromXML</a> (xmlNode *parameterNode)</td></tr> |
---|
| 121 | |
---|
| 122 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Reads in the effect parameter from a given COLLADA XML tree node. <a href="#c21a50c6bb603ff70d771e5cac5d8f4c"></a><br></td></tr> |
---|
| 123 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual xmlNode * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface.html#7afa33510da0525c2bd3954bdaeb0541">WriteToXML</a> (xmlNode *parentNode) const </td></tr> |
---|
| 124 | |
---|
| 125 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Writes out the effect parameter to the given COLLADA XML tree node. <a href="#7afa33510da0525c2bd3954bdaeb0541"></a><br></td></tr> |
---|
| 126 | </table> |
---|
| 127 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
| 128 | A COLLADA surface parameter. |
---|
| 129 | <p> |
---|
| 130 | This parameters hold the texture loading information. The texture placement information should be held by the sampler parameter.<p> |
---|
| 131 | <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_f_c_d_effect_parameter_sampler.html">FCDEffectParameterSampler</a> </dd></dl> |
---|
| 132 | |
---|
| 133 | <p> |
---|
| 134 | <hr><h2>Constructor & Destructor Documentation</h2> |
---|
| 135 | <a class="anchor" name="365475eff0f265c84c0b749b9d6e6e0d"></a><!-- doxytag: member="FCDEffectParameterSurface::FCDEffectParameterSurface" ref="365475eff0f265c84c0b749b9d6e6e0d" args="(FCDocument *document)" --><p> |
---|
| 136 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 137 | <tr> |
---|
| 138 | <td class="mdRow"> |
---|
| 139 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 140 | <tr> |
---|
| 141 | <td class="md" nowrap valign="top">FCDEffectParameterSurface::FCDEffectParameterSurface </td> |
---|
| 142 | <td class="md" valign="top">( </td> |
---|
| 143 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> * </td> |
---|
| 144 | <td class="mdname1" valign="top" nowrap> <em>document</em> </td> |
---|
| 145 | <td class="md" valign="top"> ) </td> |
---|
| 146 | <td class="md" nowrap></td> |
---|
| 147 | </tr> |
---|
| 148 | </table> |
---|
| 149 | </td> |
---|
| 150 | </tr> |
---|
| 151 | </table> |
---|
| 152 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 153 | <tr> |
---|
| 154 | <td> |
---|
| 155 | |
---|
| 156 | </td> |
---|
| 157 | <td> |
---|
| 158 | |
---|
| 159 | <p> |
---|
| 160 | Constructor: do not use directly. |
---|
| 161 | <p> |
---|
| 162 | Instead, use the <a class="el" href="class_f_c_d_effect_parameter_list.html#da878b47cabf114c520fdf70bf252a2c">FCDEffectParameterList::AddParameter</a> function. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 163 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 164 | <tr><td valign="top"></td><td valign="top"><em>document</em> </td><td>The COLLADA document that owns the effect parameter. </td></tr> |
---|
| 165 | </table> |
---|
| 166 | </dl> |
---|
| 167 | </td> |
---|
| 168 | </tr> |
---|
| 169 | </table> |
---|
| 170 | <a class="anchor" name="ca4e01369df53ced292ff7cabbb9710c"></a><!-- doxytag: member="FCDEffectParameterSurface::~FCDEffectParameterSurface" ref="ca4e01369df53ced292ff7cabbb9710c" args="()" --><p> |
---|
| 171 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 172 | <tr> |
---|
| 173 | <td class="mdRow"> |
---|
| 174 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 175 | <tr> |
---|
| 176 | <td class="md" nowrap valign="top">virtual FCDEffectParameterSurface::~FCDEffectParameterSurface </td> |
---|
| 177 | <td class="md" valign="top">( </td> |
---|
| 178 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 179 | <td class="md" valign="top"> ) </td> |
---|
| 180 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
| 181 | </tr> |
---|
| 182 | </table> |
---|
| 183 | </td> |
---|
| 184 | </tr> |
---|
| 185 | </table> |
---|
| 186 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 187 | <tr> |
---|
| 188 | <td> |
---|
| 189 | |
---|
| 190 | </td> |
---|
| 191 | <td> |
---|
| 192 | |
---|
| 193 | <p> |
---|
| 194 | Destructor: do not use directly. |
---|
| 195 | <p> |
---|
| 196 | Instead, use the <a class="el" href="class_f_c_d_effect_parameter_list.html#b5ef02e0d258871d25d75666e199a9f3">FCDEffectParameterList::ReleaseParameter</a> function. When released, the effect parameter list will also release all its parameters, if it owns them. </td> |
---|
| 197 | </tr> |
---|
| 198 | </table> |
---|
| 199 | <hr><h2>Member Function Documentation</h2> |
---|
| 200 | <a class="anchor" name="3c372157a340d2532a34cda26f846a2a"></a><!-- doxytag: member="FCDEffectParameterSurface::AddImage" ref="3c372157a340d2532a34cda26f846a2a" args="(FCDImage *image)" --><p> |
---|
| 201 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 202 | <tr> |
---|
| 203 | <td class="mdRow"> |
---|
| 204 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 205 | <tr> |
---|
| 206 | <td class="md" nowrap valign="top">size_t FCDEffectParameterSurface::AddImage </td> |
---|
| 207 | <td class="md" valign="top">( </td> |
---|
| 208 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_image.html">FCDImage</a> * </td> |
---|
| 209 | <td class="mdname1" valign="top" nowrap> <em>image</em> </td> |
---|
| 210 | <td class="md" valign="top"> ) </td> |
---|
| 211 | <td class="md" nowrap></td> |
---|
| 212 | </tr> |
---|
| 213 | </table> |
---|
| 214 | </td> |
---|
| 215 | </tr> |
---|
| 216 | </table> |
---|
| 217 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 218 | <tr> |
---|
| 219 | <td> |
---|
| 220 | |
---|
| 221 | </td> |
---|
| 222 | <td> |
---|
| 223 | |
---|
| 224 | <p> |
---|
| 225 | Adds an image to the list. |
---|
| 226 | <p> |
---|
| 227 | The initialization method indexes the images from this list. This function will verify that this image does not already exist within the list, so use the returned index. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 228 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 229 | <tr><td valign="top"></td><td valign="top"><em>image</em> </td><td>The new image. </td></tr> |
---|
| 230 | </table> |
---|
| 231 | </dl> |
---|
| 232 | <dl compact><dt><b>Returns:</b></dt><dd>The index of the image within the list. </dd></dl> |
---|
| 233 | </td> |
---|
| 234 | </tr> |
---|
| 235 | </table> |
---|
| 236 | <a class="anchor" name="b9ade5c8f79c22fdd0e001f73a1504b8"></a><!-- doxytag: member="FCDEffectParameterSurface::Clone" ref="b9ade5c8f79c22fdd0e001f73a1504b8" args="()" --><p> |
---|
| 237 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 238 | <tr> |
---|
| 239 | <td class="mdRow"> |
---|
| 240 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 241 | <tr> |
---|
| 242 | <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a>* FCDEffectParameterSurface::Clone </td> |
---|
| 243 | <td class="md" valign="top">( </td> |
---|
| 244 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 245 | <td class="md" valign="top"> ) </td> |
---|
| 246 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
| 247 | </tr> |
---|
| 248 | </table> |
---|
| 249 | </td> |
---|
| 250 | </tr> |
---|
| 251 | </table> |
---|
| 252 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 253 | <tr> |
---|
| 254 | <td> |
---|
| 255 | |
---|
| 256 | </td> |
---|
| 257 | <td> |
---|
| 258 | |
---|
| 259 | <p> |
---|
| 260 | Creates a full copy of the effect parameter. |
---|
| 261 | <p> |
---|
| 262 | <dl compact><dt><b><a class="el" href="todo.html#_todo000003">Todo:</a></b></dt><dd>The cloning does not clone the initialization method correctly. </dd></dl> |
---|
| 263 | <dl compact><dt><b>Returns:</b></dt><dd>The cloned effect parameter. You will need to delete this pointer. </dd></dl> |
---|
| 264 | |
---|
| 265 | <p> |
---|
| 266 | Implements <a class="el" href="class_f_c_d_effect_parameter.html#760f178513367b602f7c3363a158b76e">FCDEffectParameter</a>. </td> |
---|
| 267 | </tr> |
---|
| 268 | </table> |
---|
| 269 | <a class="anchor" name="18ad28d3f7f968be42d64a3dcbdca6e4"></a><!-- doxytag: member="FCDEffectParameterSurface::FindImage" ref="18ad28d3f7f968be42d64a3dcbdca6e4" args="(const FCDImage *image) const " --><p> |
---|
| 270 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 271 | <tr> |
---|
| 272 | <td class="mdRow"> |
---|
| 273 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 274 | <tr> |
---|
| 275 | <td class="md" nowrap valign="top">size_t FCDEffectParameterSurface::FindImage </td> |
---|
| 276 | <td class="md" valign="top">( </td> |
---|
| 277 | <td class="md" nowrap valign="top">const <a class="el" href="class_f_c_d_image.html">FCDImage</a> * </td> |
---|
| 278 | <td class="mdname1" valign="top" nowrap> <em>image</em> </td> |
---|
| 279 | <td class="md" valign="top"> ) </td> |
---|
| 280 | <td class="md" nowrap> const</td> |
---|
| 281 | </tr> |
---|
| 282 | </table> |
---|
| 283 | </td> |
---|
| 284 | </tr> |
---|
| 285 | </table> |
---|
| 286 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 287 | <tr> |
---|
| 288 | <td> |
---|
| 289 | |
---|
| 290 | </td> |
---|
| 291 | <td> |
---|
| 292 | |
---|
| 293 | <p> |
---|
| 294 | Retrieves the index that matches the given image. |
---|
| 295 | <p> |
---|
| 296 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 297 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 298 | <tr><td valign="top"></td><td valign="top"><em>image</em> </td><td>The image to match. </td></tr> |
---|
| 299 | </table> |
---|
| 300 | </dl> |
---|
| 301 | <dl compact><dt><b>Returns:</b></dt><dd>The index within the list for this image. This index may be -1 if no match was found. </dd></dl> |
---|
| 302 | </td> |
---|
| 303 | </tr> |
---|
| 304 | </table> |
---|
| 305 | <a class="anchor" name="f4276ec08cfb3d4221ce194e853e035a"></a><!-- doxytag: member="FCDEffectParameterSurface::GetImage" ref="f4276ec08cfb3d4221ce194e853e035a" args="(size_t index=0)" --><p> |
---|
| 306 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 307 | <tr> |
---|
| 308 | <td class="mdRow"> |
---|
| 309 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 310 | <tr> |
---|
| 311 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_image.html">FCDImage</a>* FCDEffectParameterSurface::GetImage </td> |
---|
| 312 | <td class="md" valign="top">( </td> |
---|
| 313 | <td class="md" nowrap valign="top">size_t </td> |
---|
| 314 | <td class="mdname1" valign="top" nowrap> <em>index</em> = <code>0</code> </td> |
---|
| 315 | <td class="md" valign="top"> ) </td> |
---|
| 316 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 317 | </tr> |
---|
| 318 | </table> |
---|
| 319 | </td> |
---|
| 320 | </tr> |
---|
| 321 | </table> |
---|
| 322 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 323 | <tr> |
---|
| 324 | <td> |
---|
| 325 | |
---|
| 326 | </td> |
---|
| 327 | <td> |
---|
| 328 | |
---|
| 329 | <p> |
---|
| 330 | Retrieves a specific image. |
---|
| 331 | <p> |
---|
| 332 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 333 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 334 | <tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>The index of the image. </td></tr> |
---|
| 335 | </table> |
---|
| 336 | </dl> |
---|
| 337 | <dl compact><dt><b>Returns:</b></dt><dd>The image. This pointer will be NULL if the index is out-of-bounds. </dd></dl> |
---|
| 338 | </td> |
---|
| 339 | </tr> |
---|
| 340 | </table> |
---|
| 341 | <a class="anchor" name="443aec0a023b31f27ffd8e1d182774fe"></a><!-- doxytag: member="FCDEffectParameterSurface::GetImageCount" ref="443aec0a023b31f27ffd8e1d182774fe" args="() const " --><p> |
---|
| 342 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 343 | <tr> |
---|
| 344 | <td class="mdRow"> |
---|
| 345 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 346 | <tr> |
---|
| 347 | <td class="md" nowrap valign="top">size_t FCDEffectParameterSurface::GetImageCount </td> |
---|
| 348 | <td class="md" valign="top">( </td> |
---|
| 349 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 350 | <td class="md" valign="top"> ) </td> |
---|
| 351 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
| 352 | </tr> |
---|
| 353 | </table> |
---|
| 354 | </td> |
---|
| 355 | </tr> |
---|
| 356 | </table> |
---|
| 357 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 358 | <tr> |
---|
| 359 | <td> |
---|
| 360 | |
---|
| 361 | </td> |
---|
| 362 | <td> |
---|
| 363 | |
---|
| 364 | <p> |
---|
| 365 | Retrieves the number of COLLADA images that make up this surface. |
---|
| 366 | <p> |
---|
| 367 | There should never be more than six images to build a surface. In the large majority of cases, expect one image. <dl compact><dt><b>Returns:</b></dt><dd>The number of images. </dd></dl> |
---|
| 368 | </td> |
---|
| 369 | </tr> |
---|
| 370 | </table> |
---|
| 371 | <a class="anchor" name="2817975ff6c2f3b84398b97117c7f2cd"></a><!-- doxytag: member="FCDEffectParameterSurface::GetImages" ref="2817975ff6c2f3b84398b97117c7f2cd" args="()" --><p> |
---|
| 372 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 373 | <tr> |
---|
| 374 | <td class="mdRow"> |
---|
| 375 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 376 | <tr> |
---|
| 377 | <td class="md" nowrap valign="top"><a class="el" href="classvector.html">FCDImageList</a>& FCDEffectParameterSurface::GetImages </td> |
---|
| 378 | <td class="md" valign="top">( </td> |
---|
| 379 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 380 | <td class="md" valign="top"> ) </td> |
---|
| 381 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 382 | </tr> |
---|
| 383 | </table> |
---|
| 384 | </td> |
---|
| 385 | </tr> |
---|
| 386 | </table> |
---|
| 387 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 388 | <tr> |
---|
| 389 | <td> |
---|
| 390 | |
---|
| 391 | </td> |
---|
| 392 | <td> |
---|
| 393 | |
---|
| 394 | <p> |
---|
| 395 | Retrieves the list of images that make up this surface. |
---|
| 396 | <p> |
---|
| 397 | There should never be more than six images to build a surface. In the large majority of cases, expect one image. <dl compact><dt><b>Returns:</b></dt><dd>The list of images. </dd></dl> |
---|
| 398 | </td> |
---|
| 399 | </tr> |
---|
| 400 | </table> |
---|
| 401 | <a class="anchor" name="1b399c2a8fbf1444d3978017f8abee01"></a><!-- doxytag: member="FCDEffectParameterSurface::GetInitMethod" ref="1b399c2a8fbf1444d3978017f8abee01" args="()" --><p> |
---|
| 402 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 403 | <tr> |
---|
| 404 | <td class="mdRow"> |
---|
| 405 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 406 | <tr> |
---|
| 407 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter_surface_init.html">FCDEffectParameterSurfaceInit</a>* FCDEffectParameterSurface::GetInitMethod </td> |
---|
| 408 | <td class="md" valign="top">( </td> |
---|
| 409 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 410 | <td class="md" valign="top"> ) </td> |
---|
| 411 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 412 | </tr> |
---|
| 413 | </table> |
---|
| 414 | </td> |
---|
| 415 | </tr> |
---|
| 416 | </table> |
---|
| 417 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 418 | <tr> |
---|
| 419 | <td> |
---|
| 420 | |
---|
| 421 | </td> |
---|
| 422 | <td> |
---|
| 423 | |
---|
| 424 | <p> |
---|
| 425 | Retrieves the initialization method for the surface parameter. |
---|
| 426 | <p> |
---|
| 427 | The initialization method is a powerful method of describing how to build complex textures, such as cube maps, from one or multiple image files. <dl compact><dt><b>Returns:</b></dt><dd>The surface initialization method. This pointer will be NULL, if no initialization method is provided. </dd></dl> |
---|
| 428 | </td> |
---|
| 429 | </tr> |
---|
| 430 | </table> |
---|
| 431 | <a class="anchor" name="ce5c0d37199d08306cd98c37b492f5ae"></a><!-- doxytag: member="FCDEffectParameterSurface::GetMipLevelCount" ref="ce5c0d37199d08306cd98c37b492f5ae" args="() const " --><p> |
---|
| 432 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 433 | <tr> |
---|
| 434 | <td class="mdRow"> |
---|
| 435 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 436 | <tr> |
---|
| 437 | <td class="md" nowrap valign="top">uint16 FCDEffectParameterSurface::GetMipLevelCount </td> |
---|
| 438 | <td class="md" valign="top">( </td> |
---|
| 439 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 440 | <td class="md" valign="top"> ) </td> |
---|
| 441 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
| 442 | </tr> |
---|
| 443 | </table> |
---|
| 444 | </td> |
---|
| 445 | </tr> |
---|
| 446 | </table> |
---|
| 447 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 448 | <tr> |
---|
| 449 | <td> |
---|
| 450 | |
---|
| 451 | </td> |
---|
| 452 | <td> |
---|
| 453 | |
---|
| 454 | <p> |
---|
| 455 | Retrieves the wanted number of mip-levels. |
---|
| 456 | <p> |
---|
| 457 | This parameter is optional and may be zero to indicate that you should retrieve the mip-levels from the image file(s) or generate a full mip-chain, depending on the mip-map generate flag. <dl compact><dt><b>See also:</b></dt><dd>GetMipMapGenerate </dd></dl> |
---|
| 458 | <dl compact><dt><b>Returns:</b></dt><dd>The wanted number of mip-levels. </dd></dl> |
---|
| 459 | </td> |
---|
| 460 | </tr> |
---|
| 461 | </table> |
---|
| 462 | <a class="anchor" name="28a8ffd639296280a17677e74295f9de"></a><!-- doxytag: member="FCDEffectParameterSurface::GetName" ref="28a8ffd639296280a17677e74295f9de" args="(size_t index=0) const " --><p> |
---|
| 463 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 464 | <tr> |
---|
| 465 | <td class="mdRow"> |
---|
| 466 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 467 | <tr> |
---|
| 468 | <td class="md" nowrap valign="top">const char* FCDEffectParameterSurface::GetName </td> |
---|
| 469 | <td class="md" valign="top">( </td> |
---|
| 470 | <td class="md" nowrap valign="top">size_t </td> |
---|
| 471 | <td class="mdname1" valign="top" nowrap> <em>index</em> = <code>0</code> </td> |
---|
| 472 | <td class="md" valign="top"> ) </td> |
---|
| 473 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
| 474 | </tr> |
---|
| 475 | </table> |
---|
| 476 | </td> |
---|
| 477 | </tr> |
---|
| 478 | </table> |
---|
| 479 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 480 | <tr> |
---|
| 481 | <td> |
---|
| 482 | |
---|
| 483 | </td> |
---|
| 484 | <td> |
---|
| 485 | |
---|
| 486 | <p> |
---|
| 487 | Retrieves a specific sub-id. |
---|
| 488 | <p> |
---|
| 489 | <dl compact><dt><b><a class="el" href="todo.html#_todo000002">Todo:</a></b></dt><dd>I'm not too sure of the implications of the names, at this level of abstraction: once I'm clear why they exists, add the necessary interface to access/pull/push items from/to the list. </dd></dl> |
---|
| 490 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 491 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 492 | <tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>The sub-id index. </td></tr> |
---|
| 493 | </table> |
---|
| 494 | </dl> |
---|
| 495 | <dl compact><dt><b>Returns:</b></dt><dd>The sub-id. This pointer will be NULL if the index is out-of-bounds. </dd></dl> |
---|
| 496 | </td> |
---|
| 497 | </tr> |
---|
| 498 | </table> |
---|
| 499 | <a class="anchor" name="efdd7adb3a0405f786a0c2a4f3974067"></a><!-- doxytag: member="FCDEffectParameterSurface::GetSize" ref="efdd7adb3a0405f786a0c2a4f3974067" args="() const " --><p> |
---|
| 500 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 501 | <tr> |
---|
| 502 | <td class="mdRow"> |
---|
| 503 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 504 | <tr> |
---|
| 505 | <td class="md" nowrap valign="top">const <a class="el" href="class_f_m_vector3.html">FMVector3</a>& FCDEffectParameterSurface::GetSize </td> |
---|
| 506 | <td class="md" valign="top">( </td> |
---|
| 507 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 508 | <td class="md" valign="top"> ) </td> |
---|
| 509 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
| 510 | </tr> |
---|
| 511 | </table> |
---|
| 512 | </td> |
---|
| 513 | </tr> |
---|
| 514 | </table> |
---|
| 515 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 516 | <tr> |
---|
| 517 | <td> |
---|
| 518 | |
---|
| 519 | </td> |
---|
| 520 | <td> |
---|
| 521 | |
---|
| 522 | <p> |
---|
| 523 | Retrieves the wanted dimensions of the surface. |
---|
| 524 | <p> |
---|
| 525 | This parameter is optional and may contain all zeroes to indicate that you should read the surface dimensions from the image file(s). <dl compact><dt><b>Returns:</b></dt><dd>The wanted dimensions. </dd></dl> |
---|
| 526 | </td> |
---|
| 527 | </tr> |
---|
| 528 | </table> |
---|
| 529 | <a class="anchor" name="48e1ec0933996bc9ebb5ef1ec9b8e334"></a><!-- doxytag: member="FCDEffectParameterSurface::GetType" ref="48e1ec0933996bc9ebb5ef1ec9b8e334" args="() const " --><p> |
---|
| 530 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 531 | <tr> |
---|
| 532 | <td class="mdRow"> |
---|
| 533 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 534 | <tr> |
---|
| 535 | <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter.html#1efe74553d2ed199435085c171743b08">Type</a> FCDEffectParameterSurface::GetType </td> |
---|
| 536 | <td class="md" valign="top">( </td> |
---|
| 537 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 538 | <td class="md" valign="top"> ) </td> |
---|
| 539 | <td class="md" nowrap> const<code> [inline, virtual]</code></td> |
---|
| 540 | </tr> |
---|
| 541 | </table> |
---|
| 542 | </td> |
---|
| 543 | </tr> |
---|
| 544 | </table> |
---|
| 545 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 546 | <tr> |
---|
| 547 | <td> |
---|
| 548 | |
---|
| 549 | </td> |
---|
| 550 | <td> |
---|
| 551 | |
---|
| 552 | <p> |
---|
| 553 | Retrieves the type of effect parameter class. |
---|
| 554 | <p> |
---|
| 555 | <dl compact><dt><b>Returns:</b></dt><dd>The parameter class type: SURFACE. </dd></dl> |
---|
| 556 | |
---|
| 557 | <p> |
---|
| 558 | Implements <a class="el" href="class_f_c_d_effect_parameter.html#5858946f333ea4486ca30c4c1b104871">FCDEffectParameter</a>. </td> |
---|
| 559 | </tr> |
---|
| 560 | </table> |
---|
| 561 | <a class="anchor" name="6fe1ab43fe3939de50d6da9fe4968bd8"></a><!-- doxytag: member="FCDEffectParameterSurface::GetViewportRatio" ref="6fe1ab43fe3939de50d6da9fe4968bd8" args="() const " --><p> |
---|
| 562 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 563 | <tr> |
---|
| 564 | <td class="mdRow"> |
---|
| 565 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 566 | <tr> |
---|
| 567 | <td class="md" nowrap valign="top">float FCDEffectParameterSurface::GetViewportRatio </td> |
---|
| 568 | <td class="md" valign="top">( </td> |
---|
| 569 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 570 | <td class="md" valign="top"> ) </td> |
---|
| 571 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
| 572 | </tr> |
---|
| 573 | </table> |
---|
| 574 | </td> |
---|
| 575 | </tr> |
---|
| 576 | </table> |
---|
| 577 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 578 | <tr> |
---|
| 579 | <td> |
---|
| 580 | |
---|
| 581 | </td> |
---|
| 582 | <td> |
---|
| 583 | |
---|
| 584 | <p> |
---|
| 585 | Retrieves the viewport ratio to use when the surface is a render target. |
---|
| 586 | <p> |
---|
| 587 | <dl compact><dt><b>Returns:</b></dt><dd>The viewport ratio. </dd></dl> |
---|
| 588 | </td> |
---|
| 589 | </tr> |
---|
| 590 | </table> |
---|
| 591 | <a class="anchor" name="0e48c062f07a3590da200d38b1001b6e"></a><!-- doxytag: member="FCDEffectParameterSurface::IsGenerateMipMaps" ref="0e48c062f07a3590da200d38b1001b6e" args="() const " --><p> |
---|
| 592 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 593 | <tr> |
---|
| 594 | <td class="mdRow"> |
---|
| 595 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 596 | <tr> |
---|
| 597 | <td class="md" nowrap valign="top">bool FCDEffectParameterSurface::IsGenerateMipMaps </td> |
---|
| 598 | <td class="md" valign="top">( </td> |
---|
| 599 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 600 | <td class="md" valign="top"> ) </td> |
---|
| 601 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
| 602 | </tr> |
---|
| 603 | </table> |
---|
| 604 | </td> |
---|
| 605 | </tr> |
---|
| 606 | </table> |
---|
| 607 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 608 | <tr> |
---|
| 609 | <td> |
---|
| 610 | |
---|
| 611 | </td> |
---|
| 612 | <td> |
---|
| 613 | |
---|
| 614 | <p> |
---|
| 615 | Retrieves whether to generate the mip-map levels on load. |
---|
| 616 | <p> |
---|
| 617 | The alternative is to load the mip-map levels from the image files. <dl compact><dt><b>Returns:</b></dt><dd>Whether to generate the mip-map levels on load. </dd></dl> |
---|
| 618 | </td> |
---|
| 619 | </tr> |
---|
| 620 | </table> |
---|
| 621 | <a class="anchor" name="c21a50c6bb603ff70d771e5cac5d8f4c"></a><!-- doxytag: member="FCDEffectParameterSurface::LoadFromXML" ref="c21a50c6bb603ff70d771e5cac5d8f4c" args="(xmlNode *parameterNode)" --><p> |
---|
| 622 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 623 | <tr> |
---|
| 624 | <td class="mdRow"> |
---|
| 625 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 626 | <tr> |
---|
| 627 | <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_u_status.html">FUStatus</a> FCDEffectParameterSurface::LoadFromXML </td> |
---|
| 628 | <td class="md" valign="top">( </td> |
---|
| 629 | <td class="md" nowrap valign="top">xmlNode * </td> |
---|
| 630 | <td class="mdname1" valign="top" nowrap> <em>parameterNode</em> </td> |
---|
| 631 | <td class="md" valign="top"> ) </td> |
---|
| 632 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
| 633 | </tr> |
---|
| 634 | </table> |
---|
| 635 | </td> |
---|
| 636 | </tr> |
---|
| 637 | </table> |
---|
| 638 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 639 | <tr> |
---|
| 640 | <td> |
---|
| 641 | |
---|
| 642 | </td> |
---|
| 643 | <td> |
---|
| 644 | |
---|
| 645 | <p> |
---|
| 646 | [INTERNAL] Reads in the effect parameter from a given COLLADA XML tree node. |
---|
| 647 | <p> |
---|
| 648 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 649 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 650 | <tr><td valign="top"></td><td valign="top"><em>parameterNode</em> </td><td>The COLLADA XML tree node. </td></tr> |
---|
| 651 | </table> |
---|
| 652 | </dl> |
---|
| 653 | <dl compact><dt><b>Returns:</b></dt><dd>The status of the import. If the status is not successful, it may be dangerous to extract information from the parameter. </dd></dl> |
---|
| 654 | |
---|
| 655 | <p> |
---|
| 656 | Reimplemented from <a class="el" href="class_f_c_d_effect_parameter.html#c9dacd1e9af15e71f54daf59b3f142fd">FCDEffectParameter</a>. </td> |
---|
| 657 | </tr> |
---|
| 658 | </table> |
---|
| 659 | <a class="anchor" name="152bf2814b0ab48add562f52109c400a"></a><!-- doxytag: member="FCDEffectParameterSurface::Overwrite" ref="152bf2814b0ab48add562f52109c400a" args="(FCDEffectParameter *target)" --><p> |
---|
| 660 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 661 | <tr> |
---|
| 662 | <td class="mdRow"> |
---|
| 663 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 664 | <tr> |
---|
| 665 | <td class="md" nowrap valign="top">virtual void FCDEffectParameterSurface::Overwrite </td> |
---|
| 666 | <td class="md" valign="top">( </td> |
---|
| 667 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> * </td> |
---|
| 668 | <td class="mdname1" valign="top" nowrap> <em>target</em> </td> |
---|
| 669 | <td class="md" valign="top"> ) </td> |
---|
| 670 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
| 671 | </tr> |
---|
| 672 | </table> |
---|
| 673 | </td> |
---|
| 674 | </tr> |
---|
| 675 | </table> |
---|
| 676 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 677 | <tr> |
---|
| 678 | <td> |
---|
| 679 | |
---|
| 680 | </td> |
---|
| 681 | <td> |
---|
| 682 | |
---|
| 683 | <p> |
---|
| 684 | [INTERNAL] Overwrites the target parameter with this parameter. |
---|
| 685 | <p> |
---|
| 686 | This function is used during the flattening of materials. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 687 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 688 | <tr><td valign="top"></td><td valign="top"><em>target</em> </td><td>The target parameter to overwrite. </td></tr> |
---|
| 689 | </table> |
---|
| 690 | </dl> |
---|
| 691 | |
---|
| 692 | <p> |
---|
| 693 | Reimplemented from <a class="el" href="class_f_c_d_effect_parameter.html#016be91dbd27ff3c8c30f759f00b8c53">FCDEffectParameter</a>. </td> |
---|
| 694 | </tr> |
---|
| 695 | </table> |
---|
| 696 | <a class="anchor" name="04c6197912f5111a3e8a880b448445f2"></a><!-- doxytag: member="FCDEffectParameterSurface::RemoveImage" ref="04c6197912f5111a3e8a880b448445f2" args="(FCDImage *image)" --><p> |
---|
| 697 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 698 | <tr> |
---|
| 699 | <td class="mdRow"> |
---|
| 700 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 701 | <tr> |
---|
| 702 | <td class="md" nowrap valign="top">void FCDEffectParameterSurface::RemoveImage </td> |
---|
| 703 | <td class="md" valign="top">( </td> |
---|
| 704 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_image.html">FCDImage</a> * </td> |
---|
| 705 | <td class="mdname1" valign="top" nowrap> <em>image</em> </td> |
---|
| 706 | <td class="md" valign="top"> ) </td> |
---|
| 707 | <td class="md" nowrap></td> |
---|
| 708 | </tr> |
---|
| 709 | </table> |
---|
| 710 | </td> |
---|
| 711 | </tr> |
---|
| 712 | </table> |
---|
| 713 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 714 | <tr> |
---|
| 715 | <td> |
---|
| 716 | |
---|
| 717 | </td> |
---|
| 718 | <td> |
---|
| 719 | |
---|
| 720 | <p> |
---|
| 721 | Removes an image from the list. |
---|
| 722 | <p> |
---|
| 723 | The initialization method indexes the images from this list. This function will shift all the indexes in the initialization method so that they continue matching the correct image. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 724 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 725 | <tr><td valign="top"></td><td valign="top"><em>image</em> </td><td>The image to remove. Its memory is not released. </td></tr> |
---|
| 726 | </table> |
---|
| 727 | </dl> |
---|
| 728 | </td> |
---|
| 729 | </tr> |
---|
| 730 | </table> |
---|
| 731 | <a class="anchor" name="034a5471a03ed630a821343f927f1ae6"></a><!-- doxytag: member="FCDEffectParameterSurface::SetGenerateMipMaps" ref="034a5471a03ed630a821343f927f1ae6" args="(bool _generateMipmaps)" --><p> |
---|
| 732 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 733 | <tr> |
---|
| 734 | <td class="mdRow"> |
---|
| 735 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 736 | <tr> |
---|
| 737 | <td class="md" nowrap valign="top">void FCDEffectParameterSurface::SetGenerateMipMaps </td> |
---|
| 738 | <td class="md" valign="top">( </td> |
---|
| 739 | <td class="md" nowrap valign="top">bool </td> |
---|
| 740 | <td class="mdname1" valign="top" nowrap> <em>_generateMipmaps</em> </td> |
---|
| 741 | <td class="md" valign="top"> ) </td> |
---|
| 742 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 743 | </tr> |
---|
| 744 | </table> |
---|
| 745 | </td> |
---|
| 746 | </tr> |
---|
| 747 | </table> |
---|
| 748 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 749 | <tr> |
---|
| 750 | <td> |
---|
| 751 | |
---|
| 752 | </td> |
---|
| 753 | <td> |
---|
| 754 | |
---|
| 755 | <p> |
---|
| 756 | Sets whether to generate the mip-map levels of load. |
---|
| 757 | <p> |
---|
| 758 | The alternative is to load the mip-map levels from the image files. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 759 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 760 | <tr><td valign="top"></td><td valign="top"><em>_generateMipmaps</em> </td><td>Whether to generate the mip-map levels on load. </td></tr> |
---|
| 761 | </table> |
---|
| 762 | </dl> |
---|
| 763 | </td> |
---|
| 764 | </tr> |
---|
| 765 | </table> |
---|
| 766 | <a class="anchor" name="eabfcc4c49e58c2838442a7812d8089e"></a><!-- doxytag: member="FCDEffectParameterSurface::SetInitMethod" ref="eabfcc4c49e58c2838442a7812d8089e" args="(FCDEffectParameterSurfaceInit *method)" --><p> |
---|
| 767 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 768 | <tr> |
---|
| 769 | <td class="mdRow"> |
---|
| 770 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 771 | <tr> |
---|
| 772 | <td class="md" nowrap valign="top">void FCDEffectParameterSurface::SetInitMethod </td> |
---|
| 773 | <td class="md" valign="top">( </td> |
---|
| 774 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter_surface_init.html">FCDEffectParameterSurfaceInit</a> * </td> |
---|
| 775 | <td class="mdname1" valign="top" nowrap> <em>method</em> </td> |
---|
| 776 | <td class="md" valign="top"> ) </td> |
---|
| 777 | <td class="md" nowrap></td> |
---|
| 778 | </tr> |
---|
| 779 | </table> |
---|
| 780 | </td> |
---|
| 781 | </tr> |
---|
| 782 | </table> |
---|
| 783 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 784 | <tr> |
---|
| 785 | <td> |
---|
| 786 | |
---|
| 787 | </td> |
---|
| 788 | <td> |
---|
| 789 | |
---|
| 790 | <p> |
---|
| 791 | Sets the initialization method for the surface parameter. |
---|
| 792 | <p> |
---|
| 793 | The initialization method is a powerful method of describing how to build complex textures, such as cube maps, from one or multiple image files. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 794 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 795 | <tr><td valign="top"></td><td valign="top"><em>method</em> </td><td>The new initialization method. The old initialization method will be released. You should create a new initialization method for each surface parameter. </td></tr> |
---|
| 796 | </table> |
---|
| 797 | </dl> |
---|
| 798 | </td> |
---|
| 799 | </tr> |
---|
| 800 | </table> |
---|
| 801 | <a class="anchor" name="f6e4d39fce4cebf06f5a04025952c56f"></a><!-- doxytag: member="FCDEffectParameterSurface::SetMipLevelCount" ref="f6e4d39fce4cebf06f5a04025952c56f" args="(uint16 levelCount)" --><p> |
---|
| 802 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 803 | <tr> |
---|
| 804 | <td class="mdRow"> |
---|
| 805 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 806 | <tr> |
---|
| 807 | <td class="md" nowrap valign="top">void FCDEffectParameterSurface::SetMipLevelCount </td> |
---|
| 808 | <td class="md" valign="top">( </td> |
---|
| 809 | <td class="md" nowrap valign="top">uint16 </td> |
---|
| 810 | <td class="mdname1" valign="top" nowrap> <em>levelCount</em> </td> |
---|
| 811 | <td class="md" valign="top"> ) </td> |
---|
| 812 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 813 | </tr> |
---|
| 814 | </table> |
---|
| 815 | </td> |
---|
| 816 | </tr> |
---|
| 817 | </table> |
---|
| 818 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 819 | <tr> |
---|
| 820 | <td> |
---|
| 821 | |
---|
| 822 | </td> |
---|
| 823 | <td> |
---|
| 824 | |
---|
| 825 | <p> |
---|
| 826 | Sets the wanted number of mip-levels. |
---|
| 827 | <p> |
---|
| 828 | This parameter is optional and can be zero to indicate that you should retrieve the mip-levels from the image file(s) or generate a full mip-chain, depending on the mip-map generate flag. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 829 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 830 | <tr><td valign="top"></td><td valign="top"><em>levelCount</em> </td><td>The wanted number of mip-levels. </td></tr> |
---|
| 831 | </table> |
---|
| 832 | </dl> |
---|
| 833 | </td> |
---|
| 834 | </tr> |
---|
| 835 | </table> |
---|
| 836 | <a class="anchor" name="ba3e88b59a7126a5ce96cc8f9cb9e124"></a><!-- doxytag: member="FCDEffectParameterSurface::SetSize" ref="ba3e88b59a7126a5ce96cc8f9cb9e124" args="(const FMVector3 &dimensions)" --><p> |
---|
| 837 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 838 | <tr> |
---|
| 839 | <td class="mdRow"> |
---|
| 840 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 841 | <tr> |
---|
| 842 | <td class="md" nowrap valign="top">void FCDEffectParameterSurface::SetSize </td> |
---|
| 843 | <td class="md" valign="top">( </td> |
---|
| 844 | <td class="md" nowrap valign="top">const <a class="el" href="class_f_m_vector3.html">FMVector3</a> & </td> |
---|
| 845 | <td class="mdname1" valign="top" nowrap> <em>dimensions</em> </td> |
---|
| 846 | <td class="md" valign="top"> ) </td> |
---|
| 847 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 848 | </tr> |
---|
| 849 | </table> |
---|
| 850 | </td> |
---|
| 851 | </tr> |
---|
| 852 | </table> |
---|
| 853 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 854 | <tr> |
---|
| 855 | <td> |
---|
| 856 | |
---|
| 857 | </td> |
---|
| 858 | <td> |
---|
| 859 | |
---|
| 860 | <p> |
---|
| 861 | Sets the wanted dimensions of the surface. |
---|
| 862 | <p> |
---|
| 863 | This parameter is optional and can contain all zeroes to indicate that you should read the surface dimensions from the image file(s). <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 864 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 865 | <tr><td valign="top"></td><td valign="top"><em>dimensions</em> </td><td>The wanted dimensions. </td></tr> |
---|
| 866 | </table> |
---|
| 867 | </dl> |
---|
| 868 | </td> |
---|
| 869 | </tr> |
---|
| 870 | </table> |
---|
| 871 | <a class="anchor" name="88a5a9addf40ad180fcca095864f1bf1"></a><!-- doxytag: member="FCDEffectParameterSurface::SetViewportRatio" ref="88a5a9addf40ad180fcca095864f1bf1" args="(float ratio)" --><p> |
---|
| 872 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 873 | <tr> |
---|
| 874 | <td class="mdRow"> |
---|
| 875 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 876 | <tr> |
---|
| 877 | <td class="md" nowrap valign="top">void FCDEffectParameterSurface::SetViewportRatio </td> |
---|
| 878 | <td class="md" valign="top">( </td> |
---|
| 879 | <td class="md" nowrap valign="top">float </td> |
---|
| 880 | <td class="mdname1" valign="top" nowrap> <em>ratio</em> </td> |
---|
| 881 | <td class="md" valign="top"> ) </td> |
---|
| 882 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 883 | </tr> |
---|
| 884 | </table> |
---|
| 885 | </td> |
---|
| 886 | </tr> |
---|
| 887 | </table> |
---|
| 888 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 889 | <tr> |
---|
| 890 | <td> |
---|
| 891 | |
---|
| 892 | </td> |
---|
| 893 | <td> |
---|
| 894 | |
---|
| 895 | <p> |
---|
| 896 | Sets the viewport ratio to use when the surface is a render target. |
---|
| 897 | <p> |
---|
| 898 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 899 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 900 | <tr><td valign="top"></td><td valign="top"><em>ratio</em> </td><td>The viewport ratio. </td></tr> |
---|
| 901 | </table> |
---|
| 902 | </dl> |
---|
| 903 | </td> |
---|
| 904 | </tr> |
---|
| 905 | </table> |
---|
| 906 | <a class="anchor" name="7afa33510da0525c2bd3954bdaeb0541"></a><!-- doxytag: member="FCDEffectParameterSurface::WriteToXML" ref="7afa33510da0525c2bd3954bdaeb0541" args="(xmlNode *parentNode) const " --><p> |
---|
| 907 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 908 | <tr> |
---|
| 909 | <td class="mdRow"> |
---|
| 910 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 911 | <tr> |
---|
| 912 | <td class="md" nowrap valign="top">virtual xmlNode* FCDEffectParameterSurface::WriteToXML </td> |
---|
| 913 | <td class="md" valign="top">( </td> |
---|
| 914 | <td class="md" nowrap valign="top">xmlNode * </td> |
---|
| 915 | <td class="mdname1" valign="top" nowrap> <em>parentNode</em> </td> |
---|
| 916 | <td class="md" valign="top"> ) </td> |
---|
| 917 | <td class="md" nowrap> const<code> [virtual]</code></td> |
---|
| 918 | </tr> |
---|
| 919 | </table> |
---|
| 920 | </td> |
---|
| 921 | </tr> |
---|
| 922 | </table> |
---|
| 923 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 924 | <tr> |
---|
| 925 | <td> |
---|
| 926 | |
---|
| 927 | </td> |
---|
| 928 | <td> |
---|
| 929 | |
---|
| 930 | <p> |
---|
| 931 | [INTERNAL] Writes out the effect parameter to the given COLLADA XML tree node. |
---|
| 932 | <p> |
---|
| 933 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 934 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 935 | <tr><td valign="top"></td><td valign="top"><em>parentNode</em> </td><td>The COLLADA XML parent node in which to insert the parameter. </td></tr> |
---|
| 936 | </table> |
---|
| 937 | </dl> |
---|
| 938 | <dl compact><dt><b>Returns:</b></dt><dd>The created element XML tree node. </dd></dl> |
---|
| 939 | |
---|
| 940 | <p> |
---|
| 941 | Reimplemented from <a class="el" href="class_f_c_d_effect_parameter.html#71aaa548d040bdae0af136f250262ea5">FCDEffectParameter</a>. </td> |
---|
| 942 | </tr> |
---|
| 943 | </table> |
---|
| 944 | <hr>The documentation for this class was generated from the following file:<ul> |
---|
| 945 | <li>FCDocument/<a class="el" href="_f_c_d_effect_parameter_surface_8h-source.html">FCDEffectParameterSurface.h</a></ul> |
---|
| 946 | <hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:42 2006 for FCollada by |
---|
| 947 | <a href="http://www.doxygen.org/index.html"> |
---|
| 948 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address> |
---|
| 949 | </body> |
---|
| 950 | </html> |
---|