NvFlowGridEmitParams Struct Reference
[NvFlowGridEmit]

Parameters for both emission and collision. More...

#include <NvFlow.h>

Data Fields
float	allocationPredict
	Higher values cause extra allocation based on linear velocity and predict velocity.
NvFlowFloat3	allocationScale
	Higher values cause more blocks to allocate around emitter; 0.f means no allocation, 1.f is default.
NvFlowFloat4x4	bounds
	Transform from emitter ndc to world space.
NvFlowFloat3	centerOfMass
	Center of mass in emitter local coordinate space.
float	deltaTime
	DeltaTime used to compute impulse.
NvFlowUint	emitMaterialIndex
	Index into material lookup defined by NvFlowGridUpdateEmitMaterials().
NvFlowUint	emitMode
	Emitter behavior, based on NvFlowGridEmitMode, 0u is default.
float	fuel
	Target fuel.
float	fuelCoupleRate
	Rate of correction to target, inf means instantaneous.
float	fuelRelease
	Fuel released when temperature exceeds release temperature.
float	fuelReleaseTemp
	Minimum temperature to release fuelRelease additional fuel.
NvFlowFloat4x4	localToWorld
	Transform from shape local space to world space.
float	maxActiveDist
	Maximum distance value for active emission.
float	maxEdgeDist
	Distance before maxActiveDist to 0.0 emitter opacity.
float	minActiveDist
	Minimum distance value for active emission.
float	minEdgeDist
	Distance from minActiveDist to 1.0 emitter opacity.
NvFlowFloat3	predictVelocity
	Velocity used only for predict.
float	predictVelocityWeight
	Blend weight between linearVelocity and predictVelocity.
float	shapeDistScale
	Scale to apply to SDF value.
NvFlowUint	shapeRangeOffset
	Start of shape range, offset in number of Shapes.
NvFlowUint	shapeRangeSize
	Size of shape range, in number of Shapes.
NvFlowShapeType	shapeType
	Type of shape in the set.
float	slipFactor
	0.0 => no slip, fully damped; 1.0 => full slip
float	slipThickness
	Thickness of slip boundary region.
float	smoke
	Target smoke.
float	smokeCoupleRate
	Rate of correction to target, inf means instantaneous.
float	temperature
	Target temperature.
float	temperatureCoupleRate
	Rate of correction to target, inf means instantaneous.
NvFlowFloat3	velocityAngular
	Angular velocity, in world units, emitter direction.
NvFlowFloat3	velocityCoupleRate
	Rate of correction to target, inf means instantaneous.
NvFlowFloat3	velocityLinear
	Linear velocity, in world units, emitter direction.

---

Detailed Description

Parameters for both emission and collision.

---

Field Documentation

float NvFlowGridEmitParams::allocationPredict

Higher values cause extra allocation based on linear velocity and predict velocity.

NvFlowFloat3 NvFlowGridEmitParams::allocationScale

Higher values cause more blocks to allocate around emitter; 0.f means no allocation, 1.f is default.

NvFlowFloat4x4 NvFlowGridEmitParams::bounds

Transform from emitter ndc to world space.

NvFlowFloat3 NvFlowGridEmitParams::centerOfMass

Center of mass in emitter local coordinate space.

float NvFlowGridEmitParams::deltaTime

DeltaTime used to compute impulse.

NvFlowUint NvFlowGridEmitParams::emitMaterialIndex

Index into material lookup defined by NvFlowGridUpdateEmitMaterials().

NvFlowUint NvFlowGridEmitParams::emitMode

Emitter behavior, based on NvFlowGridEmitMode, 0u is default.

float NvFlowGridEmitParams::fuel

Target fuel.

float NvFlowGridEmitParams::fuelCoupleRate

Rate of correction to target, inf means instantaneous.

float NvFlowGridEmitParams::fuelRelease

Fuel released when temperature exceeds release temperature.

float NvFlowGridEmitParams::fuelReleaseTemp

Minimum temperature to release fuelRelease additional fuel.

NvFlowFloat4x4 NvFlowGridEmitParams::localToWorld

Transform from shape local space to world space.

float NvFlowGridEmitParams::maxActiveDist

Maximum distance value for active emission.

float NvFlowGridEmitParams::maxEdgeDist

Distance before maxActiveDist to 0.0 emitter opacity.

float NvFlowGridEmitParams::minActiveDist

Minimum distance value for active emission.

float NvFlowGridEmitParams::minEdgeDist

Distance from minActiveDist to 1.0 emitter opacity.

NvFlowFloat3 NvFlowGridEmitParams::predictVelocity

Velocity used only for predict.

float NvFlowGridEmitParams::predictVelocityWeight

Blend weight between linearVelocity and predictVelocity.

float NvFlowGridEmitParams::shapeDistScale

Scale to apply to SDF value.

NvFlowUint NvFlowGridEmitParams::shapeRangeOffset

Start of shape range, offset in number of Shapes.

NvFlowUint NvFlowGridEmitParams::shapeRangeSize

Size of shape range, in number of Shapes.

NvFlowShapeType NvFlowGridEmitParams::shapeType

Type of shape in the set.

float NvFlowGridEmitParams::slipFactor

0.0 => no slip, fully damped; 1.0 => full slip

float NvFlowGridEmitParams::slipThickness

Thickness of slip boundary region.

float NvFlowGridEmitParams::smoke

Target smoke.

float NvFlowGridEmitParams::smokeCoupleRate

Rate of correction to target, inf means instantaneous.

float NvFlowGridEmitParams::temperature

Target temperature.

float NvFlowGridEmitParams::temperatureCoupleRate

Rate of correction to target, inf means instantaneous.

NvFlowFloat3 NvFlowGridEmitParams::velocityAngular

Angular velocity, in world units, emitter direction.

NvFlowFloat3 NvFlowGridEmitParams::velocityCoupleRate

Rate of correction to target, inf means instantaneous.

NvFlowFloat3 NvFlowGridEmitParams::velocityLinear

Linear velocity, in world units, emitter direction.

---

The documentation for this struct was generated from the following file:

• NvFlow.h