Skip to main content

Interface: RenderOptions

particles/options.RenderOptions

Holds the options used to configure the renderer for a particle system.

Properties#

applyColor#

Optional applyColor: ApplyFunction<Color>

The delegate used to apply a certain color to the particle's HTMLElement.

defaultvalue Applies the specified color to the element's "background" property.

Defined in#

particles/options/renderOptions.ts:36


applyLighting#

Optional applyLighting: ApplyFunction<number>

The delegate used to apply a certain degree of lighting to the particle's HTMLElement.

defaultvalue Applies the specified lighting to the element as a brightness filter.

Defined in#

particles/options/renderOptions.ts:46


applyOpacity#

Optional applyOpacity: ApplyFunction<number>

The delegate used to apply a certain degree of opacity to the particle's HTMLElement.

defaultvalue Applies the specified opacity to the element's "opacity" property.

Defined in#

particles/options/renderOptions.ts:41


applyTransform#

Optional applyTransform: ApplyFunction<Particle>

The delegate used to apply a certain transform to the particle's HTMLElement.

defaultvalue Applies the specified transform to the element as a 3D CSS transform.

Defined in#

particles/options/renderOptions.ts:51


shapeFactory#

shapeFactory: Variation<string | HTMLElement>

The factory used to determine the element (or "shape") that a particle will be rendered as. This variation can also return a resolve-able string.

remarks Depending on the type of value that is returned from the factory, additional processing has to be done.

  • strings: The party.resolvableShapes lookup is used to resolve the string to an actual HTMLElement, before following the same procedure as if an HTMLElement would have been passed.
  • HTMLElements: The returned element is deep cloned and used to represent the particle in the document.

defaultvalue Creates a square-shaped <div> element with a size of 10px.

Defined in#

particles/options/renderOptions.ts:30