class_texturelayered.rst 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the TextureLayered.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_TextureLayered:
  6. TextureLayered
  7. ==============
  8. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. **Inherited By:** :ref:`Texture3D<class_Texture3D>`, :ref:`TextureArray<class_TextureArray>`
  10. **Category:** Core
  11. Brief Description
  12. -----------------
  13. Properties
  14. ----------
  15. +-------------------------------------+---------------------------------------------------+----------------------------------------------------------------------------+
  16. | :ref:`Dictionary<class_Dictionary>` | :ref:`data<class_TextureLayered_property_data>` | {"depth": 0,"flags": 4,"format": 37,"height": 0,"layers": [ ],"width": 0} |
  17. +-------------------------------------+---------------------------------------------------+----------------------------------------------------------------------------+
  18. | :ref:`int<class_int>` | :ref:`flags<class_TextureLayered_property_flags>` | 4 |
  19. +-------------------------------------+---------------------------------------------------+----------------------------------------------------------------------------+
  20. Methods
  21. -------
  22. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | void | :ref:`create<class_TextureLayered_method_create>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` depth, :ref:`Format<enum_Image_Format>` format, :ref:`int<class_int>` flags=4 **)** |
  24. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`int<class_int>` | :ref:`get_depth<class_TextureLayered_method_get_depth>` **(** **)** const |
  26. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. | :ref:`Format<enum_Image_Format>` | :ref:`get_format<class_TextureLayered_method_get_format>` **(** **)** const |
  28. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | :ref:`int<class_int>` | :ref:`get_height<class_TextureLayered_method_get_height>` **(** **)** const |
  30. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | :ref:`Image<class_Image>` | :ref:`get_layer_data<class_TextureLayered_method_get_layer_data>` **(** :ref:`int<class_int>` layer **)** const |
  32. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  33. | :ref:`int<class_int>` | :ref:`get_width<class_TextureLayered_method_get_width>` **(** **)** const |
  34. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  35. | void | :ref:`set_data_partial<class_TextureLayered_method_set_data_partial>` **(** :ref:`Image<class_Image>` image, :ref:`int<class_int>` x_offset, :ref:`int<class_int>` y_offset, :ref:`int<class_int>` layer, :ref:`int<class_int>` mipmap=0 **)** |
  36. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  37. | void | :ref:`set_layer_data<class_TextureLayered_method_set_layer_data>` **(** :ref:`Image<class_Image>` image, :ref:`int<class_int>` layer **)** |
  38. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  39. Enumerations
  40. ------------
  41. .. _enum_TextureLayered_Flags:
  42. .. _class_TextureLayered_constant_FLAG_MIPMAPS:
  43. .. _class_TextureLayered_constant_FLAG_REPEAT:
  44. .. _class_TextureLayered_constant_FLAG_FILTER:
  45. .. _class_TextureLayered_constant_FLAGS_DEFAULT:
  46. enum **Flags**:
  47. - **FLAG_MIPMAPS** = **1**
  48. - **FLAG_REPEAT** = **2**
  49. - **FLAG_FILTER** = **4**
  50. - **FLAGS_DEFAULT** = **4**
  51. Property Descriptions
  52. ---------------------
  53. .. _class_TextureLayered_property_data:
  54. - :ref:`Dictionary<class_Dictionary>` **data**
  55. +-----------+----------------------------------------------------------------------------+
  56. | *Default* | {"depth": 0,"flags": 4,"format": 37,"height": 0,"layers": [ ],"width": 0} |
  57. +-----------+----------------------------------------------------------------------------+
  58. .. _class_TextureLayered_property_flags:
  59. - :ref:`int<class_int>` **flags**
  60. +-----------+------------------+
  61. | *Default* | 4 |
  62. +-----------+------------------+
  63. | *Setter* | set_flags(value) |
  64. +-----------+------------------+
  65. | *Getter* | get_flags() |
  66. +-----------+------------------+
  67. Method Descriptions
  68. -------------------
  69. .. _class_TextureLayered_method_create:
  70. - void **create** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` depth, :ref:`Format<enum_Image_Format>` format, :ref:`int<class_int>` flags=4 **)**
  71. .. _class_TextureLayered_method_get_depth:
  72. - :ref:`int<class_int>` **get_depth** **(** **)** const
  73. .. _class_TextureLayered_method_get_format:
  74. - :ref:`Format<enum_Image_Format>` **get_format** **(** **)** const
  75. .. _class_TextureLayered_method_get_height:
  76. - :ref:`int<class_int>` **get_height** **(** **)** const
  77. .. _class_TextureLayered_method_get_layer_data:
  78. - :ref:`Image<class_Image>` **get_layer_data** **(** :ref:`int<class_int>` layer **)** const
  79. .. _class_TextureLayered_method_get_width:
  80. - :ref:`int<class_int>` **get_width** **(** **)** const
  81. .. _class_TextureLayered_method_set_data_partial:
  82. - void **set_data_partial** **(** :ref:`Image<class_Image>` image, :ref:`int<class_int>` x_offset, :ref:`int<class_int>` y_offset, :ref:`int<class_int>` layer, :ref:`int<class_int>` mipmap=0 **)**
  83. .. _class_TextureLayered_method_set_layer_data:
  84. - void **set_layer_data** **(** :ref:`Image<class_Image>` image, :ref:`int<class_int>` layer **)**