APEX IOFX Module: nvidia::apex Namespace Reference

NVIDIA APEX

nvidia::apex Namespace Reference

Classes

class  IofxActor
 IOFX actor public interface. More...
class  IofxAsset
 IOFX Asset public interface. Used to define the way the visual parameters are created from physical parameters of a particle. More...
class  IofxAssetAuthoring
 IOFX Asset Authoring public interface. More...
struct  IofxSharedRenderData
 IofxSharedRenderData stores common render data shared by several IOFX Renderables. More...
struct  IofxSpriteSharedRenderData
 IofxSpriteSharedRenderData stores sprite render data shared by several IOFX Renderables. More...
struct  IofxMeshSharedRenderData
 IofxMeshSharedRenderData stores mesh render data shared by several IOFX Renderables. More...
struct  IofxCommonRenderData
 IofxCommonRenderData stores common render data for one IOFX Renderable. More...
struct  IofxSpriteRenderData
 IofxSpriteRenderData stores sprite render data for one IOFX Renderable. More...
struct  IofxMeshRenderData
 IofxMeshRenderData stores mesh render data for one IOFX Renderable. More...
class  IofxRenderable
 The IOFX renderable represents a unit of rendering. It contains complete information to render a batch of particles with the same material/mesh in the same render volume. More...
struct  IofxRenderSemantic
 Enumerates the potential IOFX render semantics. More...
struct  IofxSpriteRenderLayoutElement
 Enumerates the potential IOFX mesh render layout elements. More...
struct  IofxSpriteRenderLayoutSurfaceElement
 Enumerates the potential IOFX sprite render layout surface elements. More...
struct  IofxSpriteRenderLayout
 Describes the layout for sprite rendering. More...
struct  IofxMeshRenderLayoutElement
 Enumerates the potential IOFX mesh render layout elements. More...
struct  IofxMeshRenderLayout
 Describes the layout for mesh rendering. More...
class  IofxRenderCallback
 User defined callback for IOFX rendering. More...
class  Modifier
 Modifier contains all of the data necessary to apply a single modifier type to a particle system. More...
class  ModifierT
 ModifierT is a helper class to handle the mapping of Type->Enum and Enum->Type. More...
class  RotationModifier
 RotationModifier applies rotation to the particles using one of several rotation models. More...
class  SimpleScaleModifier
 SimpleScaleModifier just applies a simple scale factor to each of the X, Y and Z aspects of the model. Each scalefactor can be applied independently. More...
class  ScaleByMassModifier
 ScaleByMassModifier scales by mass of the particle. More...
class  RandomScaleModifier
 RandomScaleModifier applies a random scale uniformly to all three dimensions. Currently, the scale is a uniform in the range specified. More...
class  ColorVsLifeModifier
 ColorVsLifeModifier modifies the color constants associated with a particle depending on the life remaining of the particle. More...
class  ColorVsDensityModifier
 ColorVsDensityModifier modifies the color constants associated with a particle depending on the density of the particle. More...
class  SubtextureVsLifeModifier
 SubtextureVsLifeModifier is a modifier to adjust the subtexture id versus the life remaining of a particular particle. More...
class  OrientAlongVelocityModifier
 OrientAlongVelocity is a modifier to orient a mesh so that a particular axis coincides with the velocity vector. More...
class  ScaleAlongVelocityModifier
 ScaleAlongVelocityModifier is a modifier to apply a scale factor along the current velocity vector. More...
class  RandomSubtextureModifier
 RandomSubtextureModifier generates a random subtexture ID and places it in the subTextureId field. More...
class  RandomRotationModifier
 RandomRotationModifier will choose a random orientation for a sprite particle within the range as specified below. More...
class  ScaleVsLifeModifier
 ScaleVsLifeModifier applies a scale factor function against a single axis versus the life remaining. More...
class  ScaleVsDensityModifier
 ScaleVsDensityModifier applies a scale factor function against a single axis versus the density of the particle. More...
class  ScaleVsCameraDistanceModifier
 ScaleVsCameraDistance applies a scale factor against a specific axis based on distance from the camera to the particle. More...
class  ViewDirectionSortingModifier
 ViewDirectionSortingModifier sorts sprite particles along view direction back to front. More...
class  RotationRateModifier
 RotationRateModifier is a modifier to apply a continuous rotation for sprites. More...
class  RotationRateVsLifeModifier
 RotationRateVsLifeModifier is a modifier to adjust the rotation rate versus the life remaining of a particular particle. More...
class  OrientScaleAlongScreenVelocityModifier
 OrientScaleAlongScreenVelocityModifier is a modifier to orient & scale sprites along the current screen velocity vector. More...
