:github_url: hide .. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the RenderingDevice.xml source instead. .. The source is found in doc/classes or modules//doc_classes. .. _class_RenderingDevice: RenderingDevice =============== **Inherits:** :ref:`Object` Methods ------- +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`barrier` **(** :ref:`int` from=7, :ref:`int` to=7 **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`buffer_clear` **(** :ref:`RID` buffer, :ref:`int` offset, :ref:`int` size_bytes, :ref:`int` post_barrier=7 **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`buffer_get_data` **(** :ref:`RID` buffer **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`buffer_update` **(** :ref:`RID` buffer, :ref:`int` offset, :ref:`int` size_bytes, :ref:`PackedByteArray` data, :ref:`int` post_barrier=7 **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`capture_timestamp` **(** :ref:`String` name **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`compute_list_add_barrier` **(** :ref:`int` compute_list **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`compute_list_begin` **(** :ref:`bool` allow_draw_overlap=false **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`compute_list_bind_compute_pipeline` **(** :ref:`int` compute_list, :ref:`RID` compute_pipeline **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`compute_list_bind_uniform_set` **(** :ref:`int` compute_list, :ref:`RID` uniform_set, :ref:`int` set_index **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`compute_list_dispatch` **(** :ref:`int` compute_list, :ref:`int` x_groups, :ref:`int` y_groups, :ref:`int` z_groups **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`compute_list_end` **(** :ref:`int` post_barrier=7 **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`compute_list_set_push_constant` **(** :ref:`int` compute_list, :ref:`PackedByteArray` buffer, :ref:`int` size_bytes **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`compute_pipeline_create` **(** :ref:`RID` shader, :ref:`RDPipelineSpecializationConstant[]` specialization_constants=[] **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`compute_pipeline_is_valid` **(** :ref:`RID` compute_pieline **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RenderingDevice` | :ref:`create_local_device` **(** **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_command_begin_label` **(** :ref:`String` name, :ref:`Color` color **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_command_end_label` **(** **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_command_insert_label` **(** :ref:`String` name, :ref:`Color` color **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`draw_list_begin` **(** :ref:`RID` framebuffer, :ref:`InitialAction` initial_color_action, :ref:`FinalAction` final_color_action, :ref:`InitialAction` initial_depth_action, :ref:`FinalAction` final_depth_action, :ref:`PackedColorArray` clear_color_values=PackedColorArray(), :ref:`float` clear_depth=1.0, :ref:`int` clear_stencil=0, :ref:`Rect2` region=Rect2(0, 0, 0, 0), :ref:`Array` storage_textures=[] **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`draw_list_begin_for_screen` **(** :ref:`int` screen=0, :ref:`Color` clear_color=Color(0, 0, 0, 1) **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt64Array` | :ref:`draw_list_begin_split` **(** :ref:`RID` framebuffer, :ref:`int` splits, :ref:`InitialAction` initial_color_action, :ref:`FinalAction` final_color_action, :ref:`InitialAction` initial_depth_action, :ref:`FinalAction` final_depth_action, :ref:`PackedColorArray` clear_color_values=PackedColorArray(), :ref:`float` clear_depth=1.0, :ref:`int` clear_stencil=0, :ref:`Rect2` region=Rect2(0, 0, 0, 0), :ref:`RID[]` storage_textures=[] **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_list_bind_index_array` **(** :ref:`int` draw_list, :ref:`RID` index_array **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_list_bind_render_pipeline` **(** :ref:`int` draw_list, :ref:`RID` render_pipeline **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_list_bind_uniform_set` **(** :ref:`int` draw_list, :ref:`RID` uniform_set, :ref:`int` set_index **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_list_bind_vertex_array` **(** :ref:`int` draw_list, :ref:`RID` vertex_array **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_list_disable_scissor` **(** :ref:`int` draw_list **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_list_draw` **(** :ref:`int` draw_list, :ref:`bool` use_indices, :ref:`int` instances, :ref:`int` procedural_vertex_count=0 **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_list_enable_scissor` **(** :ref:`int` draw_list, :ref:`Rect2` rect=Rect2(0, 0, 0, 0) **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_list_end` **(** :ref:`int` post_barrier=7 **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_list_set_push_constant` **(** :ref:`int` draw_list, :ref:`PackedByteArray` buffer, :ref:`int` size_bytes **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`draw_list_switch_to_next_pass` **(** **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt64Array` | :ref:`draw_list_switch_to_next_pass_split` **(** :ref:`int` splits **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`framebuffer_create` **(** :ref:`RID[]` textures, :ref:`int` validate_with_format=-1, :ref:`int` view_count=1 **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`framebuffer_create_empty` **(** :ref:`Vector2i` size, :ref:`TextureSamples` samples=0, :ref:`int` validate_with_format=-1 **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`framebuffer_create_multipass` **(** :ref:`RID[]` textures, :ref:`RDFramebufferPass[]` passes, :ref:`int` validate_with_format=-1, :ref:`int` view_count=1 **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`framebuffer_format_create` **(** :ref:`RDAttachmentFormat[]` attachments, :ref:`int` view_count=1 **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`framebuffer_format_create_empty` **(** :ref:`TextureSamples` samples=0 **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`framebuffer_format_create_multipass` **(** :ref:`RDAttachmentFormat[]` attachments, :ref:`RDFramebufferPass[]` passes, :ref:`int` view_count=1 **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TextureSamples` | :ref:`framebuffer_format_get_texture_samples` **(** :ref:`int` format, :ref:`int` render_pass=0 **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`framebuffer_get_format` **(** :ref:`RID` framebuffer **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`free_rid` **(** :ref:`RID` rid **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`full_barrier` **(** **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_captured_timestamp_cpu_time` **(** :ref:`int` index **)** |const| | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_captured_timestamp_gpu_time` **(** :ref:`int` index **)** |const| | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_captured_timestamp_name` **(** :ref:`int` index **)** |const| | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_captured_timestamps_count` **(** **)** |const| | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_captured_timestamps_frame` **(** **)** |const| | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_device_name` **(** **)** |const| | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_device_pipeline_cache_uuid` **(** **)** |const| | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_device_vendor_name` **(** **)** |const| | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_driver_resource` **(** :ref:`DriverResource` resource, :ref:`RID` rid, :ref:`int` index **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_frame_delay` **(** **)** |const| | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_memory_usage` **(** :ref:`MemoryType` type **)** |const| | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`index_array_create` **(** :ref:`RID` index_buffer, :ref:`int` index_offset, :ref:`int` index_count **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`index_buffer_create` **(** :ref:`int` size_indices, :ref:`IndexBufferFormat` format, :ref:`PackedByteArray` data=PackedByteArray(), :ref:`bool` use_restart_indices=false **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`limit_get` **(** :ref:`Limit` limit **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`render_pipeline_create` **(** :ref:`RID` shader, :ref:`int` framebuffer_format, :ref:`int` vertex_format, :ref:`RenderPrimitive` primitive, :ref:`RDPipelineRasterizationState` rasterization_state, :ref:`RDPipelineMultisampleState` multisample_state, :ref:`RDPipelineDepthStencilState` stencil_state, :ref:`RDPipelineColorBlendState` color_blend_state, :ref:`int` dynamic_state_flags=0, :ref:`int` for_render_pass=0, :ref:`RDPipelineSpecializationConstant[]` specialization_constants=[] **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`render_pipeline_is_valid` **(** :ref:`RID` render_pipeline **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`sampler_create` **(** :ref:`RDSamplerState` state **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`screen_get_framebuffer_format` **(** **)** |const| | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`screen_get_height` **(** :ref:`int` screen=0 **)** |const| | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`screen_get_width` **(** :ref:`int` screen=0 **)** |const| | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_resource_name` **(** :ref:`RID` id, :ref:`String` name **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`shader_compile_binary_from_spirv` **(** :ref:`RDShaderSPIRV` spirv_data, :ref:`String` name="" **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RDShaderSPIRV` | :ref:`shader_compile_spirv_from_source` **(** :ref:`RDShaderSource` shader_source, :ref:`bool` allow_cache=true **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`shader_create_from_bytecode` **(** :ref:`PackedByteArray` binary_data **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`shader_create_from_spirv` **(** :ref:`RDShaderSPIRV` spirv_data, :ref:`String` name="" **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`shader_get_vertex_input_attribute_mask` **(** :ref:`RID` shader **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`storage_buffer_create` **(** :ref:`int` size_bytes, :ref:`PackedByteArray` data=PackedByteArray(), :ref:`int` usage=0 **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`submit` **(** **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`sync` **(** **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_buffer_create` **(** :ref:`int` size_bytes, :ref:`DataFormat` format, :ref:`PackedByteArray` data=PackedByteArray() **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`texture_clear` **(** :ref:`RID` texture, :ref:`Color` color, :ref:`int` base_mipmap, :ref:`int` mipmap_count, :ref:`int` base_layer, :ref:`int` layer_count, :ref:`int` post_barrier=7 **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`texture_copy` **(** :ref:`RID` from_texture, :ref:`RID` to_texture, :ref:`Vector3` from_pos, :ref:`Vector3` to_pos, :ref:`Vector3` size, :ref:`int` src_mipmap, :ref:`int` dst_mipmap, :ref:`int` src_layer, :ref:`int` dst_layer, :ref:`int` post_barrier=7 **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_create` **(** :ref:`RDTextureFormat` format, :ref:`RDTextureView` view, :ref:`PackedByteArray[]` data=[] **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_create_shared` **(** :ref:`RDTextureView` view, :ref:`RID` with_texture **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_create_shared_from_slice` **(** :ref:`RDTextureView` view, :ref:`RID` with_texture, :ref:`int` layer, :ref:`int` mipmap, :ref:`int` mipmaps=1, :ref:`TextureSliceType` slice_type=0 **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`texture_get_data` **(** :ref:`RID` texture, :ref:`int` layer **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`texture_is_format_supported_for_usage` **(** :ref:`DataFormat` format, :ref:`int` usage_flags **)** |const| | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`texture_is_shared` **(** :ref:`RID` texture **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`texture_is_valid` **(** :ref:`RID` texture **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`texture_resolve_multisample` **(** :ref:`RID` from_texture, :ref:`RID` to_texture, :ref:`int` post_barrier=7 **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`texture_update` **(** :ref:`RID` texture, :ref:`int` layer, :ref:`PackedByteArray` data, :ref:`int` post_barrier=7 **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`uniform_buffer_create` **(** :ref:`int` size_bytes, :ref:`PackedByteArray` data=PackedByteArray() **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`uniform_set_create` **(** :ref:`Array` uniforms, :ref:`RID` shader, :ref:`int` shader_set **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`uniform_set_is_valid` **(** :ref:`RID` uniform_set **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`vertex_buffer_create` **(** :ref:`int` size_bytes, :ref:`PackedByteArray` data=PackedByteArray(), :ref:`bool` use_as_storage=false **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`vertex_format_create` **(** :ref:`RDVertexAttribute[]` vertex_descriptions **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_RenderingDevice_DeviceType: .. _class_RenderingDevice_constant_DEVICE_TYPE_OTHER: .. _class_RenderingDevice_constant_DEVICE_TYPE_INTEGRATED_GPU: .. _class_RenderingDevice_constant_DEVICE_TYPE_DISCRETE_GPU: .. _class_RenderingDevice_constant_DEVICE_TYPE_VIRTUAL_GPU: .. _class_RenderingDevice_constant_DEVICE_TYPE_CPU: .. _class_RenderingDevice_constant_DEVICE_TYPE_MAX: enum **DeviceType**: - **DEVICE_TYPE_OTHER** = **0** --- Rendering device type does not match any of the other enum values or is unknown. - **DEVICE_TYPE_INTEGRATED_GPU** = **1** --- Rendering device is an integrated GPU, which is typically *(but not always)* slower than dedicated GPUs (:ref:`DEVICE_TYPE_DISCRETE_GPU`). On Android and iOS, the rendering device type is always considered to be :ref:`DEVICE_TYPE_INTEGRATED_GPU`. - **DEVICE_TYPE_DISCRETE_GPU** = **2** --- Rendering device is a dedicated GPU, which is typically *(but not always)* faster than integrated GPUs (:ref:`DEVICE_TYPE_INTEGRATED_GPU`). - **DEVICE_TYPE_VIRTUAL_GPU** = **3** --- Rendering device is an emulated GPU in a virtual environment. This is typically much slower than the host GPU, which means the expected performance level on a dedicated GPU will be roughly equivalent to :ref:`DEVICE_TYPE_INTEGRATED_GPU`. Virtual machine GPU passthrough (such as VFIO) will not report the device type as :ref:`DEVICE_TYPE_VIRTUAL_GPU`. Instead, the host GPU's device type will be reported as if the GPU was not emulated. - **DEVICE_TYPE_CPU** = **4** --- Rendering device is provided by software emulation (such as Lavapipe or `SwiftShader `__). This is the slowest kind of rendering device available; it's typically much slower than :ref:`DEVICE_TYPE_INTEGRATED_GPU`. - **DEVICE_TYPE_MAX** = **5** --- Represents the size of the :ref:`DeviceType` enum. ---- .. _enum_RenderingDevice_DriverResource: .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_DEVICE: .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_PHYSICAL_DEVICE: .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_INSTANCE: .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_QUEUE: .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_QUEUE_FAMILY_INDEX: .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_IMAGE: .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_IMAGE_VIEW: .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_IMAGE_NATIVE_TEXTURE_FORMAT: .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_SAMPLER: .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_DESCRIPTOR_SET: .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_BUFFER: .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_COMPUTE_PIPELINE: .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_RENDER_PIPELINE: enum **DriverResource**: - **DRIVER_RESOURCE_VULKAN_DEVICE** = **0** - **DRIVER_RESOURCE_VULKAN_PHYSICAL_DEVICE** = **1** - **DRIVER_RESOURCE_VULKAN_INSTANCE** = **2** - **DRIVER_RESOURCE_VULKAN_QUEUE** = **3** - **DRIVER_RESOURCE_VULKAN_QUEUE_FAMILY_INDEX** = **4** - **DRIVER_RESOURCE_VULKAN_IMAGE** = **5** - **DRIVER_RESOURCE_VULKAN_IMAGE_VIEW** = **6** - **DRIVER_RESOURCE_VULKAN_IMAGE_NATIVE_TEXTURE_FORMAT** = **7** - **DRIVER_RESOURCE_VULKAN_SAMPLER** = **8** - **DRIVER_RESOURCE_VULKAN_DESCRIPTOR_SET** = **9** - **DRIVER_RESOURCE_VULKAN_BUFFER** = **10** - **DRIVER_RESOURCE_VULKAN_COMPUTE_PIPELINE** = **11** - **DRIVER_RESOURCE_VULKAN_RENDER_PIPELINE** = **12** ---- .. _enum_RenderingDevice_DataFormat: .. _class_RenderingDevice_constant_DATA_FORMAT_R4G4_UNORM_PACK8: .. _class_RenderingDevice_constant_DATA_FORMAT_R4G4B4A4_UNORM_PACK16: .. _class_RenderingDevice_constant_DATA_FORMAT_B4G4R4A4_UNORM_PACK16: .. _class_RenderingDevice_constant_DATA_FORMAT_R5G6B5_UNORM_PACK16: .. _class_RenderingDevice_constant_DATA_FORMAT_B5G6R5_UNORM_PACK16: .. _class_RenderingDevice_constant_DATA_FORMAT_R5G5B5A1_UNORM_PACK16: .. _class_RenderingDevice_constant_DATA_FORMAT_B5G5R5A1_UNORM_PACK16: .. _class_RenderingDevice_constant_DATA_FORMAT_A1R5G5B5_UNORM_PACK16: .. _class_RenderingDevice_constant_DATA_FORMAT_R8_UNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_R8_SNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_R8_USCALED: .. _class_RenderingDevice_constant_DATA_FORMAT_R8_SSCALED: .. _class_RenderingDevice_constant_DATA_FORMAT_R8_UINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R8_SINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R8_SRGB: .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_UNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_SNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_USCALED: .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_SSCALED: .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_UINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_SINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_SRGB: .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_UNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_SNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_USCALED: .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_SSCALED: .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_UINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_SINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_SRGB: .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_UNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_SNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_USCALED: .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_SSCALED: .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_UINT: .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_SINT: .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_SRGB: .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_UNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_SNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_USCALED: .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_SSCALED: .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_UINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_SINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_SRGB: .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_UNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_SNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_USCALED: .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_SSCALED: .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_UINT: .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_SINT: .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_SRGB: .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_UNORM_PACK32: .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_SNORM_PACK32: .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_USCALED_PACK32: .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_SSCALED_PACK32: .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_UINT_PACK32: .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_SINT_PACK32: .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_SRGB_PACK32: .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_UNORM_PACK32: .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_SNORM_PACK32: .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_USCALED_PACK32: .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_SSCALED_PACK32: .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_UINT_PACK32: .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_SINT_PACK32: .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_UNORM_PACK32: .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_SNORM_PACK32: .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_USCALED_PACK32: .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_SSCALED_PACK32: .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_UINT_PACK32: .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_SINT_PACK32: .. _class_RenderingDevice_constant_DATA_FORMAT_R16_UNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_R16_SNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_R16_USCALED: .. _class_RenderingDevice_constant_DATA_FORMAT_R16_SSCALED: .. _class_RenderingDevice_constant_DATA_FORMAT_R16_UINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R16_SINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R16_SFLOAT: .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_UNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_SNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_USCALED: .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_SSCALED: .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_UINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_SINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_SFLOAT: .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_UNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_SNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_USCALED: .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_SSCALED: .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_UINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_SINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_SFLOAT: .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_UNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_SNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_USCALED: .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_SSCALED: .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_UINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_SINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_SFLOAT: .. _class_RenderingDevice_constant_DATA_FORMAT_R32_UINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R32_SINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R32_SFLOAT: .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32_UINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32_SINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32_SFLOAT: .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32_UINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32_SINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32_SFLOAT: .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32A32_UINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32A32_SINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32A32_SFLOAT: .. _class_RenderingDevice_constant_DATA_FORMAT_R64_UINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R64_SINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R64_SFLOAT: .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64_UINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64_SINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64_SFLOAT: .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64_UINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64_SINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64_SFLOAT: .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64A64_UINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64A64_SINT: .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64A64_SFLOAT: .. _class_RenderingDevice_constant_DATA_FORMAT_B10G11R11_UFLOAT_PACK32: .. _class_RenderingDevice_constant_DATA_FORMAT_E5B9G9R9_UFLOAT_PACK32: .. _class_RenderingDevice_constant_DATA_FORMAT_D16_UNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_X8_D24_UNORM_PACK32: .. _class_RenderingDevice_constant_DATA_FORMAT_D32_SFLOAT: .. _class_RenderingDevice_constant_DATA_FORMAT_S8_UINT: .. _class_RenderingDevice_constant_DATA_FORMAT_D16_UNORM_S8_UINT: .. _class_RenderingDevice_constant_DATA_FORMAT_D24_UNORM_S8_UINT: .. _class_RenderingDevice_constant_DATA_FORMAT_D32_SFLOAT_S8_UINT: .. _class_RenderingDevice_constant_DATA_FORMAT_BC1_RGB_UNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_BC1_RGB_SRGB_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_BC1_RGBA_UNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_BC1_RGBA_SRGB_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_BC2_UNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_BC2_SRGB_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_BC3_UNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_BC3_SRGB_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_BC4_UNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_BC4_SNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_BC5_UNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_BC5_SNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_BC6H_UFLOAT_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_BC6H_SFLOAT_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_BC7_UNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_BC7_SRGB_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8_UNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8_SRGB_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8A1_UNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8A1_SRGB_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8A8_UNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8A8_SRGB_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_EAC_R11_UNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_EAC_R11_SNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_EAC_R11G11_UNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_EAC_R11G11_SNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_4x4_UNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_4x4_SRGB_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_5x4_UNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_5x4_SRGB_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_5x5_UNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_5x5_SRGB_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_6x5_UNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_6x5_SRGB_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_6x6_UNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_6x6_SRGB_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x5_UNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x5_SRGB_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x6_UNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x6_SRGB_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x8_UNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x8_SRGB_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x5_UNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x5_SRGB_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x6_UNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x6_SRGB_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x8_UNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x8_SRGB_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x10_UNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x10_SRGB_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_12x10_UNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_12x10_SRGB_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_12x12_UNORM_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_12x12_SRGB_BLOCK: .. _class_RenderingDevice_constant_DATA_FORMAT_G8B8G8R8_422_UNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8G8_422_UNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_G8_B8_R8_3PLANE_420_UNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_G8_B8R8_2PLANE_420_UNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_G8_B8_R8_3PLANE_422_UNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_G8_B8R8_2PLANE_422_UNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_G8_B8_R8_3PLANE_444_UNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_R10X6_UNORM_PACK16: .. _class_RenderingDevice_constant_DATA_FORMAT_R10X6G10X6_UNORM_2PACK16: .. _class_RenderingDevice_constant_DATA_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16: .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6B10X6G10X6R10X6_422_UNORM_4PACK16: .. _class_RenderingDevice_constant_DATA_FORMAT_B10X6G10X6R10X6G10X6_422_UNORM_4PACK16: .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16: .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16: .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_422_UNORM_3PACK16: .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_422_UNORM_3PACK16: .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_444_UNORM_3PACK16: .. _class_RenderingDevice_constant_DATA_FORMAT_R12X4_UNORM_PACK16: .. _class_RenderingDevice_constant_DATA_FORMAT_R12X4G12X4_UNORM_2PACK16: .. _class_RenderingDevice_constant_DATA_FORMAT_R12X4G12X4B12X4A12X4_UNORM_4PACK16: .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4B12X4G12X4R12X4_422_UNORM_4PACK16: .. _class_RenderingDevice_constant_DATA_FORMAT_B12X4G12X4R12X4G12X4_422_UNORM_4PACK16: .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_420_UNORM_3PACK16: .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_420_UNORM_3PACK16: .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_422_UNORM_3PACK16: .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_422_UNORM_3PACK16: .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_444_UNORM_3PACK16: .. _class_RenderingDevice_constant_DATA_FORMAT_G16B16G16R16_422_UNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_B16G16R16G16_422_UNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_G16_B16_R16_3PLANE_420_UNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_G16_B16R16_2PLANE_420_UNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_G16_B16_R16_3PLANE_422_UNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_G16_B16R16_2PLANE_422_UNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_G16_B16_R16_3PLANE_444_UNORM: .. _class_RenderingDevice_constant_DATA_FORMAT_MAX: enum **DataFormat**: - **DATA_FORMAT_R4G4_UNORM_PACK8** = **0** - **DATA_FORMAT_R4G4B4A4_UNORM_PACK16** = **1** - **DATA_FORMAT_B4G4R4A4_UNORM_PACK16** = **2** - **DATA_FORMAT_R5G6B5_UNORM_PACK16** = **3** - **DATA_FORMAT_B5G6R5_UNORM_PACK16** = **4** - **DATA_FORMAT_R5G5B5A1_UNORM_PACK16** = **5** - **DATA_FORMAT_B5G5R5A1_UNORM_PACK16** = **6** - **DATA_FORMAT_A1R5G5B5_UNORM_PACK16** = **7** - **DATA_FORMAT_R8_UNORM** = **8** - **DATA_FORMAT_R8_SNORM** = **9** - **DATA_FORMAT_R8_USCALED** = **10** - **DATA_FORMAT_R8_SSCALED** = **11** - **DATA_FORMAT_R8_UINT** = **12** - **DATA_FORMAT_R8_SINT** = **13** - **DATA_FORMAT_R8_SRGB** = **14** - **DATA_FORMAT_R8G8_UNORM** = **15** - **DATA_FORMAT_R8G8_SNORM** = **16** - **DATA_FORMAT_R8G8_USCALED** = **17** - **DATA_FORMAT_R8G8_SSCALED** = **18** - **DATA_FORMAT_R8G8_UINT** = **19** - **DATA_FORMAT_R8G8_SINT** = **20** - **DATA_FORMAT_R8G8_SRGB** = **21** - **DATA_FORMAT_R8G8B8_UNORM** = **22** - **DATA_FORMAT_R8G8B8_SNORM** = **23** - **DATA_FORMAT_R8G8B8_USCALED** = **24** - **DATA_FORMAT_R8G8B8_SSCALED** = **25** - **DATA_FORMAT_R8G8B8_UINT** = **26** - **DATA_FORMAT_R8G8B8_SINT** = **27** - **DATA_FORMAT_R8G8B8_SRGB** = **28** - **DATA_FORMAT_B8G8R8_UNORM** = **29** - **DATA_FORMAT_B8G8R8_SNORM** = **30** - **DATA_FORMAT_B8G8R8_USCALED** = **31** - **DATA_FORMAT_B8G8R8_SSCALED** = **32** - **DATA_FORMAT_B8G8R8_UINT** = **33** - **DATA_FORMAT_B8G8R8_SINT** = **34** - **DATA_FORMAT_B8G8R8_SRGB** = **35** - **DATA_FORMAT_R8G8B8A8_UNORM** = **36** - **DATA_FORMAT_R8G8B8A8_SNORM** = **37** - **DATA_FORMAT_R8G8B8A8_USCALED** = **38** - **DATA_FORMAT_R8G8B8A8_SSCALED** = **39** - **DATA_FORMAT_R8G8B8A8_UINT** = **40** - **DATA_FORMAT_R8G8B8A8_SINT** = **41** - **DATA_FORMAT_R8G8B8A8_SRGB** = **42** - **DATA_FORMAT_B8G8R8A8_UNORM** = **43** - **DATA_FORMAT_B8G8R8A8_SNORM** = **44** - **DATA_FORMAT_B8G8R8A8_USCALED** = **45** - **DATA_FORMAT_B8G8R8A8_SSCALED** = **46** - **DATA_FORMAT_B8G8R8A8_UINT** = **47** - **DATA_FORMAT_B8G8R8A8_SINT** = **48** - **DATA_FORMAT_B8G8R8A8_SRGB** = **49** - **DATA_FORMAT_A8B8G8R8_UNORM_PACK32** = **50** - **DATA_FORMAT_A8B8G8R8_SNORM_PACK32** = **51** - **DATA_FORMAT_A8B8G8R8_USCALED_PACK32** = **52** - **DATA_FORMAT_A8B8G8R8_SSCALED_PACK32** = **53** - **DATA_FORMAT_A8B8G8R8_UINT_PACK32** = **54** - **DATA_FORMAT_A8B8G8R8_SINT_PACK32** = **55** - **DATA_FORMAT_A8B8G8R8_SRGB_PACK32** = **56** - **DATA_FORMAT_A2R10G10B10_UNORM_PACK32** = **57** - **DATA_FORMAT_A2R10G10B10_SNORM_PACK32** = **58** - **DATA_FORMAT_A2R10G10B10_USCALED_PACK32** = **59** - **DATA_FORMAT_A2R10G10B10_SSCALED_PACK32** = **60** - **DATA_FORMAT_A2R10G10B10_UINT_PACK32** = **61** - **DATA_FORMAT_A2R10G10B10_SINT_PACK32** = **62** - **DATA_FORMAT_A2B10G10R10_UNORM_PACK32** = **63** - **DATA_FORMAT_A2B10G10R10_SNORM_PACK32** = **64** - **DATA_FORMAT_A2B10G10R10_USCALED_PACK32** = **65** - **DATA_FORMAT_A2B10G10R10_SSCALED_PACK32** = **66** - **DATA_FORMAT_A2B10G10R10_UINT_PACK32** = **67** - **DATA_FORMAT_A2B10G10R10_SINT_PACK32** = **68** - **DATA_FORMAT_R16_UNORM** = **69** - **DATA_FORMAT_R16_SNORM** = **70** - **DATA_FORMAT_R16_USCALED** = **71** - **DATA_FORMAT_R16_SSCALED** = **72** - **DATA_FORMAT_R16_UINT** = **73** - **DATA_FORMAT_R16_SINT** = **74** - **DATA_FORMAT_R16_SFLOAT** = **75** - **DATA_FORMAT_R16G16_UNORM** = **76** - **DATA_FORMAT_R16G16_SNORM** = **77** - **DATA_FORMAT_R16G16_USCALED** = **78** - **DATA_FORMAT_R16G16_SSCALED** = **79** - **DATA_FORMAT_R16G16_UINT** = **80** - **DATA_FORMAT_R16G16_SINT** = **81** - **DATA_FORMAT_R16G16_SFLOAT** = **82** - **DATA_FORMAT_R16G16B16_UNORM** = **83** - **DATA_FORMAT_R16G16B16_SNORM** = **84** - **DATA_FORMAT_R16G16B16_USCALED** = **85** - **DATA_FORMAT_R16G16B16_SSCALED** = **86** - **DATA_FORMAT_R16G16B16_UINT** = **87** - **DATA_FORMAT_R16G16B16_SINT** = **88** - **DATA_FORMAT_R16G16B16_SFLOAT** = **89** - **DATA_FORMAT_R16G16B16A16_UNORM** = **90** - **DATA_FORMAT_R16G16B16A16_SNORM** = **91** - **DATA_FORMAT_R16G16B16A16_USCALED** = **92** - **DATA_FORMAT_R16G16B16A16_SSCALED** = **93** - **DATA_FORMAT_R16G16B16A16_UINT** = **94** - **DATA_FORMAT_R16G16B16A16_SINT** = **95** - **DATA_FORMAT_R16G16B16A16_SFLOAT** = **96** - **DATA_FORMAT_R32_UINT** = **97** - **DATA_FORMAT_R32_SINT** = **98** - **DATA_FORMAT_R32_SFLOAT** = **99** - **DATA_FORMAT_R32G32_UINT** = **100** - **DATA_FORMAT_R32G32_SINT** = **101** - **DATA_FORMAT_R32G32_SFLOAT** = **102** - **DATA_FORMAT_R32G32B32_UINT** = **103** - **DATA_FORMAT_R32G32B32_SINT** = **104** - **DATA_FORMAT_R32G32B32_SFLOAT** = **105** - **DATA_FORMAT_R32G32B32A32_UINT** = **106** - **DATA_FORMAT_R32G32B32A32_SINT** = **107** - **DATA_FORMAT_R32G32B32A32_SFLOAT** = **108** - **DATA_FORMAT_R64_UINT** = **109** - **DATA_FORMAT_R64_SINT** = **110** - **DATA_FORMAT_R64_SFLOAT** = **111** - **DATA_FORMAT_R64G64_UINT** = **112** - **DATA_FORMAT_R64G64_SINT** = **113** - **DATA_FORMAT_R64G64_SFLOAT** = **114** - **DATA_FORMAT_R64G64B64_UINT** = **115** - **DATA_FORMAT_R64G64B64_SINT** = **116** - **DATA_FORMAT_R64G64B64_SFLOAT** = **117** - **DATA_FORMAT_R64G64B64A64_UINT** = **118** - **DATA_FORMAT_R64G64B64A64_SINT** = **119** - **DATA_FORMAT_R64G64B64A64_SFLOAT** = **120** - **DATA_FORMAT_B10G11R11_UFLOAT_PACK32** = **121** - **DATA_FORMAT_E5B9G9R9_UFLOAT_PACK32** = **122** - **DATA_FORMAT_D16_UNORM** = **123** - **DATA_FORMAT_X8_D24_UNORM_PACK32** = **124** - **DATA_FORMAT_D32_SFLOAT** = **125** - **DATA_FORMAT_S8_UINT** = **126** - **DATA_FORMAT_D16_UNORM_S8_UINT** = **127** - **DATA_FORMAT_D24_UNORM_S8_UINT** = **128** - **DATA_FORMAT_D32_SFLOAT_S8_UINT** = **129** - **DATA_FORMAT_BC1_RGB_UNORM_BLOCK** = **130** - **DATA_FORMAT_BC1_RGB_SRGB_BLOCK** = **131** - **DATA_FORMAT_BC1_RGBA_UNORM_BLOCK** = **132** - **DATA_FORMAT_BC1_RGBA_SRGB_BLOCK** = **133** - **DATA_FORMAT_BC2_UNORM_BLOCK** = **134** - **DATA_FORMAT_BC2_SRGB_BLOCK** = **135** - **DATA_FORMAT_BC3_UNORM_BLOCK** = **136** - **DATA_FORMAT_BC3_SRGB_BLOCK** = **137** - **DATA_FORMAT_BC4_UNORM_BLOCK** = **138** - **DATA_FORMAT_BC4_SNORM_BLOCK** = **139** - **DATA_FORMAT_BC5_UNORM_BLOCK** = **140** - **DATA_FORMAT_BC5_SNORM_BLOCK** = **141** - **DATA_FORMAT_BC6H_UFLOAT_BLOCK** = **142** - **DATA_FORMAT_BC6H_SFLOAT_BLOCK** = **143** - **DATA_FORMAT_BC7_UNORM_BLOCK** = **144** - **DATA_FORMAT_BC7_SRGB_BLOCK** = **145** - **DATA_FORMAT_ETC2_R8G8B8_UNORM_BLOCK** = **146** - **DATA_FORMAT_ETC2_R8G8B8_SRGB_BLOCK** = **147** - **DATA_FORMAT_ETC2_R8G8B8A1_UNORM_BLOCK** = **148** - **DATA_FORMAT_ETC2_R8G8B8A1_SRGB_BLOCK** = **149** - **DATA_FORMAT_ETC2_R8G8B8A8_UNORM_BLOCK** = **150** - **DATA_FORMAT_ETC2_R8G8B8A8_SRGB_BLOCK** = **151** - **DATA_FORMAT_EAC_R11_UNORM_BLOCK** = **152** - **DATA_FORMAT_EAC_R11_SNORM_BLOCK** = **153** - **DATA_FORMAT_EAC_R11G11_UNORM_BLOCK** = **154** - **DATA_FORMAT_EAC_R11G11_SNORM_BLOCK** = **155** - **DATA_FORMAT_ASTC_4x4_UNORM_BLOCK** = **156** - **DATA_FORMAT_ASTC_4x4_SRGB_BLOCK** = **157** - **DATA_FORMAT_ASTC_5x4_UNORM_BLOCK** = **158** - **DATA_FORMAT_ASTC_5x4_SRGB_BLOCK** = **159** - **DATA_FORMAT_ASTC_5x5_UNORM_BLOCK** = **160** - **DATA_FORMAT_ASTC_5x5_SRGB_BLOCK** = **161** - **DATA_FORMAT_ASTC_6x5_UNORM_BLOCK** = **162** - **DATA_FORMAT_ASTC_6x5_SRGB_BLOCK** = **163** - **DATA_FORMAT_ASTC_6x6_UNORM_BLOCK** = **164** - **DATA_FORMAT_ASTC_6x6_SRGB_BLOCK** = **165** - **DATA_FORMAT_ASTC_8x5_UNORM_BLOCK** = **166** - **DATA_FORMAT_ASTC_8x5_SRGB_BLOCK** = **167** - **DATA_FORMAT_ASTC_8x6_UNORM_BLOCK** = **168** - **DATA_FORMAT_ASTC_8x6_SRGB_BLOCK** = **169** - **DATA_FORMAT_ASTC_8x8_UNORM_BLOCK** = **170** - **DATA_FORMAT_ASTC_8x8_SRGB_BLOCK** = **171** - **DATA_FORMAT_ASTC_10x5_UNORM_BLOCK** = **172** - **DATA_FORMAT_ASTC_10x5_SRGB_BLOCK** = **173** - **DATA_FORMAT_ASTC_10x6_UNORM_BLOCK** = **174** - **DATA_FORMAT_ASTC_10x6_SRGB_BLOCK** = **175** - **DATA_FORMAT_ASTC_10x8_UNORM_BLOCK** = **176** - **DATA_FORMAT_ASTC_10x8_SRGB_BLOCK** = **177** - **DATA_FORMAT_ASTC_10x10_UNORM_BLOCK** = **178** - **DATA_FORMAT_ASTC_10x10_SRGB_BLOCK** = **179** - **DATA_FORMAT_ASTC_12x10_UNORM_BLOCK** = **180** - **DATA_FORMAT_ASTC_12x10_SRGB_BLOCK** = **181** - **DATA_FORMAT_ASTC_12x12_UNORM_BLOCK** = **182** - **DATA_FORMAT_ASTC_12x12_SRGB_BLOCK** = **183** - **DATA_FORMAT_G8B8G8R8_422_UNORM** = **184** - **DATA_FORMAT_B8G8R8G8_422_UNORM** = **185** - **DATA_FORMAT_G8_B8_R8_3PLANE_420_UNORM** = **186** - **DATA_FORMAT_G8_B8R8_2PLANE_420_UNORM** = **187** - **DATA_FORMAT_G8_B8_R8_3PLANE_422_UNORM** = **188** - **DATA_FORMAT_G8_B8R8_2PLANE_422_UNORM** = **189** - **DATA_FORMAT_G8_B8_R8_3PLANE_444_UNORM** = **190** - **DATA_FORMAT_R10X6_UNORM_PACK16** = **191** - **DATA_FORMAT_R10X6G10X6_UNORM_2PACK16** = **192** - **DATA_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16** = **193** - **DATA_FORMAT_G10X6B10X6G10X6R10X6_422_UNORM_4PACK16** = **194** - **DATA_FORMAT_B10X6G10X6R10X6G10X6_422_UNORM_4PACK16** = **195** - **DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16** = **196** - **DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16** = **197** - **DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_422_UNORM_3PACK16** = **198** - **DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_422_UNORM_3PACK16** = **199** - **DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_444_UNORM_3PACK16** = **200** - **DATA_FORMAT_R12X4_UNORM_PACK16** = **201** - **DATA_FORMAT_R12X4G12X4_UNORM_2PACK16** = **202** - **DATA_FORMAT_R12X4G12X4B12X4A12X4_UNORM_4PACK16** = **203** - **DATA_FORMAT_G12X4B12X4G12X4R12X4_422_UNORM_4PACK16** = **204** - **DATA_FORMAT_B12X4G12X4R12X4G12X4_422_UNORM_4PACK16** = **205** - **DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_420_UNORM_3PACK16** = **206** - **DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_420_UNORM_3PACK16** = **207** - **DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_422_UNORM_3PACK16** = **208** - **DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_422_UNORM_3PACK16** = **209** - **DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_444_UNORM_3PACK16** = **210** - **DATA_FORMAT_G16B16G16R16_422_UNORM** = **211** - **DATA_FORMAT_B16G16R16G16_422_UNORM** = **212** - **DATA_FORMAT_G16_B16_R16_3PLANE_420_UNORM** = **213** - **DATA_FORMAT_G16_B16R16_2PLANE_420_UNORM** = **214** - **DATA_FORMAT_G16_B16_R16_3PLANE_422_UNORM** = **215** - **DATA_FORMAT_G16_B16R16_2PLANE_422_UNORM** = **216** - **DATA_FORMAT_G16_B16_R16_3PLANE_444_UNORM** = **217** - **DATA_FORMAT_MAX** = **218** ---- .. _enum_RenderingDevice_TextureType: .. _class_RenderingDevice_constant_TEXTURE_TYPE_1D: .. _class_RenderingDevice_constant_TEXTURE_TYPE_2D: .. _class_RenderingDevice_constant_TEXTURE_TYPE_3D: .. _class_RenderingDevice_constant_TEXTURE_TYPE_CUBE: .. _class_RenderingDevice_constant_TEXTURE_TYPE_1D_ARRAY: .. _class_RenderingDevice_constant_TEXTURE_TYPE_2D_ARRAY: .. _class_RenderingDevice_constant_TEXTURE_TYPE_CUBE_ARRAY: .. _class_RenderingDevice_constant_TEXTURE_TYPE_MAX: enum **TextureType**: - **TEXTURE_TYPE_1D** = **0** - **TEXTURE_TYPE_2D** = **1** - **TEXTURE_TYPE_3D** = **2** - **TEXTURE_TYPE_CUBE** = **3** - **TEXTURE_TYPE_1D_ARRAY** = **4** - **TEXTURE_TYPE_2D_ARRAY** = **5** - **TEXTURE_TYPE_CUBE_ARRAY** = **6** - **TEXTURE_TYPE_MAX** = **7** ---- .. _enum_RenderingDevice_TextureSamples: .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_1: .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_2: .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_4: .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_8: .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_16: .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_32: .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_64: .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_MAX: enum **TextureSamples**: - **TEXTURE_SAMPLES_1** = **0** - **TEXTURE_SAMPLES_2** = **1** - **TEXTURE_SAMPLES_4** = **2** - **TEXTURE_SAMPLES_8** = **3** - **TEXTURE_SAMPLES_16** = **4** - **TEXTURE_SAMPLES_32** = **5** - **TEXTURE_SAMPLES_64** = **6** - **TEXTURE_SAMPLES_MAX** = **7** ---- .. _enum_RenderingDevice_TextureUsageBits: .. _class_RenderingDevice_constant_TEXTURE_USAGE_SAMPLING_BIT: .. _class_RenderingDevice_constant_TEXTURE_USAGE_COLOR_ATTACHMENT_BIT: .. _class_RenderingDevice_constant_TEXTURE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT: .. _class_RenderingDevice_constant_TEXTURE_USAGE_STORAGE_BIT: .. _class_RenderingDevice_constant_TEXTURE_USAGE_STORAGE_ATOMIC_BIT: .. _class_RenderingDevice_constant_TEXTURE_USAGE_CPU_READ_BIT: .. _class_RenderingDevice_constant_TEXTURE_USAGE_CAN_UPDATE_BIT: .. _class_RenderingDevice_constant_TEXTURE_USAGE_CAN_COPY_FROM_BIT: .. _class_RenderingDevice_constant_TEXTURE_USAGE_CAN_COPY_TO_BIT: .. _class_RenderingDevice_constant_TEXTURE_USAGE_INPUT_ATTACHMENT_BIT: enum **TextureUsageBits**: - **TEXTURE_USAGE_SAMPLING_BIT** = **1** - **TEXTURE_USAGE_COLOR_ATTACHMENT_BIT** = **2** - **TEXTURE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT** = **4** - **TEXTURE_USAGE_STORAGE_BIT** = **8** - **TEXTURE_USAGE_STORAGE_ATOMIC_BIT** = **16** - **TEXTURE_USAGE_CPU_READ_BIT** = **32** - **TEXTURE_USAGE_CAN_UPDATE_BIT** = **64** - **TEXTURE_USAGE_CAN_COPY_FROM_BIT** = **128** - **TEXTURE_USAGE_CAN_COPY_TO_BIT** = **256** - **TEXTURE_USAGE_INPUT_ATTACHMENT_BIT** = **512** ---- .. _enum_RenderingDevice_TextureSwizzle: .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_IDENTITY: .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_ZERO: .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_ONE: .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_R: .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_G: .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_B: .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_A: .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_MAX: enum **TextureSwizzle**: - **TEXTURE_SWIZZLE_IDENTITY** = **0** - **TEXTURE_SWIZZLE_ZERO** = **1** - **TEXTURE_SWIZZLE_ONE** = **2** - **TEXTURE_SWIZZLE_R** = **3** - **TEXTURE_SWIZZLE_G** = **4** - **TEXTURE_SWIZZLE_B** = **5** - **TEXTURE_SWIZZLE_A** = **6** - **TEXTURE_SWIZZLE_MAX** = **7** ---- .. _enum_RenderingDevice_TextureSliceType: .. _class_RenderingDevice_constant_TEXTURE_SLICE_2D: .. _class_RenderingDevice_constant_TEXTURE_SLICE_CUBEMAP: .. _class_RenderingDevice_constant_TEXTURE_SLICE_3D: enum **TextureSliceType**: - **TEXTURE_SLICE_2D** = **0** - **TEXTURE_SLICE_CUBEMAP** = **1** - **TEXTURE_SLICE_3D** = **2** ---- .. _enum_RenderingDevice_SamplerFilter: .. _class_RenderingDevice_constant_SAMPLER_FILTER_NEAREST: .. _class_RenderingDevice_constant_SAMPLER_FILTER_LINEAR: enum **SamplerFilter**: - **SAMPLER_FILTER_NEAREST** = **0** - **SAMPLER_FILTER_LINEAR** = **1** ---- .. _enum_RenderingDevice_SamplerRepeatMode: .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_REPEAT: .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_MIRRORED_REPEAT: .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE: .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER: .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_MIRROR_CLAMP_TO_EDGE: .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_MAX: enum **SamplerRepeatMode**: - **SAMPLER_REPEAT_MODE_REPEAT** = **0** - **SAMPLER_REPEAT_MODE_MIRRORED_REPEAT** = **1** - **SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE** = **2** - **SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER** = **3** - **SAMPLER_REPEAT_MODE_MIRROR_CLAMP_TO_EDGE** = **4** - **SAMPLER_REPEAT_MODE_MAX** = **5** ---- .. _enum_RenderingDevice_SamplerBorderColor: .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK: .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_INT_TRANSPARENT_BLACK: .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_BLACK: .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_INT_OPAQUE_BLACK: .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_WHITE: .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_INT_OPAQUE_WHITE: .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_MAX: enum **SamplerBorderColor**: - **SAMPLER_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK** = **0** - **SAMPLER_BORDER_COLOR_INT_TRANSPARENT_BLACK** = **1** - **SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_BLACK** = **2** - **SAMPLER_BORDER_COLOR_INT_OPAQUE_BLACK** = **3** - **SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_WHITE** = **4** - **SAMPLER_BORDER_COLOR_INT_OPAQUE_WHITE** = **5** - **SAMPLER_BORDER_COLOR_MAX** = **6** ---- .. _enum_RenderingDevice_VertexFrequency: .. _class_RenderingDevice_constant_VERTEX_FREQUENCY_VERTEX: .. _class_RenderingDevice_constant_VERTEX_FREQUENCY_INSTANCE: enum **VertexFrequency**: - **VERTEX_FREQUENCY_VERTEX** = **0** - **VERTEX_FREQUENCY_INSTANCE** = **1** ---- .. _enum_RenderingDevice_IndexBufferFormat: .. _class_RenderingDevice_constant_INDEX_BUFFER_FORMAT_UINT16: .. _class_RenderingDevice_constant_INDEX_BUFFER_FORMAT_UINT32: enum **IndexBufferFormat**: - **INDEX_BUFFER_FORMAT_UINT16** = **0** - **INDEX_BUFFER_FORMAT_UINT32** = **1** ---- .. _enum_RenderingDevice_StorageBufferUsage: .. _class_RenderingDevice_constant_STORAGE_BUFFER_USAGE_DISPATCH_INDIRECT: enum **StorageBufferUsage**: - **STORAGE_BUFFER_USAGE_DISPATCH_INDIRECT** = **1** ---- .. _enum_RenderingDevice_UniformType: .. _class_RenderingDevice_constant_UNIFORM_TYPE_SAMPLER: .. _class_RenderingDevice_constant_UNIFORM_TYPE_SAMPLER_WITH_TEXTURE: .. _class_RenderingDevice_constant_UNIFORM_TYPE_TEXTURE: .. _class_RenderingDevice_constant_UNIFORM_TYPE_IMAGE: .. _class_RenderingDevice_constant_UNIFORM_TYPE_TEXTURE_BUFFER: .. _class_RenderingDevice_constant_UNIFORM_TYPE_SAMPLER_WITH_TEXTURE_BUFFER: .. _class_RenderingDevice_constant_UNIFORM_TYPE_IMAGE_BUFFER: .. _class_RenderingDevice_constant_UNIFORM_TYPE_UNIFORM_BUFFER: .. _class_RenderingDevice_constant_UNIFORM_TYPE_STORAGE_BUFFER: .. _class_RenderingDevice_constant_UNIFORM_TYPE_INPUT_ATTACHMENT: .. _class_RenderingDevice_constant_UNIFORM_TYPE_MAX: enum **UniformType**: - **UNIFORM_TYPE_SAMPLER** = **0** - **UNIFORM_TYPE_SAMPLER_WITH_TEXTURE** = **1** - **UNIFORM_TYPE_TEXTURE** = **2** - **UNIFORM_TYPE_IMAGE** = **3** - **UNIFORM_TYPE_TEXTURE_BUFFER** = **4** - **UNIFORM_TYPE_SAMPLER_WITH_TEXTURE_BUFFER** = **5** - **UNIFORM_TYPE_IMAGE_BUFFER** = **6** - **UNIFORM_TYPE_UNIFORM_BUFFER** = **7** - **UNIFORM_TYPE_STORAGE_BUFFER** = **8** - **UNIFORM_TYPE_INPUT_ATTACHMENT** = **9** - **UNIFORM_TYPE_MAX** = **10** ---- .. _enum_RenderingDevice_RenderPrimitive: .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_POINTS: .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_LINES: .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_LINES_WITH_ADJACENCY: .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_LINESTRIPS: .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_LINESTRIPS_WITH_ADJACENCY: .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TRIANGLES: .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TRIANGLES_WITH_ADJACENCY: .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TRIANGLE_STRIPS: .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_AJACENCY: .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_RESTART_INDEX: .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TESSELATION_PATCH: .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_MAX: enum **RenderPrimitive**: - **RENDER_PRIMITIVE_POINTS** = **0** - **RENDER_PRIMITIVE_LINES** = **1** - **RENDER_PRIMITIVE_LINES_WITH_ADJACENCY** = **2** - **RENDER_PRIMITIVE_LINESTRIPS** = **3** - **RENDER_PRIMITIVE_LINESTRIPS_WITH_ADJACENCY** = **4** - **RENDER_PRIMITIVE_TRIANGLES** = **5** - **RENDER_PRIMITIVE_TRIANGLES_WITH_ADJACENCY** = **6** - **RENDER_PRIMITIVE_TRIANGLE_STRIPS** = **7** - **RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_AJACENCY** = **8** - **RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_RESTART_INDEX** = **9** - **RENDER_PRIMITIVE_TESSELATION_PATCH** = **10** - **RENDER_PRIMITIVE_MAX** = **11** ---- .. _enum_RenderingDevice_PolygonCullMode: .. _class_RenderingDevice_constant_POLYGON_CULL_DISABLED: .. _class_RenderingDevice_constant_POLYGON_CULL_FRONT: .. _class_RenderingDevice_constant_POLYGON_CULL_BACK: enum **PolygonCullMode**: - **POLYGON_CULL_DISABLED** = **0** - **POLYGON_CULL_FRONT** = **1** - **POLYGON_CULL_BACK** = **2** ---- .. _enum_RenderingDevice_PolygonFrontFace: .. _class_RenderingDevice_constant_POLYGON_FRONT_FACE_CLOCKWISE: .. _class_RenderingDevice_constant_POLYGON_FRONT_FACE_COUNTER_CLOCKWISE: enum **PolygonFrontFace**: - **POLYGON_FRONT_FACE_CLOCKWISE** = **0** - **POLYGON_FRONT_FACE_COUNTER_CLOCKWISE** = **1** ---- .. _enum_RenderingDevice_StencilOperation: .. _class_RenderingDevice_constant_STENCIL_OP_KEEP: .. _class_RenderingDevice_constant_STENCIL_OP_ZERO: .. _class_RenderingDevice_constant_STENCIL_OP_REPLACE: .. _class_RenderingDevice_constant_STENCIL_OP_INCREMENT_AND_CLAMP: .. _class_RenderingDevice_constant_STENCIL_OP_DECREMENT_AND_CLAMP: .. _class_RenderingDevice_constant_STENCIL_OP_INVERT: .. _class_RenderingDevice_constant_STENCIL_OP_INCREMENT_AND_WRAP: .. _class_RenderingDevice_constant_STENCIL_OP_DECREMENT_AND_WRAP: .. _class_RenderingDevice_constant_STENCIL_OP_MAX: enum **StencilOperation**: - **STENCIL_OP_KEEP** = **0** - **STENCIL_OP_ZERO** = **1** - **STENCIL_OP_REPLACE** = **2** - **STENCIL_OP_INCREMENT_AND_CLAMP** = **3** - **STENCIL_OP_DECREMENT_AND_CLAMP** = **4** - **STENCIL_OP_INVERT** = **5** - **STENCIL_OP_INCREMENT_AND_WRAP** = **6** - **STENCIL_OP_DECREMENT_AND_WRAP** = **7** - **STENCIL_OP_MAX** = **8** ---- .. _enum_RenderingDevice_CompareOperator: .. _class_RenderingDevice_constant_COMPARE_OP_NEVER: .. _class_RenderingDevice_constant_COMPARE_OP_LESS: .. _class_RenderingDevice_constant_COMPARE_OP_EQUAL: .. _class_RenderingDevice_constant_COMPARE_OP_LESS_OR_EQUAL: .. _class_RenderingDevice_constant_COMPARE_OP_GREATER: .. _class_RenderingDevice_constant_COMPARE_OP_NOT_EQUAL: .. _class_RenderingDevice_constant_COMPARE_OP_GREATER_OR_EQUAL: .. _class_RenderingDevice_constant_COMPARE_OP_ALWAYS: .. _class_RenderingDevice_constant_COMPARE_OP_MAX: enum **CompareOperator**: - **COMPARE_OP_NEVER** = **0** - **COMPARE_OP_LESS** = **1** - **COMPARE_OP_EQUAL** = **2** - **COMPARE_OP_LESS_OR_EQUAL** = **3** - **COMPARE_OP_GREATER** = **4** - **COMPARE_OP_NOT_EQUAL** = **5** - **COMPARE_OP_GREATER_OR_EQUAL** = **6** - **COMPARE_OP_ALWAYS** = **7** - **COMPARE_OP_MAX** = **8** ---- .. _enum_RenderingDevice_LogicOperation: .. _class_RenderingDevice_constant_LOGIC_OP_CLEAR: .. _class_RenderingDevice_constant_LOGIC_OP_AND: .. _class_RenderingDevice_constant_LOGIC_OP_AND_REVERSE: .. _class_RenderingDevice_constant_LOGIC_OP_COPY: .. _class_RenderingDevice_constant_LOGIC_OP_AND_INVERTED: .. _class_RenderingDevice_constant_LOGIC_OP_NO_OP: .. _class_RenderingDevice_constant_LOGIC_OP_XOR: .. _class_RenderingDevice_constant_LOGIC_OP_OR: .. _class_RenderingDevice_constant_LOGIC_OP_NOR: .. _class_RenderingDevice_constant_LOGIC_OP_EQUIVALENT: .. _class_RenderingDevice_constant_LOGIC_OP_INVERT: .. _class_RenderingDevice_constant_LOGIC_OP_OR_REVERSE: .. _class_RenderingDevice_constant_LOGIC_OP_COPY_INVERTED: .. _class_RenderingDevice_constant_LOGIC_OP_OR_INVERTED: .. _class_RenderingDevice_constant_LOGIC_OP_NAND: .. _class_RenderingDevice_constant_LOGIC_OP_SET: .. _class_RenderingDevice_constant_LOGIC_OP_MAX: enum **LogicOperation**: - **LOGIC_OP_CLEAR** = **0** - **LOGIC_OP_AND** = **1** - **LOGIC_OP_AND_REVERSE** = **2** - **LOGIC_OP_COPY** = **3** - **LOGIC_OP_AND_INVERTED** = **4** - **LOGIC_OP_NO_OP** = **5** - **LOGIC_OP_XOR** = **6** - **LOGIC_OP_OR** = **7** - **LOGIC_OP_NOR** = **8** - **LOGIC_OP_EQUIVALENT** = **9** - **LOGIC_OP_INVERT** = **10** - **LOGIC_OP_OR_REVERSE** = **11** - **LOGIC_OP_COPY_INVERTED** = **12** - **LOGIC_OP_OR_INVERTED** = **13** - **LOGIC_OP_NAND** = **14** - **LOGIC_OP_SET** = **15** - **LOGIC_OP_MAX** = **16** ---- .. _enum_RenderingDevice_BlendFactor: .. _class_RenderingDevice_constant_BLEND_FACTOR_ZERO: .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE: .. _class_RenderingDevice_constant_BLEND_FACTOR_SRC_COLOR: .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_SRC_COLOR: .. _class_RenderingDevice_constant_BLEND_FACTOR_DST_COLOR: .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_DST_COLOR: .. _class_RenderingDevice_constant_BLEND_FACTOR_SRC_ALPHA: .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_SRC_ALPHA: .. _class_RenderingDevice_constant_BLEND_FACTOR_DST_ALPHA: .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_DST_ALPHA: .. _class_RenderingDevice_constant_BLEND_FACTOR_CONSTANT_COLOR: .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_CONSTANT_COLOR: .. _class_RenderingDevice_constant_BLEND_FACTOR_CONSTANT_ALPHA: .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA: .. _class_RenderingDevice_constant_BLEND_FACTOR_SRC_ALPHA_SATURATE: .. _class_RenderingDevice_constant_BLEND_FACTOR_SRC1_COLOR: .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_SRC1_COLOR: .. _class_RenderingDevice_constant_BLEND_FACTOR_SRC1_ALPHA: .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA: .. _class_RenderingDevice_constant_BLEND_FACTOR_MAX: enum **BlendFactor**: - **BLEND_FACTOR_ZERO** = **0** - **BLEND_FACTOR_ONE** = **1** - **BLEND_FACTOR_SRC_COLOR** = **2** - **BLEND_FACTOR_ONE_MINUS_SRC_COLOR** = **3** - **BLEND_FACTOR_DST_COLOR** = **4** - **BLEND_FACTOR_ONE_MINUS_DST_COLOR** = **5** - **BLEND_FACTOR_SRC_ALPHA** = **6** - **BLEND_FACTOR_ONE_MINUS_SRC_ALPHA** = **7** - **BLEND_FACTOR_DST_ALPHA** = **8** - **BLEND_FACTOR_ONE_MINUS_DST_ALPHA** = **9** - **BLEND_FACTOR_CONSTANT_COLOR** = **10** - **BLEND_FACTOR_ONE_MINUS_CONSTANT_COLOR** = **11** - **BLEND_FACTOR_CONSTANT_ALPHA** = **12** - **BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA** = **13** - **BLEND_FACTOR_SRC_ALPHA_SATURATE** = **14** - **BLEND_FACTOR_SRC1_COLOR** = **15** - **BLEND_FACTOR_ONE_MINUS_SRC1_COLOR** = **16** - **BLEND_FACTOR_SRC1_ALPHA** = **17** - **BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA** = **18** - **BLEND_FACTOR_MAX** = **19** ---- .. _enum_RenderingDevice_BlendOperation: .. _class_RenderingDevice_constant_BLEND_OP_ADD: .. _class_RenderingDevice_constant_BLEND_OP_SUBTRACT: .. _class_RenderingDevice_constant_BLEND_OP_REVERSE_SUBTRACT: .. _class_RenderingDevice_constant_BLEND_OP_MINIMUM: .. _class_RenderingDevice_constant_BLEND_OP_MAXIMUM: .. _class_RenderingDevice_constant_BLEND_OP_MAX: enum **BlendOperation**: - **BLEND_OP_ADD** = **0** - **BLEND_OP_SUBTRACT** = **1** - **BLEND_OP_REVERSE_SUBTRACT** = **2** - **BLEND_OP_MINIMUM** = **3** - **BLEND_OP_MAXIMUM** = **4** - **BLEND_OP_MAX** = **5** ---- .. _enum_RenderingDevice_PipelineDynamicStateFlags: .. _class_RenderingDevice_constant_DYNAMIC_STATE_LINE_WIDTH: .. _class_RenderingDevice_constant_DYNAMIC_STATE_DEPTH_BIAS: .. _class_RenderingDevice_constant_DYNAMIC_STATE_BLEND_CONSTANTS: .. _class_RenderingDevice_constant_DYNAMIC_STATE_DEPTH_BOUNDS: .. _class_RenderingDevice_constant_DYNAMIC_STATE_STENCIL_COMPARE_MASK: .. _class_RenderingDevice_constant_DYNAMIC_STATE_STENCIL_WRITE_MASK: .. _class_RenderingDevice_constant_DYNAMIC_STATE_STENCIL_REFERENCE: enum **PipelineDynamicStateFlags**: - **DYNAMIC_STATE_LINE_WIDTH** = **1** - **DYNAMIC_STATE_DEPTH_BIAS** = **2** - **DYNAMIC_STATE_BLEND_CONSTANTS** = **4** - **DYNAMIC_STATE_DEPTH_BOUNDS** = **8** - **DYNAMIC_STATE_STENCIL_COMPARE_MASK** = **16** - **DYNAMIC_STATE_STENCIL_WRITE_MASK** = **32** - **DYNAMIC_STATE_STENCIL_REFERENCE** = **64** ---- .. _enum_RenderingDevice_InitialAction: .. _class_RenderingDevice_constant_INITIAL_ACTION_CLEAR: .. _class_RenderingDevice_constant_INITIAL_ACTION_CLEAR_REGION: .. _class_RenderingDevice_constant_INITIAL_ACTION_CLEAR_REGION_CONTINUE: .. _class_RenderingDevice_constant_INITIAL_ACTION_KEEP: .. _class_RenderingDevice_constant_INITIAL_ACTION_DROP: .. _class_RenderingDevice_constant_INITIAL_ACTION_CONTINUE: .. _class_RenderingDevice_constant_INITIAL_ACTION_MAX: enum **InitialAction**: - **INITIAL_ACTION_CLEAR** = **0** - **INITIAL_ACTION_CLEAR_REGION** = **1** - **INITIAL_ACTION_CLEAR_REGION_CONTINUE** = **2** - **INITIAL_ACTION_KEEP** = **3** - **INITIAL_ACTION_DROP** = **4** - **INITIAL_ACTION_CONTINUE** = **5** - **INITIAL_ACTION_MAX** = **6** ---- .. _enum_RenderingDevice_FinalAction: .. _class_RenderingDevice_constant_FINAL_ACTION_READ: .. _class_RenderingDevice_constant_FINAL_ACTION_DISCARD: .. _class_RenderingDevice_constant_FINAL_ACTION_CONTINUE: .. _class_RenderingDevice_constant_FINAL_ACTION_MAX: enum **FinalAction**: - **FINAL_ACTION_READ** = **0** - **FINAL_ACTION_DISCARD** = **1** - **FINAL_ACTION_CONTINUE** = **2** - **FINAL_ACTION_MAX** = **3** ---- .. _enum_RenderingDevice_ShaderStage: .. _class_RenderingDevice_constant_SHADER_STAGE_VERTEX: .. _class_RenderingDevice_constant_SHADER_STAGE_FRAGMENT: .. _class_RenderingDevice_constant_SHADER_STAGE_TESSELATION_CONTROL: .. _class_RenderingDevice_constant_SHADER_STAGE_TESSELATION_EVALUATION: .. _class_RenderingDevice_constant_SHADER_STAGE_COMPUTE: .. _class_RenderingDevice_constant_SHADER_STAGE_MAX: .. _class_RenderingDevice_constant_SHADER_STAGE_VERTEX_BIT: .. _class_RenderingDevice_constant_SHADER_STAGE_FRAGMENT_BIT: .. _class_RenderingDevice_constant_SHADER_STAGE_TESSELATION_CONTROL_BIT: .. _class_RenderingDevice_constant_SHADER_STAGE_TESSELATION_EVALUATION_BIT: .. _class_RenderingDevice_constant_SHADER_STAGE_COMPUTE_BIT: enum **ShaderStage**: - **SHADER_STAGE_VERTEX** = **0** - **SHADER_STAGE_FRAGMENT** = **1** - **SHADER_STAGE_TESSELATION_CONTROL** = **2** - **SHADER_STAGE_TESSELATION_EVALUATION** = **3** - **SHADER_STAGE_COMPUTE** = **4** - **SHADER_STAGE_MAX** = **5** - **SHADER_STAGE_VERTEX_BIT** = **1** - **SHADER_STAGE_FRAGMENT_BIT** = **2** - **SHADER_STAGE_TESSELATION_CONTROL_BIT** = **4** - **SHADER_STAGE_TESSELATION_EVALUATION_BIT** = **8** - **SHADER_STAGE_COMPUTE_BIT** = **16** ---- .. _enum_RenderingDevice_ShaderLanguage: .. _class_RenderingDevice_constant_SHADER_LANGUAGE_GLSL: .. _class_RenderingDevice_constant_SHADER_LANGUAGE_HLSL: enum **ShaderLanguage**: - **SHADER_LANGUAGE_GLSL** = **0** - **SHADER_LANGUAGE_HLSL** = **1** ---- .. _enum_RenderingDevice_PipelineSpecializationConstantType: .. _class_RenderingDevice_constant_PIPELINE_SPECIALIZATION_CONSTANT_TYPE_BOOL: .. _class_RenderingDevice_constant_PIPELINE_SPECIALIZATION_CONSTANT_TYPE_INT: .. _class_RenderingDevice_constant_PIPELINE_SPECIALIZATION_CONSTANT_TYPE_FLOAT: enum **PipelineSpecializationConstantType**: - **PIPELINE_SPECIALIZATION_CONSTANT_TYPE_BOOL** = **0** - **PIPELINE_SPECIALIZATION_CONSTANT_TYPE_INT** = **1** - **PIPELINE_SPECIALIZATION_CONSTANT_TYPE_FLOAT** = **2** ---- .. _enum_RenderingDevice_Limit: .. _class_RenderingDevice_constant_LIMIT_MAX_BOUND_UNIFORM_SETS: .. _class_RenderingDevice_constant_LIMIT_MAX_FRAMEBUFFER_COLOR_ATTACHMENTS: .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURES_PER_UNIFORM_SET: .. _class_RenderingDevice_constant_LIMIT_MAX_SAMPLERS_PER_UNIFORM_SET: .. _class_RenderingDevice_constant_LIMIT_MAX_STORAGE_BUFFERS_PER_UNIFORM_SET: .. _class_RenderingDevice_constant_LIMIT_MAX_STORAGE_IMAGES_PER_UNIFORM_SET: .. _class_RenderingDevice_constant_LIMIT_MAX_UNIFORM_BUFFERS_PER_UNIFORM_SET: .. _class_RenderingDevice_constant_LIMIT_MAX_DRAW_INDEXED_INDEX: .. _class_RenderingDevice_constant_LIMIT_MAX_FRAMEBUFFER_HEIGHT: .. _class_RenderingDevice_constant_LIMIT_MAX_FRAMEBUFFER_WIDTH: .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURE_ARRAY_LAYERS: .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURE_SIZE_1D: .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURE_SIZE_2D: .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURE_SIZE_3D: .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURE_SIZE_CUBE: .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURES_PER_SHADER_STAGE: .. _class_RenderingDevice_constant_LIMIT_MAX_SAMPLERS_PER_SHADER_STAGE: .. _class_RenderingDevice_constant_LIMIT_MAX_STORAGE_BUFFERS_PER_SHADER_STAGE: .. _class_RenderingDevice_constant_LIMIT_MAX_STORAGE_IMAGES_PER_SHADER_STAGE: .. _class_RenderingDevice_constant_LIMIT_MAX_UNIFORM_BUFFERS_PER_SHADER_STAGE: .. _class_RenderingDevice_constant_LIMIT_MAX_PUSH_CONSTANT_SIZE: .. _class_RenderingDevice_constant_LIMIT_MAX_UNIFORM_BUFFER_SIZE: .. _class_RenderingDevice_constant_LIMIT_MAX_VERTEX_INPUT_ATTRIBUTE_OFFSET: .. _class_RenderingDevice_constant_LIMIT_MAX_VERTEX_INPUT_ATTRIBUTES: .. _class_RenderingDevice_constant_LIMIT_MAX_VERTEX_INPUT_BINDINGS: .. _class_RenderingDevice_constant_LIMIT_MAX_VERTEX_INPUT_BINDING_STRIDE: .. _class_RenderingDevice_constant_LIMIT_MIN_UNIFORM_BUFFER_OFFSET_ALIGNMENT: .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_SHARED_MEMORY_SIZE: .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_X: .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Y: .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Z: .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_INVOCATIONS: .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_X: .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Y: .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Z: enum **Limit**: - **LIMIT_MAX_BOUND_UNIFORM_SETS** = **0** - **LIMIT_MAX_FRAMEBUFFER_COLOR_ATTACHMENTS** = **1** - **LIMIT_MAX_TEXTURES_PER_UNIFORM_SET** = **2** - **LIMIT_MAX_SAMPLERS_PER_UNIFORM_SET** = **3** - **LIMIT_MAX_STORAGE_BUFFERS_PER_UNIFORM_SET** = **4** - **LIMIT_MAX_STORAGE_IMAGES_PER_UNIFORM_SET** = **5** - **LIMIT_MAX_UNIFORM_BUFFERS_PER_UNIFORM_SET** = **6** - **LIMIT_MAX_DRAW_INDEXED_INDEX** = **7** - **LIMIT_MAX_FRAMEBUFFER_HEIGHT** = **8** - **LIMIT_MAX_FRAMEBUFFER_WIDTH** = **9** - **LIMIT_MAX_TEXTURE_ARRAY_LAYERS** = **10** - **LIMIT_MAX_TEXTURE_SIZE_1D** = **11** - **LIMIT_MAX_TEXTURE_SIZE_2D** = **12** - **LIMIT_MAX_TEXTURE_SIZE_3D** = **13** - **LIMIT_MAX_TEXTURE_SIZE_CUBE** = **14** - **LIMIT_MAX_TEXTURES_PER_SHADER_STAGE** = **15** - **LIMIT_MAX_SAMPLERS_PER_SHADER_STAGE** = **16** - **LIMIT_MAX_STORAGE_BUFFERS_PER_SHADER_STAGE** = **17** - **LIMIT_MAX_STORAGE_IMAGES_PER_SHADER_STAGE** = **18** - **LIMIT_MAX_UNIFORM_BUFFERS_PER_SHADER_STAGE** = **19** - **LIMIT_MAX_PUSH_CONSTANT_SIZE** = **20** - **LIMIT_MAX_UNIFORM_BUFFER_SIZE** = **21** - **LIMIT_MAX_VERTEX_INPUT_ATTRIBUTE_OFFSET** = **22** - **LIMIT_MAX_VERTEX_INPUT_ATTRIBUTES** = **23** - **LIMIT_MAX_VERTEX_INPUT_BINDINGS** = **24** - **LIMIT_MAX_VERTEX_INPUT_BINDING_STRIDE** = **25** - **LIMIT_MIN_UNIFORM_BUFFER_OFFSET_ALIGNMENT** = **26** - **LIMIT_MAX_COMPUTE_SHARED_MEMORY_SIZE** = **27** - **LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_X** = **28** - **LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Y** = **29** - **LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Z** = **30** - **LIMIT_MAX_COMPUTE_WORKGROUP_INVOCATIONS** = **31** - **LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_X** = **32** - **LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Y** = **33** - **LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Z** = **34** ---- .. _enum_RenderingDevice_MemoryType: .. _class_RenderingDevice_constant_MEMORY_TEXTURES: .. _class_RenderingDevice_constant_MEMORY_BUFFERS: .. _class_RenderingDevice_constant_MEMORY_TOTAL: enum **MemoryType**: - **MEMORY_TEXTURES** = **0** - **MEMORY_BUFFERS** = **1** - **MEMORY_TOTAL** = **2** Constants --------- .. _class_RenderingDevice_constant_BARRIER_MASK_RASTER: .. _class_RenderingDevice_constant_BARRIER_MASK_COMPUTE: .. _class_RenderingDevice_constant_BARRIER_MASK_TRANSFER: .. _class_RenderingDevice_constant_BARRIER_MASK_ALL: .. _class_RenderingDevice_constant_BARRIER_MASK_NO_BARRIER: .. _class_RenderingDevice_constant_INVALID_ID: .. _class_RenderingDevice_constant_INVALID_FORMAT_ID: - **BARRIER_MASK_RASTER** = **1** - **BARRIER_MASK_COMPUTE** = **2** - **BARRIER_MASK_TRANSFER** = **4** - **BARRIER_MASK_ALL** = **7** - **BARRIER_MASK_NO_BARRIER** = **8** - **INVALID_ID** = **-1** - **INVALID_FORMAT_ID** = **-1** Method Descriptions ------------------- .. _class_RenderingDevice_method_barrier: - void **barrier** **(** :ref:`int` from=7, :ref:`int` to=7 **)** ---- .. _class_RenderingDevice_method_buffer_clear: - :ref:`Error` **buffer_clear** **(** :ref:`RID` buffer, :ref:`int` offset, :ref:`int` size_bytes, :ref:`int` post_barrier=7 **)** ---- .. _class_RenderingDevice_method_buffer_get_data: - :ref:`PackedByteArray` **buffer_get_data** **(** :ref:`RID` buffer **)** ---- .. _class_RenderingDevice_method_buffer_update: - :ref:`Error` **buffer_update** **(** :ref:`RID` buffer, :ref:`int` offset, :ref:`int` size_bytes, :ref:`PackedByteArray` data, :ref:`int` post_barrier=7 **)** ---- .. _class_RenderingDevice_method_capture_timestamp: - void **capture_timestamp** **(** :ref:`String` name **)** ---- .. _class_RenderingDevice_method_compute_list_add_barrier: - void **compute_list_add_barrier** **(** :ref:`int` compute_list **)** ---- .. _class_RenderingDevice_method_compute_list_begin: - :ref:`int` **compute_list_begin** **(** :ref:`bool` allow_draw_overlap=false **)** ---- .. _class_RenderingDevice_method_compute_list_bind_compute_pipeline: - void **compute_list_bind_compute_pipeline** **(** :ref:`int` compute_list, :ref:`RID` compute_pipeline **)** ---- .. _class_RenderingDevice_method_compute_list_bind_uniform_set: - void **compute_list_bind_uniform_set** **(** :ref:`int` compute_list, :ref:`RID` uniform_set, :ref:`int` set_index **)** ---- .. _class_RenderingDevice_method_compute_list_dispatch: - void **compute_list_dispatch** **(** :ref:`int` compute_list, :ref:`int` x_groups, :ref:`int` y_groups, :ref:`int` z_groups **)** ---- .. _class_RenderingDevice_method_compute_list_end: - void **compute_list_end** **(** :ref:`int` post_barrier=7 **)** ---- .. _class_RenderingDevice_method_compute_list_set_push_constant: - void **compute_list_set_push_constant** **(** :ref:`int` compute_list, :ref:`PackedByteArray` buffer, :ref:`int` size_bytes **)** ---- .. _class_RenderingDevice_method_compute_pipeline_create: - :ref:`RID` **compute_pipeline_create** **(** :ref:`RID` shader, :ref:`RDPipelineSpecializationConstant[]` specialization_constants=[] **)** ---- .. _class_RenderingDevice_method_compute_pipeline_is_valid: - :ref:`bool` **compute_pipeline_is_valid** **(** :ref:`RID` compute_pieline **)** ---- .. _class_RenderingDevice_method_create_local_device: - :ref:`RenderingDevice` **create_local_device** **(** **)** ---- .. _class_RenderingDevice_method_draw_command_begin_label: - void **draw_command_begin_label** **(** :ref:`String` name, :ref:`Color` color **)** ---- .. _class_RenderingDevice_method_draw_command_end_label: - void **draw_command_end_label** **(** **)** ---- .. _class_RenderingDevice_method_draw_command_insert_label: - void **draw_command_insert_label** **(** :ref:`String` name, :ref:`Color` color **)** ---- .. _class_RenderingDevice_method_draw_list_begin: - :ref:`int` **draw_list_begin** **(** :ref:`RID` framebuffer, :ref:`InitialAction` initial_color_action, :ref:`FinalAction` final_color_action, :ref:`InitialAction` initial_depth_action, :ref:`FinalAction` final_depth_action, :ref:`PackedColorArray` clear_color_values=PackedColorArray(), :ref:`float` clear_depth=1.0, :ref:`int` clear_stencil=0, :ref:`Rect2` region=Rect2(0, 0, 0, 0), :ref:`Array` storage_textures=[] **)** ---- .. _class_RenderingDevice_method_draw_list_begin_for_screen: - :ref:`int` **draw_list_begin_for_screen** **(** :ref:`int` screen=0, :ref:`Color` clear_color=Color(0, 0, 0, 1) **)** ---- .. _class_RenderingDevice_method_draw_list_begin_split: - :ref:`PackedInt64Array` **draw_list_begin_split** **(** :ref:`RID` framebuffer, :ref:`int` splits, :ref:`InitialAction` initial_color_action, :ref:`FinalAction` final_color_action, :ref:`InitialAction` initial_depth_action, :ref:`FinalAction` final_depth_action, :ref:`PackedColorArray` clear_color_values=PackedColorArray(), :ref:`float` clear_depth=1.0, :ref:`int` clear_stencil=0, :ref:`Rect2` region=Rect2(0, 0, 0, 0), :ref:`RID[]` storage_textures=[] **)** ---- .. _class_RenderingDevice_method_draw_list_bind_index_array: - void **draw_list_bind_index_array** **(** :ref:`int` draw_list, :ref:`RID` index_array **)** ---- .. _class_RenderingDevice_method_draw_list_bind_render_pipeline: - void **draw_list_bind_render_pipeline** **(** :ref:`int` draw_list, :ref:`RID` render_pipeline **)** ---- .. _class_RenderingDevice_method_draw_list_bind_uniform_set: - void **draw_list_bind_uniform_set** **(** :ref:`int` draw_list, :ref:`RID` uniform_set, :ref:`int` set_index **)** ---- .. _class_RenderingDevice_method_draw_list_bind_vertex_array: - void **draw_list_bind_vertex_array** **(** :ref:`int` draw_list, :ref:`RID` vertex_array **)** ---- .. _class_RenderingDevice_method_draw_list_disable_scissor: - void **draw_list_disable_scissor** **(** :ref:`int` draw_list **)** ---- .. _class_RenderingDevice_method_draw_list_draw: - void **draw_list_draw** **(** :ref:`int` draw_list, :ref:`bool` use_indices, :ref:`int` instances, :ref:`int` procedural_vertex_count=0 **)** ---- .. _class_RenderingDevice_method_draw_list_enable_scissor: - void **draw_list_enable_scissor** **(** :ref:`int` draw_list, :ref:`Rect2` rect=Rect2(0, 0, 0, 0) **)** ---- .. _class_RenderingDevice_method_draw_list_end: - void **draw_list_end** **(** :ref:`int` post_barrier=7 **)** ---- .. _class_RenderingDevice_method_draw_list_set_push_constant: - void **draw_list_set_push_constant** **(** :ref:`int` draw_list, :ref:`PackedByteArray` buffer, :ref:`int` size_bytes **)** ---- .. _class_RenderingDevice_method_draw_list_switch_to_next_pass: - :ref:`int` **draw_list_switch_to_next_pass** **(** **)** ---- .. _class_RenderingDevice_method_draw_list_switch_to_next_pass_split: - :ref:`PackedInt64Array` **draw_list_switch_to_next_pass_split** **(** :ref:`int` splits **)** ---- .. _class_RenderingDevice_method_framebuffer_create: - :ref:`RID` **framebuffer_create** **(** :ref:`RID[]` textures, :ref:`int` validate_with_format=-1, :ref:`int` view_count=1 **)** ---- .. _class_RenderingDevice_method_framebuffer_create_empty: - :ref:`RID` **framebuffer_create_empty** **(** :ref:`Vector2i` size, :ref:`TextureSamples` samples=0, :ref:`int` validate_with_format=-1 **)** ---- .. _class_RenderingDevice_method_framebuffer_create_multipass: - :ref:`RID` **framebuffer_create_multipass** **(** :ref:`RID[]` textures, :ref:`RDFramebufferPass[]` passes, :ref:`int` validate_with_format=-1, :ref:`int` view_count=1 **)** ---- .. _class_RenderingDevice_method_framebuffer_format_create: - :ref:`int` **framebuffer_format_create** **(** :ref:`RDAttachmentFormat[]` attachments, :ref:`int` view_count=1 **)** ---- .. _class_RenderingDevice_method_framebuffer_format_create_empty: - :ref:`int` **framebuffer_format_create_empty** **(** :ref:`TextureSamples` samples=0 **)** ---- .. _class_RenderingDevice_method_framebuffer_format_create_multipass: - :ref:`int` **framebuffer_format_create_multipass** **(** :ref:`RDAttachmentFormat[]` attachments, :ref:`RDFramebufferPass[]` passes, :ref:`int` view_count=1 **)** ---- .. _class_RenderingDevice_method_framebuffer_format_get_texture_samples: - :ref:`TextureSamples` **framebuffer_format_get_texture_samples** **(** :ref:`int` format, :ref:`int` render_pass=0 **)** ---- .. _class_RenderingDevice_method_framebuffer_get_format: - :ref:`int` **framebuffer_get_format** **(** :ref:`RID` framebuffer **)** ---- .. _class_RenderingDevice_method_free_rid: - void **free_rid** **(** :ref:`RID` rid **)** ---- .. _class_RenderingDevice_method_full_barrier: - void **full_barrier** **(** **)** ---- .. _class_RenderingDevice_method_get_captured_timestamp_cpu_time: - :ref:`int` **get_captured_timestamp_cpu_time** **(** :ref:`int` index **)** |const| ---- .. _class_RenderingDevice_method_get_captured_timestamp_gpu_time: - :ref:`int` **get_captured_timestamp_gpu_time** **(** :ref:`int` index **)** |const| ---- .. _class_RenderingDevice_method_get_captured_timestamp_name: - :ref:`String` **get_captured_timestamp_name** **(** :ref:`int` index **)** |const| ---- .. _class_RenderingDevice_method_get_captured_timestamps_count: - :ref:`int` **get_captured_timestamps_count** **(** **)** |const| ---- .. _class_RenderingDevice_method_get_captured_timestamps_frame: - :ref:`int` **get_captured_timestamps_frame** **(** **)** |const| ---- .. _class_RenderingDevice_method_get_device_name: - :ref:`String` **get_device_name** **(** **)** |const| ---- .. _class_RenderingDevice_method_get_device_pipeline_cache_uuid: - :ref:`String` **get_device_pipeline_cache_uuid** **(** **)** |const| ---- .. _class_RenderingDevice_method_get_device_vendor_name: - :ref:`String` **get_device_vendor_name** **(** **)** |const| ---- .. _class_RenderingDevice_method_get_driver_resource: - :ref:`int` **get_driver_resource** **(** :ref:`DriverResource` resource, :ref:`RID` rid, :ref:`int` index **)** ---- .. _class_RenderingDevice_method_get_frame_delay: - :ref:`int` **get_frame_delay** **(** **)** |const| ---- .. _class_RenderingDevice_method_get_memory_usage: - :ref:`int` **get_memory_usage** **(** :ref:`MemoryType` type **)** |const| ---- .. _class_RenderingDevice_method_index_array_create: - :ref:`RID` **index_array_create** **(** :ref:`RID` index_buffer, :ref:`int` index_offset, :ref:`int` index_count **)** ---- .. _class_RenderingDevice_method_index_buffer_create: - :ref:`RID` **index_buffer_create** **(** :ref:`int` size_indices, :ref:`IndexBufferFormat` format, :ref:`PackedByteArray` data=PackedByteArray(), :ref:`bool` use_restart_indices=false **)** ---- .. _class_RenderingDevice_method_limit_get: - :ref:`int` **limit_get** **(** :ref:`Limit` limit **)** ---- .. _class_RenderingDevice_method_render_pipeline_create: - :ref:`RID` **render_pipeline_create** **(** :ref:`RID` shader, :ref:`int` framebuffer_format, :ref:`int` vertex_format, :ref:`RenderPrimitive` primitive, :ref:`RDPipelineRasterizationState` rasterization_state, :ref:`RDPipelineMultisampleState` multisample_state, :ref:`RDPipelineDepthStencilState` stencil_state, :ref:`RDPipelineColorBlendState` color_blend_state, :ref:`int` dynamic_state_flags=0, :ref:`int` for_render_pass=0, :ref:`RDPipelineSpecializationConstant[]` specialization_constants=[] **)** ---- .. _class_RenderingDevice_method_render_pipeline_is_valid: - :ref:`bool` **render_pipeline_is_valid** **(** :ref:`RID` render_pipeline **)** ---- .. _class_RenderingDevice_method_sampler_create: - :ref:`RID` **sampler_create** **(** :ref:`RDSamplerState` state **)** ---- .. _class_RenderingDevice_method_screen_get_framebuffer_format: - :ref:`int` **screen_get_framebuffer_format** **(** **)** |const| ---- .. _class_RenderingDevice_method_screen_get_height: - :ref:`int` **screen_get_height** **(** :ref:`int` screen=0 **)** |const| ---- .. _class_RenderingDevice_method_screen_get_width: - :ref:`int` **screen_get_width** **(** :ref:`int` screen=0 **)** |const| ---- .. _class_RenderingDevice_method_set_resource_name: - void **set_resource_name** **(** :ref:`RID` id, :ref:`String` name **)** ---- .. _class_RenderingDevice_method_shader_compile_binary_from_spirv: - :ref:`PackedByteArray` **shader_compile_binary_from_spirv** **(** :ref:`RDShaderSPIRV` spirv_data, :ref:`String` name="" **)** ---- .. _class_RenderingDevice_method_shader_compile_spirv_from_source: - :ref:`RDShaderSPIRV` **shader_compile_spirv_from_source** **(** :ref:`RDShaderSource` shader_source, :ref:`bool` allow_cache=true **)** ---- .. _class_RenderingDevice_method_shader_create_from_bytecode: - :ref:`RID` **shader_create_from_bytecode** **(** :ref:`PackedByteArray` binary_data **)** ---- .. _class_RenderingDevice_method_shader_create_from_spirv: - :ref:`RID` **shader_create_from_spirv** **(** :ref:`RDShaderSPIRV` spirv_data, :ref:`String` name="" **)** ---- .. _class_RenderingDevice_method_shader_get_vertex_input_attribute_mask: - :ref:`int` **shader_get_vertex_input_attribute_mask** **(** :ref:`RID` shader **)** ---- .. _class_RenderingDevice_method_storage_buffer_create: - :ref:`RID` **storage_buffer_create** **(** :ref:`int` size_bytes, :ref:`PackedByteArray` data=PackedByteArray(), :ref:`int` usage=0 **)** ---- .. _class_RenderingDevice_method_submit: - void **submit** **(** **)** ---- .. _class_RenderingDevice_method_sync: - void **sync** **(** **)** ---- .. _class_RenderingDevice_method_texture_buffer_create: - :ref:`RID` **texture_buffer_create** **(** :ref:`int` size_bytes, :ref:`DataFormat` format, :ref:`PackedByteArray` data=PackedByteArray() **)** ---- .. _class_RenderingDevice_method_texture_clear: - :ref:`Error` **texture_clear** **(** :ref:`RID` texture, :ref:`Color` color, :ref:`int` base_mipmap, :ref:`int` mipmap_count, :ref:`int` base_layer, :ref:`int` layer_count, :ref:`int` post_barrier=7 **)** ---- .. _class_RenderingDevice_method_texture_copy: - :ref:`Error` **texture_copy** **(** :ref:`RID` from_texture, :ref:`RID` to_texture, :ref:`Vector3` from_pos, :ref:`Vector3` to_pos, :ref:`Vector3` size, :ref:`int` src_mipmap, :ref:`int` dst_mipmap, :ref:`int` src_layer, :ref:`int` dst_layer, :ref:`int` post_barrier=7 **)** ---- .. _class_RenderingDevice_method_texture_create: - :ref:`RID` **texture_create** **(** :ref:`RDTextureFormat` format, :ref:`RDTextureView` view, :ref:`PackedByteArray[]` data=[] **)** ---- .. _class_RenderingDevice_method_texture_create_shared: - :ref:`RID` **texture_create_shared** **(** :ref:`RDTextureView` view, :ref:`RID` with_texture **)** ---- .. _class_RenderingDevice_method_texture_create_shared_from_slice: - :ref:`RID` **texture_create_shared_from_slice** **(** :ref:`RDTextureView` view, :ref:`RID` with_texture, :ref:`int` layer, :ref:`int` mipmap, :ref:`int` mipmaps=1, :ref:`TextureSliceType` slice_type=0 **)** ---- .. _class_RenderingDevice_method_texture_get_data: - :ref:`PackedByteArray` **texture_get_data** **(** :ref:`RID` texture, :ref:`int` layer **)** ---- .. _class_RenderingDevice_method_texture_is_format_supported_for_usage: - :ref:`bool` **texture_is_format_supported_for_usage** **(** :ref:`DataFormat` format, :ref:`int` usage_flags **)** |const| ---- .. _class_RenderingDevice_method_texture_is_shared: - :ref:`bool` **texture_is_shared** **(** :ref:`RID` texture **)** ---- .. _class_RenderingDevice_method_texture_is_valid: - :ref:`bool` **texture_is_valid** **(** :ref:`RID` texture **)** ---- .. _class_RenderingDevice_method_texture_resolve_multisample: - :ref:`Error` **texture_resolve_multisample** **(** :ref:`RID` from_texture, :ref:`RID` to_texture, :ref:`int` post_barrier=7 **)** ---- .. _class_RenderingDevice_method_texture_update: - :ref:`Error` **texture_update** **(** :ref:`RID` texture, :ref:`int` layer, :ref:`PackedByteArray` data, :ref:`int` post_barrier=7 **)** ---- .. _class_RenderingDevice_method_uniform_buffer_create: - :ref:`RID` **uniform_buffer_create** **(** :ref:`int` size_bytes, :ref:`PackedByteArray` data=PackedByteArray() **)** ---- .. _class_RenderingDevice_method_uniform_set_create: - :ref:`RID` **uniform_set_create** **(** :ref:`Array` uniforms, :ref:`RID` shader, :ref:`int` shader_set **)** ---- .. _class_RenderingDevice_method_uniform_set_is_valid: - :ref:`bool` **uniform_set_is_valid** **(** :ref:`RID` uniform_set **)** ---- .. _class_RenderingDevice_method_vertex_buffer_create: - :ref:`RID` **vertex_buffer_create** **(** :ref:`int` size_bytes, :ref:`PackedByteArray` data=PackedByteArray(), :ref:`bool` use_as_storage=false **)** ---- .. _class_RenderingDevice_method_vertex_format_create: - :ref:`int` **vertex_format_create** **(** :ref:`RDVertexAttribute[]` vertex_descriptions **)** .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`