Module ncine.app_configuration
The application configuration table
Tables
Fields
| ncine.window_ignore_position | Special value for window position to ignore a coordinate. Used in ncine.app_configuration.window.position.When assigned to the x or y coordinate, the current position for that axis is preserved. |
Tables
- ncine.app_configuration.logging
-
Fields:
- console_level (ncine.log_level) The minimum level that a log message needs to have to be printed in the console
- file_level (ncine.log_level) The minimum level that a log message needs to have to be written to the log file
- file string The file used when logging to file is enabled
- frame_timer_interval number The interval for frame timer accumulation average and log
- console_colors boolean Enables the use of colors for console log messages
- ncine.app_configuration.window
-
Fields:
- resolution
(ncine.vec2) The window size or the resolution of the closest video mode if going full screen.
If eitherxoryare zero or negative, the application will go in full screen at the current screen resolution. - position
(ncine.vec2) The window position coordinates in the virtual screen made of all the connected monitors.
You can also usencine.window_ignore_positionfor one or both coordinates. - refresh_rate
number
The refresh rate of the screen mode used to go in full screen.
If it is zero or negative, when requesting a full screen mode the current refresh rate will not be changed. - fullscreen boolean Enables fullscreen mode for the application window
- resizable boolean Allows the window to be resized by the user
- scaling boolean Enables automatic window size scaling according to the display factor
- title string The window title
- icon string The window icon filename
- resolution
(ncine.vec2) The window size or the resolution of the closest video mode if going full screen.
- ncine.app_configuration.graphics
-
Fields:
- opengl_caps ncine.app_configuration.graphics.opengl_caps @subtable
- opengl ncine.app_configuration.graphics.opengl @subtable
- vsync boolean Enables vertical synchronization
- frame_limit integer The maximum number of frames to render per second or 0 for no limit
- ncine.app_configuration.graphics.opengl_caps
-
Fields:
- core_profile boolean Whether the OpenGL context uses a core profile (read-only)
- forward_compatible boolean Whether the OpenGL context is forward-compatible (read-only)
- major_version integer The major version number of the OpenGL context (read-only)
- minor_version integer The minor version number of the OpenGL context (read-only)
- ncine.app_configuration.graphics.opengl
-
Fields:
- debug_context boolean Enables the OpenGL debug context for additional validation and diagnostics
- buffer_mapping boolean Enables buffer mapping for updating OpenGL buffers
- vbo_size integer The maximum size in bytes for each VBO collecting geometry data
- ibo_size integer The maximum size in bytes for each IBO collecting index data
- vao_pool_size integer The maximum size for the pool of VAOs
- rendercommand_pool_size integer The initial size for the pool of render commands
- defer_shader_queries boolean Defers shader program validation and introspection until first use
- fixed_batch_size integer Fixed size of render commands to be collected for batching on Emscripten and ANGLE
- binary_shader_cache boolean Enables the cache for loading and saving binary shader programs
- shader_cache_dirname string The directory name (not the complete path) for the binary shaders cache
- compile_batched_shaders_twice boolean Compiles batched shaders twice on devices with small UBO limits to determine maximum batch size
- ncine.app_configuration.audio
-
Fields:
- enabled boolean Enables the audio subsystem
- frequency integer The output frequency of the audio system
- mono_sources integer The number of mono audio sources
- stereo_sources integer The number of stereo audio sources
- ncine.app_configuration.job_system
-
Fields:
- enabled boolean Enables the job system
- num_threads integer The number of threads in the job system pool, or 0 for an automatic value
- ncine.app_configuration.features
-
Fields:
- scenegraph boolean Enables scenegraph-based rendering
- debug_overlay boolean Enables the debug overlay
- ncine.app_configuration
-
Fields:
- logging ncine.app_configuration.logging @subtable
- window ncine.app_configuration.window @subtable
- graphics ncine.app_configuration.graphics @subtable
- audio ncine.app_configuration.audio @subtable
- job_system ncine.app_configuration.job_system @subtable
- features ncine.app_configuration.features @subtable
- argv (string[]) The array of arguments passed on the command line (read-only)
- profile_text_update_time number The update time in seconds for the profile text nodes (read-only)
- data_path string The data path
- argc integer The number of arguments passed on the command line (read-only)