nCine

• Index

Contents

• Functions

Modules

• ncine
• ncine.animated_sprite
• ncine.app_configuration
• ncine.application
• ncine.audio_buffer
• ncine.audio_buffer_player
• ncine.audio_device
• ncine.audio_effect
• ncine.audio_effect_properties
• ncine.audio_effect_slot
• ncine.audio_filter
• ncine.audio_player
• ncine.audio_stream_player
• ncine.base_sprite
• ncine.camera
• ncine.color
• ncine.drawable_node
• EFX_Presets
• ncine.font
• ncine.frame_timer
• ncine.fs
• ncine.gfx_device
• ncine.hash64
• ncine.input
• ncine.keys
• ncine.log
• ncine.mesh_sprite
• ncinelua
• ncine.particle_affector
• ncine.particle_system
• ncine.rect
• ncine.scenenode
• ncine.shader
• ncine.shaderstate
• ncine.sprite
• ncine.textnode
• ncine.texture
• ncine.timestamp
• ncine.vec2
• ncine.vec3
• ncine.vec4
• ncine.viewport

Topics

• readme

Module ncine.frame_timer

The table containing frame timer related functions

Functions

ncine.frame_timer.total_number_frames ()	Returns the total number of frames rendered since the application started
ncine.frame_timer.last_frame_duration ()	Returns the time in seconds that last frame took to complete
ncine.frame_timer.current_frame_duration ()	Returns the elapsed time in seconds since current frame started
ncine.frame_timer.average_fps ()	Returns the average FPS during the update interval
ncine.frame_timer.average_frame_time ()	Returns the average frame time in seconds during the update interval
ncine.frame_timer.is_average_enabled ()	Returns true if the average FPS calculation is enabled
ncine.frame_timer.is_logging_enabled ()	Returns true if logging of averages is enabled
ncine.frame_timer.get_average_interval ()	Returns the number of seconds between two average FPS calculations
ncine.frame_timer.set_average_interval (interval)	Sets the number of seconds between two average FPS calculations
ncine.frame_timer.get_logging_interval ()	Returns the number of seconds between two logging events.
ncine.frame_timer.set_logging_interval (interval)	Sets the number of seconds between two logging events
ncine.frame_timer.get_log_level ()	Returns the level for the logging events
ncine.frame_timer.set_log_level (log_level)	Sets the level for the logging events

Functions

ncine.frame_timer.total_number_frames ()

Returns the total number of frames rendered since the application started

Returns:

integer

ncine.frame_timer.last_frame_duration ()

Returns the time in seconds that last frame took to complete

Returns:

number

ncine.frame_timer.current_frame_duration ()

Returns the elapsed time in seconds since current frame started

Returns:

number

ncine.frame_timer.average_fps ()

Returns the average FPS during the update interval

Returns:

number

ncine.frame_timer.average_frame_time ()

Returns the average frame time in seconds during the update interval

Returns:

number

ncine.frame_timer.is_average_enabled ()

Returns true if the average FPS calculation is enabled

Returns:

boolean

ncine.frame_timer.is_logging_enabled ()

Returns true if logging of averages is enabled

Returns:

boolean

ncine.frame_timer.get_average_interval ()

Returns the number of seconds between two average FPS calculations

Returns:

number

ncine.frame_timer.set_average_interval (interval)

Sets the number of seconds between two average FPS calculations

Parameters:

• interval number

ncine.frame_timer.get_logging_interval ()

Returns the number of seconds between two logging events.

A different and independent average is calculated over this time interval.

Returns:

number

ncine.frame_timer.set_logging_interval (interval)

Sets the number of seconds between two logging events

Parameters:

• interval number

ncine.frame_timer.get_log_level ()

Returns the level for the logging events

Returns:

ncine.log_level

ncine.frame_timer.set_log_level (log_level)

Sets the level for the logging events

Parameters:

• log_level ncine.log_level