Skip to main content

RDFramebufferPass

Inherits: RefCounted < Object

Framebuffer pass attachment description (used by RenderingDevice).

Description

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.

Multipass framebuffers can optimize some configurations in mobile. On desktop, they provide little to no advantage.

This object is used by RenderingDevice.

Properties

PackedInt32Arraycolor_attachmentsPackedInt32Array()
intdepth_attachment-1
PackedInt32Arrayinput_attachmentsPackedInt32Array()
PackedInt32Arraypreserve_attachmentsPackedInt32Array()
PackedInt32Arrayresolve_attachmentsPackedInt32Array()

Constants

ATTACHMENT_UNUSED = -1 🔗

Attachment is unused.


Property Descriptions

PackedInt32Array color_attachments = PackedInt32Array() 🔗

Color attachments in order starting from 0. If this attachment is not used by the shader, pass ATTACHMENT_UNUSED to skip.

Note: The returned array is copied and any changes to it will not update the original property value. See PackedInt32Array for more details.


int depth_attachment = -1 🔗

  • void set_depth_attachment\ (\ value: int\ )
  • int get_depth_attachment\ (\ )

Depth attachment. ATTACHMENT_UNUSED should be used if no depth buffer is required for this pass.


PackedInt32Array input_attachments = PackedInt32Array() 🔗

Used for multipass framebuffers (more than one render pass). Converts an attachment to an input. Make sure to also supply it properly in the RDUniform for the uniform set.

Note: The returned array is copied and any changes to it will not update the original property value. See PackedInt32Array for more details.


PackedInt32Array preserve_attachments = PackedInt32Array() 🔗

Attachments to preserve in this pass (otherwise they are erased).

Note: The returned array is copied and any changes to it will not update the original property value. See PackedInt32Array for more details.


PackedInt32Array resolve_attachments = PackedInt32Array() 🔗

If the color attachments are multisampled, non-multisampled resolve attachments can be provided.

Note: The returned array is copied and any changes to it will not update the original property value. See PackedInt32Array for more details.