nCine

• Index

Contents

• Functions
• Tables

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.application

The table containing application related functions

Functions

ncine.application.get_app_configuration ()	Returns the configuration used to initialize the application
ncine.application.get_rendering_settings ()	Returns the run-time rendering settings
ncine.application.set_rendering_settings (settings)	Sets the run-time rendering settings
ncine.application.get_gui_settings ()	Returns the run-time GUI settings
ncine.application.set_gui_settings (settings)	Sets the run-time GUI settings
ncine.application.get_debugoverlay_settings ()	Returns the run-time debug overlay settings, if debug overlay is available
ncine.application.set_debugoverlay_settings (settings)	Sets the run-time debug overlay settings
ncine.application.get_rootnode ()	Returns the root node of the transformation graph
ncine.application.get_screen_viewport ()	Returns the screen viewport
ncine.application.get_num_frames ()	Returns the total number of frames already rendered
ncine.application.get_interval ()	Returns the time in seconds that last frame took to complete
ncine.application.get_width ()	Returns the drawable screen width
ncine.application.get_height ()	Returns the drawable screen height
ncine.application.get_resolution ()	Returns the drawable screen resolution vector
ncine.application.is_suspended ()	Returns true if the application is suspended.
ncine.application.set_suspended (flag)	Sets a new value for the suspension flag
ncine.application.get_auto_suspension ()	Returns true if the application should auto-suspend when it loses focus
ncine.application.set_auto_suspension (flag)	Sets a new value for the auto-suspension flag
ncine.application.quit ()	Asks the application to quit as soon as possible

Tables

rendering_settings	The rendering settings table
debug_overlay_settings	The debug overlay settings table
gui_settings	The gui settings table

Functions

ncine.application.get_app_configuration ()

Returns the configuration used to initialize the application

Returns:

ncine.app_configuration

ncine.application.get_rendering_settings ()

Returns the run-time rendering settings

Returns:

rendering_settings

ncine.application.set_rendering_settings (settings)

Sets the run-time rendering settings

Parameters:

• settings rendering_settings

ncine.application.get_gui_settings ()

Returns the run-time GUI settings

Returns:

gui_settings

ncine.application.set_gui_settings (settings)

Sets the run-time GUI settings

Parameters:

• settings gui_settings

ncine.application.get_debugoverlay_settings ()

Returns the run-time debug overlay settings, if debug overlay is available

Returns:

debug_overlay_settings

ncine.application.set_debugoverlay_settings (settings)

Sets the run-time debug overlay settings

Parameters:

• settings debug_overlay_settings

ncine.application.get_rootnode ()

Returns the root node of the transformation graph

Returns:

ncine.scenenode.scenenodeObj

ncine.application.get_screen_viewport ()

Returns the screen viewport

Returns:

ncine.viewport.viewportObj

ncine.application.get_num_frames ()

Returns the total number of frames already rendered

Returns:

integer

ncine.application.get_interval ()

Returns the time in seconds that last frame took to complete

Returns:

number

ncine.application.get_width ()

Returns the drawable screen width

Returns:

number

ncine.application.get_height ()

Returns the drawable screen height

Returns:

number

ncine.application.get_resolution ()

Returns the drawable screen resolution vector

Returns:

ncine.vec2

ncine.application.is_suspended ()

Returns true if the application is suspended.

A suspended application will not update nor receive events.

Returns:

boolean

ncine.application.set_suspended (flag)

Sets a new value for the suspension flag

Parameters:

• flag boolean

ncine.application.get_auto_suspension ()

Returns true if the application should auto-suspend when it loses focus

Returns:

boolean

ncine.application.set_auto_suspension (flag)

Sets a new value for the auto-suspension flag

Parameters:

• flag boolean

ncine.application.quit ()

Asks the application to quit as soon as possible

Tables

rendering_settings

The rendering settings table

Fields:

• batching boolean True if sprite batching is enabled
• batching_with_indices boolean True if using indices for vertex batching
• culling boolean True if node culling is enabled
• min_batch_size integer Minimum size for a batch to be collected
• max_batch_size integer Maximum size for a batch before a forced split

debug_overlay_settings

The debug overlay settings table

Fields:

• profiler_graphs boolean True if showing the profiler graphs
• info_text boolean True if showing the information text
• interface boolean True if showing the debug interface

gui_settings

The gui settings table

Fields:

• imgui_viewport (ncine.viewport.viewportObj) ImGui viewport
• nuklear_viewport (ncine.viewport.viewportObj) Nuklear viewport
• imgui_layer integer ImGui drawable node layer
• nuklearLayer integer Nuklear drawable node layer