godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/RDFramebufferPass.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

36 lines
2.2 KiB
XML
Raw Normal View History

Implement Framebuffer Subpass support * Required for better optimizing mobile platforms * Will be used by the Vulkan mobile renderer.
2021-06-24 13:58:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Bump version to 4.1-dev Can't stop, won't stop, they said, huh?
2023-03-01 00:44:37 +00:00
<class name="RDFramebufferPass" inherits="RefCounted" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Implement Framebuffer Subpass support * Required for better optimizing mobile platforms * Will be used by the Vulkan mobile renderer.
2021-06-24 13:58:36 +00:00
<brief_description>
Improve RenderingServer, RenderingDevice, ShaderGlobalsOverride documentation This brings the overall class reference completion percentage from 87% to 92%.
2023-03-28 15:32:29 +00:00
Framebuffer pass attachment description (used by [RenderingDevice]).
Implement Framebuffer Subpass support * Required for better optimizing mobile platforms * Will be used by the Vulkan mobile renderer.
2021-06-24 13:58:36 +00:00
</brief_description>
<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.
Improve RenderingServer, RenderingDevice, ShaderGlobalsOverride documentation This brings the overall class reference completion percentage from 87% to 92%.
2023-03-28 15:32:29 +00:00
Multipass framebuffers can optimize some configurations in mobile. On desktop, they provide little to no advantage.
This object is used by [RenderingDevice].
Implement Framebuffer Subpass support * Required for better optimizing mobile platforms * Will be used by the Vulkan mobile renderer.
2021-06-24 13:58:36 +00:00
</description>
<tutorials>
</tutorials>
<members>
<member name="color_attachments" type="PackedInt32Array" setter="set_color_attachments" getter="get_color_attachments" default="PackedInt32Array()">
Color attachments in order starting from 0. If this attachment is not used by the shader, pass ATTACHMENT_UNUSED to skip.
</member>
<member name="depth_attachment" type="int" setter="set_depth_attachment" getter="get_depth_attachment" default="-1">
Depth attachment. ATTACHMENT_UNUSED should be used if no depth buffer is required for this pass.
</member>
<member name="input_attachments" type="PackedInt32Array" setter="set_input_attachments" getter="get_input_attachments" default="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.
</member>
<member name="preserve_attachments" type="PackedInt32Array" setter="set_preserve_attachments" getter="get_preserve_attachments" default="PackedInt32Array()">
Attachments to preserve in this pass (otherwise they are erased).
</member>
<member name="resolve_attachments" type="PackedInt32Array" setter="set_resolve_attachments" getter="get_resolve_attachments" default="PackedInt32Array()">
If the color attachments are multisampled, non-multisampled resolve attachments can be provided.
</member>
</members>
<constants>
<constant name="ATTACHMENT_UNUSED" value="-1">
Improve RenderingServer, RenderingDevice, ShaderGlobalsOverride documentation This brings the overall class reference completion percentage from 87% to 92%.
2023-03-28 15:32:29 +00:00
Attachment is unused.
Implement Framebuffer Subpass support * Required for better optimizing mobile platforms * Will be used by the Vulkan mobile renderer.
2021-06-24 13:58:36 +00:00
</constant>
</constants>
</class>