Package dev.engine_room.flywheel.api.visual

Interface DynamicVisual

All Superinterfaces:
Visual
All Known Subinterfaces:
SimpleDynamicVisual
All Known Implementing Classes:
ComponentEntityVisual, LightStorage.DebugVisual
public interface DynamicVisual extends Visual
An interface giving Visuals a hook to have a function called at the start of a frame. By implementing DynamicVisual, an Visual can animate its models in ways that could not be easily achieved by shader attribute parameterization.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    DynamicVisual.Context
    The context passed to the frame plan.

  • Method Summary

    Modifier and Type
    Method
    Description
    Plan<DynamicVisual.Context>
    planFrame()
    Invoked every frame.

    Methods inherited from interface dev.engine_room.flywheel.api.visual.Visual

    delete, update

  • Method Details

    • planFrame

      Plan<DynamicVisual.Context> planFrame()
      Invoked every frame.
      The implementation is free to parallelize the invocation of this plan. You must ensure proper synchronization if you need to mutate anything outside this visual.
      This plan and the one returned by TickableVisual.planTick() will never be invoked simultaneously.
      Instancer/Instance creation/acquisition is safe here.