FrameAPI

• webVis API Reference
• FrameAPI

Interface FrameAPI

The FrameAPI provides functionalities to register and unregister custom callback functions which are executed on every run of the ContextAPI internal update loop.

Example

// Create an instance of the ContextAPI
const myContext : ContextAPI = webvis.createContext( "example" )

// Define your frame listener
const myFrameListener : FrameListener = ( time : number, elapsed : number ) =>
{
    console.log(`Current time ${time} ms. Time since last call ${elapsed} ms.`);
};

// Register your frame listener
myContext.registerFrameListener( myFrameListener );

// Unregister your frame listener
myContext.registerFrameListener( myFrameListener );

Hierarchy

• FrameAPI
  • ContextAPI

Index

Methods

registerFrameListener unregisterFrameListener

Methods

registerFrameListener

• registerFrameListener(listener: FrameListener): void

• Registers a listener function which get called once per internal update tick.

  Parameters

  • listener: FrameListener

    The listener to register.

  Returns void

unregisterFrameListener

• unregisterFrameListener(listener: FrameListener): void

• Unregisters a previously registered listener via registerFrameListener.

  Parameters

  • listener: FrameListener

    The listener to unregister.

  Returns void

---

Did you find this page useful? Please give it a rating:

★ ★ ★ ★ ★

Thank you for rating this page!

Any issues or feedback?

What kind of problem would you like to report?

• This page needs code samples
• Code samples do not work
• Information is missing
  Please tell us more about what's wrong:
• Information is incorrect
  Please tell us more about what's wrong:
• Information is unclear or confusing
  Please tell us more about what's wrong:
• The page is rendered incorrectly (styling/CSS)
• Give Feedback

Please tell us more about what's wrong: Name E-Mail Problem (required)