class_nativeextension.rst 5.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the NativeExtension.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_NativeExtension:
  6. NativeExtension
  7. ===============
  8. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  9. Methods
  10. -------
  11. +----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  12. | void | :ref:`close_library<class_NativeExtension_method_close_library>` **(** **)** |
  13. +----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  14. | :ref:`InitializationLevel<enum_NativeExtension_InitializationLevel>` | :ref:`get_minimum_library_initialization_level<class_NativeExtension_method_get_minimum_library_initialization_level>` **(** **)** |const| |
  15. +----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  16. | void | :ref:`initialize_library<class_NativeExtension_method_initialize_library>` **(** :ref:`InitializationLevel<enum_NativeExtension_InitializationLevel>` level **)** |
  17. +----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  18. | :ref:`bool<class_bool>` | :ref:`is_library_open<class_NativeExtension_method_is_library_open>` **(** **)** |const| |
  19. +----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  20. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`open_library<class_NativeExtension_method_open_library>` **(** :ref:`String<class_String>` path, :ref:`String<class_String>` entry_symbol **)** |
  21. +----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  22. Enumerations
  23. ------------
  24. .. _enum_NativeExtension_InitializationLevel:
  25. .. _class_NativeExtension_constant_INITIALIZATION_LEVEL_CORE:
  26. .. _class_NativeExtension_constant_INITIALIZATION_LEVEL_SERVERS:
  27. .. _class_NativeExtension_constant_INITIALIZATION_LEVEL_SCENE:
  28. .. _class_NativeExtension_constant_INITIALIZATION_LEVEL_DRIVER:
  29. .. _class_NativeExtension_constant_INITIALIZATION_LEVEL_EDITOR:
  30. enum **InitializationLevel**:
  31. - **INITIALIZATION_LEVEL_CORE** = **0**
  32. - **INITIALIZATION_LEVEL_SERVERS** = **1**
  33. - **INITIALIZATION_LEVEL_SCENE** = **2**
  34. - **INITIALIZATION_LEVEL_DRIVER** = **3**
  35. - **INITIALIZATION_LEVEL_EDITOR** = **4**
  36. Method Descriptions
  37. -------------------
  38. .. _class_NativeExtension_method_close_library:
  39. - void **close_library** **(** **)**
  40. ----
  41. .. _class_NativeExtension_method_get_minimum_library_initialization_level:
  42. - :ref:`InitializationLevel<enum_NativeExtension_InitializationLevel>` **get_minimum_library_initialization_level** **(** **)** |const|
  43. ----
  44. .. _class_NativeExtension_method_initialize_library:
  45. - void **initialize_library** **(** :ref:`InitializationLevel<enum_NativeExtension_InitializationLevel>` level **)**
  46. ----
  47. .. _class_NativeExtension_method_is_library_open:
  48. - :ref:`bool<class_bool>` **is_library_open** **(** **)** |const|
  49. ----
  50. .. _class_NativeExtension_method_open_library:
  51. - :ref:`Error<enum_@GlobalScope_Error>` **open_library** **(** :ref:`String<class_String>` path, :ref:`String<class_String>` entry_symbol **)**
  52. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  53. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  54. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  55. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  56. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  57. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`