From f5f6a899903a309f1fc93b31c0297fc7b3b5cf46 Mon Sep 17 00:00:00 2001 From: Andrew Reidmeyer Date: Wed, 15 Mar 2017 09:28:59 -0600 Subject: Initial 1.0.0 binary release --- docs/api/files/group___nv_flow_grid_material.html | 270 ++++++++++++++++++++++ 1 file changed, 270 insertions(+) create mode 100644 docs/api/files/group___nv_flow_grid_material.html (limited to 'docs/api/files/group___nv_flow_grid_material.html') diff --git a/docs/api/files/group___nv_flow_grid_material.html b/docs/api/files/group___nv_flow_grid_material.html new file mode 100644 index 0000000..c3ef9eb --- /dev/null +++ b/docs/api/files/group___nv_flow_grid_material.html @@ -0,0 +1,270 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridMaterial + + + + + + + + +
+

NvFlowGridMaterial

+ + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

struct  NvFlowGridMaterialHandle
 Handle provided by grid to reference materials. More...
struct  NvFlowGridMaterialParams
 Grid material parameters. More...
struct  NvFlowGridMaterialPerComponent
 Grid material per component parameters. More...

Enumerations

enum  NvFlowGridComponent {
+  eNvFlowGridComponentVelocity = 0, +eNvFlowGridComponentSmoke = 1, +eNvFlowGridComponentTemperature = 2, +eNvFlowGridComponentFuel = 3, +
+  eNvFlowGridNumComponents = 4 +
+ }
 Grid component IDs. More...

Functions

NvFlowGridMaterialHandle NvFlowGridCreateMaterial (NvFlowGrid *grid, const NvFlowGridMaterialParams *params)
NvFlowGridMaterialHandle NvFlowGridGetDefaultMaterial (NvFlowGrid *grid)
void NvFlowGridMaterialParamsDefaults (NvFlowGridMaterialParams *params)
void NvFlowGridReleaseMaterial (NvFlowGrid *grid, NvFlowGridMaterialHandle material)
void NvFlowGridSetMaterialParams (NvFlowGrid *grid, NvFlowGridMaterialHandle material, const NvFlowGridMaterialParams *params)
+

Enumeration Type Documentation

+ +
+
+ + + + +
enum NvFlowGridComponent
+
+
+ +

+Grid component IDs. +

+

Enumerator:
+ + + + + + +
eNvFlowGridComponentVelocity  +
eNvFlowGridComponentSmoke  +
eNvFlowGridComponentTemperature  +
eNvFlowGridComponentFuel  +
eNvFlowGridNumComponents  +
+
+ +
+

+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
NvFlowGridMaterialHandle NvFlowGridCreateMaterial (NvFlowGrid *  grid,
const NvFlowGridMaterialParams *  params 
)
+
+
+ +

+Creates new grid material, initializes to params.

+

Parameters:
+ + + +
[in] grid The Flow grid to set parameters on.
[in] params The new parameter values.
+
+
Returns:
Returns handle to newly create grid material.
+ +
+

+ +

+
+ + + + + + + + + +
NvFlowGridMaterialHandle NvFlowGridGetDefaultMaterial (NvFlowGrid *  grid  ) 
+
+
+ +

+Gets a handle to the default grid material.

+

Parameters:
+ + +
[in] grid The grid to return its default grid material.
+
+
Returns:
Returns default grid material for grid.
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowGridMaterialParamsDefaults (NvFlowGridMaterialParams *  params  ) 
+
+
+ +

+Allows the application to request default grid material parameters from Flow.

+

Parameters:
+ + +
[out] params The parameters for Flow to fill out.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void NvFlowGridReleaseMaterial (NvFlowGrid *  grid,
NvFlowGridMaterialHandle  material 
)
+
+
+ +

+Release grid material

+

Parameters:
+ + + +
[in] grid The grid to set parameters on.
[in] material Handle to material to release.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowGridSetMaterialParams (NvFlowGrid *  grid,
NvFlowGridMaterialHandle  material,
const NvFlowGridMaterialParams *  params 
)
+
+
+ +

+Sets material parameters, persistent over multiple grid updates.

+

Parameters:
+ + + + +
[in] grid The grid to set parameters on.
[in] material Handle to material to update.
[in] params The new parameter values.
+
+ +
+

+

+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + -- cgit v1.2.3