class_texturelayered.rst 7.6 KB

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