TextureLayered.xml 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="TextureLayered" inherits="Texture" version="4.0">
  3. <brief_description>
  4. Base class for 3D texture types.
  5. </brief_description>
  6. <description>
  7. Base class for [Texture2DArray], [Cubemap] and [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 [Texture2DArray]s, the layer specifies the array layer.
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <methods>
  12. <method name="get_format" qualifiers="const">
  13. <return type="int" enum="Image.Format" />
  14. <description>
  15. Returns the current format being used by this texture. See [enum Image.Format] for details.
  16. </description>
  17. </method>
  18. <method name="get_height" qualifiers="const">
  19. <return type="int" />
  20. <description>
  21. Returns the height of the texture. Height is typically represented by the Y-axis.
  22. </description>
  23. </method>
  24. <method name="get_layer_data" qualifiers="const">
  25. <return type="Image" />
  26. <argument index="0" name="layer" type="int" />
  27. <description>
  28. Returns an [Image] resource with the data from specified [code]layer[/code].
  29. </description>
  30. </method>
  31. <method name="get_layered_type" qualifiers="const">
  32. <return type="int" enum="TextureLayered.LayeredType" />
  33. <description>
  34. </description>
  35. </method>
  36. <method name="get_layers" qualifiers="const">
  37. <return type="int" />
  38. <description>
  39. </description>
  40. </method>
  41. <method name="get_width" qualifiers="const">
  42. <return type="int" />
  43. <description>
  44. Returns the width of the texture. Width is typically represented by the X-axis.
  45. </description>
  46. </method>
  47. <method name="has_mipmaps" qualifiers="const">
  48. <return type="bool" />
  49. <description>
  50. </description>
  51. </method>
  52. </methods>
  53. <constants>
  54. <constant name="LAYERED_TYPE_2D_ARRAY" value="0" enum="LayeredType">
  55. </constant>
  56. <constant name="LAYERED_TYPE_CUBEMAP" value="1" enum="LayeredType">
  57. </constant>
  58. <constant name="LAYERED_TYPE_CUBEMAP_ARRAY" value="2" enum="LayeredType">
  59. </constant>
  60. </constants>
  61. </class>