class  ColorVsVelocityModifier
 ColorVsVelocityModifier modifies the color constants associated with a particle depending on the velocity of the particle. More...
struct  ApexMeshParticleRollType
 Roll type of a particle. More...
class  IofxRenderableIterator
 Iterate over all renderables in IOFX module. IMPORTANT: release() should be called for each returned not-NULL renderable! More...
class  ModuleIofx
 IOFX Module. More...
class  RenderVolume
 An object which "owns" a volume of world space. More...

Enumerations

enum  ModifierTypeEnum {
  ModifierType_Invalid = 0,
  ModifierType_Rotation = 1,
  ModifierType_SimpleScale = 2,
  ModifierType_RandomScale = 3,
  ModifierType_ColorVsLife = 4,
  ModifierType_ColorVsDensity = 5,
  ModifierType_SubtextureVsLife = 6,
  ModifierType_OrientAlongVelocity = 7,
  ModifierType_ScaleAlongVelocity = 8,
  ModifierType_RandomSubtexture = 9,
  ModifierType_RandomRotation = 10,
  ModifierType_ScaleVsLife = 11,
  ModifierType_ScaleVsDensity = 12,
  ModifierType_ScaleVsCameraDistance = 13,
  ModifierType_ViewDirectionSorting = 14,
  ModifierType_RotationRate = 15,
  ModifierType_RotationRateVsLife = 16,
  ModifierType_OrientScaleAlongScreenVelocity = 17,
  ModifierType_ScaleByMass = 18,
  ModifierType_ColorVsVelocity = 19,
  ModifierType_Count
}
 Modifiers list. More...
enum  ModifierStage {
  ModifierStage_Spawn = 0,
  ModifierStage_Continuous = 1,
  ModifierStage_Count
}
 Stage at which the modifier is applied. More...
enum  ColorChannel {
  ColorChannel_Red = 0,
  ColorChannel_Green = 1,
  ColorChannel_Blue = 2,
  ColorChannel_Alpha = 3
}
 Color channel. More...
enum  ScaleAxis {
  ScaleAxis_X = 0,
  ScaleAxis_Y = 1,
  ScaleAxis_Z = 2
}
 Scale axis. More...
enum  ModifierUsage {
  ModifierUsage_Spawn = 0x01,
  ModifierUsage_Continuous = 0x02,
  ModifierUsage_Sprite = 0x04,
  ModifierUsage_Mesh = 0x08
}
 Modifier usage. More...

Functions

PX_PUSH_PACK_DEFAULT uint32_t ModifierUsageFromStage (ModifierStage stage)
 Converts ModifierStage to bitmap.

Enumeration Type Documentation

Color channel.

Enumerator:
ColorChannel_Red 
ColorChannel_Green 
ColorChannel_Blue 
ColorChannel_Alpha 

Stage at which the modifier is applied.

Enumerator:
ModifierStage_Spawn 

at the spawn

ModifierStage_Continuous 

on every frame

ModifierStage_Count 

Modifiers list.

Note:
These are serialized to disk, so if you reorder them or change existing modifier types, you will need to version the stream and map the old values to the new values. If new values are just appended, no other special care needs to be handled.
Enumerator:
ModifierType_Invalid 
ModifierType_Rotation 
ModifierType_SimpleScale 
ModifierType_RandomScale 
ModifierType_ColorVsLife 
ModifierType_ColorVsDensity 
ModifierType_SubtextureVsLife 
ModifierType_OrientAlongVelocity 
ModifierType_ScaleAlongVelocity 
ModifierType_RandomSubtexture 
ModifierType_RandomRotation 
ModifierType_ScaleVsLife 
ModifierType_ScaleVsDensity 
ModifierType_ScaleVsCameraDistance 
ModifierType_ViewDirectionSorting 
ModifierType_RotationRate 
ModifierType_RotationRateVsLife 
ModifierType_OrientScaleAlongScreenVelocity 
ModifierType_ScaleByMass 
ModifierType_ColorVsVelocity 
ModifierType_Count 

Modifier usage.

Enumerator:
ModifierUsage_Spawn 
ModifierUsage_Continuous 
ModifierUsage_Sprite 
ModifierUsage_Mesh 

Scale axis.

Enumerator:
ScaleAxis_X 
ScaleAxis_Y 
ScaleAxis_Z 

Function Documentation

PX_PUSH_PACK_DEFAULT uint32_t nvidia::apex::ModifierUsageFromStage ( ModifierStage  stage) [inline]

Converts ModifierStage to bitmap.


Generated on Fri Dec 15 2017 13:59:03

Copyright © 2012-2017 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved.