Inheritance #
- AudioServer
- CameraServer
- ClassDB
- DisplayServer
- EditorFileSystemDirectory
- EditorInterface
- EditorPaths
- EditorSelection
- EditorUndoRedoManager
- EditorVCSInterface
- Engine
- EngineDebugger
- FramebufferCacheRD
- GDExtensionManager
- Geometry2D
- Geometry3D
- IP
- Input
- InputMap
- JNISingleton
- JSONRPC
- JavaClassWrapper
- JavaScriptBridge
- MainLoop (1)
- Marshalls
- MovieWriter
- NativeMenu
- NavigationMeshGenerator
- NavigationServer2D
- NavigationServer3D
- Node (21)
- OS
- OpenXRExtensionWrapperExtension
- OpenXRInteractionProfileMetadata
- Performance
- PhysicsDirectBodyState2D (1)
- PhysicsDirectBodyState3D (1)
- PhysicsDirectSpaceState2D (1)
- PhysicsDirectSpaceState3D (1)
- PhysicsServer2D (1)
- PhysicsServer2DManager
- PhysicsServer3D (1)
- PhysicsServer3DManager
- PhysicsServer3DRendering
ServerHandler
- ProjectSettings
- RefCounted (121)
- RenderData (2)
- RenderSceneData (2)
- RenderingDevice
- RenderingServer
- ResourceLoader
- ResourceSaver
- ResourceUID
- ScriptLanguage (1)
- ShaderIncludeDB
- TextServerManager
- ThemeDB
- TileData
- Time
- TranslationServer
- TreeItem
- UndoRedo
- UniformSetCacheRD
- WorkerThreadPool
- XRServer
- XRVRS
Table of contents
-
func barrier(to: int = 32767 enumRenderingDevice.BarrierMask) -> void -
func buffer_clear(size_bytes: int) -> intError -
func buffer_copy(size: int) -> intError -
func buffer_get_data(size_bytes: int = 0) -> PackedByteArray -
func buffer_get_data_async(size_bytes: int = 0) -> intError -
func buffer_get_device_address(buffer: RID) -> int -
func buffer_update(data: PackedByteArray) -> intError -
func capture_timestamp(name: String) -> void -
func compute_list_add_barrier(compute_list: int) -> void -
func compute_list_begin() -> int -
func compute_list_bind_compute_pipeline(compute_pipeline: RID) -> void -
func compute_list_bind_uniform_set(set_index: int) -> void -
func compute_list_dispatch(z_groups: int) -> void -
func compute_list_dispatch_indirect(offset: int) -> void -
func compute_list_end() -> void -
func compute_list_set_push_constant(size_bytes: int) -> void -
func compute_pipeline_create(specialization_constants: RDPipelineSpecializationConstant[] = []) -> RID -
func compute_pipeline_is_valid(compute_pipeline: RID) -> bool -
func create_local_device() -> RenderingDevice -
func draw_command_begin_label(color: Color) -> void -
func draw_command_end_label() -> void -
func draw_command_insert_label(color: Color) -> void -
func draw_list_begin(breadcrumb: int = 0) -> int -
func draw_list_begin_for_screen(clear_color: Color = Color(0, 0, 0, 1)) -> int -
func draw_list_begin_split(storage_textures: RID[] = []) -> PackedInt64Array -
func draw_list_bind_index_array(index_array: RID) -> void -
func draw_list_bind_render_pipeline(render_pipeline: RID) -> void -
func draw_list_bind_uniform_set(set_index: int) -> void -
func draw_list_bind_vertex_array(vertex_array: RID) -> void -
func draw_list_disable_scissor(draw_list: int) -> void -
func draw_list_draw(procedural_vertex_count: int = 0) -> void -
func draw_list_draw_indirect(stride: int = 0) -> void -
func draw_list_enable_scissor(rect: Rect2 = Rect2(0, 0, 0, 0)) -> void -
func draw_list_end() -> void -
func draw_list_set_blend_constants(color: Color) -> void -
func draw_list_set_push_constant(size_bytes: int) -> void -
func draw_list_switch_to_next_pass() -> int -
func draw_list_switch_to_next_pass_split(splits: int) -> PackedInt64Array -
func framebuffer_create(view_count: int = 1) -> RID -
func framebuffer_create_empty(validate_with_format: int = -1) -> RID -
func framebuffer_create_multipass(view_count: int = 1) -> RID -
func framebuffer_format_create(view_count: int = 1) -> int -
func framebuffer_format_create_empty(samples: int = 0 enumRenderingDevice.TextureSamples) -> int -
func framebuffer_format_create_multipass(view_count: int = 1) -> int -
func framebuffer_format_get_texture_samples(render_pass: int = 0) -> intRenderingDevice.TextureSamples -
func framebuffer_get_format(framebuffer: RID) -> int -
const func framebuffer_is_valid(framebuffer: RID) -> bool -
func free_rid(rid: RID) -> void -
func full_barrier() -> void -
const func get_captured_timestamp_cpu_time(index: int) -> int -
const func get_captured_timestamp_gpu_time(index: int) -> int -
const func get_captured_timestamp_name(index: int) -> String -
const func get_captured_timestamps_count() -> int -
const func get_captured_timestamps_frame() -> int -
const func get_device_allocation_count() -> int -
const func get_device_allocs_by_object_type(type: int) -> int -
const func get_device_memory_by_object_type(type: int) -> int -
const func get_device_name() -> String -
const func get_device_pipeline_cache_uuid() -> String -
const func get_device_total_memory() -> int -
const func get_device_vendor_name() -> String -
const func get_driver_allocation_count() -> int -
const func get_driver_allocs_by_object_type(type: int) -> int -
const func get_driver_and_device_memory_report() -> String -
const func get_driver_memory_by_object_type(type: int) -> int -
func get_driver_resource(index: int) -> int -
const func get_driver_total_memory() -> int -
const func get_frame_delay() -> int -
const func get_memory_usage(type: int enumRenderingDevice.MemoryType) -> int -
const func get_perf_report() -> String -
const func get_tracked_object_name(type_index: int) -> String -
const func get_tracked_object_type_count() -> int -
const func has_feature(feature: int enumRenderingDevice.Features) -> bool -
func index_array_create(index_count: int) -> RID -
func index_buffer_create(creation_bits: int = 0 enumRenderingDevice.BufferCreationBits) -> RID -
const func limit_get(limit: int enumRenderingDevice.Limit) -> int -
func render_pipeline_create(specialization_constants: RDPipelineSpecializationConstant[] = []) -> RID -
func render_pipeline_is_valid(render_pipeline: RID) -> bool -
func sampler_create(state: RDSamplerState) -> RID -
const func sampler_is_format_supported_for_filter(sampler_filter: int enumRenderingDevice.SamplerFilter) -> bool -
const func screen_get_framebuffer_format(screen: int = 0) -> int -
const func screen_get_height(screen: int = 0) -> int -
const func screen_get_width(screen: int = 0) -> int -
func set_resource_name(name: String) -> void -
func shader_compile_binary_from_spirv(name: String = "") -> PackedByteArray -
func shader_compile_spirv_from_source(allow_cache: bool = true) -> RDShaderSPIRV -
func shader_create_from_bytecode(placeholder_rid: RID = RID()) -> RID -
func shader_create_from_spirv(name: String = "") -> RID -
func shader_create_placeholder() -> RID -
func shader_get_vertex_input_attribute_mask(shader: RID) -> int -
func storage_buffer_create(creation_bits: int = 0 enumRenderingDevice.BufferCreationBits) -> RID -
func submit() -> void -
func sync() -> void -
func texture_buffer_create(data: PackedByteArray = PackedByteArray()) -> RID -
func texture_clear(layer_count: int) -> intError -
func texture_copy(dst_layer: int) -> intError -
func texture_create(data: PackedByteArray[] = []) -> RID -
func texture_create_from_extension(layers: int) -> RID -
func texture_create_shared(with_texture: RID) -> RID -
func texture_create_shared_from_slice(slice_type: int = 0 enumRenderingDevice.TextureSliceType) -> RID -
func texture_get_data(layer: int) -> PackedByteArray -
func texture_get_data_async(callback: Callable) -> intError -
func texture_get_format(texture: RID) -> RDTextureFormat -
func texture_get_native_handle(texture: RID) -> int -
func texture_is_discardable(texture: RID) -> bool -
const func texture_is_format_supported_for_usage(usage_flags: int enumRenderingDevice.TextureUsageBits) -> bool -
func texture_is_shared(texture: RID) -> bool -
func texture_is_valid(texture: RID) -> bool -
func texture_resolve_multisample(to_texture: RID) -> intError -
func texture_set_discardable(discardable: bool) -> void -
func texture_update(data: PackedByteArray) -> intError -
func uniform_buffer_create(creation_bits: int = 0 enumRenderingDevice.BufferCreationBits) -> RID -
func uniform_set_create(shader_set: int) -> RID -
func uniform_set_is_valid(uniform_set: RID) -> bool -
func vertex_array_create(offsets: PackedInt64Array = PackedInt64Array()) -> RID -
func vertex_buffer_create(creation_bits: int = 0 enumRenderingDevice.BufferCreationBits) -> RID -
func vertex_format_create(vertex_descriptions: RDVertexAttribute[]) -> int -
const DEVICE_TYPE_OTHER = 0 enum DeviceType -
const DEVICE_TYPE_INTEGRATED_GPU = 1 enum DeviceType -
const DEVICE_TYPE_DISCRETE_GPU = 2 enum DeviceType -
const DEVICE_TYPE_VIRTUAL_GPU = 3 enum DeviceType -
const DEVICE_TYPE_CPU = 4 enum DeviceType -
const DEVICE_TYPE_MAX = 5 enum DeviceType -
const DRIVER_RESOURCE_LOGICAL_DEVICE = 0 enum DriverResource -
const DRIVER_RESOURCE_PHYSICAL_DEVICE = 1 enum DriverResource -
const DRIVER_RESOURCE_TOPMOST_OBJECT = 2 enum DriverResource -
const DRIVER_RESOURCE_COMMAND_QUEUE = 3 enum DriverResource -
const DRIVER_RESOURCE_QUEUE_FAMILY = 4 enum DriverResource -
const DRIVER_RESOURCE_TEXTURE = 5 enum DriverResource -
const DRIVER_RESOURCE_TEXTURE_VIEW = 6 enum DriverResource -
const DRIVER_RESOURCE_TEXTURE_DATA_FORMAT = 7 enum DriverResource -
const DRIVER_RESOURCE_SAMPLER = 8 enum DriverResource -
const DRIVER_RESOURCE_UNIFORM_SET = 9 enum DriverResource -
const DRIVER_RESOURCE_BUFFER = 10 enum DriverResource -
const DRIVER_RESOURCE_COMPUTE_PIPELINE = 11 enum DriverResource -
const DRIVER_RESOURCE_RENDER_PIPELINE = 12 enum DriverResource -
const DRIVER_RESOURCE_VULKAN_DEVICE = 0 enum DriverResourceDeprecated -
const DRIVER_RESOURCE_VULKAN_PHYSICAL_DEVICE = 1 enum DriverResourceDeprecated -
const DRIVER_RESOURCE_VULKAN_INSTANCE = 2 enum DriverResourceDeprecated -
const DRIVER_RESOURCE_VULKAN_QUEUE = 3 enum DriverResourceDeprecated -
const DRIVER_RESOURCE_VULKAN_QUEUE_FAMILY_INDEX = 4 enum DriverResourceDeprecated -
const DRIVER_RESOURCE_VULKAN_IMAGE = 5 enum DriverResourceDeprecated -
const DRIVER_RESOURCE_VULKAN_IMAGE_VIEW = 6 enum DriverResourceDeprecated -
const DRIVER_RESOURCE_VULKAN_IMAGE_NATIVE_TEXTURE_FORMAT = 7 enum DriverResourceDeprecated -
const DRIVER_RESOURCE_VULKAN_SAMPLER = 8 enum DriverResourceDeprecated -
const DRIVER_RESOURCE_VULKAN_DESCRIPTOR_SET = 9 enum DriverResourceDeprecated -
const DRIVER_RESOURCE_VULKAN_BUFFER = 10 enum DriverResourceDeprecated -
const DRIVER_RESOURCE_VULKAN_COMPUTE_PIPELINE = 11 enum DriverResourceDeprecated -
const DRIVER_RESOURCE_VULKAN_RENDER_PIPELINE = 12 enum DriverResourceDeprecated -
const DATA_FORMAT_R4G4_UNORM_PACK8 = 0 enum DataFormat -
const DATA_FORMAT_R4G4B4A4_UNORM_PACK16 = 1 enum DataFormat -
const DATA_FORMAT_B4G4R4A4_UNORM_PACK16 = 2 enum DataFormat -
const DATA_FORMAT_R5G6B5_UNORM_PACK16 = 3 enum DataFormat -
const DATA_FORMAT_B5G6R5_UNORM_PACK16 = 4 enum DataFormat -
const DATA_FORMAT_R5G5B5A1_UNORM_PACK16 = 5 enum DataFormat -
const DATA_FORMAT_B5G5R5A1_UNORM_PACK16 = 6 enum DataFormat -
const DATA_FORMAT_A1R5G5B5_UNORM_PACK16 = 7 enum DataFormat -
const DATA_FORMAT_R8_UNORM = 8 enum DataFormat -
const DATA_FORMAT_R8_SNORM = 9 enum DataFormat -
const DATA_FORMAT_R8_USCALED = 10 enum DataFormat -
const DATA_FORMAT_R8_SSCALED = 11 enum DataFormat -
const DATA_FORMAT_R8_UINT = 12 enum DataFormat -
const DATA_FORMAT_R8_SINT = 13 enum DataFormat -
const DATA_FORMAT_R8_SRGB = 14 enum DataFormat -
const DATA_FORMAT_R8G8_UNORM = 15 enum DataFormat -
const DATA_FORMAT_R8G8_SNORM = 16 enum DataFormat -
const DATA_FORMAT_R8G8_USCALED = 17 enum DataFormat -
const DATA_FORMAT_R8G8_SSCALED = 18 enum DataFormat -
const DATA_FORMAT_R8G8_UINT = 19 enum DataFormat -
const DATA_FORMAT_R8G8_SINT = 20 enum DataFormat -
const DATA_FORMAT_R8G8_SRGB = 21 enum DataFormat -
const DATA_FORMAT_R8G8B8_UNORM = 22 enum DataFormat -
const DATA_FORMAT_R8G8B8_SNORM = 23 enum DataFormat -
const DATA_FORMAT_R8G8B8_USCALED = 24 enum DataFormat -
const DATA_FORMAT_R8G8B8_SSCALED = 25 enum DataFormat -
const DATA_FORMAT_R8G8B8_UINT = 26 enum DataFormat -
const DATA_FORMAT_R8G8B8_SINT = 27 enum DataFormat -
const DATA_FORMAT_R8G8B8_SRGB = 28 enum DataFormat -
const DATA_FORMAT_B8G8R8_UNORM = 29 enum DataFormat -
const DATA_FORMAT_B8G8R8_SNORM = 30 enum DataFormat -
const DATA_FORMAT_B8G8R8_USCALED = 31 enum DataFormat -
const DATA_FORMAT_B8G8R8_SSCALED = 32 enum DataFormat -
const DATA_FORMAT_B8G8R8_UINT = 33 enum DataFormat -
const DATA_FORMAT_B8G8R8_SINT = 34 enum DataFormat -
const DATA_FORMAT_B8G8R8_SRGB = 35 enum DataFormat -
const DATA_FORMAT_R8G8B8A8_UNORM = 36 enum DataFormat -
const DATA_FORMAT_R8G8B8A8_SNORM = 37 enum DataFormat -
const DATA_FORMAT_R8G8B8A8_USCALED = 38 enum DataFormat -
const DATA_FORMAT_R8G8B8A8_SSCALED = 39 enum DataFormat -
const DATA_FORMAT_R8G8B8A8_UINT = 40 enum DataFormat -
const DATA_FORMAT_R8G8B8A8_SINT = 41 enum DataFormat -
const DATA_FORMAT_R8G8B8A8_SRGB = 42 enum DataFormat -
const DATA_FORMAT_B8G8R8A8_UNORM = 43 enum DataFormat -
const DATA_FORMAT_B8G8R8A8_SNORM = 44 enum DataFormat -
const DATA_FORMAT_B8G8R8A8_USCALED = 45 enum DataFormat -
const DATA_FORMAT_B8G8R8A8_SSCALED = 46 enum DataFormat -
const DATA_FORMAT_B8G8R8A8_UINT = 47 enum DataFormat -
const DATA_FORMAT_B8G8R8A8_SINT = 48 enum DataFormat -
const DATA_FORMAT_B8G8R8A8_SRGB = 49 enum DataFormat -
const DATA_FORMAT_A8B8G8R8_UNORM_PACK32 = 50 enum DataFormat -
const DATA_FORMAT_A8B8G8R8_SNORM_PACK32 = 51 enum DataFormat -
const DATA_FORMAT_A8B8G8R8_USCALED_PACK32 = 52 enum DataFormat -
const DATA_FORMAT_A8B8G8R8_SSCALED_PACK32 = 53 enum DataFormat -
const DATA_FORMAT_A8B8G8R8_UINT_PACK32 = 54 enum DataFormat -
const DATA_FORMAT_A8B8G8R8_SINT_PACK32 = 55 enum DataFormat -
const DATA_FORMAT_A8B8G8R8_SRGB_PACK32 = 56 enum DataFormat -
const DATA_FORMAT_A2R10G10B10_UNORM_PACK32 = 57 enum DataFormat -
const DATA_FORMAT_A2R10G10B10_SNORM_PACK32 = 58 enum DataFormat -
const DATA_FORMAT_A2R10G10B10_USCALED_PACK32 = 59 enum DataFormat -
const DATA_FORMAT_A2R10G10B10_SSCALED_PACK32 = 60 enum DataFormat -
const DATA_FORMAT_A2R10G10B10_UINT_PACK32 = 61 enum DataFormat -
const DATA_FORMAT_A2R10G10B10_SINT_PACK32 = 62 enum DataFormat -
const DATA_FORMAT_A2B10G10R10_UNORM_PACK32 = 63 enum DataFormat -
const DATA_FORMAT_A2B10G10R10_SNORM_PACK32 = 64 enum DataFormat -
const DATA_FORMAT_A2B10G10R10_USCALED_PACK32 = 65 enum DataFormat -
const DATA_FORMAT_A2B10G10R10_SSCALED_PACK32 = 66 enum DataFormat -
const DATA_FORMAT_A2B10G10R10_UINT_PACK32 = 67 enum DataFormat -
const DATA_FORMAT_A2B10G10R10_SINT_PACK32 = 68 enum DataFormat -
const DATA_FORMAT_R16_UNORM = 69 enum DataFormat -
const DATA_FORMAT_R16_SNORM = 70 enum DataFormat -
const DATA_FORMAT_R16_USCALED = 71 enum DataFormat -
const DATA_FORMAT_R16_SSCALED = 72 enum DataFormat -
const DATA_FORMAT_R16_UINT = 73 enum DataFormat -
const DATA_FORMAT_R16_SINT = 74 enum DataFormat -
const DATA_FORMAT_R16_SFLOAT = 75 enum DataFormat -
const DATA_FORMAT_R16G16_UNORM = 76 enum DataFormat -
const DATA_FORMAT_R16G16_SNORM = 77 enum DataFormat -
const DATA_FORMAT_R16G16_USCALED = 78 enum DataFormat -
const DATA_FORMAT_R16G16_SSCALED = 79 enum DataFormat -
const DATA_FORMAT_R16G16_UINT = 80 enum DataFormat -
const DATA_FORMAT_R16G16_SINT = 81 enum DataFormat -
const DATA_FORMAT_R16G16_SFLOAT = 82 enum DataFormat -
const DATA_FORMAT_R16G16B16_UNORM = 83 enum DataFormat -
const DATA_FORMAT_R16G16B16_SNORM = 84 enum DataFormat -
const DATA_FORMAT_R16G16B16_USCALED = 85 enum DataFormat -
const DATA_FORMAT_R16G16B16_SSCALED = 86 enum DataFormat -
const DATA_FORMAT_R16G16B16_UINT = 87 enum DataFormat -
const DATA_FORMAT_R16G16B16_SINT = 88 enum DataFormat -
const DATA_FORMAT_R16G16B16_SFLOAT = 89 enum DataFormat -
const DATA_FORMAT_R16G16B16A16_UNORM = 90 enum DataFormat -
const DATA_FORMAT_R16G16B16A16_SNORM = 91 enum DataFormat -
const DATA_FORMAT_R16G16B16A16_USCALED = 92 enum DataFormat -
const DATA_FORMAT_R16G16B16A16_SSCALED = 93 enum DataFormat -
const DATA_FORMAT_R16G16B16A16_UINT = 94 enum DataFormat -
const DATA_FORMAT_R16G16B16A16_SINT = 95 enum DataFormat -
const DATA_FORMAT_R16G16B16A16_SFLOAT = 96 enum DataFormat -
const DATA_FORMAT_R32_UINT = 97 enum DataFormat -
const DATA_FORMAT_R32_SINT = 98 enum DataFormat -
const DATA_FORMAT_R32_SFLOAT = 99 enum DataFormat -
const DATA_FORMAT_R32G32_UINT = 100 enum DataFormat -
const DATA_FORMAT_R32G32_SINT = 101 enum DataFormat -
const DATA_FORMAT_R32G32_SFLOAT = 102 enum DataFormat -
const DATA_FORMAT_R32G32B32_UINT = 103 enum DataFormat -
const DATA_FORMAT_R32G32B32_SINT = 104 enum DataFormat -
const DATA_FORMAT_R32G32B32_SFLOAT = 105 enum DataFormat -
const DATA_FORMAT_R32G32B32A32_UINT = 106 enum DataFormat -
const DATA_FORMAT_R32G32B32A32_SINT = 107 enum DataFormat -
const DATA_FORMAT_R32G32B32A32_SFLOAT = 108 enum DataFormat -
const DATA_FORMAT_R64_UINT = 109 enum DataFormat -
const DATA_FORMAT_R64_SINT = 110 enum DataFormat -
const DATA_FORMAT_R64_SFLOAT = 111 enum DataFormat -
const DATA_FORMAT_R64G64_UINT = 112 enum DataFormat -
const DATA_FORMAT_R64G64_SINT = 113 enum DataFormat -
const DATA_FORMAT_R64G64_SFLOAT = 114 enum DataFormat -
const DATA_FORMAT_R64G64B64_UINT = 115 enum DataFormat -
const DATA_FORMAT_R64G64B64_SINT = 116 enum DataFormat -
const DATA_FORMAT_R64G64B64_SFLOAT = 117 enum DataFormat -
const DATA_FORMAT_R64G64B64A64_UINT = 118 enum DataFormat -
const DATA_FORMAT_R64G64B64A64_SINT = 119 enum DataFormat -
const DATA_FORMAT_R64G64B64A64_SFLOAT = 120 enum DataFormat -
const DATA_FORMAT_B10G11R11_UFLOAT_PACK32 = 121 enum DataFormat -
const DATA_FORMAT_E5B9G9R9_UFLOAT_PACK32 = 122 enum DataFormat -
const DATA_FORMAT_D16_UNORM = 123 enum DataFormat -
const DATA_FORMAT_X8_D24_UNORM_PACK32 = 124 enum DataFormat -
const DATA_FORMAT_D32_SFLOAT = 125 enum DataFormat -
const DATA_FORMAT_S8_UINT = 126 enum DataFormat -
const DATA_FORMAT_D16_UNORM_S8_UINT = 127 enum DataFormat -
const DATA_FORMAT_D24_UNORM_S8_UINT = 128 enum DataFormat -
const DATA_FORMAT_D32_SFLOAT_S8_UINT = 129 enum DataFormat -
const DATA_FORMAT_BC1_RGB_UNORM_BLOCK = 130 enum DataFormat -
const DATA_FORMAT_BC1_RGB_SRGB_BLOCK = 131 enum DataFormat -
const DATA_FORMAT_BC1_RGBA_UNORM_BLOCK = 132 enum DataFormat -
const DATA_FORMAT_BC1_RGBA_SRGB_BLOCK = 133 enum DataFormat -
const DATA_FORMAT_BC2_UNORM_BLOCK = 134 enum DataFormat -
const DATA_FORMAT_BC2_SRGB_BLOCK = 135 enum DataFormat -
const DATA_FORMAT_BC3_UNORM_BLOCK = 136 enum DataFormat -
const DATA_FORMAT_BC3_SRGB_BLOCK = 137 enum DataFormat -
const DATA_FORMAT_BC4_UNORM_BLOCK = 138 enum DataFormat -
const DATA_FORMAT_BC4_SNORM_BLOCK = 139 enum DataFormat -
const DATA_FORMAT_BC5_UNORM_BLOCK = 140 enum DataFormat -
const DATA_FORMAT_BC5_SNORM_BLOCK = 141 enum DataFormat -
const DATA_FORMAT_BC6H_UFLOAT_BLOCK = 142 enum DataFormat -
const DATA_FORMAT_BC6H_SFLOAT_BLOCK = 143 enum DataFormat -
const DATA_FORMAT_BC7_UNORM_BLOCK = 144 enum DataFormat -
const DATA_FORMAT_BC7_SRGB_BLOCK = 145 enum DataFormat -
const DATA_FORMAT_ETC2_R8G8B8_UNORM_BLOCK = 146 enum DataFormat -
const DATA_FORMAT_ETC2_R8G8B8_SRGB_BLOCK = 147 enum DataFormat -
const DATA_FORMAT_ETC2_R8G8B8A1_UNORM_BLOCK = 148 enum DataFormat -
const DATA_FORMAT_ETC2_R8G8B8A1_SRGB_BLOCK = 149 enum DataFormat -
const DATA_FORMAT_ETC2_R8G8B8A8_UNORM_BLOCK = 150 enum DataFormat -
const DATA_FORMAT_ETC2_R8G8B8A8_SRGB_BLOCK = 151 enum DataFormat -
const DATA_FORMAT_EAC_R11_UNORM_BLOCK = 152 enum DataFormat -
const DATA_FORMAT_EAC_R11_SNORM_BLOCK = 153 enum DataFormat -
const DATA_FORMAT_EAC_R11G11_UNORM_BLOCK = 154 enum DataFormat -
const DATA_FORMAT_EAC_R11G11_SNORM_BLOCK = 155 enum DataFormat -
const DATA_FORMAT_ASTC_4x4_UNORM_BLOCK = 156 enum DataFormat -
const DATA_FORMAT_ASTC_4x4_SRGB_BLOCK = 157 enum DataFormat -
const DATA_FORMAT_ASTC_5x4_UNORM_BLOCK = 158 enum DataFormat -
const DATA_FORMAT_ASTC_5x4_SRGB_BLOCK = 159 enum DataFormat -
const DATA_FORMAT_ASTC_5x5_UNORM_BLOCK = 160 enum DataFormat -
const DATA_FORMAT_ASTC_5x5_SRGB_BLOCK = 161 enum DataFormat -
const DATA_FORMAT_ASTC_6x5_UNORM_BLOCK = 162 enum DataFormat -
const DATA_FORMAT_ASTC_6x5_SRGB_BLOCK = 163 enum DataFormat -
const DATA_FORMAT_ASTC_6x6_UNORM_BLOCK = 164 enum DataFormat -
const DATA_FORMAT_ASTC_6x6_SRGB_BLOCK = 165 enum DataFormat -
const DATA_FORMAT_ASTC_8x5_UNORM_BLOCK = 166 enum DataFormat -
const DATA_FORMAT_ASTC_8x5_SRGB_BLOCK = 167 enum DataFormat -
const DATA_FORMAT_ASTC_8x6_UNORM_BLOCK = 168 enum DataFormat -
const DATA_FORMAT_ASTC_8x6_SRGB_BLOCK = 169 enum DataFormat -
const DATA_FORMAT_ASTC_8x8_UNORM_BLOCK = 170 enum DataFormat -
const DATA_FORMAT_ASTC_8x8_SRGB_BLOCK = 171 enum DataFormat -
const DATA_FORMAT_ASTC_10x5_UNORM_BLOCK = 172 enum DataFormat -
const DATA_FORMAT_ASTC_10x5_SRGB_BLOCK = 173 enum DataFormat -
const DATA_FORMAT_ASTC_10x6_UNORM_BLOCK = 174 enum DataFormat -
const DATA_FORMAT_ASTC_10x6_SRGB_BLOCK = 175 enum DataFormat -
const DATA_FORMAT_ASTC_10x8_UNORM_BLOCK = 176 enum DataFormat -
const DATA_FORMAT_ASTC_10x8_SRGB_BLOCK = 177 enum DataFormat -
const DATA_FORMAT_ASTC_10x10_UNORM_BLOCK = 178 enum DataFormat -
const DATA_FORMAT_ASTC_10x10_SRGB_BLOCK = 179 enum DataFormat -
const DATA_FORMAT_ASTC_12x10_UNORM_BLOCK = 180 enum DataFormat -
const DATA_FORMAT_ASTC_12x10_SRGB_BLOCK = 181 enum DataFormat -
const DATA_FORMAT_ASTC_12x12_UNORM_BLOCK = 182 enum DataFormat -
const DATA_FORMAT_ASTC_12x12_SRGB_BLOCK = 183 enum DataFormat -
const DATA_FORMAT_G8B8G8R8_422_UNORM = 184 enum DataFormat -
const DATA_FORMAT_B8G8R8G8_422_UNORM = 185 enum DataFormat -
const DATA_FORMAT_G8_B8_R8_3PLANE_420_UNORM = 186 enum DataFormat -
const DATA_FORMAT_G8_B8R8_2PLANE_420_UNORM = 187 enum DataFormat -
const DATA_FORMAT_G8_B8_R8_3PLANE_422_UNORM = 188 enum DataFormat -
const DATA_FORMAT_G8_B8R8_2PLANE_422_UNORM = 189 enum DataFormat -
const DATA_FORMAT_G8_B8_R8_3PLANE_444_UNORM = 190 enum DataFormat -
const DATA_FORMAT_R10X6_UNORM_PACK16 = 191 enum DataFormat -
const DATA_FORMAT_R10X6G10X6_UNORM_2PACK16 = 192 enum DataFormat -
const DATA_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16 = 193 enum DataFormat -
const DATA_FORMAT_G10X6B10X6G10X6R10X6_422_UNORM_4PACK16 = 194 enum DataFormat -
const DATA_FORMAT_B10X6G10X6R10X6G10X6_422_UNORM_4PACK16 = 195 enum DataFormat -
const DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16 = 196 enum DataFormat -
const DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16 = 197 enum DataFormat -
const DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_422_UNORM_3PACK16 = 198 enum DataFormat -
const DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_422_UNORM_3PACK16 = 199 enum DataFormat -
const DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_444_UNORM_3PACK16 = 200 enum DataFormat -
const DATA_FORMAT_R12X4_UNORM_PACK16 = 201 enum DataFormat -
const DATA_FORMAT_R12X4G12X4_UNORM_2PACK16 = 202 enum DataFormat -
const DATA_FORMAT_R12X4G12X4B12X4A12X4_UNORM_4PACK16 = 203 enum DataFormat -
const DATA_FORMAT_G12X4B12X4G12X4R12X4_422_UNORM_4PACK16 = 204 enum DataFormat -
const DATA_FORMAT_B12X4G12X4R12X4G12X4_422_UNORM_4PACK16 = 205 enum DataFormat -
const DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_420_UNORM_3PACK16 = 206 enum DataFormat -
const DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_420_UNORM_3PACK16 = 207 enum DataFormat -
const DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_422_UNORM_3PACK16 = 208 enum DataFormat -
const DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_422_UNORM_3PACK16 = 209 enum DataFormat -
const DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_444_UNORM_3PACK16 = 210 enum DataFormat -
const DATA_FORMAT_G16B16G16R16_422_UNORM = 211 enum DataFormat -
const DATA_FORMAT_B16G16R16G16_422_UNORM = 212 enum DataFormat -
const DATA_FORMAT_G16_B16_R16_3PLANE_420_UNORM = 213 enum DataFormat -
const DATA_FORMAT_G16_B16R16_2PLANE_420_UNORM = 214 enum DataFormat -
const DATA_FORMAT_G16_B16_R16_3PLANE_422_UNORM = 215 enum DataFormat -
const DATA_FORMAT_G16_B16R16_2PLANE_422_UNORM = 216 enum DataFormat -
const DATA_FORMAT_G16_B16_R16_3PLANE_444_UNORM = 217 enum DataFormat -
const DATA_FORMAT_ASTC_4x4_SFLOAT_BLOCK = 218 enum DataFormat -
const DATA_FORMAT_ASTC_5x4_SFLOAT_BLOCK = 219 enum DataFormat -
const DATA_FORMAT_ASTC_5x5_SFLOAT_BLOCK = 220 enum DataFormat -
const DATA_FORMAT_ASTC_6x5_SFLOAT_BLOCK = 221 enum DataFormat -
const DATA_FORMAT_ASTC_6x6_SFLOAT_BLOCK = 222 enum DataFormat -
const DATA_FORMAT_ASTC_8x5_SFLOAT_BLOCK = 223 enum DataFormat -
const DATA_FORMAT_ASTC_8x6_SFLOAT_BLOCK = 224 enum DataFormat -
const DATA_FORMAT_ASTC_8x8_SFLOAT_BLOCK = 225 enum DataFormat -
const DATA_FORMAT_ASTC_10x5_SFLOAT_BLOCK = 226 enum DataFormat -
const DATA_FORMAT_ASTC_10x6_SFLOAT_BLOCK = 227 enum DataFormat -
const DATA_FORMAT_ASTC_10x8_SFLOAT_BLOCK = 228 enum DataFormat -
const DATA_FORMAT_ASTC_10x10_SFLOAT_BLOCK = 229 enum DataFormat -
const DATA_FORMAT_ASTC_12x10_SFLOAT_BLOCK = 230 enum DataFormat -
const DATA_FORMAT_ASTC_12x12_SFLOAT_BLOCK = 231 enum DataFormat -
const DATA_FORMAT_MAX = 232 enum DataFormat -
const BARRIER_MASK_VERTEX = 1 enum BarrierMaskBitfield -
const BARRIER_MASK_FRAGMENT = 8 enum BarrierMaskBitfield -
const BARRIER_MASK_COMPUTE = 2 enum BarrierMaskBitfield -
const BARRIER_MASK_TRANSFER = 4 enum BarrierMaskBitfield -
const BARRIER_MASK_RASTER = 9 enum BarrierMaskBitfield -
const BARRIER_MASK_ALL_BARRIERS = 32767 enum BarrierMaskBitfield -
const BARRIER_MASK_NO_BARRIER = 32768 enum BarrierMaskBitfield -
const TEXTURE_TYPE_1D = 0 enum TextureType -
const TEXTURE_TYPE_2D = 1 enum TextureType -
const TEXTURE_TYPE_3D = 2 enum TextureType -
const TEXTURE_TYPE_CUBE = 3 enum TextureType -
const TEXTURE_TYPE_1D_ARRAY = 4 enum TextureType -
const TEXTURE_TYPE_2D_ARRAY = 5 enum TextureType -
const TEXTURE_TYPE_CUBE_ARRAY = 6 enum TextureType -
const TEXTURE_TYPE_MAX = 7 enum TextureType -
const TEXTURE_SAMPLES_1 = 0 enum TextureSamples -
const TEXTURE_SAMPLES_2 = 1 enum TextureSamples -
const TEXTURE_SAMPLES_4 = 2 enum TextureSamples -
const TEXTURE_SAMPLES_8 = 3 enum TextureSamples -
const TEXTURE_SAMPLES_16 = 4 enum TextureSamples -
const TEXTURE_SAMPLES_32 = 5 enum TextureSamples -
const TEXTURE_SAMPLES_64 = 6 enum TextureSamples -
const TEXTURE_SAMPLES_MAX = 7 enum TextureSamples -
const TEXTURE_USAGE_SAMPLING_BIT = 1 enum TextureUsageBitsBitfield -
const TEXTURE_USAGE_COLOR_ATTACHMENT_BIT = 2 enum TextureUsageBitsBitfield -
const TEXTURE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT = 4 enum TextureUsageBitsBitfield -
const TEXTURE_USAGE_STORAGE_BIT = 8 enum TextureUsageBitsBitfield -
const TEXTURE_USAGE_STORAGE_ATOMIC_BIT = 16 enum TextureUsageBitsBitfield -
const TEXTURE_USAGE_CPU_READ_BIT = 32 enum TextureUsageBitsBitfield -
const TEXTURE_USAGE_CAN_UPDATE_BIT = 64 enum TextureUsageBitsBitfield -
const TEXTURE_USAGE_CAN_COPY_FROM_BIT = 128 enum TextureUsageBitsBitfield -
const TEXTURE_USAGE_CAN_COPY_TO_BIT = 256 enum TextureUsageBitsBitfield -
const TEXTURE_USAGE_INPUT_ATTACHMENT_BIT = 512 enum TextureUsageBitsBitfield -
const TEXTURE_SWIZZLE_IDENTITY = 0 enum TextureSwizzle -
const TEXTURE_SWIZZLE_ZERO = 1 enum TextureSwizzle -
const TEXTURE_SWIZZLE_ONE = 2 enum TextureSwizzle -
const TEXTURE_SWIZZLE_R = 3 enum TextureSwizzle -
const TEXTURE_SWIZZLE_G = 4 enum TextureSwizzle -
const TEXTURE_SWIZZLE_B = 5 enum TextureSwizzle -
const TEXTURE_SWIZZLE_A = 6 enum TextureSwizzle -
const TEXTURE_SWIZZLE_MAX = 7 enum TextureSwizzle -
const TEXTURE_SLICE_2D = 0 enum TextureSliceType -
const TEXTURE_SLICE_CUBEMAP = 1 enum TextureSliceType -
const TEXTURE_SLICE_3D = 2 enum TextureSliceType -
const SAMPLER_FILTER_NEAREST = 0 enum SamplerFilter -
const SAMPLER_FILTER_LINEAR = 1 enum SamplerFilter -
const SAMPLER_REPEAT_MODE_REPEAT = 0 enum SamplerRepeatMode -
const SAMPLER_REPEAT_MODE_MIRRORED_REPEAT = 1 enum SamplerRepeatMode -
const SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE = 2 enum SamplerRepeatMode -
const SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER = 3 enum SamplerRepeatMode -
const SAMPLER_REPEAT_MODE_MIRROR_CLAMP_TO_EDGE = 4 enum SamplerRepeatMode -
const SAMPLER_REPEAT_MODE_MAX = 5 enum SamplerRepeatMode -
const SAMPLER_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK = 0 enum SamplerBorderColor -
const SAMPLER_BORDER_COLOR_INT_TRANSPARENT_BLACK = 1 enum SamplerBorderColor -
const SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_BLACK = 2 enum SamplerBorderColor -
const SAMPLER_BORDER_COLOR_INT_OPAQUE_BLACK = 3 enum SamplerBorderColor -
const SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_WHITE = 4 enum SamplerBorderColor -
const SAMPLER_BORDER_COLOR_INT_OPAQUE_WHITE = 5 enum SamplerBorderColor -
const SAMPLER_BORDER_COLOR_MAX = 6 enum SamplerBorderColor -
const VERTEX_FREQUENCY_VERTEX = 0 enum VertexFrequency -
const VERTEX_FREQUENCY_INSTANCE = 1 enum VertexFrequency -
const INDEX_BUFFER_FORMAT_UINT16 = 0 enum IndexBufferFormat -
const INDEX_BUFFER_FORMAT_UINT32 = 1 enum IndexBufferFormat -
const STORAGE_BUFFER_USAGE_DISPATCH_INDIRECT = 1 enum StorageBufferUsageBitfield -
const BUFFER_CREATION_DEVICE_ADDRESS_BIT = 1 enum BufferCreationBitsBitfield -
const BUFFER_CREATION_AS_STORAGE_BIT = 2 enum BufferCreationBitsBitfield -
const UNIFORM_TYPE_SAMPLER = 0 enum UniformType -
const UNIFORM_TYPE_SAMPLER_WITH_TEXTURE = 1 enum UniformType -
const UNIFORM_TYPE_TEXTURE = 2 enum UniformType -
const UNIFORM_TYPE_IMAGE = 3 enum UniformType -
const UNIFORM_TYPE_TEXTURE_BUFFER = 4 enum UniformType -
const UNIFORM_TYPE_SAMPLER_WITH_TEXTURE_BUFFER = 5 enum UniformType -
const UNIFORM_TYPE_IMAGE_BUFFER = 6 enum UniformType -
const UNIFORM_TYPE_UNIFORM_BUFFER = 7 enum UniformType -
const UNIFORM_TYPE_STORAGE_BUFFER = 8 enum UniformType -
const UNIFORM_TYPE_INPUT_ATTACHMENT = 9 enum UniformType -
const UNIFORM_TYPE_MAX = 10 enum UniformType -
const RENDER_PRIMITIVE_POINTS = 0 enum RenderPrimitive -
const RENDER_PRIMITIVE_LINES = 1 enum RenderPrimitive -
const RENDER_PRIMITIVE_LINES_WITH_ADJACENCY = 2 enum RenderPrimitive -
const RENDER_PRIMITIVE_LINESTRIPS = 3 enum RenderPrimitive -
const RENDER_PRIMITIVE_LINESTRIPS_WITH_ADJACENCY = 4 enum RenderPrimitive -
const RENDER_PRIMITIVE_TRIANGLES = 5 enum RenderPrimitive -
const RENDER_PRIMITIVE_TRIANGLES_WITH_ADJACENCY = 6 enum RenderPrimitive -
const RENDER_PRIMITIVE_TRIANGLE_STRIPS = 7 enum RenderPrimitive -
const RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_AJACENCY = 8 enum RenderPrimitive -
const RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_RESTART_INDEX = 9 enum RenderPrimitive -
const RENDER_PRIMITIVE_TESSELATION_PATCH = 10 enum RenderPrimitive -
const RENDER_PRIMITIVE_MAX = 11 enum RenderPrimitive -
const POLYGON_CULL_DISABLED = 0 enum PolygonCullMode -
const POLYGON_CULL_FRONT = 1 enum PolygonCullMode -
const POLYGON_CULL_BACK = 2 enum PolygonCullMode -
const POLYGON_FRONT_FACE_CLOCKWISE = 0 enum PolygonFrontFace -
const POLYGON_FRONT_FACE_COUNTER_CLOCKWISE = 1 enum PolygonFrontFace -
const STENCIL_OP_KEEP = 0 enum StencilOperation -
const STENCIL_OP_ZERO = 1 enum StencilOperation -
const STENCIL_OP_REPLACE = 2 enum StencilOperation -
const STENCIL_OP_INCREMENT_AND_CLAMP = 3 enum StencilOperation -
const STENCIL_OP_DECREMENT_AND_CLAMP = 4 enum StencilOperation -
const STENCIL_OP_INVERT = 5 enum StencilOperation -
const STENCIL_OP_INCREMENT_AND_WRAP = 6 enum StencilOperation -
const STENCIL_OP_DECREMENT_AND_WRAP = 7 enum StencilOperation -
const STENCIL_OP_MAX = 8 enum StencilOperation -
const COMPARE_OP_NEVER = 0 enum CompareOperator -
const COMPARE_OP_LESS = 1 enum CompareOperator -
const COMPARE_OP_EQUAL = 2 enum CompareOperator -
const COMPARE_OP_LESS_OR_EQUAL = 3 enum CompareOperator -
const COMPARE_OP_GREATER = 4 enum CompareOperator -
const COMPARE_OP_NOT_EQUAL = 5 enum CompareOperator -
const COMPARE_OP_GREATER_OR_EQUAL = 6 enum CompareOperator -
const COMPARE_OP_ALWAYS = 7 enum CompareOperator -
const COMPARE_OP_MAX = 8 enum CompareOperator -
const LOGIC_OP_CLEAR = 0 enum LogicOperation -
const LOGIC_OP_AND = 1 enum LogicOperation -
const LOGIC_OP_AND_REVERSE = 2 enum LogicOperation -
const LOGIC_OP_COPY = 3 enum LogicOperation -
const LOGIC_OP_AND_INVERTED = 4 enum LogicOperation -
const LOGIC_OP_NO_OP = 5 enum LogicOperation -
const LOGIC_OP_XOR = 6 enum LogicOperation -
const LOGIC_OP_OR = 7 enum LogicOperation -
const LOGIC_OP_NOR = 8 enum LogicOperation -
const LOGIC_OP_EQUIVALENT = 9 enum LogicOperation -
const LOGIC_OP_INVERT = 10 enum LogicOperation -
const LOGIC_OP_OR_REVERSE = 11 enum LogicOperation -
const LOGIC_OP_COPY_INVERTED = 12 enum LogicOperation -
const LOGIC_OP_OR_INVERTED = 13 enum LogicOperation -
const LOGIC_OP_NAND = 14 enum LogicOperation -
const LOGIC_OP_SET = 15 enum LogicOperation -
const LOGIC_OP_MAX = 16 enum LogicOperation -
const BLEND_FACTOR_ZERO = 0 enum BlendFactor -
const BLEND_FACTOR_ONE = 1 enum BlendFactor -
const BLEND_FACTOR_SRC_COLOR = 2 enum BlendFactor -
const BLEND_FACTOR_ONE_MINUS_SRC_COLOR = 3 enum BlendFactor -
const BLEND_FACTOR_DST_COLOR = 4 enum BlendFactor -
const BLEND_FACTOR_ONE_MINUS_DST_COLOR = 5 enum BlendFactor -
const BLEND_FACTOR_SRC_ALPHA = 6 enum BlendFactor -
const BLEND_FACTOR_ONE_MINUS_SRC_ALPHA = 7 enum BlendFactor -
const BLEND_FACTOR_DST_ALPHA = 8 enum BlendFactor -
const BLEND_FACTOR_ONE_MINUS_DST_ALPHA = 9 enum BlendFactor -
const BLEND_FACTOR_CONSTANT_COLOR = 10 enum BlendFactor -
const BLEND_FACTOR_ONE_MINUS_CONSTANT_COLOR = 11 enum BlendFactor -
const BLEND_FACTOR_CONSTANT_ALPHA = 12 enum BlendFactor -
const BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA = 13 enum BlendFactor -
const BLEND_FACTOR_SRC_ALPHA_SATURATE = 14 enum BlendFactor -
const BLEND_FACTOR_SRC1_COLOR = 15 enum BlendFactor -
const BLEND_FACTOR_ONE_MINUS_SRC1_COLOR = 16 enum BlendFactor -
const BLEND_FACTOR_SRC1_ALPHA = 17 enum BlendFactor -
const BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA = 18 enum BlendFactor -
const BLEND_FACTOR_MAX = 19 enum BlendFactor -
const BLEND_OP_ADD = 0 enum BlendOperation -
const BLEND_OP_SUBTRACT = 1 enum BlendOperation -
const BLEND_OP_REVERSE_SUBTRACT = 2 enum BlendOperation -
const BLEND_OP_MINIMUM = 3 enum BlendOperation -
const BLEND_OP_MAXIMUM = 4 enum BlendOperation -
const BLEND_OP_MAX = 5 enum BlendOperation -
const DYNAMIC_STATE_LINE_WIDTH = 1 enum PipelineDynamicStateFlagsBitfield -
const DYNAMIC_STATE_DEPTH_BIAS = 2 enum PipelineDynamicStateFlagsBitfield -
const DYNAMIC_STATE_BLEND_CONSTANTS = 4 enum PipelineDynamicStateFlagsBitfield -
const DYNAMIC_STATE_DEPTH_BOUNDS = 8 enum PipelineDynamicStateFlagsBitfield -
const DYNAMIC_STATE_STENCIL_COMPARE_MASK = 16 enum PipelineDynamicStateFlagsBitfield -
const DYNAMIC_STATE_STENCIL_WRITE_MASK = 32 enum PipelineDynamicStateFlagsBitfield -
const DYNAMIC_STATE_STENCIL_REFERENCE = 64 enum PipelineDynamicStateFlagsBitfield -
const INITIAL_ACTION_LOAD = 0 enum InitialActionDeprecated -
const INITIAL_ACTION_CLEAR = 1 enum InitialActionDeprecated -
const INITIAL_ACTION_DISCARD = 2 enum InitialActionDeprecated -
const INITIAL_ACTION_MAX = 3 enum InitialActionDeprecated -
const INITIAL_ACTION_CLEAR_REGION = 1 enum InitialActionDeprecated -
const INITIAL_ACTION_CLEAR_REGION_CONTINUE = 1 enum InitialActionDeprecated -
const INITIAL_ACTION_KEEP = 0 enum InitialActionDeprecated -
const INITIAL_ACTION_DROP = 2 enum InitialActionDeprecated -
const INITIAL_ACTION_CONTINUE = 0 enum InitialActionDeprecated -
const FINAL_ACTION_STORE = 0 enum FinalActionDeprecated -
const FINAL_ACTION_DISCARD = 1 enum FinalActionDeprecated -
const FINAL_ACTION_MAX = 2 enum FinalActionDeprecated -
const FINAL_ACTION_READ = 0 enum FinalActionDeprecated -
const FINAL_ACTION_CONTINUE = 0 enum FinalActionDeprecated -
const SHADER_STAGE_VERTEX = 0 enum ShaderStage -
const SHADER_STAGE_FRAGMENT = 1 enum ShaderStage -
const SHADER_STAGE_TESSELATION_CONTROL = 2 enum ShaderStage -
const SHADER_STAGE_TESSELATION_EVALUATION = 3 enum ShaderStage -
const SHADER_STAGE_COMPUTE = 4 enum ShaderStage -
const SHADER_STAGE_MAX = 5 enum ShaderStage -
const SHADER_STAGE_VERTEX_BIT = 1 enum ShaderStage -
const SHADER_STAGE_FRAGMENT_BIT = 2 enum ShaderStage -
const SHADER_STAGE_TESSELATION_CONTROL_BIT = 4 enum ShaderStage -
const SHADER_STAGE_TESSELATION_EVALUATION_BIT = 8 enum ShaderStage -
const SHADER_STAGE_COMPUTE_BIT = 16 enum ShaderStage -
const SHADER_LANGUAGE_GLSL = 0 enum ShaderLanguage -
const SHADER_LANGUAGE_HLSL = 1 enum ShaderLanguage -
const PIPELINE_SPECIALIZATION_CONSTANT_TYPE_BOOL = 0 enum PipelineSpecializationConstantType -
const PIPELINE_SPECIALIZATION_CONSTANT_TYPE_INT = 1 enum PipelineSpecializationConstantType -
const PIPELINE_SPECIALIZATION_CONSTANT_TYPE_FLOAT = 2 enum PipelineSpecializationConstantType -
const SUPPORTS_BUFFER_DEVICE_ADDRESS = 6 enum Features -
const LIMIT_MAX_BOUND_UNIFORM_SETS = 0 enum Limit -
const LIMIT_MAX_FRAMEBUFFER_COLOR_ATTACHMENTS = 1 enum Limit -
const LIMIT_MAX_TEXTURES_PER_UNIFORM_SET = 2 enum Limit -
const LIMIT_MAX_SAMPLERS_PER_UNIFORM_SET = 3 enum Limit -
const LIMIT_MAX_STORAGE_BUFFERS_PER_UNIFORM_SET = 4 enum Limit -
const LIMIT_MAX_STORAGE_IMAGES_PER_UNIFORM_SET = 5 enum Limit -
const LIMIT_MAX_UNIFORM_BUFFERS_PER_UNIFORM_SET = 6 enum Limit -
const LIMIT_MAX_DRAW_INDEXED_INDEX = 7 enum Limit -
const LIMIT_MAX_FRAMEBUFFER_HEIGHT = 8 enum Limit -
const LIMIT_MAX_FRAMEBUFFER_WIDTH = 9 enum Limit -
const LIMIT_MAX_TEXTURE_ARRAY_LAYERS = 10 enum Limit -
const LIMIT_MAX_TEXTURE_SIZE_1D = 11 enum Limit -
const LIMIT_MAX_TEXTURE_SIZE_2D = 12 enum Limit -
const LIMIT_MAX_TEXTURE_SIZE_3D = 13 enum Limit -
const LIMIT_MAX_TEXTURE_SIZE_CUBE = 14 enum Limit -
const LIMIT_MAX_TEXTURES_PER_SHADER_STAGE = 15 enum Limit -
const LIMIT_MAX_SAMPLERS_PER_SHADER_STAGE = 16 enum Limit -
const LIMIT_MAX_STORAGE_BUFFERS_PER_SHADER_STAGE = 17 enum Limit -
const LIMIT_MAX_STORAGE_IMAGES_PER_SHADER_STAGE = 18 enum Limit -
const LIMIT_MAX_UNIFORM_BUFFERS_PER_SHADER_STAGE = 19 enum Limit -
const LIMIT_MAX_PUSH_CONSTANT_SIZE = 20 enum Limit -
const LIMIT_MAX_UNIFORM_BUFFER_SIZE = 21 enum Limit -
const LIMIT_MAX_VERTEX_INPUT_ATTRIBUTE_OFFSET = 22 enum Limit -
const LIMIT_MAX_VERTEX_INPUT_ATTRIBUTES = 23 enum Limit -
const LIMIT_MAX_VERTEX_INPUT_BINDINGS = 24 enum Limit -
const LIMIT_MAX_VERTEX_INPUT_BINDING_STRIDE = 25 enum Limit -
const LIMIT_MIN_UNIFORM_BUFFER_OFFSET_ALIGNMENT = 26 enum Limit -
const LIMIT_MAX_COMPUTE_SHARED_MEMORY_SIZE = 27 enum Limit -
const LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_X = 28 enum Limit -
const LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Y = 29 enum Limit -
const LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Z = 30 enum Limit -
const LIMIT_MAX_COMPUTE_WORKGROUP_INVOCATIONS = 31 enum Limit -
const LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_X = 32 enum Limit -
const LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Y = 33 enum Limit -
const LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Z = 34 enum Limit -
const LIMIT_MAX_VIEWPORT_DIMENSIONS_X = 35 enum Limit -
const LIMIT_MAX_VIEWPORT_DIMENSIONS_Y = 36 enum Limit -
const LIMIT_METALFX_TEMPORAL_SCALER_MIN_SCALE = 46 enum Limit -
const LIMIT_METALFX_TEMPORAL_SCALER_MAX_SCALE = 47 enum Limit -
const MEMORY_TEXTURES = 0 enum MemoryType -
const MEMORY_BUFFERS = 1 enum MemoryType -
const MEMORY_TOTAL = 2 enum MemoryType -
const INVALID_ID = -1 -
const INVALID_FORMAT_ID = -1 -
const NONE = 0 enum BreadcrumbMarker -
const REFLECTION_PROBES = 65536 enum BreadcrumbMarker -
const SKY_PASS = 131072 enum BreadcrumbMarker -
const LIGHTMAPPER_PASS = 196608 enum BreadcrumbMarker -
const SHADOW_PASS_DIRECTIONAL = 262144 enum BreadcrumbMarker -
const SHADOW_PASS_CUBE = 327680 enum BreadcrumbMarker -
const OPAQUE_PASS = 393216 enum BreadcrumbMarker -
const ALPHA_PASS = 458752 enum BreadcrumbMarker -
const TRANSPARENT_PASS = 524288 enum BreadcrumbMarker -
const POST_PROCESSING_PASS = 589824 enum BreadcrumbMarker -
const BLIT_PASS = 655360 enum BreadcrumbMarker -
const UI_PASS = 720896 enum BreadcrumbMarker -
const DEBUG_PASS = 786432 enum BreadcrumbMarker -
const DRAW_DEFAULT_ALL = 0 enum DrawFlagsBitfield -
const DRAW_CLEAR_COLOR_0 = 1 enum DrawFlagsBitfield -
const DRAW_CLEAR_COLOR_1 = 2 enum DrawFlagsBitfield -
const DRAW_CLEAR_COLOR_2 = 4 enum DrawFlagsBitfield -
const DRAW_CLEAR_COLOR_3 = 8 enum DrawFlagsBitfield -
const DRAW_CLEAR_COLOR_4 = 16 enum DrawFlagsBitfield -
const DRAW_CLEAR_COLOR_5 = 32 enum DrawFlagsBitfield -
const DRAW_CLEAR_COLOR_6 = 64 enum DrawFlagsBitfield -
const DRAW_CLEAR_COLOR_7 = 128 enum DrawFlagsBitfield -
const DRAW_CLEAR_COLOR_MASK = 255 enum DrawFlagsBitfield -
const DRAW_CLEAR_COLOR_ALL = 255 enum DrawFlagsBitfield -
const DRAW_IGNORE_COLOR_0 = 256 enum DrawFlagsBitfield -
const DRAW_IGNORE_COLOR_1 = 512 enum DrawFlagsBitfield -
const DRAW_IGNORE_COLOR_2 = 1024 enum DrawFlagsBitfield -
const DRAW_IGNORE_COLOR_3 = 2048 enum DrawFlagsBitfield -
const DRAW_IGNORE_COLOR_4 = 4096 enum DrawFlagsBitfield -
const DRAW_IGNORE_COLOR_5 = 8192 enum DrawFlagsBitfield -
const DRAW_IGNORE_COLOR_6 = 16384 enum DrawFlagsBitfield -
const DRAW_IGNORE_COLOR_7 = 32768 enum DrawFlagsBitfield -
const DRAW_IGNORE_COLOR_MASK = 65280 enum DrawFlagsBitfield -
const DRAW_IGNORE_COLOR_ALL = 65280 enum DrawFlagsBitfield -
const DRAW_CLEAR_DEPTH = 65536 enum DrawFlagsBitfield -
const DRAW_IGNORE_DEPTH = 131072 enum DrawFlagsBitfield -
const DRAW_CLEAR_STENCIL = 262144 enum DrawFlagsBitfield -
const DRAW_IGNORE_STENCIL = 524288 enum DrawFlagsBitfield -
const DRAW_CLEAR_ALL = 327935 enum DrawFlagsBitfield -
const DRAW_IGNORE_ALL = 720640 enum DrawFlagsBitfield -
enum DeviceType -
enum DriverResource -
enum DataFormat -
enum BarrierMask -
enum TextureType -
enum TextureSamples -
enum TextureUsageBits -
enum TextureSwizzle -
enum TextureSliceType -
enum SamplerFilter -
enum SamplerRepeatMode -
enum SamplerBorderColor -
enum VertexFrequency -
enum IndexBufferFormat -
enum StorageBufferUsage -
enum BufferCreationBits -
enum UniformType -
enum RenderPrimitive -
enum PolygonCullMode -
enum PolygonFrontFace -
enum StencilOperation -
enum CompareOperator -
enum LogicOperation -
enum BlendFactor -
enum BlendOperation -
enum PipelineDynamicStateFlags -
enum InitialAction -
enum FinalAction -
enum ShaderStage -
enum ShaderLanguage -
enum PipelineSpecializationConstantType -
enum Features -
enum Limit -
enum MemoryType -
enum BreadcrumbMarker -
enum DrawFlags
RenderingDevice #
Abstraction for working with modern low-level graphics APIs.
RenderingDevice is an abstraction for working with modern low-level graphics APIs such as Vulkan. Compared to RenderingServer (which works with Godot's own rendering subsystems), RenderingDevice is much lower-level and allows working more directly with the underlying graphics APIs. RenderingDevice is used in Godot to provide support for several modern low-level graphics APIs while reducing the amount of code duplication required. RenderingDevice can also be used in your own projects to perform things that are not exposed by RenderingServer or high-level nodes, such as using compute shaders.
On startup, Godot creates a global RenderingDevice which can be retrieved using RenderingServer.get_rendering_device. This global RenderingDevice performs drawing to the screen.
Local RenderingDevices: Using RenderingServer.create_local_rendering_device, you can create "secondary" rendering devices to perform drawing and GPU compute operations on separate threads.
Note: RenderingDevice assumes intermediate knowledge of modern graphics APIs such as Vulkan, Direct3D 12, Metal or WebGPU. These graphics APIs are lower-level than OpenGL or Direct3D 11, requiring you to perform what was previously done by the graphics driver itself. If you have difficulty understanding the concepts used in this class, follow the Vulkan Tutorial or Vulkan Guide. It's recommended to have existing modern OpenGL or Direct3D 11 knowledge before attempting to learn a low-level graphics API.
Note: RenderingDevice is not available when running in headless mode or when using the Compatibility rendering method.
Members #
Methods #
func barrier(to: int = 32767 enumRenderingDevice.BarrierMask) -> void#
This method does nothing.
func buffer_clear(size_bytes: int) -> intError#
Clears the contents of the buffer, clearing size_bytes bytes, starting at offset.
Prints an error if:
- the size isn't a multiple of four
- the region specified by offset + size_bytes exceeds the buffer
- a draw list is currently active (created by draw_list_begin)
- a compute list is currently active (created by compute_list_begin)
func buffer_copy(size: int) -> intError#
Copies size bytes from the src_buffer at src_offset into dst_buffer at dst_offset.
Prints an error if:
- size exceeds the size of either src_buffer or dst_buffer at their corresponding offsets
- a draw list is currently active (created by draw_list_begin)
- a compute list is currently active (created by compute_list_begin)
func buffer_get_data(size_bytes: int = 0) -> PackedByteArray#
Returns a copy of the data of the specified buffer, optionally offset_bytes and size_bytes can be set to copy only a portion of the buffer.
Note: This method will block the GPU from working until the data is retrieved. Refer to buffer_get_data_async for an alternative that returns the data in more performant way.
func buffer_get_data_async(size_bytes: int = 0) -> intError#
Asynchronous version of buffer_get_data. RenderingDevice will call callback in a certain amount of frames with the data the buffer had at the time of the request.
Note: At the moment, the delay corresponds to the amount of frames specified by ProjectSettings.rendering/rendering_device/vsync/frame_queue_size.
Note: Downloading large buffers can have a prohibitive cost for real-time even when using the asynchronous method due to hardware bandwidth limitations. When dealing with large resources, you can adjust settings such as ProjectSettings.rendering/rendering_device/staging_buffer/block_size_kb to improve the transfer speed at the cost of extra memory.
func _buffer_get_data_callback(array):
value = array.decode_u32(0)
...
rd.buffer_get_data_async(buffer, _buffer_get_data_callback)func buffer_get_device_address(buffer: RID) -> int#
Returns the address of the given buffer which can be passed to shaders in any way to access underlying data. Buffer must have been created with this feature enabled.
Note: You must check that the GPU supports this functionality by calling has_feature with SUPPORTS_BUFFER_DEVICE_ADDRESS as a parameter.
func buffer_update(data: PackedByteArray) -> intError#
Updates a region of size_bytes bytes, starting at offset, in the buffer, with the specified data.
Prints an error if:
- the region specified by offset + size_bytes exceeds the buffer
- a draw list is currently active (created by draw_list_begin)
- a compute list is currently active (created by compute_list_begin)
func capture_timestamp(name: String) -> void#
Creates a timestamp marker with the specified name. This is used for performance reporting with the get_captured_timestamp_cpu_time, get_captured_timestamp_gpu_time and get_captured_timestamp_name methods.
func compute_list_add_barrier(compute_list: int) -> void#
Raises a Vulkan compute barrier in the specified compute_list.
func compute_list_begin() -> int#
Starts a list of compute commands created with the compute_* methods. The returned value should be passed to other compute_list_* functions.
Multiple compute lists cannot be created at the same time; you must finish the previous compute list first using compute_list_end.
A simple compute operation might look like this (code is not a complete example):
var rd = RenderingDevice.new()
var compute_list = rd.compute_list_begin()
rd.compute_list_bind_compute_pipeline(compute_list, compute_shader_dilate_pipeline)
rd.compute_list_bind_uniform_set(compute_list, compute_base_uniform_set, 0)
rd.compute_list_bind_uniform_set(compute_list, dilate_uniform_set, 1)
for i in atlas_slices:
rd.compute_list_set_push_constant(compute_list, push_constant, push_constant.size())
rd.compute_list_dispatch(compute_list, group_size.x, group_size.y, group_size.z)
# No barrier, let them run all together.
rd.compute_list_end()func compute_list_bind_compute_pipeline(compute_pipeline: RID) -> void#
Tells the GPU what compute pipeline to use when processing the compute list. If the shader has changed since the last time this function was called, Godot will unbind all descriptor sets and will re-bind them inside compute_list_dispatch.
func compute_list_bind_uniform_set(set_index: int) -> void#
Binds the uniform_set to this compute_list. Godot ensures that all textures in the uniform set have the correct Vulkan access masks. If Godot had to change access masks of textures, it will raise a Vulkan image memory barrier.
func compute_list_dispatch(z_groups: int) -> void#
Submits the compute list for processing on the GPU. This is the compute equivalent to draw_list_draw.
func compute_list_dispatch_indirect(offset: int) -> void#
Submits the compute list for processing on the GPU with the given group counts stored in the buffer at offset. Buffer must have been created with STORAGE_BUFFER_USAGE_DISPATCH_INDIRECT flag.
func compute_list_end() -> void#
Finishes a list of compute commands created with the compute_* methods.
func compute_list_set_push_constant(size_bytes: int) -> void#
Sets the push constant data to buffer for the specified compute_list. The shader determines how this binary data is used. The buffer's size in bytes must also be specified in size_bytes (this can be obtained by calling the PackedByteArray.size method on the passed buffer).
func compute_pipeline_create(specialization_constants: RDPipelineSpecializationConstant[] = []) -> RID#
Creates a new compute pipeline. It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method.
func compute_pipeline_is_valid(compute_pipeline: RID) -> bool#
Returns true if the compute pipeline specified by the compute_pipeline RID is valid, false otherwise.
func create_local_device() -> RenderingDevice#
Create a new local RenderingDevice. This is most useful for performing compute operations on the GPU independently from the rest of the engine.
func draw_command_begin_label(color: Color) -> void#
Create a command buffer debug label region that can be displayed in third-party tools such as RenderDoc. All regions must be ended with a draw_command_end_label call. When viewed from the linear series of submissions to a single queue, calls to draw_command_begin_label and draw_command_end_label must be matched and balanced.
The VK_EXT_DEBUG_UTILS_EXTENSION_NAME Vulkan extension must be available and enabled for command buffer debug label region to work. See also draw_command_end_label.
func draw_command_end_label() -> void#
Ends the command buffer debug label region started by a draw_command_begin_label call.
func draw_command_insert_label(color: Color) -> void#
This method does nothing.
func draw_list_begin(breadcrumb: int = 0) -> int#
Starts a list of raster drawing commands created with the draw_* methods. The returned value should be passed to other draw_list_* functions.
Multiple draw lists cannot be created at the same time; you must finish the previous draw list first using draw_list_end.
A simple drawing operation might look like this (code is not a complete example):
var rd = RenderingDevice.new()
var clear_colors = PackedColorArray([Color(0, 0, 0, 0), Color(0, 0, 0, 0), Color(0, 0, 0, 0)])
var draw_list = rd.draw_list_begin(framebuffers[i], RenderingDevice.CLEAR_COLOR_ALL, clear_colors, true, 1.0f, true, 0, Rect2(), RenderingDevice.OPAQUE_PASS)
# Draw opaque.
rd.draw_list_bind_render_pipeline(draw_list, raster_pipeline)
rd.draw_list_bind_uniform_set(draw_list, raster_base_uniform, 0)
rd.draw_list_set_push_constant(draw_list, raster_push_constant, raster_push_constant.size())
rd.draw_list_draw(draw_list, false, 1, slice_triangle_count[i] * 3)
# Draw wire.
rd.draw_list_bind_render_pipeline(draw_list, raster_pipeline_wire)
rd.draw_list_bind_uniform_set(draw_list, raster_base_uniform, 0)
rd.draw_list_set_push_constant(draw_list, raster_push_constant, raster_push_constant.size())
rd.draw_list_draw(draw_list, false, 1, slice_triangle_count[i] * 3)
rd.draw_list_end()The draw_flags indicates if the texture attachments of the framebuffer should be cleared or ignored. Only one of the two flags can be used for each individual attachment. Ignoring an attachment means that any contents that existed before the draw list will be completely discarded, reducing the memory bandwidth used by the render pass but producing garbage results if the pixels aren't replaced. The default behavior allows the engine to figure out the right operation to use if the texture is discardable, which can result in increased performance. See RDTextureFormat or texture_set_discardable.
The breadcrumb parameter can be an arbitrary 32-bit integer that is useful to diagnose GPU crashes. If Godot is built in dev or debug mode; when the GPU crashes Godot will dump all shaders that were being executed at the time of the crash and the breadcrumb is useful to diagnose what passes did those shaders belong to.
It does not affect rendering behavior and can be set to 0. It is recommended to use BreadcrumbMarker enumerations for consistency but it's not required. It is also possible to use bitwise operations to add extra data. e.g.
rd.draw_list_begin(fb[i], RenderingDevice.CLEAR_COLOR_ALL, clear_colors, true, 1.0f, true, 0, Rect2(), RenderingDevice.OPAQUE_PASS | 5)func draw_list_begin_for_screen(clear_color: Color = Color(0, 0, 0, 1)) -> int#
High-level variant of draw_list_begin, with the parameters automatically being adjusted for drawing onto the window specified by the screen ID.
Note: Cannot be used with local RenderingDevices, as these don't have a screen. If called on a local RenderingDevice, draw_list_begin_for_screen returns INVALID_ID.
func draw_list_begin_split(storage_textures: RID[] = []) -> PackedInt64Array#
This method does nothing and always returns an empty PackedInt64Array.
func draw_list_bind_index_array(index_array: RID) -> void#
Binds index_array to the specified draw_list.
func draw_list_bind_render_pipeline(render_pipeline: RID) -> void#
Binds render_pipeline to the specified draw_list.
func draw_list_bind_uniform_set(set_index: int) -> void#
Binds uniform_set to the specified draw_list. A set_index must also be specified, which is an identifier starting from 0 that must match the one expected by the draw list.
func draw_list_bind_vertex_array(vertex_array: RID) -> void#
Binds vertex_array to the specified draw_list.
func draw_list_disable_scissor(draw_list: int) -> void#
Removes and disables the scissor rectangle for the specified draw_list. See also draw_list_enable_scissor.
func draw_list_draw(procedural_vertex_count: int = 0) -> void#
Submits draw_list for rendering on the GPU. This is the raster equivalent to compute_list_dispatch.
func draw_list_draw_indirect(stride: int = 0) -> void#
Submits draw_list for rendering on the GPU with the given parameters stored in the buffer at offset. Parameters being integers: vertex count, instance count, first vertex, first instance. And when using indices: index count, instance count, first index, vertex offset, first instance. Buffer must have been created with STORAGE_BUFFER_USAGE_DISPATCH_INDIRECT flag.
func draw_list_enable_scissor(rect: Rect2 = Rect2(0, 0, 0, 0)) -> void#
Creates a scissor rectangle and enables it for the specified draw_list. Scissor rectangles are used for clipping by discarding fragments that fall outside a specified rectangular portion of the screen. See also draw_list_disable_scissor.
Note: The specified rect is automatically intersected with the screen's dimensions, which means it cannot exceed the screen's dimensions.
func draw_list_end() -> void#
Finishes a list of raster drawing commands created with the draw_* methods.
func draw_list_set_blend_constants(color: Color) -> void#
Sets blend constants for the specified draw_list to color. Blend constants are used only if the graphics pipeline is created with DYNAMIC_STATE_BLEND_CONSTANTS flag set.
func draw_list_set_push_constant(size_bytes: int) -> void#
Sets the push constant data to buffer for the specified draw_list. The shader determines how this binary data is used. The buffer's size in bytes must also be specified in size_bytes (this can be obtained by calling the PackedByteArray.size method on the passed buffer).
func draw_list_switch_to_next_pass() -> int#
Switches to the next draw pass.
func draw_list_switch_to_next_pass_split(splits: int) -> PackedInt64Array#
This method does nothing and always returns an empty PackedInt64Array.
func framebuffer_create(view_count: int = 1) -> RID#
Creates a new framebuffer. It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method.
func framebuffer_create_empty(validate_with_format: int = -1) -> RID#
Creates a new empty framebuffer. It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method.
func framebuffer_create_multipass(view_count: int = 1) -> RID#
Creates a new multipass framebuffer. It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method.
func framebuffer_format_create(view_count: int = 1) -> int#
Creates a new framebuffer format with the specified attachments and view_count. Returns the new framebuffer's unique framebuffer format ID.
If view_count is greater than or equal to 2, enables multiview which is used for VR rendering. This requires support for the Vulkan multiview extension.
func framebuffer_format_create_empty(samples: int = 0 enumRenderingDevice.TextureSamples) -> int#
Creates a new empty framebuffer format with the specified number of samples and returns its ID.
func framebuffer_format_create_multipass(view_count: int = 1) -> int#
Creates a multipass framebuffer format with the specified attachments, passes and view_count and returns its ID. If view_count is greater than or equal to 2, enables multiview which is used for VR rendering. This requires support for the Vulkan multiview extension.
func framebuffer_format_get_texture_samples(render_pass: int = 0) -> intRenderingDevice.TextureSamples#
Returns the number of texture samples used for the given framebuffer format ID (returned by framebuffer_get_format).
func framebuffer_get_format(framebuffer: RID) -> int#
Returns the format ID of the framebuffer specified by the framebuffer RID. This ID is guaranteed to be unique for the same formats and does not need to be freed.
const func framebuffer_is_valid(framebuffer: RID) -> bool#
Returns true if the framebuffer specified by the framebuffer RID is valid, false otherwise.
func free_rid(rid: RID) -> void#
Tries to free an object in the RenderingDevice. To avoid memory leaks, this should be called after using an object as memory management does not occur automatically when using RenderingDevice directly.
func full_barrier() -> void#
This method does nothing.
const func get_captured_timestamp_cpu_time(index: int) -> int#
Returns the timestamp in CPU time for the rendering step specified by index (in microseconds since the engine started). See also get_captured_timestamp_gpu_time and capture_timestamp.
const func get_captured_timestamp_gpu_time(index: int) -> int#
Returns the timestamp in GPU time for the rendering step specified by index (in microseconds since the engine started). See also get_captured_timestamp_cpu_time and capture_timestamp.
const func get_captured_timestamp_name(index: int) -> String#
Returns the timestamp's name for the rendering step specified by index. See also capture_timestamp.
const func get_captured_timestamps_count() -> int#
Returns the total number of timestamps (rendering steps) available for profiling.
const func get_captured_timestamps_frame() -> int#
Returns the index of the last frame rendered that has rendering timestamps available for querying.
const func get_device_allocation_count() -> int#
Returns how many allocations the GPU has performed for internal driver structures.
This is only used by Vulkan in debug builds and can return 0 when this information is not tracked or unknown.
const func get_device_allocs_by_object_type(type: int) -> int#
Same as get_device_allocation_count but filtered for a given object type.
The type argument must be in range [0; get_tracked_object_type_count - 1]. If get_tracked_object_type_count is 0, then type argument is ignored and always returns 0.
This is only used by Vulkan in debug builds and can return 0 when this information is not tracked or unknown.
const func get_device_memory_by_object_type(type: int) -> int#
Same as get_device_total_memory but filtered for a given object type.
The type argument must be in range [0; get_tracked_object_type_count - 1]. If get_tracked_object_type_count is 0, then type argument is ignored and always returns 0.
This is only used by Vulkan in debug builds and can return 0 when this information is not tracked or unknown.
const func get_device_name() -> String#
Returns the name of the video adapter (e.g. "GeForce GTX 1080/PCIe/SSE2"). Equivalent to RenderingServer.get_video_adapter_name. See also get_device_vendor_name.
const func get_device_pipeline_cache_uuid() -> String#
Returns the universally unique identifier for the pipeline cache. This is used to cache shader files on disk, which avoids shader recompilations on subsequent engine runs. This UUID varies depending on the graphics card model, but also the driver version. Therefore, updating graphics drivers will invalidate the shader cache.
const func get_device_total_memory() -> int#
Returns how much bytes the GPU is using.
This is only used by Vulkan in debug builds and can return 0 when this information is not tracked or unknown.
const func get_device_vendor_name() -> String#
Returns the vendor of the video adapter (e.g. "NVIDIA Corporation"). Equivalent to RenderingServer.get_video_adapter_vendor. See also get_device_name.
const func get_driver_allocation_count() -> int#
Returns how many allocations the GPU driver has performed for internal driver structures.
This is only used by Vulkan in debug builds and can return 0 when this information is not tracked or unknown.
const func get_driver_allocs_by_object_type(type: int) -> int#
Same as get_driver_allocation_count but filtered for a given object type.
The type argument must be in range [0; get_tracked_object_type_count - 1]. If get_tracked_object_type_count is 0, then type argument is ignored and always returns 0.
This is only used by Vulkan in debug builds and can return 0 when this information is not tracked or unknown.
const func get_driver_and_device_memory_report() -> String#
Returns string report in CSV format using the following methods:
- get_tracked_object_type_count
- get_driver_memory_by_object_type
- get_driver_allocs_by_object_type
- get_device_memory_by_object_type
- get_device_allocs_by_object_type
This is only used by Vulkan in debug builds. Godot must also be started with the --extra-gpu-memory-tracking command line argument.
const func get_driver_memory_by_object_type(type: int) -> int#
Same as get_driver_total_memory but filtered for a given object type.
The type argument must be in range [0; get_tracked_object_type_count - 1]. If get_tracked_object_type_count is 0, then type argument is ignored and always returns 0.
This is only used by Vulkan in debug builds and can return 0 when this information is not tracked or unknown.
func get_driver_resource(index: int) -> int#
Returns the unique identifier of the driver resource for the specified rid. Some driver resource types ignore the specified rid (see DriverResource descriptions). index is always ignored but must be specified anyway.
const func get_driver_total_memory() -> int#
Returns how much bytes the GPU driver is using for internal driver structures.
This is only used by Vulkan in debug builds and can return 0 when this information is not tracked or unknown.
const func get_frame_delay() -> int#
Returns the frame count kept by the graphics API. Higher values result in higher input lag, but with more consistent throughput. For the main RenderingDevice, frames are cycled (usually 3 with triple-buffered V-Sync enabled). However, local RenderingDevices only have 1 frame.
const func get_memory_usage(type: int enumRenderingDevice.MemoryType) -> int#
Returns the memory usage in bytes corresponding to the given type. When using Vulkan, these statistics are calculated by Vulkan Memory Allocator.
const func get_perf_report() -> String#
Returns a string with a performance report from the past frame. Updates every frame.
const func get_tracked_object_name(type_index: int) -> String#
Returns the name of the type of object for the given type_index. This value must be in range [0; get_tracked_object_type_count - 1]. If get_tracked_object_type_count is 0, then type argument is ignored and always returns the same string.
The return value is important because it gives meaning to the types passed to get_driver_memory_by_object_type, get_driver_allocs_by_object_type, get_device_memory_by_object_type, and get_device_allocs_by_object_type. Examples of strings it can return (not exhaustive):
- DEVICE_MEMORY
- PIPELINE_CACHE
- SWAPCHAIN_KHR
- COMMAND_POOL
Thus if e.g. get_tracked_object_name(5) returns "COMMAND_POOL", then get_device_memory_by_object_type(5) returns the bytes used by the GPU for command pools.
This is only used by Vulkan in debug builds. Godot must also be started with the --extra-gpu-memory-tracking command line argument.
const func get_tracked_object_type_count() -> int#
Returns how many types of trackable objects are.
This is only used by Vulkan in debug builds. Godot must also be started with the --extra-gpu-memory-tracking command line argument.
const func has_feature(feature: int enumRenderingDevice.Features) -> bool#
Returns true if the feature is supported by the GPU.
func index_array_create(index_count: int) -> RID#
Creates a new index array. It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method.
func index_buffer_create(creation_bits: int = 0 enumRenderingDevice.BufferCreationBits) -> RID#
Creates a new index buffer. It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method.
const func limit_get(limit: int enumRenderingDevice.Limit) -> int#
Returns the value of the specified limit. This limit varies depending on the current graphics hardware (and sometimes the driver version). If the given limit is exceeded, rendering errors will occur.
Limits for various graphics hardware can be found in the Vulkan Hardware Database.
func render_pipeline_create(specialization_constants: RDPipelineSpecializationConstant[] = []) -> RID#
Creates a new render pipeline. It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method.
func render_pipeline_is_valid(render_pipeline: RID) -> bool#
Returns true if the render pipeline specified by the render_pipeline RID is valid, false otherwise.
func sampler_create(state: RDSamplerState) -> RID#
Creates a new sampler. It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method.
const func sampler_is_format_supported_for_filter(sampler_filter: int enumRenderingDevice.SamplerFilter) -> bool#
Returns true if implementation supports using a texture of format with the given sampler_filter.
const func screen_get_framebuffer_format(screen: int = 0) -> int#
Returns the framebuffer format of the given screen.
Note: Only the main RenderingDevice returned by RenderingServer.get_rendering_device has a format. If called on a local RenderingDevice, this method prints an error and returns INVALID_ID.
const func screen_get_height(screen: int = 0) -> int#
Returns the window height matching the graphics API context for the given window ID (in pixels). Despite the parameter being named screen, this returns the window size. See also screen_get_width.
Note: Only the main RenderingDevice returned by RenderingServer.get_rendering_device has a height. If called on a local RenderingDevice, this method prints an error and returns INVALID_ID.
const func screen_get_width(screen: int = 0) -> int#
Returns the window width matching the graphics API context for the given window ID (in pixels). Despite the parameter being named screen, this returns the window size. See also screen_get_height.
Note: Only the main RenderingDevice returned by RenderingServer.get_rendering_device has a width. If called on a local RenderingDevice, this method prints an error and returns INVALID_ID.
func set_resource_name(name: String) -> void#
Sets the resource name for id to name. This is used for debugging with third-party tools such as RenderDoc.
The following types of resources can be named: texture, sampler, vertex buffer, index buffer, uniform buffer, texture buffer, storage buffer, uniform set buffer, shader, render pipeline and compute pipeline. Framebuffers cannot be named. Attempting to name an incompatible resource type will print an error.
Note: Resource names are only set when the engine runs in verbose mode (OS.is_stdout_verbose = true), or when using an engine build compiled with the dev_mode=yes SCons option. The graphics driver must also support the VK_EXT_DEBUG_UTILS_EXTENSION_NAME Vulkan extension for named resources to work.
func shader_compile_binary_from_spirv(name: String = "") -> PackedByteArray#
Compiles a binary shader from spirv_data and returns the compiled binary data as a PackedByteArray. This compiled shader is specific to the GPU model and driver version used; it will not work on different GPU models or even different driver versions. See also shader_compile_spirv_from_source.
name is an optional human-readable name that can be given to the compiled shader for organizational purposes.
func shader_compile_spirv_from_source(allow_cache: bool = true) -> RDShaderSPIRV#
Compiles a SPIR-V from the shader source code in shader_source and returns the SPIR-V as a RDShaderSPIRV. This intermediate language shader is portable across different GPU models and driver versions, but cannot be run directly by GPUs until compiled into a binary shader using shader_compile_binary_from_spirv.
If allow_cache is true, make use of the shader cache generated by Godot. This avoids a potentially lengthy shader compilation step if the shader is already in cache. If allow_cache is false, Godot's shader cache is ignored and the shader will always be recompiled.
func shader_create_from_bytecode(placeholder_rid: RID = RID()) -> RID#
Creates a new shader instance from a binary compiled shader. It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method. See also shader_compile_binary_from_spirv and shader_create_from_spirv.
func shader_create_from_spirv(name: String = "") -> RID#
Creates a new shader instance from SPIR-V intermediate code. It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method. See also shader_compile_spirv_from_source and shader_create_from_bytecode.
func shader_create_placeholder() -> RID#
Create a placeholder RID by allocating an RID without initializing it for use in shader_create_from_bytecode. This allows you to create an RID for a shader and pass it around, but defer compiling the shader to a later time.
func shader_get_vertex_input_attribute_mask(shader: RID) -> int#
Returns the internal vertex input mask. Internally, the vertex input mask is an unsigned integer consisting of the locations (specified in GLSL via. layout(location = ...)) of the input variables (specified in GLSL by the in keyword).
func storage_buffer_create(creation_bits: int = 0 enumRenderingDevice.BufferCreationBits) -> RID#
Creates a storage buffer with the specified data and usage. It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method.
func submit() -> void#
Pushes the frame setup and draw command buffers then marks the local device as currently processing (which allows calling sync).
Note: Only available in local RenderingDevices.
func sync() -> void#
Forces a synchronization between the CPU and GPU, which may be required in certain cases. Only call this when needed, as CPU-GPU synchronization has a performance cost.
Note: Only available in local RenderingDevices.
func texture_buffer_create(data: PackedByteArray = PackedByteArray()) -> RID#
Creates a new texture buffer. It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method.
func texture_clear(layer_count: int) -> intError#
Clears the specified texture by replacing all of its pixels with the specified color. base_mipmap and mipmap_count determine which mipmaps of the texture are affected by this clear operation, while base_layer and layer_count determine which layers of a 3D texture (or texture array) are affected by this clear operation. For 2D textures (which only have one layer by design), base_layer must be 0 and layer_count must be 1.
Note: texture can't be cleared while a draw list that uses it as part of a framebuffer is being created. Ensure the draw list is finalized (and that the color/depth texture using it is not set to FINAL_ACTION_CONTINUE) to clear this texture.
func texture_copy(dst_layer: int) -> intError#
Copies the from_texture to to_texture with the specified from_pos, to_pos and size coordinates. The Z axis of the from_pos, to_pos and size must be 0 for 2-dimensional textures. Source and destination mipmaps/layers must also be specified, with these parameters being 0 for textures without mipmaps or single-layer textures. Returns @GlobalScope.OK if the texture copy was successful or @GlobalScope.ERR_INVALID_PARAMETER otherwise.
Note: from_texture texture can't be copied while a draw list that uses it as part of a framebuffer is being created. Ensure the draw list is finalized (and that the color/depth texture using it is not set to FINAL_ACTION_CONTINUE) to copy this texture.
Note: from_texture texture requires the TEXTURE_USAGE_CAN_COPY_FROM_BIT to be retrieved.
Note: to_texture can't be copied while a draw list that uses it as part of a framebuffer is being created. Ensure the draw list is finalized (and that the color/depth texture using it is not set to FINAL_ACTION_CONTINUE) to copy this texture.
Note: to_texture requires the TEXTURE_USAGE_CAN_COPY_TO_BIT to be retrieved.
Note: from_texture and to_texture must be of the same type (color or depth).
func texture_create(data: PackedByteArray[] = []) -> RID#
Creates a new texture. It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method.
Note: Not to be confused with RenderingServer.texture_2d_create, which creates the Godot-specific Texture2D resource as opposed to the graphics API's own texture type.
func texture_create_from_extension(layers: int) -> RID#
Returns an RID for an existing image (VkImage) with the given type, format, samples, usage_flags, width, height, depth, and layers. This can be used to allow Godot to render onto foreign images.
func texture_create_shared(with_texture: RID) -> RID#
Creates a shared texture using the specified view and the texture information from with_texture.
func texture_create_shared_from_slice(slice_type: int = 0 enumRenderingDevice.TextureSliceType) -> RID#
Creates a shared texture using the specified view and the texture information from with_texture's layer and mipmap. The number of included mipmaps from the original texture can be controlled using the mipmaps parameter. Only relevant for textures with multiple layers, such as 3D textures, texture arrays and cubemaps. For single-layer textures, use texture_create_shared.
For 2D textures (which only have one layer), layer must be 0.
Note: Layer slicing is only supported for 2D texture arrays, not 3D textures or cubemaps.
func texture_get_data(layer: int) -> PackedByteArray#
Returns the texture data for the specified layer as raw binary data. For 2D textures (which only have one layer), layer must be 0.
Note: texture can't be retrieved while a draw list that uses it as part of a framebuffer is being created. Ensure the draw list is finalized (and that the color/depth texture using it is not set to FINAL_ACTION_CONTINUE) to retrieve this texture. Otherwise, an error is printed and a empty PackedByteArray is returned.
Note: texture requires the TEXTURE_USAGE_CAN_COPY_FROM_BIT to be retrieved. Otherwise, an error is printed and a empty PackedByteArray is returned.
Note: This method will block the GPU from working until the data is retrieved. Refer to texture_get_data_async for an alternative that returns the data in more performant way.
func texture_get_data_async(callback: Callable) -> intError#
Asynchronous version of texture_get_data. RenderingDevice will call callback in a certain amount of frames with the data the texture had at the time of the request.
Note: At the moment, the delay corresponds to the amount of frames specified by ProjectSettings.rendering/rendering_device/vsync/frame_queue_size.
Note: Downloading large textures can have a prohibitive cost for real-time even when using the asynchronous method due to hardware bandwidth limitations. When dealing with large resources, you can adjust settings such as ProjectSettings.rendering/rendering_device/staging_buffer/texture_download_region_size_px and ProjectSettings.rendering/rendering_device/staging_buffer/block_size_kb to improve the transfer speed at the cost of extra memory.
func _texture_get_data_callback(array):
value = array.decode_u32(0)
...
rd.texture_get_data_async(texture, 0, _texture_get_data_callback)func texture_get_format(texture: RID) -> RDTextureFormat#
Returns the data format used to create this texture.
func texture_get_native_handle(texture: RID) -> int#
Returns the internal graphics handle for this texture object. For use when communicating with third-party APIs mostly with GDExtension.
Note: This function returns a uint64_t which internally maps to a GLuint (OpenGL) or VkImage (Vulkan).
func texture_is_discardable(texture: RID) -> bool#
Returns true if the texture is discardable, false otherwise. See RDTextureFormat or texture_set_discardable.
const func texture_is_format_supported_for_usage(usage_flags: int enumRenderingDevice.TextureUsageBits) -> bool#
Returns true if the specified format is supported for the given usage_flags, false otherwise.
func texture_is_shared(texture: RID) -> bool#
Returns true if the texture is shared, false otherwise. See RDTextureView.
func texture_is_valid(texture: RID) -> bool#
Returns true if the texture is valid, false otherwise.
func texture_resolve_multisample(to_texture: RID) -> intError#
Resolves the from_texture texture onto to_texture with multisample antialiasing enabled. This must be used when rendering a framebuffer for MSAA to work. Returns @GlobalScope.OK if successful, @GlobalScope.ERR_INVALID_PARAMETER otherwise.
Note: from_texture and to_texture textures must have the same dimension, format and type (color or depth).
Note: from_texture can't be copied while a draw list that uses it as part of a framebuffer is being created. Ensure the draw list is finalized (and that the color/depth texture using it is not set to FINAL_ACTION_CONTINUE) to resolve this texture.
Note: from_texture requires the TEXTURE_USAGE_CAN_COPY_FROM_BIT to be retrieved.
Note: from_texture must be multisampled and must also be 2D (or a slice of a 3D/cubemap texture).
Note: to_texture can't be copied while a draw list that uses it as part of a framebuffer is being created. Ensure the draw list is finalized (and that the color/depth texture using it is not set to FINAL_ACTION_CONTINUE) to resolve this texture.
Note: to_texture texture requires the TEXTURE_USAGE_CAN_COPY_TO_BIT to be retrieved.
Note: to_texture texture must not be multisampled and must also be 2D (or a slice of a 3D/cubemap texture).
func texture_set_discardable(discardable: bool) -> void#
Updates the discardable property of texture.
If a texture is discardable, its contents do not need to be preserved between frames. This flag is only relevant when the texture is used as target in a draw list.
This information is used by RenderingDevice to figure out if a texture's contents can be discarded, eliminating unnecessary writes to memory and boosting performance.
func texture_update(data: PackedByteArray) -> intError#
Updates texture data with new data, replacing the previous data in place. The updated texture data must have the same dimensions and format. For 2D textures (which only have one layer), layer must be 0. Returns @GlobalScope.OK if the update was successful, @GlobalScope.ERR_INVALID_PARAMETER otherwise.
Note: Updating textures is forbidden during creation of a draw or compute list.
Note: The existing texture can't be updated while a draw list that uses it as part of a framebuffer is being created. Ensure the draw list is finalized (and that the color/depth texture using it is not set to FINAL_ACTION_CONTINUE) to update this texture.
Note: The existing texture requires the TEXTURE_USAGE_CAN_UPDATE_BIT to be updatable.
func uniform_buffer_create(creation_bits: int = 0 enumRenderingDevice.BufferCreationBits) -> RID#
Creates a new uniform buffer. It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method.
func uniform_set_create(shader_set: int) -> RID#
Creates a new uniform set. It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method.
func uniform_set_is_valid(uniform_set: RID) -> bool#
Checks if the uniform_set is valid, i.e. is owned.
func vertex_array_create(offsets: PackedInt64Array = PackedInt64Array()) -> RID#
Creates a vertex array based on the specified buffers. Optionally, offsets (in bytes) may be defined for each buffer.
func vertex_buffer_create(creation_bits: int = 0 enumRenderingDevice.BufferCreationBits) -> RID#
It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method.
func vertex_format_create(vertex_descriptions: RDVertexAttribute[]) -> int#
Creates a new vertex format with the specified vertex_descriptions. Returns a unique vertex format ID corresponding to the newly created vertex format.
Annotations #
Constants #
const DEVICE_TYPE_OTHER = 0 enum DeviceType#
Rendering device type does not match any of the other enum values or is unknown.
const DEVICE_TYPE_INTEGRATED_GPU = 1 enum DeviceType#
Rendering device is an integrated GPU, which is typically (but not always) slower than dedicated GPUs (DEVICE_TYPE_DISCRETE_GPU). On Android and iOS, the rendering device type is always considered to be DEVICE_TYPE_INTEGRATED_GPU.
const DEVICE_TYPE_DISCRETE_GPU = 2 enum DeviceType#
Rendering device is a dedicated GPU, which is typically (but not always) faster than integrated GPUs (DEVICE_TYPE_INTEGRATED_GPU).
const DEVICE_TYPE_VIRTUAL_GPU = 3 enum DeviceType#
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 DEVICE_TYPE_INTEGRATED_GPU. Virtual machine GPU passthrough (such as VFIO) will not report the device type as DEVICE_TYPE_VIRTUAL_GPU. Instead, the host GPU's device type will be reported as if the GPU was not emulated.
const DEVICE_TYPE_CPU = 4 enum DeviceType#
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 DEVICE_TYPE_INTEGRATED_GPU.
const DEVICE_TYPE_MAX = 5 enum DeviceType#
Represents the size of the DeviceType enum.
const DRIVER_RESOURCE_LOGICAL_DEVICE = 0 enum DriverResource#
Specific device object based on a physical device.
- Vulkan: Vulkan device driver resource (VkDevice). (rid argument doesn't apply.)
const DRIVER_RESOURCE_PHYSICAL_DEVICE = 1 enum DriverResource#
Physical device the specific logical device is based on.
- Vulkan: VkDevice. (rid argument doesn't apply.)
const DRIVER_RESOURCE_TOPMOST_OBJECT = 2 enum DriverResource#
Top-most graphics API entry object.
- Vulkan: VkInstance. (rid argument doesn't apply.)
const DRIVER_RESOURCE_COMMAND_QUEUE = 3 enum DriverResource#
The main graphics-compute command queue.
- Vulkan: VkQueue. (rid argument doesn't apply.)
const DRIVER_RESOURCE_QUEUE_FAMILY = 4 enum DriverResource#
The specific family the main queue belongs to.
- Vulkan: the queue family index, an uint32_t. (rid argument doesn't apply.)
const DRIVER_RESOURCE_TEXTURE = 5 enum DriverResource#
- Vulkan: VkImage.
const DRIVER_RESOURCE_TEXTURE_VIEW = 6 enum DriverResource#
The view of an owned or shared texture.
- Vulkan: VkImageView.
const DRIVER_RESOURCE_TEXTURE_DATA_FORMAT = 7 enum DriverResource#
The native id of the data format of the texture.
- Vulkan: VkFormat.
const DRIVER_RESOURCE_SAMPLER = 8 enum DriverResource#
- Vulkan: VkSampler.
const DRIVER_RESOURCE_UNIFORM_SET = 9 enum DriverResource#
- Vulkan: VkDescriptorSet.
const DRIVER_RESOURCE_BUFFER = 10 enum DriverResource#
Buffer of any kind of (storage, vertex, etc.).
- Vulkan: VkBuffer.
const DRIVER_RESOURCE_COMPUTE_PIPELINE = 11 enum DriverResource#
- Vulkan: VkPipeline.
const DRIVER_RESOURCE_RENDER_PIPELINE = 12 enum DriverResource#
- Vulkan: VkPipeline.
const DRIVER_RESOURCE_VULKAN_DEVICE = 0 enum DriverResourceDeprecated#
const DRIVER_RESOURCE_VULKAN_PHYSICAL_DEVICE = 1 enum DriverResourceDeprecated#
const DRIVER_RESOURCE_VULKAN_INSTANCE = 2 enum DriverResourceDeprecated#
const DRIVER_RESOURCE_VULKAN_QUEUE = 3 enum DriverResourceDeprecated#
const DRIVER_RESOURCE_VULKAN_QUEUE_FAMILY_INDEX = 4 enum DriverResourceDeprecated#
const DRIVER_RESOURCE_VULKAN_IMAGE = 5 enum DriverResourceDeprecated#
const DRIVER_RESOURCE_VULKAN_IMAGE_VIEW = 6 enum DriverResourceDeprecated#
const DRIVER_RESOURCE_VULKAN_IMAGE_NATIVE_TEXTURE_FORMAT = 7 enum DriverResourceDeprecated#
const DRIVER_RESOURCE_VULKAN_SAMPLER = 8 enum DriverResourceDeprecated#
const DRIVER_RESOURCE_VULKAN_DESCRIPTOR_SET = 9 enum DriverResourceDeprecated#
const DRIVER_RESOURCE_VULKAN_BUFFER = 10 enum DriverResourceDeprecated#
const DRIVER_RESOURCE_VULKAN_COMPUTE_PIPELINE = 11 enum DriverResourceDeprecated#
const DRIVER_RESOURCE_VULKAN_RENDER_PIPELINE = 12 enum DriverResourceDeprecated#
const DATA_FORMAT_R4G4_UNORM_PACK8 = 0 enum DataFormat#
4-bit-per-channel red/green channel data format, packed into 8 bits. Values are in the [0.0, 1.0] range.
Note: More information on all data formats can be found on the Identification of formats section of the Vulkan specification, as well as the VkFormat enum.
const DATA_FORMAT_R4G4B4A4_UNORM_PACK16 = 1 enum DataFormat#
4-bit-per-channel red/green/blue/alpha channel data format, packed into 16 bits. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_B4G4R4A4_UNORM_PACK16 = 2 enum DataFormat#
4-bit-per-channel blue/green/red/alpha channel data format, packed into 16 bits. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_R5G6B5_UNORM_PACK16 = 3 enum DataFormat#
Red/green/blue channel data format with 5 bits of red, 6 bits of green and 5 bits of blue, packed into 16 bits. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_B5G6R5_UNORM_PACK16 = 4 enum DataFormat#
Blue/green/red channel data format with 5 bits of blue, 6 bits of green and 5 bits of red, packed into 16 bits. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_R5G5B5A1_UNORM_PACK16 = 5 enum DataFormat#
Red/green/blue/alpha channel data format with 5 bits of red, 6 bits of green, 5 bits of blue and 1 bit of alpha, packed into 16 bits. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_B5G5R5A1_UNORM_PACK16 = 6 enum DataFormat#
Blue/green/red/alpha channel data format with 5 bits of blue, 6 bits of green, 5 bits of red and 1 bit of alpha, packed into 16 bits. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_A1R5G5B5_UNORM_PACK16 = 7 enum DataFormat#
Alpha/red/green/blue channel data format with 1 bit of alpha, 5 bits of red, 6 bits of green and 5 bits of blue, packed into 16 bits. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_R8_UNORM = 8 enum DataFormat#
8-bit-per-channel unsigned floating-point red channel data format with normalized value. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_R8_SNORM = 9 enum DataFormat#
8-bit-per-channel signed floating-point red channel data format with normalized value. Values are in the [-1.0, 1.0] range.
const DATA_FORMAT_R8_USCALED = 10 enum DataFormat#
8-bit-per-channel unsigned floating-point red channel data format with scaled value (value is converted from integer to float). Values are in the [0.0, 255.0] range.
const DATA_FORMAT_R8_SSCALED = 11 enum DataFormat#
8-bit-per-channel signed floating-point red channel data format with scaled value (value is converted from integer to float). Values are in the [-127.0, 127.0] range.
const DATA_FORMAT_R8_UINT = 12 enum DataFormat#
8-bit-per-channel unsigned integer red channel data format. Values are in the [0, 255] range.
const DATA_FORMAT_R8_SINT = 13 enum DataFormat#
8-bit-per-channel signed integer red channel data format. Values are in the [-127, 127] range.
const DATA_FORMAT_R8_SRGB = 14 enum DataFormat#
8-bit-per-channel unsigned floating-point red channel data format with normalized value and non-linear sRGB encoding. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_R8G8_UNORM = 15 enum DataFormat#
8-bit-per-channel unsigned floating-point red/green channel data format with normalized value. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_R8G8_SNORM = 16 enum DataFormat#
8-bit-per-channel signed floating-point red/green channel data format with normalized value. Values are in the [-1.0, 1.0] range.
const DATA_FORMAT_R8G8_USCALED = 17 enum DataFormat#
8-bit-per-channel unsigned floating-point red/green channel data format with scaled value (value is converted from integer to float). Values are in the [0.0, 255.0] range.
const DATA_FORMAT_R8G8_SSCALED = 18 enum DataFormat#
8-bit-per-channel signed floating-point red/green channel data format with scaled value (value is converted from integer to float). Values are in the [-127.0, 127.0] range.
const DATA_FORMAT_R8G8_UINT = 19 enum DataFormat#
8-bit-per-channel unsigned integer red/green channel data format. Values are in the [0, 255] range.
const DATA_FORMAT_R8G8_SINT = 20 enum DataFormat#
8-bit-per-channel signed integer red/green channel data format. Values are in the [-127, 127] range.
const DATA_FORMAT_R8G8_SRGB = 21 enum DataFormat#
8-bit-per-channel unsigned floating-point red/green channel data format with normalized value and non-linear sRGB encoding. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_R8G8B8_UNORM = 22 enum DataFormat#
8-bit-per-channel unsigned floating-point red/green/blue channel data format with normalized value. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_R8G8B8_SNORM = 23 enum DataFormat#
8-bit-per-channel signed floating-point red/green/blue channel data format with normalized value. Values are in the [-1.0, 1.0] range.
const DATA_FORMAT_R8G8B8_USCALED = 24 enum DataFormat#
8-bit-per-channel unsigned floating-point red/green/blue channel data format with scaled value (value is converted from integer to float). Values are in the [0.0, 255.0] range.
const DATA_FORMAT_R8G8B8_SSCALED = 25 enum DataFormat#
8-bit-per-channel signed floating-point red/green/blue channel data format with scaled value (value is converted from integer to float). Values are in the [-127.0, 127.0] range.
const DATA_FORMAT_R8G8B8_UINT = 26 enum DataFormat#
8-bit-per-channel unsigned integer red/green/blue channel data format. Values are in the [0, 255] range.
const DATA_FORMAT_R8G8B8_SINT = 27 enum DataFormat#
8-bit-per-channel signed integer red/green/blue channel data format. Values are in the [-127, 127] range.
const DATA_FORMAT_R8G8B8_SRGB = 28 enum DataFormat#
8-bit-per-channel unsigned floating-point red/green/blue/blue channel data format with normalized value and non-linear sRGB encoding. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_B8G8R8_UNORM = 29 enum DataFormat#
8-bit-per-channel unsigned floating-point blue/green/red channel data format with normalized value. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_B8G8R8_SNORM = 30 enum DataFormat#
8-bit-per-channel signed floating-point blue/green/red channel data format with normalized value. Values are in the [-1.0, 1.0] range.
const DATA_FORMAT_B8G8R8_USCALED = 31 enum DataFormat#
8-bit-per-channel unsigned floating-point blue/green/red channel data format with scaled value (value is converted from integer to float). Values are in the [0.0, 255.0] range.
const DATA_FORMAT_B8G8R8_SSCALED = 32 enum DataFormat#
8-bit-per-channel signed floating-point blue/green/red channel data format with scaled value (value is converted from integer to float). Values are in the [-127.0, 127.0] range.
const DATA_FORMAT_B8G8R8_UINT = 33 enum DataFormat#
8-bit-per-channel unsigned integer blue/green/red channel data format. Values are in the [0, 255] range.
const DATA_FORMAT_B8G8R8_SINT = 34 enum DataFormat#
8-bit-per-channel signed integer blue/green/red channel data format. Values are in the [-127, 127] range.
const DATA_FORMAT_B8G8R8_SRGB = 35 enum DataFormat#
8-bit-per-channel unsigned floating-point blue/green/red data format with normalized value and non-linear sRGB encoding. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_R8G8B8A8_UNORM = 36 enum DataFormat#
8-bit-per-channel unsigned floating-point red/green/blue/alpha channel data format with normalized value. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_R8G8B8A8_SNORM = 37 enum DataFormat#
8-bit-per-channel signed floating-point red/green/blue/alpha channel data format with normalized value. Values are in the [-1.0, 1.0] range.
const DATA_FORMAT_R8G8B8A8_USCALED = 38 enum DataFormat#
8-bit-per-channel unsigned floating-point red/green/blue/alpha channel data format with scaled value (value is converted from integer to float). Values are in the [0.0, 255.0] range.
const DATA_FORMAT_R8G8B8A8_SSCALED = 39 enum DataFormat#
8-bit-per-channel signed floating-point red/green/blue/alpha channel data format with scaled value (value is converted from integer to float). Values are in the [-127.0, 127.0] range.
const DATA_FORMAT_R8G8B8A8_UINT = 40 enum DataFormat#
8-bit-per-channel unsigned integer red/green/blue/alpha channel data format. Values are in the [0, 255] range.
const DATA_FORMAT_R8G8B8A8_SINT = 41 enum DataFormat#
8-bit-per-channel signed integer red/green/blue/alpha channel data format. Values are in the [-127, 127] range.
const DATA_FORMAT_R8G8B8A8_SRGB = 42 enum DataFormat#
8-bit-per-channel unsigned floating-point red/green/blue/alpha channel data format with normalized value and non-linear sRGB encoding. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_B8G8R8A8_UNORM = 43 enum DataFormat#
8-bit-per-channel unsigned floating-point blue/green/red/alpha channel data format with normalized value. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_B8G8R8A8_SNORM = 44 enum DataFormat#
8-bit-per-channel signed floating-point blue/green/red/alpha channel data format with normalized value. Values are in the [-1.0, 1.0] range.
const DATA_FORMAT_B8G8R8A8_USCALED = 45 enum DataFormat#
8-bit-per-channel unsigned floating-point blue/green/red/alpha channel data format with scaled value (value is converted from integer to float). Values are in the [0.0, 255.0] range.
const DATA_FORMAT_B8G8R8A8_SSCALED = 46 enum DataFormat#
8-bit-per-channel signed floating-point blue/green/red/alpha channel data format with scaled value (value is converted from integer to float). Values are in the [-127.0, 127.0] range.
const DATA_FORMAT_B8G8R8A8_UINT = 47 enum DataFormat#
8-bit-per-channel unsigned integer blue/green/red/alpha channel data format. Values are in the [0, 255] range.
const DATA_FORMAT_B8G8R8A8_SINT = 48 enum DataFormat#
8-bit-per-channel signed integer blue/green/red/alpha channel data format. Values are in the [-127, 127] range.
const DATA_FORMAT_B8G8R8A8_SRGB = 49 enum DataFormat#
8-bit-per-channel unsigned floating-point blue/green/red/alpha channel data format with normalized value and non-linear sRGB encoding. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_A8B8G8R8_UNORM_PACK32 = 50 enum DataFormat#
8-bit-per-channel unsigned floating-point alpha/red/green/blue channel data format with normalized value, packed in 32 bits. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_A8B8G8R8_SNORM_PACK32 = 51 enum DataFormat#
8-bit-per-channel signed floating-point alpha/red/green/blue channel data format with normalized value, packed in 32 bits. Values are in the [-1.0, 1.0] range.
const DATA_FORMAT_A8B8G8R8_USCALED_PACK32 = 52 enum DataFormat#
8-bit-per-channel unsigned floating-point alpha/red/green/blue channel data format with scaled value (value is converted from integer to float), packed in 32 bits. Values are in the [0.0, 255.0] range.
const DATA_FORMAT_A8B8G8R8_SSCALED_PACK32 = 53 enum DataFormat#
8-bit-per-channel signed floating-point alpha/red/green/blue channel data format with scaled value (value is converted from integer to float), packed in 32 bits. Values are in the [-127.0, 127.0] range.
const DATA_FORMAT_A8B8G8R8_UINT_PACK32 = 54 enum DataFormat#
8-bit-per-channel unsigned integer alpha/red/green/blue channel data format, packed in 32 bits. Values are in the [0, 255] range.
const DATA_FORMAT_A8B8G8R8_SINT_PACK32 = 55 enum DataFormat#
8-bit-per-channel signed integer alpha/red/green/blue channel data format, packed in 32 bits. Values are in the [-127, 127] range.
const DATA_FORMAT_A8B8G8R8_SRGB_PACK32 = 56 enum DataFormat#
8-bit-per-channel unsigned floating-point alpha/red/green/blue channel data format with normalized value and non-linear sRGB encoding, packed in 32 bits. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_A2R10G10B10_UNORM_PACK32 = 57 enum DataFormat#
Unsigned floating-point alpha/red/green/blue channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of red, 10 bits of green and 10 bits of blue. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_A2R10G10B10_SNORM_PACK32 = 58 enum DataFormat#
Signed floating-point alpha/red/green/blue channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of red, 10 bits of green and 10 bits of blue. Values are in the [-1.0, 1.0] range.
const DATA_FORMAT_A2R10G10B10_USCALED_PACK32 = 59 enum DataFormat#
Unsigned floating-point alpha/red/green/blue channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of red, 10 bits of green and 10 bits of blue. Values are in the [0.0, 1023.0] range for red/green/blue and [0.0, 3.0] for alpha.
const DATA_FORMAT_A2R10G10B10_SSCALED_PACK32 = 60 enum DataFormat#
Signed floating-point alpha/red/green/blue channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of red, 10 bits of green and 10 bits of blue. Values are in the [-511.0, 511.0] range for red/green/blue and [-1.0, 1.0] for alpha.
const DATA_FORMAT_A2R10G10B10_UINT_PACK32 = 61 enum DataFormat#
Unsigned integer alpha/red/green/blue channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of red, 10 bits of green and 10 bits of blue. Values are in the [0, 1023] range for red/green/blue and [0, 3] for alpha.
const DATA_FORMAT_A2R10G10B10_SINT_PACK32 = 62 enum DataFormat#
Signed integer alpha/red/green/blue channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of red, 10 bits of green and 10 bits of blue. Values are in the [-511, 511] range for red/green/blue and [-1, 1] for alpha.
const DATA_FORMAT_A2B10G10R10_UNORM_PACK32 = 63 enum DataFormat#
Unsigned floating-point alpha/blue/green/red channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of blue, 10 bits of green and 10 bits of red. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_A2B10G10R10_SNORM_PACK32 = 64 enum DataFormat#
Signed floating-point alpha/blue/green/red channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of blue, 10 bits of green and 10 bits of red. Values are in the [-1.0, 1.0] range.
const DATA_FORMAT_A2B10G10R10_USCALED_PACK32 = 65 enum DataFormat#
Unsigned floating-point alpha/blue/green/red channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of blue, 10 bits of green and 10 bits of red. Values are in the [0.0, 1023.0] range for blue/green/red and [0.0, 3.0] for alpha.
const DATA_FORMAT_A2B10G10R10_SSCALED_PACK32 = 66 enum DataFormat#
Signed floating-point alpha/blue/green/red channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of blue, 10 bits of green and 10 bits of red. Values are in the [-511.0, 511.0] range for blue/green/red and [-1.0, 1.0] for alpha.
const DATA_FORMAT_A2B10G10R10_UINT_PACK32 = 67 enum DataFormat#
Unsigned integer alpha/blue/green/red channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of blue, 10 bits of green and 10 bits of red. Values are in the [0, 1023] range for blue/green/red and [0, 3] for alpha.
const DATA_FORMAT_A2B10G10R10_SINT_PACK32 = 68 enum DataFormat#
Signed integer alpha/blue/green/red channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of blue, 10 bits of green and 10 bits of red. Values are in the [-511, 511] range for blue/green/red and [-1, 1] for alpha.
const DATA_FORMAT_R16_UNORM = 69 enum DataFormat#
16-bit-per-channel unsigned floating-point red channel data format with normalized value. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_R16_SNORM = 70 enum DataFormat#
16-bit-per-channel signed floating-point red channel data format with normalized value. Values are in the [-1.0, 1.0] range.
const DATA_FORMAT_R16_USCALED = 71 enum DataFormat#
16-bit-per-channel unsigned floating-point red channel data format with scaled value (value is converted from integer to float). Values are in the [0.0, 65535.0] range.
const DATA_FORMAT_R16_SSCALED = 72 enum DataFormat#
16-bit-per-channel signed floating-point red channel data format with scaled value (value is converted from integer to float). Values are in the [-32767.0, 32767.0] range.
const DATA_FORMAT_R16_UINT = 73 enum DataFormat#
16-bit-per-channel unsigned integer red channel data format. Values are in the [0.0, 65535] range.
const DATA_FORMAT_R16_SINT = 74 enum DataFormat#
16-bit-per-channel signed integer red channel data format. Values are in the [-32767, 32767] range.
const DATA_FORMAT_R16_SFLOAT = 75 enum DataFormat#
16-bit-per-channel signed floating-point red channel data format with the value stored as-is.
const DATA_FORMAT_R16G16_UNORM = 76 enum DataFormat#
16-bit-per-channel unsigned floating-point red/green channel data format with normalized value. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_R16G16_SNORM = 77 enum DataFormat#
16-bit-per-channel signed floating-point red/green channel data format with normalized value. Values are in the [-1.0, 1.0] range.
const DATA_FORMAT_R16G16_USCALED = 78 enum DataFormat#
16-bit-per-channel unsigned floating-point red/green channel data format with scaled value (value is converted from integer to float). Values are in the [0.0, 65535.0] range.
const DATA_FORMAT_R16G16_SSCALED = 79 enum DataFormat#
16-bit-per-channel signed floating-point red/green channel data format with scaled value (value is converted from integer to float). Values are in the [-32767.0, 32767.0] range.
const DATA_FORMAT_R16G16_UINT = 80 enum DataFormat#
16-bit-per-channel unsigned integer red/green channel data format. Values are in the [0.0, 65535] range.
const DATA_FORMAT_R16G16_SINT = 81 enum DataFormat#
16-bit-per-channel signed integer red/green channel data format. Values are in the [-32767, 32767] range.
const DATA_FORMAT_R16G16_SFLOAT = 82 enum DataFormat#
16-bit-per-channel signed floating-point red/green channel data format with the value stored as-is.
const DATA_FORMAT_R16G16B16_UNORM = 83 enum DataFormat#
16-bit-per-channel unsigned floating-point red/green/blue channel data format with normalized value. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_R16G16B16_SNORM = 84 enum DataFormat#
16-bit-per-channel signed floating-point red/green/blue channel data format with normalized value. Values are in the [-1.0, 1.0] range.
const DATA_FORMAT_R16G16B16_USCALED = 85 enum DataFormat#
16-bit-per-channel unsigned floating-point red/green/blue channel data format with scaled value (value is converted from integer to float). Values are in the [0.0, 65535.0] range.
const DATA_FORMAT_R16G16B16_SSCALED = 86 enum DataFormat#
16-bit-per-channel signed floating-point red/green/blue channel data format with scaled value (value is converted from integer to float). Values are in the [-32767.0, 32767.0] range.
const DATA_FORMAT_R16G16B16_UINT = 87 enum DataFormat#
16-bit-per-channel unsigned integer red/green/blue channel data format. Values are in the [0.0, 65535] range.
const DATA_FORMAT_R16G16B16_SINT = 88 enum DataFormat#
16-bit-per-channel signed integer red/green/blue channel data format. Values are in the [-32767, 32767] range.
const DATA_FORMAT_R16G16B16_SFLOAT = 89 enum DataFormat#
16-bit-per-channel signed floating-point red/green/blue channel data format with the value stored as-is.
const DATA_FORMAT_R16G16B16A16_UNORM = 90 enum DataFormat#
16-bit-per-channel unsigned floating-point red/green/blue/alpha channel data format with normalized value. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_R16G16B16A16_SNORM = 91 enum DataFormat#
16-bit-per-channel signed floating-point red/green/blue/alpha channel data format with normalized value. Values are in the [-1.0, 1.0] range.
const DATA_FORMAT_R16G16B16A16_USCALED = 92 enum DataFormat#
16-bit-per-channel unsigned floating-point red/green/blue/alpha channel data format with scaled value (value is converted from integer to float). Values are in the [0.0, 65535.0] range.
const DATA_FORMAT_R16G16B16A16_SSCALED = 93 enum DataFormat#
16-bit-per-channel signed floating-point red/green/blue/alpha channel data format with scaled value (value is converted from integer to float). Values are in the [-32767.0, 32767.0] range.
const DATA_FORMAT_R16G16B16A16_UINT = 94 enum DataFormat#
16-bit-per-channel unsigned integer red/green/blue/alpha channel data format. Values are in the [0.0, 65535] range.
const DATA_FORMAT_R16G16B16A16_SINT = 95 enum DataFormat#
16-bit-per-channel signed integer red/green/blue/alpha channel data format. Values are in the [-32767, 32767] range.
const DATA_FORMAT_R16G16B16A16_SFLOAT = 96 enum DataFormat#
16-bit-per-channel signed floating-point red/green/blue/alpha channel data format with the value stored as-is.
const DATA_FORMAT_R32_UINT = 97 enum DataFormat#
32-bit-per-channel unsigned integer red channel data format. Values are in the [0, 2^32 - 1] range.
const DATA_FORMAT_R32_SINT = 98 enum DataFormat#
32-bit-per-channel signed integer red channel data format. Values are in the [2^31 + 1, 2^31 - 1] range.
const DATA_FORMAT_R32_SFLOAT = 99 enum DataFormat#
32-bit-per-channel signed floating-point red channel data format with the value stored as-is.
const DATA_FORMAT_R32G32_UINT = 100 enum DataFormat#
32-bit-per-channel unsigned integer red/green channel data format. Values are in the [0, 2^32 - 1] range.
const DATA_FORMAT_R32G32_SINT = 101 enum DataFormat#
32-bit-per-channel signed integer red/green channel data format. Values are in the [2^31 + 1, 2^31 - 1] range.
const DATA_FORMAT_R32G32_SFLOAT = 102 enum DataFormat#
32-bit-per-channel signed floating-point red/green channel data format with the value stored as-is.
const DATA_FORMAT_R32G32B32_UINT = 103 enum DataFormat#
32-bit-per-channel unsigned integer red/green/blue channel data format. Values are in the [0, 2^32 - 1] range.
const DATA_FORMAT_R32G32B32_SINT = 104 enum DataFormat#
32-bit-per-channel signed integer red/green/blue channel data format. Values are in the [2^31 + 1, 2^31 - 1] range.
const DATA_FORMAT_R32G32B32_SFLOAT = 105 enum DataFormat#
32-bit-per-channel signed floating-point red/green/blue channel data format with the value stored as-is.
const DATA_FORMAT_R32G32B32A32_UINT = 106 enum DataFormat#
32-bit-per-channel unsigned integer red/green/blue/alpha channel data format. Values are in the [0, 2^32 - 1] range.
const DATA_FORMAT_R32G32B32A32_SINT = 107 enum DataFormat#
32-bit-per-channel signed integer red/green/blue/alpha channel data format. Values are in the [2^31 + 1, 2^31 - 1] range.
const DATA_FORMAT_R32G32B32A32_SFLOAT = 108 enum DataFormat#
32-bit-per-channel signed floating-point red/green/blue/alpha channel data format with the value stored as-is.
const DATA_FORMAT_R64_UINT = 109 enum DataFormat#
64-bit-per-channel unsigned integer red channel data format. Values are in the [0, 2^64 - 1] range.
const DATA_FORMAT_R64_SINT = 110 enum DataFormat#
64-bit-per-channel signed integer red channel data format. Values are in the [2^63 + 1, 2^63 - 1] range.
const DATA_FORMAT_R64_SFLOAT = 111 enum DataFormat#
64-bit-per-channel signed floating-point red channel data format with the value stored as-is.
const DATA_FORMAT_R64G64_UINT = 112 enum DataFormat#
64-bit-per-channel unsigned integer red/green channel data format. Values are in the [0, 2^64 - 1] range.
const DATA_FORMAT_R64G64_SINT = 113 enum DataFormat#
64-bit-per-channel signed integer red/green channel data format. Values are in the [2^63 + 1, 2^63 - 1] range.
const DATA_FORMAT_R64G64_SFLOAT = 114 enum DataFormat#
64-bit-per-channel signed floating-point red/green channel data format with the value stored as-is.
const DATA_FORMAT_R64G64B64_UINT = 115 enum DataFormat#
64-bit-per-channel unsigned integer red/green/blue channel data format. Values are in the [0, 2^64 - 1] range.
const DATA_FORMAT_R64G64B64_SINT = 116 enum DataFormat#
64-bit-per-channel signed integer red/green/blue channel data format. Values are in the [2^63 + 1, 2^63 - 1] range.
const DATA_FORMAT_R64G64B64_SFLOAT = 117 enum DataFormat#
64-bit-per-channel signed floating-point red/green/blue channel data format with the value stored as-is.
const DATA_FORMAT_R64G64B64A64_UINT = 118 enum DataFormat#
64-bit-per-channel unsigned integer red/green/blue/alpha channel data format. Values are in the [0, 2^64 - 1] range.
const DATA_FORMAT_R64G64B64A64_SINT = 119 enum DataFormat#
64-bit-per-channel signed integer red/green/blue/alpha channel data format. Values are in the [2^63 + 1, 2^63 - 1] range.
const DATA_FORMAT_R64G64B64A64_SFLOAT = 120 enum DataFormat#
64-bit-per-channel signed floating-point red/green/blue/alpha channel data format with the value stored as-is.
const DATA_FORMAT_B10G11R11_UFLOAT_PACK32 = 121 enum DataFormat#
Unsigned floating-point blue/green/red data format with the value stored as-is, packed in 32 bits. The format's precision is 10 bits of blue channel, 11 bits of green channel and 11 bits of red channel.
const DATA_FORMAT_E5B9G9R9_UFLOAT_PACK32 = 122 enum DataFormat#
Unsigned floating-point exposure/blue/green/red data format with the value stored as-is, packed in 32 bits. The format's precision is 5 bits of exposure, 9 bits of blue channel, 9 bits of green channel and 9 bits of red channel.
const DATA_FORMAT_D16_UNORM = 123 enum DataFormat#
16-bit unsigned floating-point depth data format with normalized value. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_X8_D24_UNORM_PACK32 = 124 enum DataFormat#
24-bit unsigned floating-point depth data format with normalized value, plus 8 unused bits, packed in 32 bits. Values for depth are in the [0.0, 1.0] range.
const DATA_FORMAT_D32_SFLOAT = 125 enum DataFormat#
32-bit signed floating-point depth data format with the value stored as-is.
const DATA_FORMAT_S8_UINT = 126 enum DataFormat#
8-bit unsigned integer stencil data format.
const DATA_FORMAT_D16_UNORM_S8_UINT = 127 enum DataFormat#
16-bit unsigned floating-point depth data format with normalized value, plus 8 bits of stencil in unsigned integer format. Values for depth are in the [0.0, 1.0] range. Values for stencil are in the [0, 255] range.
const DATA_FORMAT_D24_UNORM_S8_UINT = 128 enum DataFormat#
24-bit unsigned floating-point depth data format with normalized value, plus 8 bits of stencil in unsigned integer format. Values for depth are in the [0.0, 1.0] range. Values for stencil are in the [0, 255] range.
const DATA_FORMAT_D32_SFLOAT_S8_UINT = 129 enum DataFormat#
32-bit signed floating-point depth data format with the value stored as-is, plus 8 bits of stencil in unsigned integer format. Values for stencil are in the [0, 255] range.
const DATA_FORMAT_BC1_RGB_UNORM_BLOCK = 130 enum DataFormat#
VRAM-compressed unsigned red/green/blue channel data format with normalized value. Values are in the [0.0, 1.0] range. The format's precision is 5 bits of red channel, 6 bits of green channel and 5 bits of blue channel. Using BC1 texture compression (also known as S3TC DXT1).
const DATA_FORMAT_BC1_RGB_SRGB_BLOCK = 131 enum DataFormat#
VRAM-compressed unsigned red/green/blue channel data format with normalized value and non-linear sRGB encoding. Values are in the [0.0, 1.0] range. The format's precision is 5 bits of red channel, 6 bits of green channel and 5 bits of blue channel. Using BC1 texture compression (also known as S3TC DXT1).
const DATA_FORMAT_BC1_RGBA_UNORM_BLOCK = 132 enum DataFormat#
VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value. Values are in the [0.0, 1.0] range. The format's precision is 5 bits of red channel, 6 bits of green channel, 5 bits of blue channel and 1 bit of alpha channel. Using BC1 texture compression (also known as S3TC DXT1).
const DATA_FORMAT_BC1_RGBA_SRGB_BLOCK = 133 enum DataFormat#
VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value and non-linear sRGB encoding. Values are in the [0.0, 1.0] range. The format's precision is 5 bits of red channel, 6 bits of green channel, 5 bits of blue channel and 1 bit of alpha channel. Using BC1 texture compression (also known as S3TC DXT1).
const DATA_FORMAT_BC2_UNORM_BLOCK = 134 enum DataFormat#
VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value. Values are in the [0.0, 1.0] range. The format's precision is 5 bits of red channel, 6 bits of green channel, 5 bits of blue channel and 4 bits of alpha channel. Using BC2 texture compression (also known as S3TC DXT3).
const DATA_FORMAT_BC2_SRGB_BLOCK = 135 enum DataFormat#
VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value and non-linear sRGB encoding. Values are in the [0.0, 1.0] range. The format's precision is 5 bits of red channel, 6 bits of green channel, 5 bits of blue channel and 4 bits of alpha channel. Using BC2 texture compression (also known as S3TC DXT3).
const DATA_FORMAT_BC3_UNORM_BLOCK = 136 enum DataFormat#
VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value. Values are in the [0.0, 1.0] range. The format's precision is 5 bits of red channel, 6 bits of green channel, 5 bits of blue channel and 8 bits of alpha channel. Using BC3 texture compression (also known as S3TC DXT5).
const DATA_FORMAT_BC3_SRGB_BLOCK = 137 enum DataFormat#
VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value and non-linear sRGB encoding. Values are in the [0.0, 1.0] range. The format's precision is 5 bits of red channel, 6 bits of green channel, 5 bits of blue channel and 8 bits of alpha channel. Using BC3 texture compression (also known as S3TC DXT5).
const DATA_FORMAT_BC4_UNORM_BLOCK = 138 enum DataFormat#
VRAM-compressed unsigned red channel data format with normalized value. Values are in the [0.0, 1.0] range. The format's precision is 8 bits of red channel. Using BC4 texture compression.
const DATA_FORMAT_BC4_SNORM_BLOCK = 139 enum DataFormat#
VRAM-compressed signed red channel data format with normalized value. Values are in the [-1.0, 1.0] range. The format's precision is 8 bits of red channel. Using BC4 texture compression.
const DATA_FORMAT_BC5_UNORM_BLOCK = 140 enum DataFormat#
VRAM-compressed unsigned red/green channel data format with normalized value. Values are in the [0.0, 1.0] range. The format's precision is 8 bits of red channel and 8 bits of green channel. Using BC5 texture compression (also known as S3TC RGTC).
const DATA_FORMAT_BC5_SNORM_BLOCK = 141 enum DataFormat#
VRAM-compressed signed red/green channel data format with normalized value. Values are in the [-1.0, 1.0] range. The format's precision is 8 bits of red channel and 8 bits of green channel. Using BC5 texture compression (also known as S3TC RGTC).
const DATA_FORMAT_BC6H_UFLOAT_BLOCK = 142 enum DataFormat#
VRAM-compressed unsigned red/green/blue channel data format with the floating-point value stored as-is. The format's precision is between 10 and 13 bits for the red/green/blue channels. Using BC6H texture compression (also known as BPTC HDR).
const DATA_FORMAT_BC6H_SFLOAT_BLOCK = 143 enum DataFormat#
VRAM-compressed signed red/green/blue channel data format with the floating-point value stored as-is. The format's precision is between 10 and 13 bits for the red/green/blue channels. Using BC6H texture compression (also known as BPTC HDR).
const DATA_FORMAT_BC7_UNORM_BLOCK = 144 enum DataFormat#
VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value. Values are in the [0.0, 1.0] range. The format's precision is between 4 and 7 bits for the red/green/blue channels and between 0 and 8 bits for the alpha channel. Also known as BPTC LDR.
const DATA_FORMAT_BC7_SRGB_BLOCK = 145 enum DataFormat#
VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value and non-linear sRGB encoding. Values are in the [0.0, 1.0] range. The format's precision is between 4 and 7 bits for the red/green/blue channels and between 0 and 8 bits for the alpha channel. Also known as BPTC LDR.
const DATA_FORMAT_ETC2_R8G8B8_UNORM_BLOCK = 146 enum DataFormat#
VRAM-compressed unsigned red/green/blue channel data format with normalized value. Values are in the [0.0, 1.0] range. Using ETC2 texture compression.
const DATA_FORMAT_ETC2_R8G8B8_SRGB_BLOCK = 147 enum DataFormat#
VRAM-compressed unsigned red/green/blue channel data format with normalized value and non-linear sRGB encoding. Values are in the [0.0, 1.0] range. Using ETC2 texture compression.
const DATA_FORMAT_ETC2_R8G8B8A1_UNORM_BLOCK = 148 enum DataFormat#
VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value. Values are in the [0.0, 1.0] range. Red/green/blue use 8 bit of precision each, with alpha using 1 bit of precision. Using ETC2 texture compression.
const DATA_FORMAT_ETC2_R8G8B8A1_SRGB_BLOCK = 149 enum DataFormat#
VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value and non-linear sRGB encoding. Values are in the [0.0, 1.0] range. Red/green/blue use 8 bit of precision each, with alpha using 1 bit of precision. Using ETC2 texture compression.
const DATA_FORMAT_ETC2_R8G8B8A8_UNORM_BLOCK = 150 enum DataFormat#
VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value. Values are in the [0.0, 1.0] range. Red/green/blue use 8 bits of precision each, with alpha using 8 bits of precision. Using ETC2 texture compression.
const DATA_FORMAT_ETC2_R8G8B8A8_SRGB_BLOCK = 151 enum DataFormat#
VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value and non-linear sRGB encoding. Values are in the [0.0, 1.0] range. Red/green/blue use 8 bits of precision each, with alpha using 8 bits of precision. Using ETC2 texture compression.
const DATA_FORMAT_EAC_R11_UNORM_BLOCK = 152 enum DataFormat#
11-bit VRAM-compressed unsigned red channel data format with normalized value. Values are in the [0.0, 1.0] range. Using ETC2 texture compression.
const DATA_FORMAT_EAC_R11_SNORM_BLOCK = 153 enum DataFormat#
11-bit VRAM-compressed signed red channel data format with normalized value. Values are in the [-1.0, 1.0] range. Using ETC2 texture compression.
const DATA_FORMAT_EAC_R11G11_UNORM_BLOCK = 154 enum DataFormat#
11-bit VRAM-compressed unsigned red/green channel data format with normalized value. Values are in the [0.0, 1.0] range. Using ETC2 texture compression.
const DATA_FORMAT_EAC_R11G11_SNORM_BLOCK = 155 enum DataFormat#
11-bit VRAM-compressed signed red/green channel data format with normalized value. Values are in the [-1.0, 1.0] range. Using ETC2 texture compression.
const DATA_FORMAT_ASTC_4x4_UNORM_BLOCK = 156 enum DataFormat#
VRAM-compressed unsigned floating-point data format with normalized value, packed in 4×4 blocks (highest quality). Values are in the [0.0, 1.0] range. Using ASTC compression.
const DATA_FORMAT_ASTC_4x4_SRGB_BLOCK = 157 enum DataFormat#
VRAM-compressed unsigned floating-point data format with normalized value and non-linear sRGB encoding, packed in 4×4 blocks (highest quality). Values are in the [0.0, 1.0] range. Using ASTC compression.
const DATA_FORMAT_ASTC_5x4_UNORM_BLOCK = 158 enum DataFormat#
VRAM-compressed unsigned floating-point data format with normalized value, packed in 5×4 blocks. Values are in the [0.0, 1.0] range. Using ASTC compression.
const DATA_FORMAT_ASTC_5x4_SRGB_BLOCK = 159 enum DataFormat#
VRAM-compressed unsigned floating-point data format with normalized value and non-linear sRGB encoding, packed in 5×4 blocks. Values are in the [0.0, 1.0] range. Using ASTC compression.
const DATA_FORMAT_ASTC_5x5_UNORM_BLOCK = 160 enum DataFormat#
VRAM-compressed unsigned floating-point data format with normalized value, packed in 5×5 blocks. Values are in the [0.0, 1.0] range. Using ASTC compression.
const DATA_FORMAT_ASTC_5x5_SRGB_BLOCK = 161 enum DataFormat#
VRAM-compressed unsigned floating-point data format with normalized value and non-linear sRGB encoding, packed in 5×5 blocks. Values are in the [0.0, 1.0] range. Using ASTC compression.
const DATA_FORMAT_ASTC_6x5_UNORM_BLOCK = 162 enum DataFormat#
VRAM-compressed unsigned floating-point data format with normalized value, packed in 6×5 blocks. Values are in the [0.0, 1.0] range. Using ASTC compression.
const DATA_FORMAT_ASTC_6x5_SRGB_BLOCK = 163 enum DataFormat#
VRAM-compressed unsigned floating-point data format with normalized value and non-linear sRGB encoding, packed in 6×5 blocks. Values are in the [0.0, 1.0] range. Using ASTC compression.
const DATA_FORMAT_ASTC_6x6_UNORM_BLOCK = 164 enum DataFormat#
VRAM-compressed unsigned floating-point data format with normalized value, packed in 6×6 blocks. Values are in the [0.0, 1.0] range. Using ASTC compression.
const DATA_FORMAT_ASTC_6x6_SRGB_BLOCK = 165 enum DataFormat#
VRAM-compressed unsigned floating-point data format with normalized value and non-linear sRGB encoding, packed in 6×6 blocks. Values are in the [0.0, 1.0] range. Using ASTC compression.
const DATA_FORMAT_ASTC_8x5_UNORM_BLOCK = 166 enum DataFormat#
VRAM-compressed unsigned floating-point data format with normalized value, packed in 8×5 blocks. Values are in the [0.0, 1.0] range. Using ASTC compression.
const DATA_FORMAT_ASTC_8x5_SRGB_BLOCK = 167 enum DataFormat#
VRAM-compressed unsigned floating-point data format with normalized value and non-linear sRGB encoding, packed in 8×5 blocks. Values are in the [0.0, 1.0] range. Using ASTC compression.
const DATA_FORMAT_ASTC_8x6_UNORM_BLOCK = 168 enum DataFormat#
VRAM-compressed unsigned floating-point data format with normalized value, packed in 8×6 blocks. Values are in the [0.0, 1.0] range. Using ASTC compression.
const DATA_FORMAT_ASTC_8x6_SRGB_BLOCK = 169 enum DataFormat#
VRAM-compressed unsigned floating-point data format with normalized value and non-linear sRGB encoding, packed in 8×6 blocks. Values are in the [0.0, 1.0] range. Using ASTC compression.
const DATA_FORMAT_ASTC_8x8_UNORM_BLOCK = 170 enum DataFormat#
VRAM-compressed unsigned floating-point data format with normalized value, packed in 8×8 blocks. Values are in the [0.0, 1.0] range. Using ASTC compression.
const DATA_FORMAT_ASTC_8x8_SRGB_BLOCK = 171 enum DataFormat#
VRAM-compressed unsigned floating-point data format with normalized value and non-linear sRGB encoding, packed in 8×8 blocks. Values are in the [0.0, 1.0] range. Using ASTC compression.
const DATA_FORMAT_ASTC_10x5_UNORM_BLOCK = 172 enum DataFormat#
VRAM-compressed unsigned floating-point data format with normalized value, packed in 10×5 blocks. Values are in the [0.0, 1.0] range. Using ASTC compression.
const DATA_FORMAT_ASTC_10x5_SRGB_BLOCK = 173 enum DataFormat#
VRAM-compressed unsigned floating-point data format with normalized value and non-linear sRGB encoding, packed in 10×5 blocks. Values are in the [0.0, 1.0] range. Using ASTC compression.
const DATA_FORMAT_ASTC_10x6_UNORM_BLOCK = 174 enum DataFormat#
VRAM-compressed unsigned floating-point data format with normalized value, packed in 10×6 blocks. Values are in the [0.0, 1.0] range. Using ASTC compression.
const DATA_FORMAT_ASTC_10x6_SRGB_BLOCK = 175 enum DataFormat#
VRAM-compressed unsigned floating-point data format with normalized value and non-linear sRGB encoding, packed in 10×6 blocks. Values are in the [0.0, 1.0] range. Using ASTC compression.
const DATA_FORMAT_ASTC_10x8_UNORM_BLOCK = 176 enum DataFormat#
VRAM-compressed unsigned floating-point data format with normalized value, packed in 10×8 blocks. Values are in the [0.0, 1.0] range. Using ASTC compression.
const DATA_FORMAT_ASTC_10x8_SRGB_BLOCK = 177 enum DataFormat#
VRAM-compressed unsigned floating-point data format with normalized value and non-linear sRGB encoding, packed in 10×8 blocks. Values are in the [0.0, 1.0] range. Using ASTC compression.
const DATA_FORMAT_ASTC_10x10_UNORM_BLOCK = 178 enum DataFormat#
VRAM-compressed unsigned floating-point data format with normalized value, packed in 10×10 blocks. Values are in the [0.0, 1.0] range. Using ASTC compression.
const DATA_FORMAT_ASTC_10x10_SRGB_BLOCK = 179 enum DataFormat#
VRAM-compressed unsigned floating-point data format with normalized value and non-linear sRGB encoding, packed in 10×10 blocks. Values are in the [0.0, 1.0] range. Using ASTC compression.
const DATA_FORMAT_ASTC_12x10_UNORM_BLOCK = 180 enum DataFormat#
VRAM-compressed unsigned floating-point data format with normalized value, packed in 12×10 blocks. Values are in the [0.0, 1.0] range. Using ASTC compression.
const DATA_FORMAT_ASTC_12x10_SRGB_BLOCK = 181 enum DataFormat#
VRAM-compressed unsigned floating-point data format with normalized value and non-linear sRGB encoding, packed in 12×10 blocks. Values are in the [0.0, 1.0] range. Using ASTC compression.
const DATA_FORMAT_ASTC_12x12_UNORM_BLOCK = 182 enum DataFormat#
VRAM-compressed unsigned floating-point data format with normalized value, packed in 12 blocks (lowest quality). Values are in the [0.0, 1.0] range. Using ASTC compression.
const DATA_FORMAT_ASTC_12x12_SRGB_BLOCK = 183 enum DataFormat#
VRAM-compressed unsigned floating-point data format with normalized value and non-linear sRGB encoding, packed in 12 blocks (lowest quality). Values are in the [0.0, 1.0] range. Using ASTC compression.
const DATA_FORMAT_G8B8G8R8_422_UNORM = 184 enum DataFormat#
8-bit-per-channel unsigned floating-point green/blue/red channel data format with normalized value. Values are in the [0.0, 1.0] range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel).
const DATA_FORMAT_B8G8R8G8_422_UNORM = 185 enum DataFormat#
8-bit-per-channel unsigned floating-point blue/green/red channel data format with normalized value. Values are in the [0.0, 1.0] range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel).
const DATA_FORMAT_G8_B8_R8_3PLANE_420_UNORM = 186 enum DataFormat#
8-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, stored across 3 separate planes (green + blue + red). Values are in the [0.0, 1.0] range. Blue and red channel data is stored at halved horizontal and vertical resolution (i.e. 2×2 adjacent pixels will share the same value for the blue/red channel).
const DATA_FORMAT_G8_B8R8_2PLANE_420_UNORM = 187 enum DataFormat#
8-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, stored across 2 separate planes (green + blue/red). Values are in the [0.0, 1.0] range. Blue and red channel data is stored at halved horizontal and vertical resolution (i.e. 2×2 adjacent pixels will share the same value for the blue/red channel).
const DATA_FORMAT_G8_B8_R8_3PLANE_422_UNORM = 188 enum DataFormat#
8-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, stored across 2 separate planes (green + blue + red). Values are in the [0.0, 1.0] range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel).
const DATA_FORMAT_G8_B8R8_2PLANE_422_UNORM = 189 enum DataFormat#
8-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, stored across 2 separate planes (green + blue/red). Values are in the [0.0, 1.0] range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel).
const DATA_FORMAT_G8_B8_R8_3PLANE_444_UNORM = 190 enum DataFormat#
8-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, stored across 3 separate planes. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_R10X6_UNORM_PACK16 = 191 enum DataFormat#
10-bit-per-channel unsigned floating-point red channel data with normalized value, plus 6 unused bits, packed in 16 bits. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_R10X6G10X6_UNORM_2PACK16 = 192 enum DataFormat#
10-bit-per-channel unsigned floating-point red/green channel data with normalized value, plus 6 unused bits after each channel, packed in 2×16 bits. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16 = 193 enum DataFormat#
10-bit-per-channel unsigned floating-point red/green/blue/alpha channel data with normalized value, plus 6 unused bits after each channel, packed in 4×16 bits. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_G10X6B10X6G10X6R10X6_422_UNORM_4PACK16 = 194 enum DataFormat#
10-bit-per-channel unsigned floating-point green/blue/green/red channel data with normalized value, plus 6 unused bits after each channel, packed in 4×16 bits. Values are in the [0.0, 1.0] range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel). The green channel is listed twice, but contains different values to allow it to be represented at full resolution.
const DATA_FORMAT_B10X6G10X6R10X6G10X6_422_UNORM_4PACK16 = 195 enum DataFormat#
10-bit-per-channel unsigned floating-point blue/green/red/green channel data with normalized value, plus 6 unused bits after each channel, packed in 4×16 bits. Values are in the [0.0, 1.0] range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel). The green channel is listed twice, but contains different values to allow it to be represented at full resolution.
const DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16 = 196 enum DataFormat#
10-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3×16 bits and stored across 2 separate planes (green + blue + red). Values are in the [0.0, 1.0] range. Blue and red channel data is stored at halved horizontal and vertical resolution (i.e. 2×2 adjacent pixels will share the same value for the blue/red channel).
const DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16 = 197 enum DataFormat#
10-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3×16 bits and stored across 2 separate planes (green + blue/red). Values are in the [0.0, 1.0] range. Blue and red channel data is stored at halved horizontal and vertical resolution (i.e. 2×2 adjacent pixels will share the same value for the blue/red channel).
const DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_422_UNORM_3PACK16 = 198 enum DataFormat#
10-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3×16 bits and stored across 3 separate planes (green + blue + red). Values are in the [0.0, 1.0] range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel).
const DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_422_UNORM_3PACK16 = 199 enum DataFormat#
10-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3×16 bits and stored across 3 separate planes (green + blue/red). Values are in the [0.0, 1.0] range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel).
const DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_444_UNORM_3PACK16 = 200 enum DataFormat#
10-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3×16 bits and stored across 3 separate planes (green + blue + red). Values are in the [0.0, 1.0] range.
const DATA_FORMAT_R12X4_UNORM_PACK16 = 201 enum DataFormat#
12-bit-per-channel unsigned floating-point red channel data with normalized value, plus 6 unused bits, packed in 16 bits. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_R12X4G12X4_UNORM_2PACK16 = 202 enum DataFormat#
12-bit-per-channel unsigned floating-point red/green channel data with normalized value, plus 6 unused bits after each channel, packed in 2×16 bits. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_R12X4G12X4B12X4A12X4_UNORM_4PACK16 = 203 enum DataFormat#
12-bit-per-channel unsigned floating-point red/green/blue/alpha channel data with normalized value, plus 6 unused bits after each channel, packed in 4×16 bits. Values are in the [0.0, 1.0] range.
const DATA_FORMAT_G12X4B12X4G12X4R12X4_422_UNORM_4PACK16 = 204 enum DataFormat#
12-bit-per-channel unsigned floating-point green/blue/green/red channel data with normalized value, plus 6 unused bits after each channel, packed in 4×16 bits. Values are in the [0.0, 1.0] range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel). The green channel is listed twice, but contains different values to allow it to be represented at full resolution.
const DATA_FORMAT_B12X4G12X4R12X4G12X4_422_UNORM_4PACK16 = 205 enum DataFormat#
12-bit-per-channel unsigned floating-point blue/green/red/green channel data with normalized value, plus 6 unused bits after each channel, packed in 4×16 bits. Values are in the [0.0, 1.0] range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel). The green channel is listed twice, but contains different values to allow it to be represented at full resolution.
const DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_420_UNORM_3PACK16 = 206 enum DataFormat#
12-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3×16 bits and stored across 2 separate planes (green + blue + red). Values are in the [0.0, 1.0] range. Blue and red channel data is stored at halved horizontal and vertical resolution (i.e. 2×2 adjacent pixels will share the same value for the blue/red channel).
const DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_420_UNORM_3PACK16 = 207 enum DataFormat#
12-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3×16 bits and stored across 2 separate planes (green + blue/red). Values are in the [0.0, 1.0] range. Blue and red channel data is stored at halved horizontal and vertical resolution (i.e. 2×2 adjacent pixels will share the same value for the blue/red channel).
const DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_422_UNORM_3PACK16 = 208 enum DataFormat#
12-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3×16 bits and stored across 3 separate planes (green + blue + red). Values are in the [0.0, 1.0] range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel).
const DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_422_UNORM_3PACK16 = 209 enum DataFormat#
12-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3×16 bits and stored across 3 separate planes (green + blue/red). Values are in the [0.0, 1.0] range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel).
const DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_444_UNORM_3PACK16 = 210 enum DataFormat#
12-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3×16 bits and stored across 3 separate planes (green + blue + red). Values are in the [0.0, 1.0] range.
const DATA_FORMAT_G16B16G16R16_422_UNORM = 211 enum DataFormat#
16-bit-per-channel unsigned floating-point green/blue/red channel data format with normalized value. Values are in the [0.0, 1.0] range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel).
const DATA_FORMAT_B16G16R16G16_422_UNORM = 212 enum DataFormat#
16-bit-per-channel unsigned floating-point blue/green/red channel data format with normalized value. Values are in the [0.0, 1.0] range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel).
const DATA_FORMAT_G16_B16_R16_3PLANE_420_UNORM = 213 enum DataFormat#
16-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Stored across 2 separate planes (green + blue + red). Values are in the [0.0, 1.0] range. Blue and red channel data is stored at halved horizontal and vertical resolution (i.e. 2×2 adjacent pixels will share the same value for the blue/red channel).
const DATA_FORMAT_G16_B16R16_2PLANE_420_UNORM = 214 enum DataFormat#
16-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Stored across 2 separate planes (green + blue/red). Values are in the [0.0, 1.0] range. Blue and red channel data is stored at halved horizontal and vertical resolution (i.e. 2×2 adjacent pixels will share the same value for the blue/red channel).
const DATA_FORMAT_G16_B16_R16_3PLANE_422_UNORM = 215 enum DataFormat#
16-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Stored across 3 separate planes (green + blue + red). Values are in the [0.0, 1.0] range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel).
const DATA_FORMAT_G16_B16R16_2PLANE_422_UNORM = 216 enum DataFormat#
16-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Stored across 3 separate planes (green + blue/red). Values are in the [0.0, 1.0] range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel).
const DATA_FORMAT_G16_B16_R16_3PLANE_444_UNORM = 217 enum DataFormat#
16-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Stored across 3 separate planes (green + blue + red). Values are in the [0.0, 1.0] range.
const DATA_FORMAT_ASTC_4x4_SFLOAT_BLOCK = 218 enum DataFormat#
const DATA_FORMAT_ASTC_5x4_SFLOAT_BLOCK = 219 enum DataFormat#
const DATA_FORMAT_ASTC_5x5_SFLOAT_BLOCK = 220 enum DataFormat#
const DATA_FORMAT_ASTC_6x5_SFLOAT_BLOCK = 221 enum DataFormat#
const DATA_FORMAT_ASTC_6x6_SFLOAT_BLOCK = 222 enum DataFormat#
const DATA_FORMAT_ASTC_8x5_SFLOAT_BLOCK = 223 enum DataFormat#
const DATA_FORMAT_ASTC_8x6_SFLOAT_BLOCK = 224 enum DataFormat#
const DATA_FORMAT_ASTC_8x8_SFLOAT_BLOCK = 225 enum DataFormat#
const DATA_FORMAT_ASTC_10x5_SFLOAT_BLOCK = 226 enum DataFormat#
const DATA_FORMAT_ASTC_10x6_SFLOAT_BLOCK = 227 enum DataFormat#
const DATA_FORMAT_ASTC_10x8_SFLOAT_BLOCK = 228 enum DataFormat#
const DATA_FORMAT_ASTC_10x10_SFLOAT_BLOCK = 229 enum DataFormat#
const DATA_FORMAT_ASTC_12x10_SFLOAT_BLOCK = 230 enum DataFormat#
const DATA_FORMAT_ASTC_12x12_SFLOAT_BLOCK = 231 enum DataFormat#
const DATA_FORMAT_MAX = 232 enum DataFormat#
Represents the size of the DataFormat enum.
const BARRIER_MASK_VERTEX = 1 enum BarrierMaskBitfield#
Vertex shader barrier mask.
const BARRIER_MASK_FRAGMENT = 8 enum BarrierMaskBitfield#
Fragment shader barrier mask.
const BARRIER_MASK_COMPUTE = 2 enum BarrierMaskBitfield#
Compute barrier mask.
const BARRIER_MASK_TRANSFER = 4 enum BarrierMaskBitfield#
Transfer barrier mask.
const BARRIER_MASK_RASTER = 9 enum BarrierMaskBitfield#
Raster barrier mask (vertex and fragment). Equivalent to BARRIER_MASK_VERTEX | BARRIER_MASK_FRAGMENT.
const BARRIER_MASK_ALL_BARRIERS = 32767 enum BarrierMaskBitfield#
Barrier mask for all types (vertex, fragment, compute, transfer).
const BARRIER_MASK_NO_BARRIER = 32768 enum BarrierMaskBitfield#
No barrier for any type.
const TEXTURE_TYPE_1D = 0 enum TextureType#
1-dimensional texture.
const TEXTURE_TYPE_2D = 1 enum TextureType#
2-dimensional texture.
const TEXTURE_TYPE_3D = 2 enum TextureType#
3-dimensional texture.
const TEXTURE_TYPE_CUBE = 3 enum TextureType#
Cubemap texture.
const TEXTURE_TYPE_1D_ARRAY = 4 enum TextureType#
Array of 1-dimensional textures.
const TEXTURE_TYPE_2D_ARRAY = 5 enum TextureType#
Array of 2-dimensional textures.
const TEXTURE_TYPE_CUBE_ARRAY = 6 enum TextureType#
Array of Cubemap textures.
const TEXTURE_TYPE_MAX = 7 enum TextureType#
Represents the size of the TextureType enum.
const TEXTURE_SAMPLES_1 = 0 enum TextureSamples#
Perform 1 texture sample (this is the fastest but lowest-quality for antialiasing).
const TEXTURE_SAMPLES_2 = 1 enum TextureSamples#
Perform 2 texture samples.
const TEXTURE_SAMPLES_4 = 2 enum TextureSamples#
Perform 4 texture samples.
const TEXTURE_SAMPLES_8 = 3 enum TextureSamples#
Perform 8 texture samples. Not supported on mobile GPUs (including Apple Silicon).
const TEXTURE_SAMPLES_16 = 4 enum TextureSamples#
Perform 16 texture samples. Not supported on mobile GPUs and many desktop GPUs.
const TEXTURE_SAMPLES_32 = 5 enum TextureSamples#
Perform 32 texture samples. Not supported on most GPUs.
const TEXTURE_SAMPLES_64 = 6 enum TextureSamples#
Perform 64 texture samples (this is the slowest but highest-quality for antialiasing). Not supported on most GPUs.
const TEXTURE_SAMPLES_MAX = 7 enum TextureSamples#
Represents the size of the TextureSamples enum.
const TEXTURE_USAGE_SAMPLING_BIT = 1 enum TextureUsageBitsBitfield#
Texture can be sampled.
const TEXTURE_USAGE_COLOR_ATTACHMENT_BIT = 2 enum TextureUsageBitsBitfield#
Texture can be used as a color attachment in a framebuffer.
const TEXTURE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT = 4 enum TextureUsageBitsBitfield#
Texture can be used as a depth/stencil attachment in a framebuffer.
const TEXTURE_USAGE_STORAGE_BIT = 8 enum TextureUsageBitsBitfield#
Texture can be used as a storage image.
const TEXTURE_USAGE_STORAGE_ATOMIC_BIT = 16 enum TextureUsageBitsBitfield#
Texture can be used as a storage image with support for atomic operations.
const TEXTURE_USAGE_CPU_READ_BIT = 32 enum TextureUsageBitsBitfield#
Texture can be read back on the CPU using texture_get_data faster than without this bit, since it is always kept in the system memory.
const TEXTURE_USAGE_CAN_UPDATE_BIT = 64 enum TextureUsageBitsBitfield#
Texture can be updated using texture_update.
const TEXTURE_USAGE_CAN_COPY_FROM_BIT = 128 enum TextureUsageBitsBitfield#
Texture can be a source for texture_copy.
const TEXTURE_USAGE_CAN_COPY_TO_BIT = 256 enum TextureUsageBitsBitfield#
Texture can be a destination for texture_copy.
const TEXTURE_USAGE_INPUT_ATTACHMENT_BIT = 512 enum TextureUsageBitsBitfield#
Texture can be used as a input attachment in a framebuffer.
const TEXTURE_SWIZZLE_IDENTITY = 0 enum TextureSwizzle#
Return the sampled value as-is.
const TEXTURE_SWIZZLE_ZERO = 1 enum TextureSwizzle#
Always return 0.0 when sampling.
const TEXTURE_SWIZZLE_ONE = 2 enum TextureSwizzle#
Always return 1.0 when sampling.
const TEXTURE_SWIZZLE_R = 3 enum TextureSwizzle#
Sample the red color channel.
const TEXTURE_SWIZZLE_G = 4 enum TextureSwizzle#
Sample the green color channel.
const TEXTURE_SWIZZLE_B = 5 enum TextureSwizzle#
Sample the blue color channel.
const TEXTURE_SWIZZLE_A = 6 enum TextureSwizzle#
Sample the alpha channel.
const TEXTURE_SWIZZLE_MAX = 7 enum TextureSwizzle#
Represents the size of the TextureSwizzle enum.
const TEXTURE_SLICE_2D = 0 enum TextureSliceType#
2-dimensional texture slice.
const TEXTURE_SLICE_CUBEMAP = 1 enum TextureSliceType#
Cubemap texture slice.
const TEXTURE_SLICE_3D = 2 enum TextureSliceType#
3-dimensional texture slice.
const SAMPLER_FILTER_NEAREST = 0 enum SamplerFilter#
Nearest-neighbor sampler filtering. Sampling at higher resolutions than the source will result in a pixelated look.
const SAMPLER_FILTER_LINEAR = 1 enum SamplerFilter#
Bilinear sampler filtering. Sampling at higher resolutions than the source will result in a blurry look.
const SAMPLER_REPEAT_MODE_REPEAT = 0 enum SamplerRepeatMode#
Sample with repeating enabled.
const SAMPLER_REPEAT_MODE_MIRRORED_REPEAT = 1 enum SamplerRepeatMode#
Sample with mirrored repeating enabled. When sampling outside the [0.0, 1.0] range, return a mirrored version of the sampler. This mirrored version is mirrored again if sampling further away, with the pattern repeating indefinitely.
const SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE = 2 enum SamplerRepeatMode#
Sample with repeating disabled. When sampling outside the [0.0, 1.0] range, return the color of the last pixel on the edge.
const SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER = 3 enum SamplerRepeatMode#
Sample with repeating disabled. When sampling outside the [0.0, 1.0] range, return the specified RDSamplerState.border_color.
const SAMPLER_REPEAT_MODE_MIRROR_CLAMP_TO_EDGE = 4 enum SamplerRepeatMode#
Sample with mirrored repeating enabled, but only once. When sampling in the [-1.0, 0.0] range, return a mirrored version of the sampler. When sampling outside the [-1.0, 1.0] range, return the color of the last pixel on the edge.
const SAMPLER_REPEAT_MODE_MAX = 5 enum SamplerRepeatMode#
Represents the size of the SamplerRepeatMode enum.
const SAMPLER_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK = 0 enum SamplerBorderColor#
Return a floating-point transparent black color when sampling outside the [0.0, 1.0] range. Only effective if the sampler repeat mode is SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER.
const SAMPLER_BORDER_COLOR_INT_TRANSPARENT_BLACK = 1 enum SamplerBorderColor#
Return a integer transparent black color when sampling outside the [0.0, 1.0] range. Only effective if the sampler repeat mode is SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER.
const SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_BLACK = 2 enum SamplerBorderColor#
Return a floating-point opaque black color when sampling outside the [0.0, 1.0] range. Only effective if the sampler repeat mode is SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER.
const SAMPLER_BORDER_COLOR_INT_OPAQUE_BLACK = 3 enum SamplerBorderColor#
Return a integer opaque black color when sampling outside the [0.0, 1.0] range. Only effective if the sampler repeat mode is SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER.
const SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_WHITE = 4 enum SamplerBorderColor#
Return a floating-point opaque white color when sampling outside the [0.0, 1.0] range. Only effective if the sampler repeat mode is SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER.
const SAMPLER_BORDER_COLOR_INT_OPAQUE_WHITE = 5 enum SamplerBorderColor#
Return a integer opaque white color when sampling outside the [0.0, 1.0] range. Only effective if the sampler repeat mode is SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER.
const SAMPLER_BORDER_COLOR_MAX = 6 enum SamplerBorderColor#
Represents the size of the SamplerBorderColor enum.
const VERTEX_FREQUENCY_VERTEX = 0 enum VertexFrequency#
Vertex attribute addressing is a function of the vertex. This is used to specify the rate at which vertex attributes are pulled from buffers.
const VERTEX_FREQUENCY_INSTANCE = 1 enum VertexFrequency#
Vertex attribute addressing is a function of the instance index. This is used to specify the rate at which vertex attributes are pulled from buffers.
const INDEX_BUFFER_FORMAT_UINT16 = 0 enum IndexBufferFormat#
Index buffer in 16-bit unsigned integer format. This limits the maximum index that can be specified to 65535.
const INDEX_BUFFER_FORMAT_UINT32 = 1 enum IndexBufferFormat#
Index buffer in 32-bit unsigned integer format. This limits the maximum index that can be specified to 4294967295.
const STORAGE_BUFFER_USAGE_DISPATCH_INDIRECT = 1 enum StorageBufferUsageBitfield#
const BUFFER_CREATION_DEVICE_ADDRESS_BIT = 1 enum BufferCreationBitsBitfield#
Optionally, set this flag if you wish to use buffer_get_device_address functionality. You must first check the GPU supports it:
rd = RenderingServer.get_rendering_device()
if rd.has_feature(RenderingDevice.SUPPORTS_BUFFER_DEVICE_ADDRESS):
storage_buffer = rd.storage_buffer_create(bytes.size(), bytes, RenderingDevice.STORAGE_BUFFER_USAGE_SHADER_DEVICE_ADDRESS):
storage_buffer_address = rd.buffer_get_device_address(storage_buffer)const BUFFER_CREATION_AS_STORAGE_BIT = 2 enum BufferCreationBitsBitfield#
Set this flag so that it is created as storage. This is useful if Compute Shaders need access (for reading or writing) to the buffer, e.g. skeletal animations are processed in Compute Shaders which need access to vertex buffers, to be later consumed by vertex shaders as part of the regular rasterization pipeline.
const UNIFORM_TYPE_SAMPLER = 0 enum UniformType#
Sampler uniform.
const UNIFORM_TYPE_SAMPLER_WITH_TEXTURE = 1 enum UniformType#
Sampler uniform with a texture.
const UNIFORM_TYPE_TEXTURE = 2 enum UniformType#
Texture uniform.
const UNIFORM_TYPE_IMAGE = 3 enum UniformType#
Image uniform.
const UNIFORM_TYPE_TEXTURE_BUFFER = 4 enum UniformType#
Texture buffer uniform.
const UNIFORM_TYPE_SAMPLER_WITH_TEXTURE_BUFFER = 5 enum UniformType#
Sampler uniform with a texture buffer.
const UNIFORM_TYPE_IMAGE_BUFFER = 6 enum UniformType#
Image buffer uniform.
const UNIFORM_TYPE_UNIFORM_BUFFER = 7 enum UniformType#
Uniform buffer uniform.
const UNIFORM_TYPE_STORAGE_BUFFER = 8 enum UniformType#
Storage buffer uniform.
const UNIFORM_TYPE_INPUT_ATTACHMENT = 9 enum UniformType#
Input attachment uniform.
const UNIFORM_TYPE_MAX = 10 enum UniformType#
Represents the size of the UniformType enum.
const RENDER_PRIMITIVE_POINTS = 0 enum RenderPrimitive#
Point rendering primitive (with constant size, regardless of distance from camera).
const RENDER_PRIMITIVE_LINES = 1 enum RenderPrimitive#
Line list rendering primitive. Lines are drawn separated from each other.
const RENDER_PRIMITIVE_LINES_WITH_ADJACENCY = 2 enum RenderPrimitive#
Line list rendering primitive with adjacency.
Note: Adjacency is only useful with geometry shaders, which Godot does not expose.
const RENDER_PRIMITIVE_LINESTRIPS = 3 enum RenderPrimitive#
Line strip rendering primitive. Lines drawn are connected to the previous vertex.
const RENDER_PRIMITIVE_LINESTRIPS_WITH_ADJACENCY = 4 enum RenderPrimitive#
Line strip rendering primitive with adjacency.
Note: Adjacency is only useful with geometry shaders, which Godot does not expose.
const RENDER_PRIMITIVE_TRIANGLES = 5 enum RenderPrimitive#
Triangle list rendering primitive. Triangles are drawn separated from each other.
const RENDER_PRIMITIVE_TRIANGLES_WITH_ADJACENCY = 6 enum RenderPrimitive#
Triangle list rendering primitive with adjacency.
Note: Adjacency is only useful with geometry shaders, which Godot does not expose.
const RENDER_PRIMITIVE_TRIANGLE_STRIPS = 7 enum RenderPrimitive#
Triangle strip rendering primitive. Triangles drawn are connected to the previous triangle.
const RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_AJACENCY = 8 enum RenderPrimitive#
Triangle strip rendering primitive with adjacency.
Note: Adjacency is only useful with geometry shaders, which Godot does not expose.
const RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_RESTART_INDEX = 9 enum RenderPrimitive#
Triangle strip rendering primitive with primitive restart enabled. Triangles drawn are connected to the previous triangle, but a primitive restart index can be specified before drawing to create a second triangle strip after the specified index.
Note: Only compatible with indexed draws.
const RENDER_PRIMITIVE_TESSELATION_PATCH = 10 enum RenderPrimitive#
Tessellation patch rendering primitive. Only useful with tessellation shaders, which can be used to deform these patches.
const RENDER_PRIMITIVE_MAX = 11 enum RenderPrimitive#
Represents the size of the RenderPrimitive enum.
const POLYGON_CULL_DISABLED = 0 enum PolygonCullMode#
Do not use polygon front face or backface culling.
const POLYGON_CULL_FRONT = 1 enum PolygonCullMode#
Use polygon frontface culling (faces pointing towards the camera are hidden).
const POLYGON_CULL_BACK = 2 enum PolygonCullMode#
Use polygon backface culling (faces pointing away from the camera are hidden).
const POLYGON_FRONT_FACE_CLOCKWISE = 0 enum PolygonFrontFace#
Clockwise winding order to determine which face of a polygon is its front face.
const POLYGON_FRONT_FACE_COUNTER_CLOCKWISE = 1 enum PolygonFrontFace#
Counter-clockwise winding order to determine which face of a polygon is its front face.
const STENCIL_OP_KEEP = 0 enum StencilOperation#
Keep the current stencil value.
const STENCIL_OP_ZERO = 1 enum StencilOperation#
Set the stencil value to 0.
const STENCIL_OP_REPLACE = 2 enum StencilOperation#
Replace the existing stencil value with the new one.
const STENCIL_OP_INCREMENT_AND_CLAMP = 3 enum StencilOperation#
Increment the existing stencil value and clamp to the maximum representable unsigned value if reached. Stencil bits are considered as an unsigned integer.
const STENCIL_OP_DECREMENT_AND_CLAMP = 4 enum StencilOperation#
Decrement the existing stencil value and clamp to the minimum value if reached. Stencil bits are considered as an unsigned integer.
const STENCIL_OP_INVERT = 5 enum StencilOperation#
Bitwise-invert the existing stencil value.
const STENCIL_OP_INCREMENT_AND_WRAP = 6 enum StencilOperation#
Increment the stencil value and wrap around to 0 if reaching the maximum representable unsigned. Stencil bits are considered as an unsigned integer.
const STENCIL_OP_DECREMENT_AND_WRAP = 7 enum StencilOperation#
Decrement the stencil value and wrap around to the maximum representable unsigned if reaching the minimum. Stencil bits are considered as an unsigned integer.
const STENCIL_OP_MAX = 8 enum StencilOperation#
Represents the size of the StencilOperation enum.
const COMPARE_OP_NEVER = 0 enum CompareOperator#
"Never" comparison (opposite of COMPARE_OP_ALWAYS).
const COMPARE_OP_LESS = 1 enum CompareOperator#
"Less than" comparison.
const COMPARE_OP_EQUAL = 2 enum CompareOperator#
"Equal" comparison.
const COMPARE_OP_LESS_OR_EQUAL = 3 enum CompareOperator#
"Less than or equal" comparison.
const COMPARE_OP_GREATER = 4 enum CompareOperator#
"Greater than" comparison.
const COMPARE_OP_NOT_EQUAL = 5 enum CompareOperator#
"Not equal" comparison.
const COMPARE_OP_GREATER_OR_EQUAL = 6 enum CompareOperator#
"Greater than or equal" comparison.
const COMPARE_OP_ALWAYS = 7 enum CompareOperator#
"Always" comparison (opposite of COMPARE_OP_NEVER).
const COMPARE_OP_MAX = 8 enum CompareOperator#
Represents the size of the CompareOperator enum.
const LOGIC_OP_CLEAR = 0 enum LogicOperation#
Clear logic operation (result is always 0). See also LOGIC_OP_SET.
const LOGIC_OP_AND = 1 enum LogicOperation#
AND logic operation.
const LOGIC_OP_AND_REVERSE = 2 enum LogicOperation#
AND logic operation with the destination operand being inverted. See also LOGIC_OP_AND_INVERTED.
const LOGIC_OP_COPY = 3 enum LogicOperation#
Copy logic operation (keeps the source value as-is). See also LOGIC_OP_COPY_INVERTED and LOGIC_OP_NO_OP.
const LOGIC_OP_AND_INVERTED = 4 enum LogicOperation#
AND logic operation with the source operand being inverted. See also LOGIC_OP_AND_REVERSE.
const LOGIC_OP_NO_OP = 5 enum LogicOperation#
No-op logic operation (keeps the destination value as-is). See also LOGIC_OP_COPY.
const LOGIC_OP_XOR = 6 enum LogicOperation#
Exclusive or (XOR) logic operation.
const LOGIC_OP_OR = 7 enum LogicOperation#
OR logic operation.
const LOGIC_OP_NOR = 8 enum LogicOperation#
Not-OR (NOR) logic operation.
const LOGIC_OP_EQUIVALENT = 9 enum LogicOperation#
Not-XOR (XNOR) logic operation.
const LOGIC_OP_INVERT = 10 enum LogicOperation#
Invert logic operation.
const LOGIC_OP_OR_REVERSE = 11 enum LogicOperation#
OR logic operation with the destination operand being inverted. See also LOGIC_OP_OR_REVERSE.
const LOGIC_OP_COPY_INVERTED = 12 enum LogicOperation#
NOT logic operation (inverts the value). See also LOGIC_OP_COPY.
const LOGIC_OP_OR_INVERTED = 13 enum LogicOperation#
OR logic operation with the source operand being inverted. See also LOGIC_OP_OR_REVERSE.
const LOGIC_OP_NAND = 14 enum LogicOperation#
Not-AND (NAND) logic operation.
const LOGIC_OP_SET = 15 enum LogicOperation#
SET logic operation (result is always 1). See also LOGIC_OP_CLEAR.
const LOGIC_OP_MAX = 16 enum LogicOperation#
Represents the size of the LogicOperation enum.
const BLEND_FACTOR_ZERO = 0 enum BlendFactor#
Constant 0.0 blend factor.
const BLEND_FACTOR_ONE = 1 enum BlendFactor#
Constant 1.0 blend factor.
const BLEND_FACTOR_SRC_COLOR = 2 enum BlendFactor#
Color blend factor is source color. Alpha blend factor is source alpha.
const BLEND_FACTOR_ONE_MINUS_SRC_COLOR = 3 enum BlendFactor#
Color blend factor is 1.0 - source color. Alpha blend factor is 1.0 - source alpha.
const BLEND_FACTOR_DST_COLOR = 4 enum BlendFactor#
Color blend factor is destination color. Alpha blend factor is destination alpha.
const BLEND_FACTOR_ONE_MINUS_DST_COLOR = 5 enum BlendFactor#
Color blend factor is 1.0 - destination color. Alpha blend factor is 1.0 - destination alpha.
const BLEND_FACTOR_SRC_ALPHA = 6 enum BlendFactor#
Color and alpha blend factor is source alpha.
const BLEND_FACTOR_ONE_MINUS_SRC_ALPHA = 7 enum BlendFactor#
Color and alpha blend factor is 1.0 - source alpha.
const BLEND_FACTOR_DST_ALPHA = 8 enum BlendFactor#
Color and alpha blend factor is destination alpha.
const BLEND_FACTOR_ONE_MINUS_DST_ALPHA = 9 enum BlendFactor#
Color and alpha blend factor is 1.0 - destination alpha.
const BLEND_FACTOR_CONSTANT_COLOR = 10 enum BlendFactor#
Color blend factor is blend constant color. Alpha blend factor is blend constant alpha (see draw_list_set_blend_constants).
const BLEND_FACTOR_ONE_MINUS_CONSTANT_COLOR = 11 enum BlendFactor#
Color blend factor is 1.0 - blend constant color. Alpha blend factor is 1.0 - blend constant alpha (see draw_list_set_blend_constants).
const BLEND_FACTOR_CONSTANT_ALPHA = 12 enum BlendFactor#
Color and alpha blend factor is blend constant alpha (see draw_list_set_blend_constants).
const BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA = 13 enum BlendFactor#
Color and alpha blend factor is 1.0 - blend constant alpha (see draw_list_set_blend_constants).
const BLEND_FACTOR_SRC_ALPHA_SATURATE = 14 enum BlendFactor#
Color blend factor is min(source alpha, 1.0 - destination alpha). Alpha blend factor is 1.0.
const BLEND_FACTOR_SRC1_COLOR = 15 enum BlendFactor#
Color blend factor is second source color. Alpha blend factor is second source alpha. Only relevant for dual-source blending.
const BLEND_FACTOR_ONE_MINUS_SRC1_COLOR = 16 enum BlendFactor#
Color blend factor is 1.0 - second source color. Alpha blend factor is 1.0 - second source alpha. Only relevant for dual-source blending.
const BLEND_FACTOR_SRC1_ALPHA = 17 enum BlendFactor#
Color and alpha blend factor is second source alpha. Only relevant for dual-source blending.
const BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA = 18 enum BlendFactor#
Color and alpha blend factor is 1.0 - second source alpha. Only relevant for dual-source blending.
const BLEND_FACTOR_MAX = 19 enum BlendFactor#
Represents the size of the BlendFactor enum.
const BLEND_OP_ADD = 0 enum BlendOperation#
Additive blending operation (source + destination).
const BLEND_OP_SUBTRACT = 1 enum BlendOperation#
Subtractive blending operation (source - destination).
const BLEND_OP_REVERSE_SUBTRACT = 2 enum BlendOperation#
Reverse subtractive blending operation (destination - source).
const BLEND_OP_MINIMUM = 3 enum BlendOperation#
Minimum blending operation (keep the lowest value of the two).
const BLEND_OP_MAXIMUM = 4 enum BlendOperation#
Maximum blending operation (keep the highest value of the two).
const BLEND_OP_MAX = 5 enum BlendOperation#
Represents the size of the BlendOperation enum.
const DYNAMIC_STATE_LINE_WIDTH = 1 enum PipelineDynamicStateFlagsBitfield#
Allows dynamically changing the width of rendering lines.
const DYNAMIC_STATE_DEPTH_BIAS = 2 enum PipelineDynamicStateFlagsBitfield#
Allows dynamically changing the depth bias.
const DYNAMIC_STATE_BLEND_CONSTANTS = 4 enum PipelineDynamicStateFlagsBitfield#
const DYNAMIC_STATE_DEPTH_BOUNDS = 8 enum PipelineDynamicStateFlagsBitfield#
const DYNAMIC_STATE_STENCIL_COMPARE_MASK = 16 enum PipelineDynamicStateFlagsBitfield#
const DYNAMIC_STATE_STENCIL_WRITE_MASK = 32 enum PipelineDynamicStateFlagsBitfield#
const DYNAMIC_STATE_STENCIL_REFERENCE = 64 enum PipelineDynamicStateFlagsBitfield#
const INITIAL_ACTION_LOAD = 0 enum InitialActionDeprecated#
Load the previous contents of the framebuffer.
const INITIAL_ACTION_CLEAR = 1 enum InitialActionDeprecated#
Clear the whole framebuffer or its specified region.
const INITIAL_ACTION_DISCARD = 2 enum InitialActionDeprecated#
Ignore the previous contents of the framebuffer. This is the fastest option if you'll overwrite all of the pixels and don't need to read any of them.
const INITIAL_ACTION_MAX = 3 enum InitialActionDeprecated#
Represents the size of the InitialAction enum.
const INITIAL_ACTION_CLEAR_REGION = 1 enum InitialActionDeprecated#
const INITIAL_ACTION_CLEAR_REGION_CONTINUE = 1 enum InitialActionDeprecated#
const INITIAL_ACTION_KEEP = 0 enum InitialActionDeprecated#
const INITIAL_ACTION_DROP = 2 enum InitialActionDeprecated#
const INITIAL_ACTION_CONTINUE = 0 enum InitialActionDeprecated#
const FINAL_ACTION_STORE = 0 enum FinalActionDeprecated#
Store the result of the draw list in the framebuffer. This is generally what you want to do.
const FINAL_ACTION_DISCARD = 1 enum FinalActionDeprecated#
Discard the contents of the framebuffer. This is the fastest option if you don't need to use the results of the draw list.
const FINAL_ACTION_MAX = 2 enum FinalActionDeprecated#
Represents the size of the FinalAction enum.
const FINAL_ACTION_READ = 0 enum FinalActionDeprecated#
const FINAL_ACTION_CONTINUE = 0 enum FinalActionDeprecated#
const SHADER_STAGE_VERTEX = 0 enum ShaderStage#
Vertex shader stage. This can be used to manipulate vertices from a shader (but not create new vertices).
const SHADER_STAGE_FRAGMENT = 1 enum ShaderStage#
Fragment shader stage (called "pixel shader" in Direct3D). This can be used to manipulate pixels from a shader.
const SHADER_STAGE_TESSELATION_CONTROL = 2 enum ShaderStage#
Tessellation control shader stage. This can be used to create additional geometry from a shader.
const SHADER_STAGE_TESSELATION_EVALUATION = 3 enum ShaderStage#
Tessellation evaluation shader stage. This can be used to create additional geometry from a shader.
const SHADER_STAGE_COMPUTE = 4 enum ShaderStage#
Compute shader stage. This can be used to run arbitrary computing tasks in a shader, performing them on the GPU instead of the CPU.
const SHADER_STAGE_MAX = 5 enum ShaderStage#
Represents the size of the ShaderStage enum.
const SHADER_STAGE_VERTEX_BIT = 1 enum ShaderStage#
Vertex shader stage bit (see also SHADER_STAGE_VERTEX).
const SHADER_STAGE_FRAGMENT_BIT = 2 enum ShaderStage#
Fragment shader stage bit (see also SHADER_STAGE_FRAGMENT).
const SHADER_STAGE_TESSELATION_CONTROL_BIT = 4 enum ShaderStage#
Tessellation control shader stage bit (see also SHADER_STAGE_TESSELATION_CONTROL).
const SHADER_STAGE_TESSELATION_EVALUATION_BIT = 8 enum ShaderStage#
Tessellation evaluation shader stage bit (see also SHADER_STAGE_TESSELATION_EVALUATION).
const SHADER_STAGE_COMPUTE_BIT = 16 enum ShaderStage#
Compute shader stage bit (see also SHADER_STAGE_COMPUTE).
const SHADER_LANGUAGE_GLSL = 0 enum ShaderLanguage#
Khronos' GLSL shading language (used natively by OpenGL and Vulkan). This is the language used for core Godot shaders.
const SHADER_LANGUAGE_HLSL = 1 enum ShaderLanguage#
Microsoft's High-Level Shading Language (used natively by Direct3D, but can also be used in Vulkan).
const PIPELINE_SPECIALIZATION_CONSTANT_TYPE_BOOL = 0 enum PipelineSpecializationConstantType#
Boolean specialization constant.
const PIPELINE_SPECIALIZATION_CONSTANT_TYPE_INT = 1 enum PipelineSpecializationConstantType#
Integer specialization constant.
const PIPELINE_SPECIALIZATION_CONSTANT_TYPE_FLOAT = 2 enum PipelineSpecializationConstantType#
Floating-point specialization constant.
const SUPPORTS_BUFFER_DEVICE_ADDRESS = 6 enum Features#
Features support for buffer device address extension.
const LIMIT_MAX_BOUND_UNIFORM_SETS = 0 enum Limit#
Maximum number of uniform sets that can be bound at a given time.
const LIMIT_MAX_FRAMEBUFFER_COLOR_ATTACHMENTS = 1 enum Limit#
Maximum number of color framebuffer attachments that can be used at a given time.
const LIMIT_MAX_TEXTURES_PER_UNIFORM_SET = 2 enum Limit#
Maximum number of textures that can be used per uniform set.
const LIMIT_MAX_SAMPLERS_PER_UNIFORM_SET = 3 enum Limit#
Maximum number of samplers that can be used per uniform set.
const LIMIT_MAX_STORAGE_BUFFERS_PER_UNIFORM_SET = 4 enum Limit#
Maximum number of storage buffers per uniform set.
const LIMIT_MAX_STORAGE_IMAGES_PER_UNIFORM_SET = 5 enum Limit#
Maximum number of storage images per uniform set.
const LIMIT_MAX_UNIFORM_BUFFERS_PER_UNIFORM_SET = 6 enum Limit#
Maximum number of uniform buffers per uniform set.
const LIMIT_MAX_DRAW_INDEXED_INDEX = 7 enum Limit#
Maximum index for an indexed draw command.
const LIMIT_MAX_FRAMEBUFFER_HEIGHT = 8 enum Limit#
Maximum height of a framebuffer (in pixels).
const LIMIT_MAX_FRAMEBUFFER_WIDTH = 9 enum Limit#
Maximum width of a framebuffer (in pixels).
const LIMIT_MAX_TEXTURE_ARRAY_LAYERS = 10 enum Limit#
Maximum number of texture array layers.
const LIMIT_MAX_TEXTURE_SIZE_1D = 11 enum Limit#
Maximum supported 1-dimensional texture size (in pixels on a single axis).
const LIMIT_MAX_TEXTURE_SIZE_2D = 12 enum Limit#
Maximum supported 2-dimensional texture size (in pixels on a single axis).
const LIMIT_MAX_TEXTURE_SIZE_3D = 13 enum Limit#
Maximum supported 3-dimensional texture size (in pixels on a single axis).
const LIMIT_MAX_TEXTURE_SIZE_CUBE = 14 enum Limit#
Maximum supported cubemap texture size (in pixels on a single axis of a single face).
const LIMIT_MAX_TEXTURES_PER_SHADER_STAGE = 15 enum Limit#
Maximum number of textures per shader stage.
const LIMIT_MAX_SAMPLERS_PER_SHADER_STAGE = 16 enum Limit#
Maximum number of samplers per shader stage.
const LIMIT_MAX_STORAGE_BUFFERS_PER_SHADER_STAGE = 17 enum Limit#
Maximum number of storage buffers per shader stage.
const LIMIT_MAX_STORAGE_IMAGES_PER_SHADER_STAGE = 18 enum Limit#
Maximum number of storage images per shader stage.
const LIMIT_MAX_UNIFORM_BUFFERS_PER_SHADER_STAGE = 19 enum Limit#
Maximum number of uniform buffers per uniform set.
const LIMIT_MAX_PUSH_CONSTANT_SIZE = 20 enum Limit#
Maximum size of a push constant. A lot of devices are limited to 128 bytes, so try to avoid exceeding 128 bytes in push constants to ensure compatibility even if your GPU is reporting a higher value.
const LIMIT_MAX_UNIFORM_BUFFER_SIZE = 21 enum Limit#
Maximum size of a uniform buffer.
const LIMIT_MAX_VERTEX_INPUT_ATTRIBUTE_OFFSET = 22 enum Limit#
Maximum vertex input attribute offset.
const LIMIT_MAX_VERTEX_INPUT_ATTRIBUTES = 23 enum Limit#
Maximum number of vertex input attributes.
const LIMIT_MAX_VERTEX_INPUT_BINDINGS = 24 enum Limit#
Maximum number of vertex input bindings.
const LIMIT_MAX_VERTEX_INPUT_BINDING_STRIDE = 25 enum Limit#
Maximum vertex input binding stride.
const LIMIT_MIN_UNIFORM_BUFFER_OFFSET_ALIGNMENT = 26 enum Limit#
Minimum uniform buffer offset alignment.
const LIMIT_MAX_COMPUTE_SHARED_MEMORY_SIZE = 27 enum Limit#
Maximum shared memory size for compute shaders.
const LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_X = 28 enum Limit#
Maximum number of workgroups for compute shaders on the X axis.
const LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Y = 29 enum Limit#
Maximum number of workgroups for compute shaders on the Y axis.
const LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Z = 30 enum Limit#
Maximum number of workgroups for compute shaders on the Z axis.
const LIMIT_MAX_COMPUTE_WORKGROUP_INVOCATIONS = 31 enum Limit#
Maximum number of workgroup invocations for compute shaders.
const LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_X = 32 enum Limit#
Maximum workgroup size for compute shaders on the X axis.
const LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Y = 33 enum Limit#
Maximum workgroup size for compute shaders on the Y axis.
const LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Z = 34 enum Limit#
Maximum workgroup size for compute shaders on the Z axis.
const LIMIT_MAX_VIEWPORT_DIMENSIONS_X = 35 enum Limit#
Maximum viewport width (in pixels).
const LIMIT_MAX_VIEWPORT_DIMENSIONS_Y = 36 enum Limit#
Maximum viewport height (in pixels).
const LIMIT_METALFX_TEMPORAL_SCALER_MIN_SCALE = 46 enum Limit#
Returns the smallest value for ProjectSettings.rendering/scaling_3d/scale when using the MetalFX temporal upscaler.
Note: The returned value is multiplied by a factor of 1000000 to preserve 6 digits of precision. It must be divided by 1000000.0 to convert the value to a floating point number.
const LIMIT_METALFX_TEMPORAL_SCALER_MAX_SCALE = 47 enum Limit#
Returns the largest value for ProjectSettings.rendering/scaling_3d/scale when using the MetalFX temporal upscaler.
Note: The returned value is multiplied by a factor of 1000000 to preserve 6 digits of precision. It must be divided by 1000000.0 to convert the value to a floating point number.
const MEMORY_TEXTURES = 0 enum MemoryType#
Memory taken by textures.
const MEMORY_BUFFERS = 1 enum MemoryType#
Memory taken by buffers.
const MEMORY_TOTAL = 2 enum MemoryType#
Total memory taken. This is greater than the sum of MEMORY_TEXTURES and MEMORY_BUFFERS, as it also includes miscellaneous memory usage.
const INVALID_ID = -1#
Returned by functions that return an ID if a value is invalid.
const INVALID_FORMAT_ID = -1#
Returned by functions that return a format ID if a value is invalid.
const NONE = 0 enum BreadcrumbMarker#
const REFLECTION_PROBES = 65536 enum BreadcrumbMarker#
const SKY_PASS = 131072 enum BreadcrumbMarker#
const LIGHTMAPPER_PASS = 196608 enum BreadcrumbMarker#
const SHADOW_PASS_DIRECTIONAL = 262144 enum BreadcrumbMarker#
const SHADOW_PASS_CUBE = 327680 enum BreadcrumbMarker#
const OPAQUE_PASS = 393216 enum BreadcrumbMarker#
const ALPHA_PASS = 458752 enum BreadcrumbMarker#
const TRANSPARENT_PASS = 524288 enum BreadcrumbMarker#
const POST_PROCESSING_PASS = 589824 enum BreadcrumbMarker#
const BLIT_PASS = 655360 enum BreadcrumbMarker#
const UI_PASS = 720896 enum BreadcrumbMarker#
const DEBUG_PASS = 786432 enum BreadcrumbMarker#
const DRAW_DEFAULT_ALL = 0 enum DrawFlagsBitfield#
Do not clear or ignore any attachments.
const DRAW_CLEAR_COLOR_0 = 1 enum DrawFlagsBitfield#
Clear the first color attachment.
const DRAW_CLEAR_COLOR_1 = 2 enum DrawFlagsBitfield#
Clear the second color attachment.
const DRAW_CLEAR_COLOR_2 = 4 enum DrawFlagsBitfield#
Clear the third color attachment.
const DRAW_CLEAR_COLOR_3 = 8 enum DrawFlagsBitfield#
Clear the fourth color attachment.
const DRAW_CLEAR_COLOR_4 = 16 enum DrawFlagsBitfield#
Clear the fifth color attachment.
const DRAW_CLEAR_COLOR_5 = 32 enum DrawFlagsBitfield#
Clear the sixth color attachment.
const DRAW_CLEAR_COLOR_6 = 64 enum DrawFlagsBitfield#
Clear the seventh color attachment.
const DRAW_CLEAR_COLOR_7 = 128 enum DrawFlagsBitfield#
Clear the eighth color attachment.
const DRAW_CLEAR_COLOR_MASK = 255 enum DrawFlagsBitfield#
Mask for clearing all color attachments.
const DRAW_CLEAR_COLOR_ALL = 255 enum DrawFlagsBitfield#
Clear all color attachments.
const DRAW_IGNORE_COLOR_0 = 256 enum DrawFlagsBitfield#
Ignore the previous contents of the first color attachment.
const DRAW_IGNORE_COLOR_1 = 512 enum DrawFlagsBitfield#
Ignore the previous contents of the second color attachment.
const DRAW_IGNORE_COLOR_2 = 1024 enum DrawFlagsBitfield#
Ignore the previous contents of the third color attachment.
const DRAW_IGNORE_COLOR_3 = 2048 enum DrawFlagsBitfield#
Ignore the previous contents of the fourth color attachment.
const DRAW_IGNORE_COLOR_4 = 4096 enum DrawFlagsBitfield#
Ignore the previous contents of the fifth color attachment.
const DRAW_IGNORE_COLOR_5 = 8192 enum DrawFlagsBitfield#
Ignore the previous contents of the sixth color attachment.
const DRAW_IGNORE_COLOR_6 = 16384 enum DrawFlagsBitfield#
Ignore the previous contents of the seventh color attachment.
const DRAW_IGNORE_COLOR_7 = 32768 enum DrawFlagsBitfield#
Ignore the previous contents of the eighth color attachment.
const DRAW_IGNORE_COLOR_MASK = 65280 enum DrawFlagsBitfield#
Mask for ignoring all the previous contents of the color attachments.
const DRAW_IGNORE_COLOR_ALL = 65280 enum DrawFlagsBitfield#
Ignore the previous contents of all color attachments.
const DRAW_CLEAR_DEPTH = 65536 enum DrawFlagsBitfield#
Clear the depth attachment.
const DRAW_IGNORE_DEPTH = 131072 enum DrawFlagsBitfield#
Ignore the previous contents of the depth attachment.
const DRAW_CLEAR_STENCIL = 262144 enum DrawFlagsBitfield#
Clear the stencil attachment.
const DRAW_IGNORE_STENCIL = 524288 enum DrawFlagsBitfield#
Ignore the previous contents of the stencil attachment.
const DRAW_CLEAR_ALL = 327935 enum DrawFlagsBitfield#
Clear all attachments.
const DRAW_IGNORE_ALL = 720640 enum DrawFlagsBitfield#
Ignore the previous contents of all attachments.
Constructors #
Enums #
DeviceType#
enum DeviceType {
DEVICE_TYPE_OTHER = 0,
DEVICE_TYPE_INTEGRATED_GPU = 1,
DEVICE_TYPE_DISCRETE_GPU = 2,
DEVICE_TYPE_VIRTUAL_GPU = 3,
DEVICE_TYPE_CPU = 4,
DEVICE_TYPE_MAX = 5,
}DriverResource#
enum DriverResource {
DRIVER_RESOURCE_LOGICAL_DEVICE = 0,
DRIVER_RESOURCE_PHYSICAL_DEVICE = 1,
DRIVER_RESOURCE_TOPMOST_OBJECT = 2,
DRIVER_RESOURCE_COMMAND_QUEUE = 3,
DRIVER_RESOURCE_QUEUE_FAMILY = 4,
DRIVER_RESOURCE_TEXTURE = 5,
DRIVER_RESOURCE_TEXTURE_VIEW = 6,
DRIVER_RESOURCE_TEXTURE_DATA_FORMAT = 7,
DRIVER_RESOURCE_SAMPLER = 8,
DRIVER_RESOURCE_UNIFORM_SET = 9,
DRIVER_RESOURCE_BUFFER = 10,
DRIVER_RESOURCE_COMPUTE_PIPELINE = 11,
DRIVER_RESOURCE_RENDER_PIPELINE = 12,
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,
}DataFormat#
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_ASTC_4x4_SFLOAT_BLOCK = 218,
DATA_FORMAT_ASTC_5x4_SFLOAT_BLOCK = 219,
DATA_FORMAT_ASTC_5x5_SFLOAT_BLOCK = 220,
DATA_FORMAT_ASTC_6x5_SFLOAT_BLOCK = 221,
DATA_FORMAT_ASTC_6x6_SFLOAT_BLOCK = 222,
DATA_FORMAT_ASTC_8x5_SFLOAT_BLOCK = 223,
DATA_FORMAT_ASTC_8x6_SFLOAT_BLOCK = 224,
DATA_FORMAT_ASTC_8x8_SFLOAT_BLOCK = 225,
DATA_FORMAT_ASTC_10x5_SFLOAT_BLOCK = 226,
DATA_FORMAT_ASTC_10x6_SFLOAT_BLOCK = 227,
DATA_FORMAT_ASTC_10x8_SFLOAT_BLOCK = 228,
DATA_FORMAT_ASTC_10x10_SFLOAT_BLOCK = 229,
DATA_FORMAT_ASTC_12x10_SFLOAT_BLOCK = 230,
DATA_FORMAT_ASTC_12x12_SFLOAT_BLOCK = 231,
DATA_FORMAT_MAX = 232,
}BarrierMask#
enum BarrierMask {
BARRIER_MASK_VERTEX = 1,
BARRIER_MASK_FRAGMENT = 8,
BARRIER_MASK_COMPUTE = 2,
BARRIER_MASK_TRANSFER = 4,
BARRIER_MASK_RASTER = 9,
BARRIER_MASK_ALL_BARRIERS = 32767,
BARRIER_MASK_NO_BARRIER = 32768,
}TextureType#
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,
}TextureSamples#
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,
}TextureUsageBits#
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,
}TextureSwizzle#
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,
}TextureSliceType#
enum TextureSliceType {
TEXTURE_SLICE_2D = 0,
TEXTURE_SLICE_CUBEMAP = 1,
TEXTURE_SLICE_3D = 2,
}SamplerFilter#
enum SamplerFilter {
SAMPLER_FILTER_NEAREST = 0,
SAMPLER_FILTER_LINEAR = 1,
}SamplerRepeatMode#
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,
}SamplerBorderColor#
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,
}VertexFrequency#
enum VertexFrequency {
VERTEX_FREQUENCY_VERTEX = 0,
VERTEX_FREQUENCY_INSTANCE = 1,
}IndexBufferFormat#
enum IndexBufferFormat {
INDEX_BUFFER_FORMAT_UINT16 = 0,
INDEX_BUFFER_FORMAT_UINT32 = 1,
}StorageBufferUsage#
enum StorageBufferUsage {
STORAGE_BUFFER_USAGE_DISPATCH_INDIRECT = 1,
}BufferCreationBits#
enum BufferCreationBits {
BUFFER_CREATION_DEVICE_ADDRESS_BIT = 1,
BUFFER_CREATION_AS_STORAGE_BIT = 2,
}UniformType#
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,
}RenderPrimitive#
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,
}PolygonCullMode#
enum PolygonCullMode {
POLYGON_CULL_DISABLED = 0,
POLYGON_CULL_FRONT = 1,
POLYGON_CULL_BACK = 2,
}PolygonFrontFace#
enum PolygonFrontFace {
POLYGON_FRONT_FACE_CLOCKWISE = 0,
POLYGON_FRONT_FACE_COUNTER_CLOCKWISE = 1,
}StencilOperation#
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,
}CompareOperator#
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,
}LogicOperation#
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,
}BlendFactor#
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,
}BlendOperation#
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,
}PipelineDynamicStateFlags#
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,
}InitialAction#
enum InitialAction {
INITIAL_ACTION_LOAD = 0,
INITIAL_ACTION_CLEAR = 1,
INITIAL_ACTION_DISCARD = 2,
INITIAL_ACTION_MAX = 3,
INITIAL_ACTION_CLEAR_REGION = 1,
INITIAL_ACTION_CLEAR_REGION_CONTINUE = 1,
INITIAL_ACTION_KEEP = 0,
INITIAL_ACTION_DROP = 2,
INITIAL_ACTION_CONTINUE = 0,
}FinalAction#
enum FinalAction {
FINAL_ACTION_STORE = 0,
FINAL_ACTION_DISCARD = 1,
FINAL_ACTION_MAX = 2,
FINAL_ACTION_READ = 0,
FINAL_ACTION_CONTINUE = 0,
}ShaderStage#
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,
}ShaderLanguage#
enum ShaderLanguage {
SHADER_LANGUAGE_GLSL = 0,
SHADER_LANGUAGE_HLSL = 1,
}PipelineSpecializationConstantType#
enum PipelineSpecializationConstantType {
PIPELINE_SPECIALIZATION_CONSTANT_TYPE_BOOL = 0,
PIPELINE_SPECIALIZATION_CONSTANT_TYPE_INT = 1,
PIPELINE_SPECIALIZATION_CONSTANT_TYPE_FLOAT = 2,
}Features#
enum Features {
SUPPORTS_BUFFER_DEVICE_ADDRESS = 6,
}Limit#
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,
LIMIT_MAX_VIEWPORT_DIMENSIONS_X = 35,
LIMIT_MAX_VIEWPORT_DIMENSIONS_Y = 36,
LIMIT_METALFX_TEMPORAL_SCALER_MIN_SCALE = 46,
LIMIT_METALFX_TEMPORAL_SCALER_MAX_SCALE = 47,
}MemoryType#
enum MemoryType {
MEMORY_TEXTURES = 0,
MEMORY_BUFFERS = 1,
MEMORY_TOTAL = 2,
}BreadcrumbMarker#
enum BreadcrumbMarker {
NONE = 0,
REFLECTION_PROBES = 65536,
SKY_PASS = 131072,
LIGHTMAPPER_PASS = 196608,
SHADOW_PASS_DIRECTIONAL = 262144,
SHADOW_PASS_CUBE = 327680,
OPAQUE_PASS = 393216,
ALPHA_PASS = 458752,
TRANSPARENT_PASS = 524288,
POST_PROCESSING_PASS = 589824,
BLIT_PASS = 655360,
UI_PASS = 720896,
DEBUG_PASS = 786432,
}DrawFlags#
enum DrawFlags {
DRAW_DEFAULT_ALL = 0,
DRAW_CLEAR_COLOR_0 = 1,
DRAW_CLEAR_COLOR_1 = 2,
DRAW_CLEAR_COLOR_2 = 4,
DRAW_CLEAR_COLOR_3 = 8,
DRAW_CLEAR_COLOR_4 = 16,
DRAW_CLEAR_COLOR_5 = 32,
DRAW_CLEAR_COLOR_6 = 64,
DRAW_CLEAR_COLOR_7 = 128,
DRAW_CLEAR_COLOR_MASK = 255,
DRAW_CLEAR_COLOR_ALL = 255,
DRAW_IGNORE_COLOR_0 = 256,
DRAW_IGNORE_COLOR_1 = 512,
DRAW_IGNORE_COLOR_2 = 1024,
DRAW_IGNORE_COLOR_3 = 2048,
DRAW_IGNORE_COLOR_4 = 4096,
DRAW_IGNORE_COLOR_5 = 8192,
DRAW_IGNORE_COLOR_6 = 16384,
DRAW_IGNORE_COLOR_7 = 32768,
DRAW_IGNORE_COLOR_MASK = 65280,
DRAW_IGNORE_COLOR_ALL = 65280,
DRAW_CLEAR_DEPTH = 65536,
DRAW_IGNORE_DEPTH = 131072,
DRAW_CLEAR_STENCIL = 262144,
DRAW_IGNORE_STENCIL = 524288,
DRAW_CLEAR_ALL = 327935,
DRAW_IGNORE_ALL = 720640,
} Notifications#
enum {
INVALID_ID = -1,
INVALID_FORMAT_ID = -1,
}