1. Home
  2. Docs
  3. PopcornFX v2.4
  4. Editor UI
  5. Rendering interface editor

Rendering interface editor

Overview

Renderer Interface Editor
.pkri files editor

A minimal UI is available for editing rendering interface files (.pkri).

When editing a custom .pkri file, there are three parts to consider:

  • What rendering features should be available to the project
  • What are the properties of those features (per particle data, constants, ..)
  • What data PopcornFX Editor should send to the shader if that feature is enabled (only required for in-editor rendering or if your engine integration uses PK-SampleLib’s RHI implementation to render particles)

Rendering features

Rendering features

  1. Rendering interface name (this is currently unused)
  2. Rendering features list
  3. Creation dialog

This list displays every features defined by this rendering interface file.

Rendering feature

Rendering feature properties

  1. Rendering feature properties, this order determines the order in which they will be displayed in the renderer’s detail panel
  2. Creation dialog
  3. PopcornFX rendering only (PK-SampleLib’s RHI implementation)

When selecting a feature from the features list, its properties are displayed.

Rendering feature property

Rendering feature property

  1. Description that will be displayed when hovering that property in the renderer’s detail panel
  2. How that property should be displayed in the UI and named when retrieved in code
  3. Whether it’s an image, color, .. not all property types are supported by PopcornFX Editor shaders
  4. Property type:
    1. If Link, this is a per particle value
    2. If Property, this is a per renderer value (constant)
  5. Property category, if none is set the property will be displayed under “General”
  6. Default value, will depend on the property’s Exported Type
  7. Pin visibility rules: allows to display that property under conditions

When selecting a rendering feature property, its properties are displayed.

IMPORTANT: The UI allows to modify various properties (Custom Name, Active, Exec Stage, ..) that are not used internally. You should only modify properties numbered above. The UI for editing rendering feature properties will be improved in future versions.

Note: Some rendering feature properties (ie. Diffuse.DiffuseMap) are setup as “Link” while this is a draw call constant. This is only to enable the value to be exported to parent graphs. Data types are special cases and will end up being a renderer property once the graph is compiled. Only numeric values are expected to be per particle values (Float1, float2, ..).

Rendering feature shaders infos

Rendering feature editor rendering

  1. Determines which mesh data should be available in the vertex and fragment shaders
  2. Determines which scene samplers are available in the fragment shader
  3. Determines which rendering feature properties (constants) should be available in the vertex and fragment shaders
  4. Determines which scene samplers are available in the fragment shader
Still stuck? Contact us
Was this article helpful to you? Yes No

How can we help?