summaryrefslogtreecommitdiff
path: root/doc/classes/RenderingDevice.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/RenderingDevice.xml')
-rw-r--r--doc/classes/RenderingDevice.xml476
1 files changed, 252 insertions, 224 deletions
diff --git a/doc/classes/RenderingDevice.xml b/doc/classes/RenderingDevice.xml
index 6248394b1a..f318430611 100644
--- a/doc/classes/RenderingDevice.xml
+++ b/doc/classes/RenderingDevice.xml
@@ -9,102 +9,102 @@
<methods>
<method name="barrier">
<return type="void" />
- <argument index="0" name="from" type="int" default="7" />
- <argument index="1" name="to" type="int" default="7" />
+ <param index="0" name="from" type="int" enum="RenderingDevice.BarrierMask" default="7" />
+ <param index="1" name="to" type="int" enum="RenderingDevice.BarrierMask" default="7" />
<description>
</description>
</method>
<method name="buffer_clear">
<return type="int" enum="Error" />
- <argument index="0" name="buffer" type="RID" />
- <argument index="1" name="offset" type="int" />
- <argument index="2" name="size_bytes" type="int" />
- <argument index="3" name="post_barrier" type="int" default="7" />
+ <param index="0" name="buffer" type="RID" />
+ <param index="1" name="offset" type="int" />
+ <param index="2" name="size_bytes" type="int" />
+ <param index="3" name="post_barrier" type="int" enum="RenderingDevice.BarrierMask" default="7" />
<description>
</description>
</method>
<method name="buffer_get_data">
<return type="PackedByteArray" />
- <argument index="0" name="buffer" type="RID" />
+ <param index="0" name="buffer" type="RID" />
<description>
</description>
</method>
<method name="buffer_update">
<return type="int" enum="Error" />
- <argument index="0" name="buffer" type="RID" />
- <argument index="1" name="offset" type="int" />
- <argument index="2" name="size_bytes" type="int" />
- <argument index="3" name="data" type="PackedByteArray" />
- <argument index="4" name="post_barrier" type="int" default="7" />
+ <param index="0" name="buffer" type="RID" />
+ <param index="1" name="offset" type="int" />
+ <param index="2" name="size_bytes" type="int" />
+ <param index="3" name="data" type="PackedByteArray" />
+ <param index="4" name="post_barrier" type="int" enum="RenderingDevice.BarrierMask" default="7" />
<description>
</description>
</method>
<method name="capture_timestamp">
<return type="void" />
- <argument index="0" name="name" type="String" />
+ <param index="0" name="name" type="String" />
<description>
</description>
</method>
<method name="compute_list_add_barrier">
<return type="void" />
- <argument index="0" name="compute_list" type="int" />
+ <param index="0" name="compute_list" type="int" />
<description>
</description>
</method>
<method name="compute_list_begin">
<return type="int" />
- <argument index="0" name="allow_draw_overlap" type="bool" default="false" />
+ <param index="0" name="allow_draw_overlap" type="bool" default="false" />
<description>
</description>
</method>
<method name="compute_list_bind_compute_pipeline">
<return type="void" />
- <argument index="0" name="compute_list" type="int" />
- <argument index="1" name="compute_pipeline" type="RID" />
+ <param index="0" name="compute_list" type="int" />
+ <param index="1" name="compute_pipeline" type="RID" />
<description>
</description>
</method>
<method name="compute_list_bind_uniform_set">
<return type="void" />
- <argument index="0" name="compute_list" type="int" />
- <argument index="1" name="uniform_set" type="RID" />
- <argument index="2" name="set_index" type="int" />
+ <param index="0" name="compute_list" type="int" />
+ <param index="1" name="uniform_set" type="RID" />
+ <param index="2" name="set_index" type="int" />
<description>
</description>
</method>
<method name="compute_list_dispatch">
<return type="void" />
- <argument index="0" name="compute_list" type="int" />
- <argument index="1" name="x_groups" type="int" />
- <argument index="2" name="y_groups" type="int" />
- <argument index="3" name="z_groups" type="int" />
+ <param index="0" name="compute_list" type="int" />
+ <param index="1" name="x_groups" type="int" />
+ <param index="2" name="y_groups" type="int" />
+ <param index="3" name="z_groups" type="int" />
<description>
</description>
</method>
<method name="compute_list_end">
<return type="void" />
- <argument index="0" name="post_barrier" type="int" default="7" />
+ <param index="0" name="post_barrier" type="int" enum="RenderingDevice.BarrierMask" default="7" />
<description>
</description>
</method>
<method name="compute_list_set_push_constant">
<return type="void" />
- <argument index="0" name="compute_list" type="int" />
- <argument index="1" name="buffer" type="PackedByteArray" />
- <argument index="2" name="size_bytes" type="int" />
+ <param index="0" name="compute_list" type="int" />
+ <param index="1" name="buffer" type="PackedByteArray" />
+ <param index="2" name="size_bytes" type="int" />
<description>
</description>
</method>
<method name="compute_pipeline_create">
<return type="RID" />
- <argument index="0" name="shader" type="RID" />
- <argument index="1" name="specialization_constants" type="RDPipelineSpecializationConstant[]" default="[]" />
+ <param index="0" name="shader" type="RID" />
+ <param index="1" name="specialization_constants" type="RDPipelineSpecializationConstant[]" default="[]" />
<description>
</description>
</method>
<method name="compute_pipeline_is_valid">
<return type="bool" />
- <argument index="0" name="compute_pieline" type="RID" />
+ <param index="0" name="compute_pieline" type="RID" />
<description>
</description>
</method>
@@ -115,8 +115,8 @@
</method>
<method name="draw_command_begin_label">
<return type="void" />
- <argument index="0" name="name" type="String" />
- <argument index="1" name="color" type="Color" />
+ <param index="0" name="name" type="String" />
+ <param index="1" name="color" type="Color" />
<description>
</description>
</method>
@@ -127,111 +127,119 @@
</method>
<method name="draw_command_insert_label">
<return type="void" />
- <argument index="0" name="name" type="String" />
- <argument index="1" name="color" type="Color" />
+ <param index="0" name="name" type="String" />
+ <param index="1" name="color" type="Color" />
<description>
</description>
</method>
<method name="draw_list_begin">
<return type="int" />
- <argument index="0" name="framebuffer" type="RID" />
- <argument index="1" name="initial_color_action" type="int" enum="RenderingDevice.InitialAction" />
- <argument index="2" name="final_color_action" type="int" enum="RenderingDevice.FinalAction" />
- <argument index="3" name="initial_depth_action" type="int" enum="RenderingDevice.InitialAction" />
- <argument index="4" name="final_depth_action" type="int" enum="RenderingDevice.FinalAction" />
- <argument index="5" name="clear_color_values" type="PackedColorArray" default="PackedColorArray()" />
- <argument index="6" name="clear_depth" type="float" default="1.0" />
- <argument index="7" name="clear_stencil" type="int" default="0" />
- <argument index="8" name="region" type="Rect2" default="Rect2(0, 0, 0, 0)" />
- <argument index="9" name="storage_textures" type="Array" default="[]" />
+ <param index="0" name="framebuffer" type="RID" />
+ <param index="1" name="initial_color_action" type="int" enum="RenderingDevice.InitialAction" />
+ <param index="2" name="final_color_action" type="int" enum="RenderingDevice.FinalAction" />
+ <param index="3" name="initial_depth_action" type="int" enum="RenderingDevice.InitialAction" />
+ <param index="4" name="final_depth_action" type="int" enum="RenderingDevice.FinalAction" />
+ <param index="5" name="clear_color_values" type="PackedColorArray" default="PackedColorArray()" />
+ <param index="6" name="clear_depth" type="float" default="1.0" />
+ <param index="7" name="clear_stencil" type="int" default="0" />
+ <param index="8" name="region" type="Rect2" default="Rect2(0, 0, 0, 0)" />
+ <param index="9" name="storage_textures" type="Array" default="[]" />
<description>
</description>
</method>
<method name="draw_list_begin_for_screen">
<return type="int" />
- <argument index="0" name="screen" type="int" default="0" />
- <argument index="1" name="clear_color" type="Color" default="Color(0, 0, 0, 1)" />
+ <param index="0" name="screen" type="int" default="0" />
+ <param index="1" name="clear_color" type="Color" default="Color(0, 0, 0, 1)" />
<description>
</description>
</method>
<method name="draw_list_begin_split">
<return type="PackedInt64Array" />
- <argument index="0" name="framebuffer" type="RID" />
- <argument index="1" name="splits" type="int" />
- <argument index="2" name="initial_color_action" type="int" enum="RenderingDevice.InitialAction" />
- <argument index="3" name="final_color_action" type="int" enum="RenderingDevice.FinalAction" />
- <argument index="4" name="initial_depth_action" type="int" enum="RenderingDevice.InitialAction" />
- <argument index="5" name="final_depth_action" type="int" enum="RenderingDevice.FinalAction" />
- <argument index="6" name="clear_color_values" type="PackedColorArray" default="PackedColorArray()" />
- <argument index="7" name="clear_depth" type="float" default="1.0" />
- <argument index="8" name="clear_stencil" type="int" default="0" />
- <argument index="9" name="region" type="Rect2" default="Rect2(0, 0, 0, 0)" />
- <argument index="10" name="storage_textures" type="RID[]" default="[]" />
+ <param index="0" name="framebuffer" type="RID" />
+ <param index="1" name="splits" type="int" />
+ <param index="2" name="initial_color_action" type="int" enum="RenderingDevice.InitialAction" />
+ <param index="3" name="final_color_action" type="int" enum="RenderingDevice.FinalAction" />
+ <param index="4" name="initial_depth_action" type="int" enum="RenderingDevice.InitialAction" />
+ <param index="5" name="final_depth_action" type="int" enum="RenderingDevice.FinalAction" />
+ <param index="6" name="clear_color_values" type="PackedColorArray" default="PackedColorArray()" />
+ <param index="7" name="clear_depth" type="float" default="1.0" />
+ <param index="8" name="clear_stencil" type="int" default="0" />
+ <param index="9" name="region" type="Rect2" default="Rect2(0, 0, 0, 0)" />
+ <param index="10" name="storage_textures" type="RID[]" default="[]" />
<description>
</description>
</method>
<method name="draw_list_bind_index_array">
<return type="void" />
- <argument index="0" name="draw_list" type="int" />
- <argument index="1" name="index_array" type="RID" />
+ <param index="0" name="draw_list" type="int" />
+ <param index="1" name="index_array" type="RID" />
<description>
</description>
</method>
<method name="draw_list_bind_render_pipeline">
<return type="void" />
- <argument index="0" name="draw_list" type="int" />
- <argument index="1" name="render_pipeline" type="RID" />
+ <param index="0" name="draw_list" type="int" />
+ <param index="1" name="render_pipeline" type="RID" />
<description>
</description>
</method>
<method name="draw_list_bind_uniform_set">
<return type="void" />
- <argument index="0" name="draw_list" type="int" />
- <argument index="1" name="uniform_set" type="RID" />
- <argument index="2" name="set_index" type="int" />
+ <param index="0" name="draw_list" type="int" />
+ <param index="1" name="uniform_set" type="RID" />
+ <param index="2" name="set_index" type="int" />
<description>
</description>
</method>
<method name="draw_list_bind_vertex_array">
<return type="void" />
- <argument index="0" name="draw_list" type="int" />
- <argument index="1" name="vertex_array" type="RID" />
+ <param index="0" name="draw_list" type="int" />
+ <param index="1" name="vertex_array" type="RID" />
<description>
</description>
</method>
<method name="draw_list_disable_scissor">
<return type="void" />
- <argument index="0" name="draw_list" type="int" />
+ <param index="0" name="draw_list" type="int" />
<description>
</description>
</method>
<method name="draw_list_draw">
<return type="void" />
- <argument index="0" name="draw_list" type="int" />
- <argument index="1" name="use_indices" type="bool" />
- <argument index="2" name="instances" type="int" />
- <argument index="3" name="procedural_vertex_count" type="int" default="0" />
+ <param index="0" name="draw_list" type="int" />
+ <param index="1" name="use_indices" type="bool" />
+ <param index="2" name="instances" type="int" />
+ <param index="3" name="procedural_vertex_count" type="int" default="0" />
<description>
</description>
</method>
<method name="draw_list_enable_scissor">
<return type="void" />
- <argument index="0" name="draw_list" type="int" />
- <argument index="1" name="rect" type="Rect2" default="Rect2(0, 0, 0, 0)" />
+ <param index="0" name="draw_list" type="int" />
+ <param index="1" name="rect" type="Rect2" default="Rect2(0, 0, 0, 0)" />
<description>
</description>
</method>
<method name="draw_list_end">
<return type="void" />
- <argument index="0" name="post_barrier" type="int" default="7" />
+ <param index="0" name="post_barrier" type="int" enum="RenderingDevice.BarrierMask" default="7" />
<description>
</description>
</method>
+ <method name="draw_list_set_blend_constants">
+ <return type="void" />
+ <param index="0" name="draw_list" type="int" />
+ <param index="1" name="color" type="Color" />
+ <description>
+ Sets blend constants for draw list, blend constants are used only if the graphics pipeline is created with [constant DYNAMIC_STATE_BLEND_CONSTANTS] flag set.
+ </description>
+ </method>
<method name="draw_list_set_push_constant">
<return type="void" />
- <argument index="0" name="draw_list" type="int" />
- <argument index="1" name="buffer" type="PackedByteArray" />
- <argument index="2" name="size_bytes" type="int" />
+ <param index="0" name="draw_list" type="int" />
+ <param index="1" name="buffer" type="PackedByteArray" />
+ <param index="2" name="size_bytes" type="int" />
<description>
</description>
</method>
@@ -242,72 +250,78 @@
</method>
<method name="draw_list_switch_to_next_pass_split">
<return type="PackedInt64Array" />
- <argument index="0" name="splits" type="int" />
+ <param index="0" name="splits" type="int" />
<description>
</description>
</method>
<method name="framebuffer_create">
<return type="RID" />
- <argument index="0" name="textures" type="RID[]" />
- <argument index="1" name="validate_with_format" type="int" default="-1" />
- <argument index="2" name="view_count" type="int" default="1" />
+ <param index="0" name="textures" type="RID[]" />
+ <param index="1" name="validate_with_format" type="int" default="-1" />
+ <param index="2" name="view_count" type="int" default="1" />
<description>
</description>
</method>
<method name="framebuffer_create_empty">
<return type="RID" />
- <argument index="0" name="size" type="Vector2i" />
- <argument index="1" name="samples" type="int" enum="RenderingDevice.TextureSamples" default="0" />
- <argument index="2" name="validate_with_format" type="int" default="-1" />
+ <param index="0" name="size" type="Vector2i" />
+ <param index="1" name="samples" type="int" enum="RenderingDevice.TextureSamples" default="0" />
+ <param index="2" name="validate_with_format" type="int" default="-1" />
<description>
</description>
</method>
<method name="framebuffer_create_multipass">
<return type="RID" />
- <argument index="0" name="textures" type="RID[]" />
- <argument index="1" name="passes" type="RDFramebufferPass[]" />
- <argument index="2" name="validate_with_format" type="int" default="-1" />
- <argument index="3" name="view_count" type="int" default="1" />
+ <param index="0" name="textures" type="RID[]" />
+ <param index="1" name="passes" type="RDFramebufferPass[]" />
+ <param index="2" name="validate_with_format" type="int" default="-1" />
+ <param index="3" name="view_count" type="int" default="1" />
<description>
</description>
</method>
<method name="framebuffer_format_create">
<return type="int" />
- <argument index="0" name="attachments" type="RDAttachmentFormat[]" />
- <argument index="1" name="view_count" type="int" default="1" />
+ <param index="0" name="attachments" type="RDAttachmentFormat[]" />
+ <param index="1" name="view_count" type="int" default="1" />
<description>
</description>
</method>
<method name="framebuffer_format_create_empty">
<return type="int" />
- <argument index="0" name="samples" type="int" enum="RenderingDevice.TextureSamples" default="0" />
+ <param index="0" name="samples" type="int" enum="RenderingDevice.TextureSamples" default="0" />
<description>
</description>
</method>
<method name="framebuffer_format_create_multipass">
<return type="int" />
- <argument index="0" name="attachments" type="RDAttachmentFormat[]" />
- <argument index="1" name="passes" type="RDFramebufferPass[]" />
- <argument index="2" name="view_count" type="int" default="1" />
+ <param index="0" name="attachments" type="RDAttachmentFormat[]" />
+ <param index="1" name="passes" type="RDFramebufferPass[]" />
+ <param index="2" name="view_count" type="int" default="1" />
<description>
</description>
</method>
<method name="framebuffer_format_get_texture_samples">
<return type="int" enum="RenderingDevice.TextureSamples" />
- <argument index="0" name="format" type="int" />
- <argument index="1" name="render_pass" type="int" default="0" />
+ <param index="0" name="format" type="int" />
+ <param index="1" name="render_pass" type="int" default="0" />
<description>
</description>
</method>
<method name="framebuffer_get_format">
<return type="int" />
- <argument index="0" name="framebuffer" type="RID" />
+ <param index="0" name="framebuffer" type="RID" />
+ <description>
+ </description>
+ </method>
+ <method name="framebuffer_is_valid" qualifiers="const">
+ <return type="bool" />
+ <param index="0" name="framebuffer" type="RID" />
<description>
</description>
</method>
<method name="free_rid">
<return type="void" />
- <argument index="0" name="rid" type="RID" />
+ <param index="0" name="rid" type="RID" />
<description>
</description>
</method>
@@ -318,19 +332,19 @@
</method>
<method name="get_captured_timestamp_cpu_time" qualifiers="const">
<return type="int" />
- <argument index="0" name="index" type="int" />
+ <param index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="get_captured_timestamp_gpu_time" qualifiers="const">
<return type="int" />
- <argument index="0" name="index" type="int" />
+ <param index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="get_captured_timestamp_name" qualifiers="const">
<return type="String" />
- <argument index="0" name="index" type="int" />
+ <param index="0" name="index" type="int" />
<description>
</description>
</method>
@@ -361,9 +375,9 @@
</method>
<method name="get_driver_resource">
<return type="int" />
- <argument index="0" name="resource" type="int" enum="RenderingDevice.DriverResource" />
- <argument index="1" name="rid" type="RID" />
- <argument index="2" name="index" type="int" />
+ <param index="0" name="resource" type="int" enum="RenderingDevice.DriverResource" />
+ <param index="1" name="rid" type="RID" />
+ <param index="2" name="index" type="int" />
<description>
</description>
</method>
@@ -374,58 +388,58 @@
</method>
<method name="get_memory_usage" qualifiers="const">
<return type="int" />
- <argument index="0" name="type" type="int" enum="RenderingDevice.MemoryType" />
+ <param index="0" name="type" type="int" enum="RenderingDevice.MemoryType" />
<description>
</description>
</method>
<method name="index_array_create">
<return type="RID" />
- <argument index="0" name="index_buffer" type="RID" />
- <argument index="1" name="index_offset" type="int" />
- <argument index="2" name="index_count" type="int" />
+ <param index="0" name="index_buffer" type="RID" />
+ <param index="1" name="index_offset" type="int" />
+ <param index="2" name="index_count" type="int" />
<description>
</description>
</method>
<method name="index_buffer_create">
<return type="RID" />
- <argument index="0" name="size_indices" type="int" />
- <argument index="1" name="format" type="int" enum="RenderingDevice.IndexBufferFormat" />
- <argument index="2" name="data" type="PackedByteArray" default="PackedByteArray()" />
- <argument index="3" name="use_restart_indices" type="bool" default="false" />
+ <param index="0" name="size_indices" type="int" />
+ <param index="1" name="format" type="int" enum="RenderingDevice.IndexBufferFormat" />
+ <param index="2" name="data" type="PackedByteArray" default="PackedByteArray()" />
+ <param index="3" name="use_restart_indices" type="bool" default="false" />
<description>
</description>
</method>
<method name="limit_get" qualifiers="const">
<return type="int" />
- <argument index="0" name="limit" type="int" enum="RenderingDevice.Limit" />
+ <param index="0" name="limit" type="int" enum="RenderingDevice.Limit" />
<description>
</description>
</method>
<method name="render_pipeline_create">
<return type="RID" />
- <argument index="0" name="shader" type="RID" />
- <argument index="1" name="framebuffer_format" type="int" />
- <argument index="2" name="vertex_format" type="int" />
- <argument index="3" name="primitive" type="int" enum="RenderingDevice.RenderPrimitive" />
- <argument index="4" name="rasterization_state" type="RDPipelineRasterizationState" />
- <argument index="5" name="multisample_state" type="RDPipelineMultisampleState" />
- <argument index="6" name="stencil_state" type="RDPipelineDepthStencilState" />
- <argument index="7" name="color_blend_state" type="RDPipelineColorBlendState" />
- <argument index="8" name="dynamic_state_flags" type="int" default="0" />
- <argument index="9" name="for_render_pass" type="int" default="0" />
- <argument index="10" name="specialization_constants" type="RDPipelineSpecializationConstant[]" default="[]" />
+ <param index="0" name="shader" type="RID" />
+ <param index="1" name="framebuffer_format" type="int" />
+ <param index="2" name="vertex_format" type="int" />
+ <param index="3" name="primitive" type="int" enum="RenderingDevice.RenderPrimitive" />
+ <param index="4" name="rasterization_state" type="RDPipelineRasterizationState" />
+ <param index="5" name="multisample_state" type="RDPipelineMultisampleState" />
+ <param index="6" name="stencil_state" type="RDPipelineDepthStencilState" />
+ <param index="7" name="color_blend_state" type="RDPipelineColorBlendState" />
+ <param index="8" name="dynamic_state_flags" type="int" enum="RenderingDevice.PipelineDynamicStateFlags" default="0" />
+ <param index="9" name="for_render_pass" type="int" default="0" />
+ <param index="10" name="specialization_constants" type="RDPipelineSpecializationConstant[]" default="[]" />
<description>
</description>
</method>
<method name="render_pipeline_is_valid">
<return type="bool" />
- <argument index="0" name="render_pipeline" type="RID" />
+ <param index="0" name="render_pipeline" type="RID" />
<description>
</description>
</method>
<method name="sampler_create">
<return type="RID" />
- <argument index="0" name="state" type="RDSamplerState" />
+ <param index="0" name="state" type="RDSamplerState" />
<description>
</description>
</method>
@@ -436,61 +450,61 @@
</method>
<method name="screen_get_height" qualifiers="const">
<return type="int" />
- <argument index="0" name="screen" type="int" default="0" />
+ <param index="0" name="screen" type="int" default="0" />
<description>
</description>
</method>
<method name="screen_get_width" qualifiers="const">
<return type="int" />
- <argument index="0" name="screen" type="int" default="0" />
+ <param index="0" name="screen" type="int" default="0" />
<description>
</description>
</method>
<method name="set_resource_name">
<return type="void" />
- <argument index="0" name="id" type="RID" />
- <argument index="1" name="name" type="String" />
+ <param index="0" name="id" type="RID" />
+ <param index="1" name="name" type="String" />
<description>
</description>
</method>
<method name="shader_compile_binary_from_spirv">
<return type="PackedByteArray" />
- <argument index="0" name="spirv_data" type="RDShaderSPIRV" />
- <argument index="1" name="name" type="String" default="&quot;&quot;" />
+ <param index="0" name="spirv_data" type="RDShaderSPIRV" />
+ <param index="1" name="name" type="String" default="&quot;&quot;" />
<description>
</description>
</method>
<method name="shader_compile_spirv_from_source">
<return type="RDShaderSPIRV" />
- <argument index="0" name="shader_source" type="RDShaderSource" />
- <argument index="1" name="allow_cache" type="bool" default="true" />
+ <param index="0" name="shader_source" type="RDShaderSource" />
+ <param index="1" name="allow_cache" type="bool" default="true" />
<description>
</description>
</method>
<method name="shader_create_from_bytecode">
<return type="RID" />
- <argument index="0" name="binary_data" type="PackedByteArray" />
+ <param index="0" name="binary_data" type="PackedByteArray" />
<description>
</description>
</method>
<method name="shader_create_from_spirv">
<return type="RID" />
- <argument index="0" name="spirv_data" type="RDShaderSPIRV" />
- <argument index="1" name="name" type="String" default="&quot;&quot;" />
+ <param index="0" name="spirv_data" type="RDShaderSPIRV" />
+ <param index="1" name="name" type="String" default="&quot;&quot;" />
<description>
</description>
</method>
<method name="shader_get_vertex_input_attribute_mask">
<return type="int" />
- <argument index="0" name="shader" type="RID" />
+ <param index="0" name="shader" type="RID" />
<description>
</description>
</method>
<method name="storage_buffer_create">
<return type="RID" />
- <argument index="0" name="size_bytes" type="int" />
- <argument index="1" name="data" type="PackedByteArray" default="PackedByteArray()" />
- <argument index="2" name="usage" type="int" default="0" />
+ <param index="0" name="size_bytes" type="int" />
+ <param index="1" name="data" type="PackedByteArray" default="PackedByteArray()" />
+ <param index="2" name="usage" type="int" enum="RenderingDevice.StorageBufferUsage" default="0" />
<description>
</description>
</method>
@@ -506,155 +520,155 @@
</method>
<method name="texture_buffer_create">
<return type="RID" />
- <argument index="0" name="size_bytes" type="int" />
- <argument index="1" name="format" type="int" enum="RenderingDevice.DataFormat" />
- <argument index="2" name="data" type="PackedByteArray" default="PackedByteArray()" />
+ <param index="0" name="size_bytes" type="int" />
+ <param index="1" name="format" type="int" enum="RenderingDevice.DataFormat" />
+ <param index="2" name="data" type="PackedByteArray" default="PackedByteArray()" />
<description>
</description>
</method>
<method name="texture_clear">
<return type="int" enum="Error" />
- <argument index="0" name="texture" type="RID" />
- <argument index="1" name="color" type="Color" />
- <argument index="2" name="base_mipmap" type="int" />
- <argument index="3" name="mipmap_count" type="int" />
- <argument index="4" name="base_layer" type="int" />
- <argument index="5" name="layer_count" type="int" />
- <argument index="6" name="post_barrier" type="int" default="7" />
+ <param index="0" name="texture" type="RID" />
+ <param index="1" name="color" type="Color" />
+ <param index="2" name="base_mipmap" type="int" />
+ <param index="3" name="mipmap_count" type="int" />
+ <param index="4" name="base_layer" type="int" />
+ <param index="5" name="layer_count" type="int" />
+ <param index="6" name="post_barrier" type="int" enum="RenderingDevice.BarrierMask" default="7" />
<description>
</description>
</method>
<method name="texture_copy">
<return type="int" enum="Error" />
- <argument index="0" name="from_texture" type="RID" />
- <argument index="1" name="to_texture" type="RID" />
- <argument index="2" name="from_pos" type="Vector3" />
- <argument index="3" name="to_pos" type="Vector3" />
- <argument index="4" name="size" type="Vector3" />
- <argument index="5" name="src_mipmap" type="int" />
- <argument index="6" name="dst_mipmap" type="int" />
- <argument index="7" name="src_layer" type="int" />
- <argument index="8" name="dst_layer" type="int" />
- <argument index="9" name="post_barrier" type="int" default="7" />
+ <param index="0" name="from_texture" type="RID" />
+ <param index="1" name="to_texture" type="RID" />
+ <param index="2" name="from_pos" type="Vector3" />
+ <param index="3" name="to_pos" type="Vector3" />
+ <param index="4" name="size" type="Vector3" />
+ <param index="5" name="src_mipmap" type="int" />
+ <param index="6" name="dst_mipmap" type="int" />
+ <param index="7" name="src_layer" type="int" />
+ <param index="8" name="dst_layer" type="int" />
+ <param index="9" name="post_barrier" type="int" enum="RenderingDevice.BarrierMask" default="7" />
<description>
</description>
</method>
<method name="texture_create">
<return type="RID" />
- <argument index="0" name="format" type="RDTextureFormat" />
- <argument index="1" name="view" type="RDTextureView" />
- <argument index="2" name="data" type="PackedByteArray[]" default="[]" />
+ <param index="0" name="format" type="RDTextureFormat" />
+ <param index="1" name="view" type="RDTextureView" />
+ <param index="2" name="data" type="PackedByteArray[]" default="[]" />
<description>
</description>
</method>
<method name="texture_create_shared">
<return type="RID" />
- <argument index="0" name="view" type="RDTextureView" />
- <argument index="1" name="with_texture" type="RID" />
+ <param index="0" name="view" type="RDTextureView" />
+ <param index="1" name="with_texture" type="RID" />
<description>
</description>
</method>
<method name="texture_create_shared_from_slice">
<return type="RID" />
- <argument index="0" name="view" type="RDTextureView" />
- <argument index="1" name="with_texture" type="RID" />
- <argument index="2" name="layer" type="int" />
- <argument index="3" name="mipmap" type="int" />
- <argument index="4" name="mipmaps" type="int" default="1" />
- <argument index="5" name="slice_type" type="int" enum="RenderingDevice.TextureSliceType" default="0" />
+ <param index="0" name="view" type="RDTextureView" />
+ <param index="1" name="with_texture" type="RID" />
+ <param index="2" name="layer" type="int" />
+ <param index="3" name="mipmap" type="int" />
+ <param index="4" name="mipmaps" type="int" default="1" />
+ <param index="5" name="slice_type" type="int" enum="RenderingDevice.TextureSliceType" default="0" />
<description>
</description>
</method>
<method name="texture_get_data">
<return type="PackedByteArray" />
- <argument index="0" name="texture" type="RID" />
- <argument index="1" name="layer" type="int" />
+ <param index="0" name="texture" type="RID" />
+ <param index="1" name="layer" type="int" />
<description>
</description>
</method>
<method name="texture_is_format_supported_for_usage" qualifiers="const">
<return type="bool" />
- <argument index="0" name="format" type="int" enum="RenderingDevice.DataFormat" />
- <argument index="1" name="usage_flags" type="int" />
+ <param index="0" name="format" type="int" enum="RenderingDevice.DataFormat" />
+ <param index="1" name="usage_flags" type="int" enum="RenderingDevice.TextureUsageBits" />
<description>
</description>
</method>
<method name="texture_is_shared">
<return type="bool" />
- <argument index="0" name="texture" type="RID" />
+ <param index="0" name="texture" type="RID" />
<description>
</description>
</method>
<method name="texture_is_valid">
<return type="bool" />
- <argument index="0" name="texture" type="RID" />
+ <param index="0" name="texture" type="RID" />
<description>
</description>
</method>
<method name="texture_resolve_multisample">
<return type="int" enum="Error" />
- <argument index="0" name="from_texture" type="RID" />
- <argument index="1" name="to_texture" type="RID" />
- <argument index="2" name="post_barrier" type="int" default="7" />
+ <param index="0" name="from_texture" type="RID" />
+ <param index="1" name="to_texture" type="RID" />
+ <param index="2" name="post_barrier" type="int" enum="RenderingDevice.BarrierMask" default="7" />
<description>
</description>
</method>
<method name="texture_update">
<return type="int" enum="Error" />
- <argument index="0" name="texture" type="RID" />
- <argument index="1" name="layer" type="int" />
- <argument index="2" name="data" type="PackedByteArray" />
- <argument index="3" name="post_barrier" type="int" default="7" />
+ <param index="0" name="texture" type="RID" />
+ <param index="1" name="layer" type="int" />
+ <param index="2" name="data" type="PackedByteArray" />
+ <param index="3" name="post_barrier" type="int" enum="RenderingDevice.BarrierMask" default="7" />
<description>
</description>
</method>
<method name="uniform_buffer_create">
<return type="RID" />
- <argument index="0" name="size_bytes" type="int" />
- <argument index="1" name="data" type="PackedByteArray" default="PackedByteArray()" />
+ <param index="0" name="size_bytes" type="int" />
+ <param index="1" name="data" type="PackedByteArray" default="PackedByteArray()" />
<description>
</description>
</method>
<method name="uniform_set_create">
<return type="RID" />
- <argument index="0" name="uniforms" type="Array" />
- <argument index="1" name="shader" type="RID" />
- <argument index="2" name="shader_set" type="int" />
+ <param index="0" name="uniforms" type="RDUniform[]" />
+ <param index="1" name="shader" type="RID" />
+ <param index="2" name="shader_set" type="int" />
<description>
</description>
</method>
<method name="uniform_set_is_valid">
<return type="bool" />
- <argument index="0" name="uniform_set" type="RID" />
+ <param index="0" name="uniform_set" type="RID" />
+ <description>
+ </description>
+ </method>
+ <method name="vertex_array_create">
+ <return type="RID" />
+ <param index="0" name="vertex_count" type="int" />
+ <param index="1" name="vertex_format" type="int" />
+ <param index="2" name="src_buffers" type="RID[]" />
+ <param index="3" name="offsets" type="PackedInt64Array" default="PackedInt64Array()" />
<description>
+ Creates a vertex array based on the specified buffers. Optionally, [param offsets] (in bytes) may be defined for each buffer.
</description>
</method>
<method name="vertex_buffer_create">
<return type="RID" />
- <argument index="0" name="size_bytes" type="int" />
- <argument index="1" name="data" type="PackedByteArray" default="PackedByteArray()" />
- <argument index="2" name="use_as_storage" type="bool" default="false" />
+ <param index="0" name="size_bytes" type="int" />
+ <param index="1" name="data" type="PackedByteArray" default="PackedByteArray()" />
+ <param index="2" name="use_as_storage" type="bool" default="false" />
<description>
</description>
</method>
<method name="vertex_format_create">
<return type="int" />
- <argument index="0" name="vertex_descriptions" type="RDVertexAttribute[]" />
+ <param index="0" name="vertex_descriptions" type="RDVertexAttribute[]" />
<description>
</description>
</method>
</methods>
<constants>
- <constant name="BARRIER_MASK_RASTER" value="1">
- </constant>
- <constant name="BARRIER_MASK_COMPUTE" value="2">
- </constant>
- <constant name="BARRIER_MASK_TRANSFER" value="4">
- </constant>
- <constant name="BARRIER_MASK_ALL" value="7">
- </constant>
- <constant name="BARRIER_MASK_NO_BARRIER" value="8">
- </constant>
<constant name="DEVICE_TYPE_OTHER" value="0" enum="DeviceType">
Rendering device type does not match any of the other enum values or is unknown.
</constant>
@@ -1137,6 +1151,16 @@
</constant>
<constant name="DATA_FORMAT_MAX" value="218" enum="DataFormat">
</constant>
+ <constant name="BARRIER_MASK_RASTER" value="1" enum="BarrierMask" is_bitfield="true">
+ </constant>
+ <constant name="BARRIER_MASK_COMPUTE" value="2" enum="BarrierMask" is_bitfield="true">
+ </constant>
+ <constant name="BARRIER_MASK_TRANSFER" value="4" enum="BarrierMask" is_bitfield="true">
+ </constant>
+ <constant name="BARRIER_MASK_ALL_BARRIERS" value="7" enum="BarrierMask" is_bitfield="true">
+ </constant>
+ <constant name="BARRIER_MASK_NO_BARRIER" value="8" enum="BarrierMask" is_bitfield="true">
+ </constant>
<constant name="TEXTURE_TYPE_1D" value="0" enum="TextureType">
</constant>
<constant name="TEXTURE_TYPE_2D" value="1" enum="TextureType">
@@ -1169,25 +1193,25 @@
</constant>
<constant name="TEXTURE_SAMPLES_MAX" value="7" enum="TextureSamples">
</constant>
- <constant name="TEXTURE_USAGE_SAMPLING_BIT" value="1" enum="TextureUsageBits">
+ <constant name="TEXTURE_USAGE_SAMPLING_BIT" value="1" enum="TextureUsageBits" is_bitfield="true">
</constant>
- <constant name="TEXTURE_USAGE_COLOR_ATTACHMENT_BIT" value="2" enum="TextureUsageBits">
+ <constant name="TEXTURE_USAGE_COLOR_ATTACHMENT_BIT" value="2" enum="TextureUsageBits" is_bitfield="true">
</constant>
- <constant name="TEXTURE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT" value="4" enum="TextureUsageBits">
+ <constant name="TEXTURE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT" value="4" enum="TextureUsageBits" is_bitfield="true">
</constant>
- <constant name="TEXTURE_USAGE_STORAGE_BIT" value="8" enum="TextureUsageBits">
+ <constant name="TEXTURE_USAGE_STORAGE_BIT" value="8" enum="TextureUsageBits" is_bitfield="true">
</constant>
- <constant name="TEXTURE_USAGE_STORAGE_ATOMIC_BIT" value="16" enum="TextureUsageBits">
+ <constant name="TEXTURE_USAGE_STORAGE_ATOMIC_BIT" value="16" enum="TextureUsageBits" is_bitfield="true">
</constant>
- <constant name="TEXTURE_USAGE_CPU_READ_BIT" value="32" enum="TextureUsageBits">
+ <constant name="TEXTURE_USAGE_CPU_READ_BIT" value="32" enum="TextureUsageBits" is_bitfield="true">
</constant>
- <constant name="TEXTURE_USAGE_CAN_UPDATE_BIT" value="64" enum="TextureUsageBits">
+ <constant name="TEXTURE_USAGE_CAN_UPDATE_BIT" value="64" enum="TextureUsageBits" is_bitfield="true">
</constant>
- <constant name="TEXTURE_USAGE_CAN_COPY_FROM_BIT" value="128" enum="TextureUsageBits">
+ <constant name="TEXTURE_USAGE_CAN_COPY_FROM_BIT" value="128" enum="TextureUsageBits" is_bitfield="true">
</constant>
- <constant name="TEXTURE_USAGE_CAN_COPY_TO_BIT" value="256" enum="TextureUsageBits">
+ <constant name="TEXTURE_USAGE_CAN_COPY_TO_BIT" value="256" enum="TextureUsageBits" is_bitfield="true">
</constant>
- <constant name="TEXTURE_USAGE_INPUT_ATTACHMENT_BIT" value="512" enum="TextureUsageBits">
+ <constant name="TEXTURE_USAGE_INPUT_ATTACHMENT_BIT" value="512" enum="TextureUsageBits" is_bitfield="true">
</constant>
<constant name="TEXTURE_SWIZZLE_IDENTITY" value="0" enum="TextureSwizzle">
</constant>
@@ -1249,7 +1273,7 @@
</constant>
<constant name="INDEX_BUFFER_FORMAT_UINT32" value="1" enum="IndexBufferFormat">
</constant>
- <constant name="STORAGE_BUFFER_USAGE_DISPATCH_INDIRECT" value="1" enum="StorageBufferUsage">
+ <constant name="STORAGE_BUFFER_USAGE_DISPATCH_INDIRECT" value="1" enum="StorageBufferUsage" is_bitfield="true">
</constant>
<constant name="UNIFORM_TYPE_SAMPLER" value="0" enum="UniformType">
</constant>
@@ -1429,19 +1453,19 @@
</constant>
<constant name="BLEND_OP_MAX" value="5" enum="BlendOperation">
</constant>
- <constant name="DYNAMIC_STATE_LINE_WIDTH" value="1" enum="PipelineDynamicStateFlags">
+ <constant name="DYNAMIC_STATE_LINE_WIDTH" value="1" enum="PipelineDynamicStateFlags" is_bitfield="true">
</constant>
- <constant name="DYNAMIC_STATE_DEPTH_BIAS" value="2" enum="PipelineDynamicStateFlags">
+ <constant name="DYNAMIC_STATE_DEPTH_BIAS" value="2" enum="PipelineDynamicStateFlags" is_bitfield="true">
</constant>
- <constant name="DYNAMIC_STATE_BLEND_CONSTANTS" value="4" enum="PipelineDynamicStateFlags">
+ <constant name="DYNAMIC_STATE_BLEND_CONSTANTS" value="4" enum="PipelineDynamicStateFlags" is_bitfield="true">
</constant>
- <constant name="DYNAMIC_STATE_DEPTH_BOUNDS" value="8" enum="PipelineDynamicStateFlags">
+ <constant name="DYNAMIC_STATE_DEPTH_BOUNDS" value="8" enum="PipelineDynamicStateFlags" is_bitfield="true">
</constant>
- <constant name="DYNAMIC_STATE_STENCIL_COMPARE_MASK" value="16" enum="PipelineDynamicStateFlags">
+ <constant name="DYNAMIC_STATE_STENCIL_COMPARE_MASK" value="16" enum="PipelineDynamicStateFlags" is_bitfield="true">
</constant>
- <constant name="DYNAMIC_STATE_STENCIL_WRITE_MASK" value="32" enum="PipelineDynamicStateFlags">
+ <constant name="DYNAMIC_STATE_STENCIL_WRITE_MASK" value="32" enum="PipelineDynamicStateFlags" is_bitfield="true">
</constant>
- <constant name="DYNAMIC_STATE_STENCIL_REFERENCE" value="64" enum="PipelineDynamicStateFlags">
+ <constant name="DYNAMIC_STATE_STENCIL_REFERENCE" value="64" enum="PipelineDynamicStateFlags" is_bitfield="true">
</constant>
<constant name="INITIAL_ACTION_CLEAR" value="0" enum="InitialAction">
</constant>
@@ -1567,6 +1591,10 @@
</constant>
<constant name="LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Z" value="34" enum="Limit">
</constant>
+ <constant name="LIMIT_MAX_VIEWPORT_DIMENSIONS_X" value="35" enum="Limit">
+ </constant>
+ <constant name="LIMIT_MAX_VIEWPORT_DIMENSIONS_Y" value="36" enum="Limit">
+ </constant>
<constant name="MEMORY_TEXTURES" value="0" enum="MemoryType">
</constant>
<constant name="MEMORY_BUFFERS" value="1" enum="MemoryType">
generated by cgit v1.2.3 (git 2.25.1) at 2025-02-03 01:15:41 +0000