Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 75b51ec2f4
Branches Tags
godot-docs
/
classes
/
class_texturelayered.rst

class_texturelayered.rst 9.6 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the TextureLayered.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_TextureLayered:
    8. 

  8. 

  9. TextureLayered
    10. 

  10. ==============
    11. 

  11. 

  12. **Inherits:** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. **Inherited By:** :ref:`CompressedTextureLayered<class_CompressedTextureLayered>`, :ref:`ImageTextureLayered<class_ImageTextureLayered>`
    15. 

  15. 

  16. Base class for 3D texture types.
    17. 

  17. 

  18. Description
    19. 

  19. -----------
    20. 

  20. 

  21. Base class for :ref:`Texture2DArray<class_Texture2DArray>`, :ref:`Cubemap<class_Cubemap>` and :ref:`CubemapArray<class_CubemapArray>`. Cannot be used directly, but contains all the functions necessary for accessing the derived resource types. Data is set on a per-layer basis. For :ref:`Texture2DArray<class_Texture2DArray>`\ s, the layer specifies the array layer.
    22. 

  22. 

  23. Methods
    24. 

  24. -------
    25. 

  25. 

  26. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
    27. 

  27. | :ref:`Format<enum_Image_Format>`                    | :ref:`_get_format<class_TextureLayered_method__get_format>` **(** **)** |virtual| |const|                                           |
    28. 

  28. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
    29. 

  29. | :ref:`int<class_int>`                               | :ref:`_get_height<class_TextureLayered_method__get_height>` **(** **)** |virtual| |const|                                           |
    30. 

  30. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
    31. 

  31. | :ref:`Image<class_Image>`                           | :ref:`_get_layer_data<class_TextureLayered_method__get_layer_data>` **(** :ref:`int<class_int>` layer_index **)** |virtual| |const| |
    32. 

  32. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
    33. 

  33. | :ref:`int<class_int>`                               | :ref:`_get_layered_type<class_TextureLayered_method__get_layered_type>` **(** **)** |virtual| |const|                               |
    34. 

  34. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
    35. 

  35. | :ref:`int<class_int>`                               | :ref:`_get_layers<class_TextureLayered_method__get_layers>` **(** **)** |virtual| |const|                                           |
    36. 

  36. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
    37. 

  37. | :ref:`int<class_int>`                               | :ref:`_get_width<class_TextureLayered_method__get_width>` **(** **)** |virtual| |const|                                             |
    38. 

  38. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
    39. 

  39. | :ref:`bool<class_bool>`                             | :ref:`_has_mipmaps<class_TextureLayered_method__has_mipmaps>` **(** **)** |virtual| |const|                                         |
    40. 

  40. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
    41. 

  41. | :ref:`Format<enum_Image_Format>`                    | :ref:`get_format<class_TextureLayered_method_get_format>` **(** **)** |const|                                                       |
    42. 

  42. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
    43. 

  43. | :ref:`int<class_int>`                               | :ref:`get_height<class_TextureLayered_method_get_height>` **(** **)** |const|                                                       |
    44. 

  44. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
    45. 

  45. | :ref:`Image<class_Image>`                           | :ref:`get_layer_data<class_TextureLayered_method_get_layer_data>` **(** :ref:`int<class_int>` layer **)** |const|                   |
    46. 

  46. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
    47. 

  47. | :ref:`LayeredType<enum_TextureLayered_LayeredType>` | :ref:`get_layered_type<class_TextureLayered_method_get_layered_type>` **(** **)** |const|                                           |
    48. 

  48. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
    49. 

  49. | :ref:`int<class_int>`                               | :ref:`get_layers<class_TextureLayered_method_get_layers>` **(** **)** |const|                                                       |
    50. 

  50. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
    51. 

  51. | :ref:`int<class_int>`                               | :ref:`get_width<class_TextureLayered_method_get_width>` **(** **)** |const|                                                         |
    52. 

  52. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
    53. 

  53. | :ref:`bool<class_bool>`                             | :ref:`has_mipmaps<class_TextureLayered_method_has_mipmaps>` **(** **)** |const|                                                     |
    54. 

  54. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
    55. 

  55. 

  56. Enumerations
    57. 

  57. ------------
    58. 

  58. 

  59. .. _enum_TextureLayered_LayeredType:
    60. 

  60. 

  61. .. _class_TextureLayered_constant_LAYERED_TYPE_2D_ARRAY:
    62. 

  62. 

  63. .. _class_TextureLayered_constant_LAYERED_TYPE_CUBEMAP:
    64. 

  64. 

  65. .. _class_TextureLayered_constant_LAYERED_TYPE_CUBEMAP_ARRAY:
    66. 

  66. 

  67. enum **LayeredType**:
    68. 

  68. 

  69. - **LAYERED_TYPE_2D_ARRAY** = **0**
    70. 

  70. 

  71. - **LAYERED_TYPE_CUBEMAP** = **1**
    72. 

  72. 

  73. - **LAYERED_TYPE_CUBEMAP_ARRAY** = **2**
    74. 

  74. 

  75. Method Descriptions
    76. 

  76. -------------------
    77. 

  77. 

  78. .. _class_TextureLayered_method__get_format:
    79. 

  79. 

  80. - :ref:`Format<enum_Image_Format>` **_get_format** **(** **)** |virtual| |const|
    81. 

  81. 

  82. ----
    83. 

  83. 

  84. .. _class_TextureLayered_method__get_height:
    85. 

  85. 

  86. - :ref:`int<class_int>` **_get_height** **(** **)** |virtual| |const|
    87. 

  87. 

  88. ----
    89. 

  89. 

  90. .. _class_TextureLayered_method__get_layer_data:
    91. 

  91. 

  92. - :ref:`Image<class_Image>` **_get_layer_data** **(** :ref:`int<class_int>` layer_index **)** |virtual| |const|
    93. 

  93. 

  94. ----
    95. 

  95. 

  96. .. _class_TextureLayered_method__get_layered_type:
    97. 

  97. 

  98. - :ref:`int<class_int>` **_get_layered_type** **(** **)** |virtual| |const|
    99. 

  99. 

  100. ----
    101. 

  101. 

  102. .. _class_TextureLayered_method__get_layers:
    103. 

  103. 

  104. - :ref:`int<class_int>` **_get_layers** **(** **)** |virtual| |const|
    105. 

  105. 

  106. ----
    107. 

  107. 

  108. .. _class_TextureLayered_method__get_width:
    109. 

  109. 

  110. - :ref:`int<class_int>` **_get_width** **(** **)** |virtual| |const|
    111. 

  111. 

  112. ----
    113. 

  113. 

  114. .. _class_TextureLayered_method__has_mipmaps:
    115. 

  115. 

  116. - :ref:`bool<class_bool>` **_has_mipmaps** **(** **)** |virtual| |const|
    117. 

  117. 

  118. ----
    119. 

  119. 

  120. .. _class_TextureLayered_method_get_format:
    121. 

  121. 

  122. - :ref:`Format<enum_Image_Format>` **get_format** **(** **)** |const|
    123. 

  123. 

  124. Returns the current format being used by this texture. See :ref:`Format<enum_Image_Format>` for details.
    125. 

  125. 

  126. ----
    127. 

  127. 

  128. .. _class_TextureLayered_method_get_height:
    129. 

  129. 

  130. - :ref:`int<class_int>` **get_height** **(** **)** |const|
    131. 

  131. 

  132. Returns the height of the texture. Height is typically represented by the Y-axis.
    133. 

  133. 

  134. ----
    135. 

  135. 

  136. .. _class_TextureLayered_method_get_layer_data:
    137. 

  137. 

  138. - :ref:`Image<class_Image>` **get_layer_data** **(** :ref:`int<class_int>` layer **)** |const|
    139. 

  139. 

  140. Returns an :ref:`Image<class_Image>` resource with the data from specified ``layer``.
    141. 

  141. 

  142. ----
    143. 

  143. 

  144. .. _class_TextureLayered_method_get_layered_type:
    145. 

  145. 

  146. - :ref:`LayeredType<enum_TextureLayered_LayeredType>` **get_layered_type** **(** **)** |const|
    147. 

  147. 

  148. ----
    149. 

  149. 

  150. .. _class_TextureLayered_method_get_layers:
    151. 

  151. 

  152. - :ref:`int<class_int>` **get_layers** **(** **)** |const|
    153. 

  153. 

  154. ----
    155. 

  155. 

  156. .. _class_TextureLayered_method_get_width:
    157. 

  157. 

  158. - :ref:`int<class_int>` **get_width** **(** **)** |const|
    159. 

  159. 

  160. Returns the width of the texture. Width is typically represented by the X-axis.
    161. 

  161. 

  162. ----
    163. 

  163. 

  164. .. _class_TextureLayered_method_has_mipmaps:
    165. 

  165. 

  166. - :ref:`bool<class_bool>` **has_mipmaps** **(** **)** |const|
    167. 

  167. 

  168. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    169. 

  169. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    170. 

  170. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    171. 

  171. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    172. 

  172. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    173. 

  173. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    174.