VolumeRenderMaterialData Struct Reference

Describes the NxParameterized::Interface for 'VolumeRenderMaterialData' : Contains the volume render material properties for this asset. More...

#include <params.h>

List of all members.

Public Attributes
String	Name
	'Name' : The name of this volume render material
String	ApplicationMaterialName
	'ApplicationMaterialName' : The name of the material to match up with the application's material system
String	UserProperties
	'UserProperties' : Optional user properties string
Bool	RenderVelocityField
	'RenderVelocityField' : Set to true if you want to copy out the velocity field instead of the density field
F32	TextureRangeMin
	'TextureRangeMin' : The minimum clamp range to use when copying velocity/desnity to the 3d volume texture; this range will be scaled 0-255; it's important to tune the proper range value
F32	TextureRangeMax
	'TextureRangeMax' : The maximum clamp range to use when copying velocity/desnity to the 3d volume texture; this range will be scaled 0-255; it's important to tune the proper range value
F32	VolumeDensity
	'VolumeDensity' : The volume density in the range of 0-1000
F32	EdgeFade
	'EdgeFade' : The edge fade distance in the range of 0-1
F32	OpacityThreshold
	'OpacityThreshold' : stop ray marching once opacity has reached this threshold [0, 1]
U32	ShadowSamples
	'ShadowSamples' : number of samples for shadows [0, 256]
F32	ShadowDistance
	'ShadowDistance' : distance to ray march shadows [0, 1]
F32	ShadowDensity
	'ShadowDensity' : shadow density [0, 1000]
F32	ShadowJitter
	'ShadowJitter' : amount to jitter shadow rays [0, 1]
Vec4	LightColor
	'LightColor' : The color to use for the 'light' on this volume render
Vec4	AbsorptionColor
	'AbsorptionColor' : The 'absorption' color
F32	LightingAmount
	'LightingAmount' : Adjusts the strength of the material's lighting
F32	ShadowAmount
	'ShadowAmount' : Adjusts the strength of the material's shadow

---

Detailed Description

Describes the NxParameterized::Interface for 'VolumeRenderMaterialData' : Contains the volume render material properties for this asset.

VolumeRenderMaterialData contains 17 fully qualified names
---------------------------------------------
  1 : String  Name                     
  2 : String  ApplicationMaterialName  
  3 : String  UserProperties           
  4 : Bool    RenderVelocityField      
  5 : F32     TextureRangeMin          
  6 : F32     TextureRangeMax          
  7 : F32     VolumeDensity            
  8 : F32     EdgeFade                 
  9 : F32     OpacityThreshold         
 10 : U32     ShadowSamples            
 11 : F32     ShadowDistance           
 12 : F32     ShadowDensity            
 13 : F32     ShadowJitter             
 14 : Vec4    LightColor               
 15 : Vec4    AbsorptionColor          
 16 : F32     LightingAmount           
 17 : F32     ShadowAmount             

---

Member Data Documentation

Vec4 VolumeRenderMaterialData::AbsorptionColor

'AbsorptionColor' : The 'absorption' color

String VolumeRenderMaterialData::ApplicationMaterialName

'ApplicationMaterialName' : The name of the material to match up with the application's material system

F32 VolumeRenderMaterialData::EdgeFade

'EdgeFade' : The edge fade distance in the range of 0-1

Vec4 VolumeRenderMaterialData::LightColor

'LightColor' : The color to use for the 'light' on this volume render

F32 VolumeRenderMaterialData::LightingAmount

'LightingAmount' : Adjusts the strength of the material's lighting

String VolumeRenderMaterialData::Name

'Name' : The name of this volume render material

F32 VolumeRenderMaterialData::OpacityThreshold

'OpacityThreshold' : stop ray marching once opacity has reached this threshold [0, 1]

Bool VolumeRenderMaterialData::RenderVelocityField

'RenderVelocityField' : Set to true if you want to copy out the velocity field instead of the density field

F32 VolumeRenderMaterialData::ShadowAmount

'ShadowAmount' : Adjusts the strength of the material's shadow

F32 VolumeRenderMaterialData::ShadowDensity

'ShadowDensity' : shadow density [0, 1000]

F32 VolumeRenderMaterialData::ShadowDistance

'ShadowDistance' : distance to ray march shadows [0, 1]

F32 VolumeRenderMaterialData::ShadowJitter

'ShadowJitter' : amount to jitter shadow rays [0, 1]

U32 VolumeRenderMaterialData::ShadowSamples

'ShadowSamples' : number of samples for shadows [0, 256]

F32 VolumeRenderMaterialData::TextureRangeMax

'TextureRangeMax' : The maximum clamp range to use when copying velocity/desnity to the 3d volume texture; this range will be scaled 0-255; it's important to tune the proper range value

F32 VolumeRenderMaterialData::TextureRangeMin

'TextureRangeMin' : The minimum clamp range to use when copying velocity/desnity to the 3d volume texture; this range will be scaled 0-255; it's important to tune the proper range value

String VolumeRenderMaterialData::UserProperties

'UserProperties' : Optional user properties string

F32 VolumeRenderMaterialData::VolumeDensity

'VolumeDensity' : The volume density in the range of 0-1000

---

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

• params.h