class_rdframebufferpass.rst 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDFramebufferPass.xml.
  6. .. _class_RDFramebufferPass:
  7. RDFramebufferPass
  8. =================
  9. **Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. Framebuffer pass attachment description.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. This class contains the list of attachment descriptions for a framebuffer pass. Each points with an index to a previously supplied list of texture attachments.
  15. Multipass framebuffers can optimize some configurations in mobile, on desktop they provide little to no advantage.
  16. .. rst-class:: classref-reftable-group
  17. Properties
  18. ----------
  19. .. table::
  20. :widths: auto
  21. +-------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
  22. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`color_attachments<class_RDFramebufferPass_property_color_attachments>` | ``PackedInt32Array()`` |
  23. +-------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
  24. | :ref:`int<class_int>` | :ref:`depth_attachment<class_RDFramebufferPass_property_depth_attachment>` | ``-1`` |
  25. +-------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
  26. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`input_attachments<class_RDFramebufferPass_property_input_attachments>` | ``PackedInt32Array()`` |
  27. +-------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
  28. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`preserve_attachments<class_RDFramebufferPass_property_preserve_attachments>` | ``PackedInt32Array()`` |
  29. +-------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
  30. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`resolve_attachments<class_RDFramebufferPass_property_resolve_attachments>` | ``PackedInt32Array()`` |
  31. +-------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
  32. .. rst-class:: classref-section-separator
  33. ----
  34. .. rst-class:: classref-descriptions-group
  35. Constants
  36. ---------
  37. .. _class_RDFramebufferPass_constant_ATTACHMENT_UNUSED:
  38. .. rst-class:: classref-constant
  39. **ATTACHMENT_UNUSED** = ``-1``
  40. .. rst-class:: classref-section-separator
  41. ----
  42. .. rst-class:: classref-descriptions-group
  43. Property Descriptions
  44. ---------------------
  45. .. _class_RDFramebufferPass_property_color_attachments:
  46. .. rst-class:: classref-property
  47. :ref:`PackedInt32Array<class_PackedInt32Array>` **color_attachments** = ``PackedInt32Array()``
  48. .. rst-class:: classref-property-setget
  49. - void **set_color_attachments** **(** :ref:`PackedInt32Array<class_PackedInt32Array>` value **)**
  50. - :ref:`PackedInt32Array<class_PackedInt32Array>` **get_color_attachments** **(** **)**
  51. Color attachments in order starting from 0. If this attachment is not used by the shader, pass ATTACHMENT_UNUSED to skip.
  52. .. rst-class:: classref-item-separator
  53. ----
  54. .. _class_RDFramebufferPass_property_depth_attachment:
  55. .. rst-class:: classref-property
  56. :ref:`int<class_int>` **depth_attachment** = ``-1``
  57. .. rst-class:: classref-property-setget
  58. - void **set_depth_attachment** **(** :ref:`int<class_int>` value **)**
  59. - :ref:`int<class_int>` **get_depth_attachment** **(** **)**
  60. Depth attachment. ATTACHMENT_UNUSED should be used if no depth buffer is required for this pass.
  61. .. rst-class:: classref-item-separator
  62. ----
  63. .. _class_RDFramebufferPass_property_input_attachments:
  64. .. rst-class:: classref-property
  65. :ref:`PackedInt32Array<class_PackedInt32Array>` **input_attachments** = ``PackedInt32Array()``
  66. .. rst-class:: classref-property-setget
  67. - void **set_input_attachments** **(** :ref:`PackedInt32Array<class_PackedInt32Array>` value **)**
  68. - :ref:`PackedInt32Array<class_PackedInt32Array>` **get_input_attachments** **(** **)**
  69. Used for multipass framebuffers (more than one render pass). Converts an attachment to an input. Make sure to also supply it properly in the :ref:`RDUniform<class_RDUniform>` for the uniform set.
  70. .. rst-class:: classref-item-separator
  71. ----
  72. .. _class_RDFramebufferPass_property_preserve_attachments:
  73. .. rst-class:: classref-property
  74. :ref:`PackedInt32Array<class_PackedInt32Array>` **preserve_attachments** = ``PackedInt32Array()``
  75. .. rst-class:: classref-property-setget
  76. - void **set_preserve_attachments** **(** :ref:`PackedInt32Array<class_PackedInt32Array>` value **)**
  77. - :ref:`PackedInt32Array<class_PackedInt32Array>` **get_preserve_attachments** **(** **)**
  78. Attachments to preserve in this pass (otherwise they are erased).
  79. .. rst-class:: classref-item-separator
  80. ----
  81. .. _class_RDFramebufferPass_property_resolve_attachments:
  82. .. rst-class:: classref-property
  83. :ref:`PackedInt32Array<class_PackedInt32Array>` **resolve_attachments** = ``PackedInt32Array()``
  84. .. rst-class:: classref-property-setget
  85. - void **set_resolve_attachments** **(** :ref:`PackedInt32Array<class_PackedInt32Array>` value **)**
  86. - :ref:`PackedInt32Array<class_PackedInt32Array>` **get_resolve_attachments** **(** **)**
  87. If the color attachments are multisampled, non-multisampled resolve attachments can be provided.
  88. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  89. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  90. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  91. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  92. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  93. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`