mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
classref: Sync with current master branch (f87858a8f)
This commit is contained in:
Yuri Sizov
@@ -14,6 +14,8 @@ RDFramebufferPass
|
||||
|
||||
Framebuffer pass attachment description.
|
||||
|
||||
.. rst-class:: classref-introduction-group
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
@@ -21,106 +23,130 @@ This class contains the list of attachment descriptions for a framebuffer pass.
|
||||
|
||||
Multipass framebuffers can optimize some configurations in mobile, on desktop they provide little to no advantage.
|
||||
|
||||
.. rst-class:: classref-reftable-group
|
||||
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
|
||||
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`color_attachments<class_RDFramebufferPass_property_color_attachments>` | ``PackedInt32Array()`` |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`depth_attachment<class_RDFramebufferPass_property_depth_attachment>` | ``-1`` |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
|
||||
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`input_attachments<class_RDFramebufferPass_property_input_attachments>` | ``PackedInt32Array()`` |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
|
||||
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`preserve_attachments<class_RDFramebufferPass_property_preserve_attachments>` | ``PackedInt32Array()`` |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
|
||||
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`resolve_attachments<class_RDFramebufferPass_property_resolve_attachments>` | ``PackedInt32Array()`` |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
|
||||
.. table::
|
||||
:widths: auto
|
||||
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
|
||||
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`color_attachments<class_RDFramebufferPass_property_color_attachments>` | ``PackedInt32Array()`` |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`depth_attachment<class_RDFramebufferPass_property_depth_attachment>` | ``-1`` |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
|
||||
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`input_attachments<class_RDFramebufferPass_property_input_attachments>` | ``PackedInt32Array()`` |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
|
||||
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`preserve_attachments<class_RDFramebufferPass_property_preserve_attachments>` | ``PackedInt32Array()`` |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
|
||||
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`resolve_attachments<class_RDFramebufferPass_property_resolve_attachments>` | ``PackedInt32Array()`` |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
|
||||
|
||||
.. rst-class:: classref-section-separator
|
||||
|
||||
----
|
||||
|
||||
.. rst-class:: classref-descriptions-group
|
||||
|
||||
Constants
|
||||
---------
|
||||
|
||||
.. _class_RDFramebufferPass_constant_ATTACHMENT_UNUSED:
|
||||
|
||||
- **ATTACHMENT_UNUSED** = **-1**
|
||||
.. rst-class:: classref-constant
|
||||
|
||||
**ATTACHMENT_UNUSED** = ``-1``
|
||||
|
||||
|
||||
|
||||
.. rst-class:: classref-section-separator
|
||||
|
||||
----
|
||||
|
||||
.. rst-class:: classref-descriptions-group
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_RDFramebufferPass_property_color_attachments:
|
||||
|
||||
- :ref:`PackedInt32Array<class_PackedInt32Array>` **color_attachments**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+------------------------------+
|
||||
| *Default* | ``PackedInt32Array()`` |
|
||||
+-----------+------------------------------+
|
||||
| *Setter* | set_color_attachments(value) |
|
||||
+-----------+------------------------------+
|
||||
| *Getter* | get_color_attachments() |
|
||||
+-----------+------------------------------+
|
||||
:ref:`PackedInt32Array<class_PackedInt32Array>` **color_attachments** = ``PackedInt32Array()``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_color_attachments** **(** :ref:`PackedInt32Array<class_PackedInt32Array>` value **)**
|
||||
- :ref:`PackedInt32Array<class_PackedInt32Array>` **get_color_attachments** **(** **)**
|
||||
|
||||
Color attachments in order starting from 0. If this attachment is not used by the shader, pass ATTACHMENT_UNUSED to skip.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_RDFramebufferPass_property_depth_attachment:
|
||||
|
||||
- :ref:`int<class_int>` **depth_attachment**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | ``-1`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_depth_attachment(value) |
|
||||
+-----------+-----------------------------+
|
||||
| *Getter* | get_depth_attachment() |
|
||||
+-----------+-----------------------------+
|
||||
:ref:`int<class_int>` **depth_attachment** = ``-1``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_depth_attachment** **(** :ref:`int<class_int>` value **)**
|
||||
- :ref:`int<class_int>` **get_depth_attachment** **(** **)**
|
||||
|
||||
Depth attachment. ATTACHMENT_UNUSED should be used if no depth buffer is required for this pass.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_RDFramebufferPass_property_input_attachments:
|
||||
|
||||
- :ref:`PackedInt32Array<class_PackedInt32Array>` **input_attachments**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+------------------------------+
|
||||
| *Default* | ``PackedInt32Array()`` |
|
||||
+-----------+------------------------------+
|
||||
| *Setter* | set_input_attachments(value) |
|
||||
+-----------+------------------------------+
|
||||
| *Getter* | get_input_attachments() |
|
||||
+-----------+------------------------------+
|
||||
:ref:`PackedInt32Array<class_PackedInt32Array>` **input_attachments** = ``PackedInt32Array()``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_input_attachments** **(** :ref:`PackedInt32Array<class_PackedInt32Array>` value **)**
|
||||
- :ref:`PackedInt32Array<class_PackedInt32Array>` **get_input_attachments** **(** **)**
|
||||
|
||||
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.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_RDFramebufferPass_property_preserve_attachments:
|
||||
|
||||
- :ref:`PackedInt32Array<class_PackedInt32Array>` **preserve_attachments**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+---------------------------------+
|
||||
| *Default* | ``PackedInt32Array()`` |
|
||||
+-----------+---------------------------------+
|
||||
| *Setter* | set_preserve_attachments(value) |
|
||||
+-----------+---------------------------------+
|
||||
| *Getter* | get_preserve_attachments() |
|
||||
+-----------+---------------------------------+
|
||||
:ref:`PackedInt32Array<class_PackedInt32Array>` **preserve_attachments** = ``PackedInt32Array()``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_preserve_attachments** **(** :ref:`PackedInt32Array<class_PackedInt32Array>` value **)**
|
||||
- :ref:`PackedInt32Array<class_PackedInt32Array>` **get_preserve_attachments** **(** **)**
|
||||
|
||||
Attachments to preserve in this pass (otherwise they are erased).
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_RDFramebufferPass_property_resolve_attachments:
|
||||
|
||||
- :ref:`PackedInt32Array<class_PackedInt32Array>` **resolve_attachments**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+--------------------------------+
|
||||
| *Default* | ``PackedInt32Array()`` |
|
||||
+-----------+--------------------------------+
|
||||
| *Setter* | set_resolve_attachments(value) |
|
||||
+-----------+--------------------------------+
|
||||
| *Getter* | get_resolve_attachments() |
|
||||
+-----------+--------------------------------+
|
||||
:ref:`PackedInt32Array<class_PackedInt32Array>` **resolve_attachments** = ``PackedInt32Array()``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_resolve_attachments** **(** :ref:`PackedInt32Array<class_PackedInt32Array>` value **)**
|
||||
- :ref:`PackedInt32Array<class_PackedInt32Array>` **get_resolve_attachments** **(** **)**
|
||||
|
||||
If the color attachments are multisampled, non-multisampled resolve attachments can be provided.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user