Gjsify LogoGjsify Logo

#ClutterTimeoutPool is an opaque structure whose members cannot be directly accessed.

record

Hierarchy

  • TimeoutPool

Index

Constructors

Properties

Methods

Constructors

Properties

name: string

Methods

  • Sets a function to be called at regular intervals, and puts it inside the pool. The function is repeatedly called until it returns %FALSE, at which point the timeout is automatically destroyed and the function won't be called again. If notify is not %NULL, the notify function will be called. The first call to func will be at the end of interval.

    Since Clutter 0.8 this will try to compensate for delays. For example, if func takes half the interval time to execute then the function will be called again half the interval time after it finished. Before version 0.8 it would not fire until a full interval after the function completes so the delay between calls would be interval * 1.5. This function does not however try to invoke the function multiple times to catch up missing frames if func takes more than interval ms to execute.

    Parameters

    • fps: number

      the time between calls to the function, in frames per second

    • func: SourceFunc

      function to call

    Returns number

  • remove(id_: number): void
  • Removes a timeout function with id_ from the timeout pool. The id is the same returned when adding a function to the timeout pool with clutter_timeout_pool_add().

    Parameters

    • id_: number

      the id of the timeout to remove

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method