PKFxRenderingPlugin component

From PopcornFX
Jump to: navigation, search

UnityPKFxRenderingPluginComponent.png

This is the rendering component. Attach it to your camera to have Popcorn in your scene.
The "Build" version number corresponds to the version of the PopcornFx runtime and subsequently of the compatible PopcornFx editor. Only the first 2 numbers, respectively major and minor version numbers are relevant, the following (respectively patch and commit number) can be safely ignored as far as effects compatibility is concerned.

Unity-logo-g.png

HasPostFx

Needs to be enabled if your camera has post effects to prevent axis flipping in the particles rendering.

This has to be done manually and is DirectX-specific.

Automatically enabled when distortions are enabled (see below).

Depth RT

Depth texture, used for soft particles and distortions when enabled.
Can be reused for image effects.
Access through scripts with m_DepthRT

Bound Shaders

See Custom Shaders (Unity Plugin)

Advanced Settings

Advanced settings may impact performance in non-negligible ways.

EnableSoftParticles

Enables soft particles on effects that support it (see example).

It creates an offline-rendering camera to get the scene's depth, depending on the version of Unity used.

See Rendering Pipeline (Unity Plugin)

EnableDistortions

Enables distortions in effects that support it.

Enables soft particles to get the scene's depth.
Adds non-negligible rendering steps.

See Rendering Pipeline (Unity Plugin)

EnableBlur

Enables the blur post effect.

Adds yet another post effect.

BlurFactor

Adjusts the amplitude of the blur.

UseSceneMesh

See "How To Setup Particle Collisions".
Loads a static scene mesh to compute particles' collisions.

SceneMeshPkmmPath

Path relative to the PackFx root to the scene mesh (see PKFxSceneMeshBuilder).

Texture LOD Bias

Specifies the particles' textures mip map bias.
Analogous to Unity's mipMapBias.