class_rdvertexattribute.rst 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  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 RDVertexAttribute.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_RDVertexAttribute:
  6. RDVertexAttribute
  7. =================
  8. **Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  9. Properties
  10. ----------
  11. +--------------------------------------------------------------+--------------------------------------------------------------+---------+
  12. | :ref:`DataFormat<enum_RenderingDevice_DataFormat>` | :ref:`format<class_RDVertexAttribute_property_format>` | ``218`` |
  13. +--------------------------------------------------------------+--------------------------------------------------------------+---------+
  14. | :ref:`VertexFrequency<enum_RenderingDevice_VertexFrequency>` | :ref:`frequency<class_RDVertexAttribute_property_frequency>` | ``0`` |
  15. +--------------------------------------------------------------+--------------------------------------------------------------+---------+
  16. | :ref:`int<class_int>` | :ref:`location<class_RDVertexAttribute_property_location>` | ``0`` |
  17. +--------------------------------------------------------------+--------------------------------------------------------------+---------+
  18. | :ref:`int<class_int>` | :ref:`offset<class_RDVertexAttribute_property_offset>` | ``0`` |
  19. +--------------------------------------------------------------+--------------------------------------------------------------+---------+
  20. | :ref:`int<class_int>` | :ref:`stride<class_RDVertexAttribute_property_stride>` | ``0`` |
  21. +--------------------------------------------------------------+--------------------------------------------------------------+---------+
  22. Property Descriptions
  23. ---------------------
  24. .. _class_RDVertexAttribute_property_format:
  25. - :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **format**
  26. +-----------+-------------------+
  27. | *Default* | ``218`` |
  28. +-----------+-------------------+
  29. | *Setter* | set_format(value) |
  30. +-----------+-------------------+
  31. | *Getter* | get_format() |
  32. +-----------+-------------------+
  33. ----
  34. .. _class_RDVertexAttribute_property_frequency:
  35. - :ref:`VertexFrequency<enum_RenderingDevice_VertexFrequency>` **frequency**
  36. +-----------+----------------------+
  37. | *Default* | ``0`` |
  38. +-----------+----------------------+
  39. | *Setter* | set_frequency(value) |
  40. +-----------+----------------------+
  41. | *Getter* | get_frequency() |
  42. +-----------+----------------------+
  43. ----
  44. .. _class_RDVertexAttribute_property_location:
  45. - :ref:`int<class_int>` **location**
  46. +-----------+---------------------+
  47. | *Default* | ``0`` |
  48. +-----------+---------------------+
  49. | *Setter* | set_location(value) |
  50. +-----------+---------------------+
  51. | *Getter* | get_location() |
  52. +-----------+---------------------+
  53. ----
  54. .. _class_RDVertexAttribute_property_offset:
  55. - :ref:`int<class_int>` **offset**
  56. +-----------+-------------------+
  57. | *Default* | ``0`` |
  58. +-----------+-------------------+
  59. | *Setter* | set_offset(value) |
  60. +-----------+-------------------+
  61. | *Getter* | get_offset() |
  62. +-----------+-------------------+
  63. ----
  64. .. _class_RDVertexAttribute_property_stride:
  65. - :ref:`int<class_int>` **stride**
  66. +-----------+-------------------+
  67. | *Default* | ``0`` |
  68. +-----------+-------------------+
  69. | *Setter* | set_stride(value) |
  70. +-----------+-------------------+
  71. | *Getter* | get_stride() |
  72. +-----------+-------------------+
  73. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  74. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  75. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  76. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  77. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  78. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`