aboutsummaryrefslogtreecommitdiff
path: root/docs/api/files/struct_nv_flow_render_material_params.html
blob: cda94832d39e7c49d866744cc72bfdc2cf2e1957 (plain) (blame)
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
<html>
	<head>
		<title>NVIDIA(R) Flow(R) 1.0.1 API Reference: NvFlowRenderMaterialParams Struct Reference</title>
		<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
		<LINK HREF="NVIDIA.css" REL="stylesheet" TYPE="text/css">
	</head>

	<body bgcolor="#FFFFFF">
		<div id="header">
			<hr class="first">
			<img alt="" src="nvflow_logo.png">
			<br>
			<hr class="second">
		</div>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>NvFlowRenderMaterialParams Struct Reference<br>
<small>
[<a class="el" href="group___nv_flow_render_material.html">NvFlowRenderMaterial</a>]</small>
</h1><!-- doxytag: class="NvFlowRenderMaterialParams" -->Per material parameters for Flow grid rendering.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="_nv_flow_8h-source.html">NvFlow.h</a>&gt;</code>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_nv_flow_render_material_params.html#f37d9b76d7d307a6b3f992b6f71da057">additiveFactor</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">1.0 makes material blend fully additive  <a href="#f37d9b76d7d307a6b3f992b6f71da057"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_nv_flow_render_material_params.html#ac636e8007434c403f7195d1d807ab77">alphaBias</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Offsets alpha before saturate(alpha).  <a href="#ac636e8007434c403f7195d1d807ab77"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_nv_flow_float4.html">NvFlowFloat4</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_nv_flow_render_material_params.html#36f6e4fab162b539a7f14039d0469057">alphaCompMask</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Component mask to control which channel(s) modulation the alpha.  <a href="#36f6e4fab162b539a7f14039d0469057"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_nv_flow_render_material_params.html#0b1a7d6147c78bae5d56f6c365722e0f">alphaScale</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Global alpha scale for adjust net opacity without color map changes, applied after saturate(alpha).  <a href="#0b1a7d6147c78bae5d56f6c365722e0f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_nv_flow_float4.html">NvFlowFloat4</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_nv_flow_render_material_params.html#b28d459df39a8287d11dad0d06d86dae">colorMapCompMask</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Component mask for colormap, control what channel drives color map X axis;.  <a href="#b28d459df39a8287d11dad0d06d86dae"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_nv_flow_render_material_params.html#c717cc5e4cd3f8a94c597d24a94bcd0c">colorMapMaxX</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Maximum value on the x channel (typically temperature), maps to colorMap u = 1.0.  <a href="#c717cc5e4cd3f8a94c597d24a94bcd0c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_nv_flow_render_material_params.html#71f13f7ce2d72733755fcd203e28be4b">colorMapMinX</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Minimum value on the x channel (typically temperature), maps to colorMap u = 0.0.  <a href="#71f13f7ce2d72733755fcd203e28be4b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_nv_flow_render_material_params.html#791262663a4383e3824bc0f322573020">intensityBias</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Offsets intensity before modulating color.  <a href="#791262663a4383e3824bc0f322573020"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_nv_flow_float4.html">NvFlowFloat4</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_nv_flow_render_material_params.html#c1be4aec3dd95682b079eb4596c3a2ff">intensityCompMask</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Component mask to control which channel(s) modulates the intensity.  <a href="#c1be4aec3dd95682b079eb4596c3a2ff"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_nv_flow_grid_material_handle.html">NvFlowGridMaterialHandle</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_nv_flow_render_material_params.html#8ae7808037e49c8c5d8432f5ffc3c2f1">material</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Grid material to align these parameters with.  <a href="#8ae7808037e49c8c5d8432f5ffc3c2f1"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Per material parameters for Flow grid rendering. <hr><h2>Field Documentation</h2>
<a class="anchor" name="f37d9b76d7d307a6b3f992b6f71da057"></a><!-- doxytag: member="NvFlowRenderMaterialParams::additiveFactor" ref="f37d9b76d7d307a6b3f992b6f71da057" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float <a class="el" href="struct_nv_flow_render_material_params.html#f37d9b76d7d307a6b3f992b6f71da057">NvFlowRenderMaterialParams::additiveFactor</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
1.0 makes material blend fully additive 
<p>

</div>
</div><p>
<a class="anchor" name="ac636e8007434c403f7195d1d807ab77"></a><!-- doxytag: member="NvFlowRenderMaterialParams::alphaBias" ref="ac636e8007434c403f7195d1d807ab77" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float <a class="el" href="struct_nv_flow_render_material_params.html#ac636e8007434c403f7195d1d807ab77">NvFlowRenderMaterialParams::alphaBias</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Offsets alpha before saturate(alpha). 
<p>

