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

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.