mini_arcade_core.engine.engine_config
=====================================

.. py:module:: mini_arcade_core.engine.engine_config

.. autoapi-nested-parse::

   Public module exposing engine configuration classes.



Classes
-------

.. autoapisummary::

   mini_arcade_core.engine.engine_config.EngineConfig
   mini_arcade_core.engine.engine_config.PostFXConfig
   mini_arcade_core.engine.engine_config.SceneConfig


Module Contents
---------------

.. py:class:: EngineConfig

   Configuration options for the Engine.

   :ivar fps (int): Target frames per second.
   :ivar virtual_resolution (tuple[int, int]): Virtual render resolution.
   :ivar postfx (PostFXConfig): Configuration for post-processing effects.


   .. py:attribute:: fps
      :type:  int
      :value: 60



   .. py:attribute:: virtual_resolution
      :type:  tuple[int, int]
      :value: (800, 600)



   .. py:attribute:: postfx
      :type:  PostFXConfig


   .. py:attribute:: enable_profiler
      :type:  bool
      :value: False



   .. py:method:: from_dict(data: dict[str, Any]) -> EngineConfig
      :classmethod:


      Create an EngineConfig instance from a dictionary.

      :param data: Dictionary containing configuration values.
      :type data: dict

      :return: An EngineConfig instance populated with the provided data.
      :rtype: EngineConfig



.. py:class:: PostFXConfig

   Configuration for post-processing effects.

   :ivar enabled (bool): Whether post effects are enabled by default.
   :ivar active (list[str]): List of active effect IDs by default.


   .. py:attribute:: enabled
      :type:  bool
      :value: True



   .. py:attribute:: active
      :type:  list[str]
      :value: []



.. py:class:: SceneConfig

   Scene bootstrap configuration.

   :ivar initial_scene: Identifier of the initial scene to load.
   :ivar discover_packages: Packages used for scene auto-discovery.


   .. py:attribute:: initial_scene
      :type:  str
      :value: 'main'



   .. py:attribute:: discover_packages
      :type:  list[str]
      :value: []



   .. py:method:: from_dict(data: dict[str, Any] | None) -> SceneConfig
      :classmethod:


      Construct scene config from a dict, typically parsed from a game config file.

      :param data: The input data to parse.
      :type data: dict or None
      :return: A SceneConfig instance populated with the parsed data.
      :rtype: SceneConfig