</div>
</div><p>
<a class="anchor" name="36f6e4fab162b539a7f14039d0469057"></a><!-- doxytag: member="NvFlowRenderMaterialParams::alphaCompMask" ref="36f6e4fab162b539a7f14039d0469057" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_nv_flow_float4.html">NvFlowFloat4</a> <a class="el" href="struct_nv_flow_render_material_params.html#36f6e4fab162b539a7f14039d0469057">NvFlowRenderMaterialParams::alphaCompMask</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Component mask to control which channel(s) modulation the alpha. 
<p>

</div>
</div><p>
<a class="anchor" name="0b1a7d6147c78bae5d56f6c365722e0f"></a><!-- doxytag: member="NvFlowRenderMaterialParams::alphaScale" ref="0b1a7d6147c78bae5d56f6c365722e0f" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float <a class="el" href="struct_nv_flow_render_material_params.html#0b1a7d6147c78bae5d56f6c365722e0f">NvFlowRenderMaterialParams::alphaScale</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Global alpha scale for adjust net opacity without color map changes, applied after saturate(alpha). 
<p>

</div>
</div><p>
<a class="anchor" name="b28d459df39a8287d11dad0d06d86dae"></a><!-- doxytag: member="NvFlowRenderMaterialParams::colorMapCompMask" ref="b28d459df39a8287d11dad0d06d86dae" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_nv_flow_float4.html">NvFlowFloat4</a> <a class="el" href="struct_nv_flow_render_material_params.html#b28d459df39a8287d11dad0d06d86dae">NvFlowRenderMaterialParams::colorMapCompMask</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Component mask for colormap, control what channel drives color map X axis;. 
<p>

</div>
</div><p>
<a class="anchor" name="c717cc5e4cd3f8a94c597d24a94bcd0c"></a><!-- doxytag: member="NvFlowRenderMaterialParams::colorMapMaxX" ref="c717cc5e4cd3f8a94c597d24a94bcd0c" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float <a class="el" href="struct_nv_flow_render_material_params.html#c717cc5e4cd3f8a94c597d24a94bcd0c">NvFlowRenderMaterialParams::colorMapMaxX</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Maximum value on the x channel (typically temperature), maps to colorMap u = 1.0. 
<p>

</div>
</div><p>
<a class="anchor" name="71f13f7ce2d72733755fcd203e28be4b"></a><!-- doxytag: member="NvFlowRenderMaterialParams::colorMapMinX" ref="71f13f7ce2d72733755fcd203e28be4b" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float <a class="el" href="struct_nv_flow_render_material_params.html#71f13f7ce2d72733755fcd203e28be4b">NvFlowRenderMaterialParams::colorMapMinX</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Minimum value on the x channel (typically temperature), maps to colorMap u = 0.0. 
<p>

</div>
</div><p>
<a class="anchor" name="791262663a4383e3824bc0f322573020"></a><!-- doxytag: member="NvFlowRenderMaterialParams::intensityBias" ref="791262663a4383e3824bc0f322573020" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float <a class="el" href="struct_nv_flow_render_material_params.html#791262663a4383e3824bc0f322573020">NvFlowRenderMaterialParams::intensityBias</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Offsets intensity before modulating color. 
<p>

</div>
</div><p>
<a class="anchor" name="c1be4aec3dd95682b079eb4596c3a2ff"></a><!-- doxytag: member="NvFlowRenderMaterialParams::intensityCompMask" ref="c1be4aec3dd95682b079eb4596c3a2ff" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_nv_flow_float4.html">NvFlowFloat4</a> <a class="el" href="struct_nv_flow_render_material_params.html#c1be4aec3dd95682b079eb4596c3a2ff">NvFlowRenderMaterialParams::intensityCompMask</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Component mask to control which channel(s) modulates the intensity. 
<p>

</div>
</div><p>
<a class="anchor" name="8ae7808037e49c8c5d8432f5ffc3c2f1"></a><!-- doxytag: member="NvFlowRenderMaterialParams::material" ref="8ae7808037e49c8c5d8432f5ffc3c2f1" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_nv_flow_grid_material_handle.html">NvFlowGridMaterialHandle</a> <a class="el" href="struct_nv_flow_render_material_params.html#8ae7808037e49c8c5d8432f5ffc3c2f1">NvFlowRenderMaterialParams::material</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Grid material to align these parameters with. 
<p>

</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="_nv_flow_8h-source.html">NvFlow.h</a></ul>
</div>
<!-- start footer part -->
<div class="footer">
Copyright &copy; 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a>
</div>
</body>
</html>